Merge pull request #23 from constructive-io/feat/orm-spatial-filter-test

test(orm): document PostGIS spatial support on memory.location_geo

Author: pyramation

packages/integration-tests/__fixtures__/seed/test-data.sql

@@ -23,3 +23,32 @@ VALUES
 INSERT INTO "agentic_db_app_public".tasks (agent_id, title, description, status)
 VALUES
   ('cccccccc-cccc-cccc-cccc-cccccccccccc', 'Summarize docs', 'Summarize all project documents', 'pending');
+
+-- Memories with PostGIS Point locations for spatial-filter tests.
+-- SF and Oakland are in the Bay Area bbox; NYC is the negative control.
+INSERT INTO "agentic_db_app_public".memories (id, agent_id, title, content, location, location_geo)
+VALUES
+  (
+    'eeeeeeee-eeee-eeee-eeee-eeeeeeee0001',
+    'cccccccc-cccc-cccc-cccc-cccccccccccc',
+    'Coffee in SF',
+    'Met a collaborator near the Ferry Building.',
+    'San Francisco, CA',
+    ST_SetSRID(ST_MakePoint(-122.4194, 37.7749), 4326)::geography
+  ),
+  (
+    'eeeeeeee-eeee-eeee-eeee-eeeeeeee0002',
+    'cccccccc-cccc-cccc-cccc-cccccccccccc',
+    'Lunch in Oakland',
+    'Reviewed the retrieval benchmark over lunch.',
+    'Oakland, CA',
+    ST_SetSRID(ST_MakePoint(-122.2712, 37.8044), 4326)::geography
+  ),
+  (
+    'eeeeeeee-eeee-eeee-eeee-eeeeeeee0003',
+    'cccccccc-cccc-cccc-cccc-cccccccccccc',
+    'Meetup in NYC',
+    'Agent-infra meetup in Manhattan.',
+    'New York, NY',
+    ST_SetSRID(ST_MakePoint(-74.0060, 40.7128), 4326)::geography
+  );

packages/integration-tests/__tests__/orm.test.ts

@@ -38,6 +38,25 @@ const CONTACT_BOB = '22222222-2222-2222-2222-222222222222';
 const NOTE_KICKOFF = 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa';
 const AGENT_RESEARCH = 'cccccccc-cccc-cccc-cccc-cccccccccccc';
 
+// Memories with seeded PostGIS Point locations (see test-data.sql)
+const MEMORY_SF = 'eeeeeeee-eeee-eeee-eeee-eeeeeeee0001';
+const MEMORY_OAKLAND = 'eeeeeeee-eeee-eeee-eeee-eeeeeeee0002';
+const MEMORY_NYC = 'eeeeeeee-eeee-eeee-eeee-eeeeeeee0003';
+
+// Bounding-box polygon around the Bay Area: covers SF + Oakland, excludes NYC.
+const BAY_AREA_POLYGON = {
+  type: 'Polygon',
+  coordinates: [
+    [
+      [-122.55, 37.70],
+      [-122.20, 37.70],
+      [-122.20, 37.85],
+      [-122.55, 37.85],
+      [-122.55, 37.70],
+    ],
+  ],
+};
+
 describe('ORM integration', () => {
   let db: PgTestClient;
   let teardown: () => Promise<void>;
@@ -502,6 +521,95 @@ describe('ORM integration', () => {
     });
   });
 
+  // =========================================================================
+  // Test: PostGIS spatial support on memories.location_geo
+  //
+  // What IS testable through the typed ORM today:
+  //   - geography columns round-trip correctly (insert WKT/GeoJSON, read
+  //     back GeoJSON + srid through the generated output type)
+  //   - `locationGeo: { isNull: false }` filters out rows without geometry
+  //
+  // What is NOT testable through the typed ORM today (verified against the
+  // real schema + graphile-postgis@2.9.7 in CI): the generated
+  // `GeographyInterfaceFilter` exposes `bboxIntersects2D`, `coveredBy`,
+  // `covers`, `exactlyEquals`, `intersects` — but all of them fail at
+  // runtime with `parse error - invalid geometry` because the spatial
+  // function operators in graphile-postgis 2.9.7 pass the GeoJSON value
+  // straight through to PostgreSQL instead of wrapping it with
+  // ST_GeomFromGeoJSON(...)::geography. Only the `withinDistance` operator
+  // has the correct wrapping, and it is not exposed on the generated
+  // filter type at all. As a result, "find memories within 5km of here"
+  // and "find memories inside this polygon" are NOT possible through the
+  // typed ORM today — they require raw SQL (ST_DWithin / ST_Covers).
+  // =========================================================================
+  describe('PostGIS spatial support on memory.location_geo', () => {
+    it('returns the stored Point as GeoJSON + srid via the generated output type', async () => {
+      const result = await orm.memory
+        .findMany({
+          where: { id: { equalTo: MEMORY_SF } },
+          select: {
+            id: true,
+            title: true,
+            locationGeo: { select: { geojson: true, srid: true } },
+          },
+        })
+        .execute();
+      expectOk(result, 'memory.findMany(MEMORY_SF)');
+      const nodes = unwrapData(result.data).nodes;
+      expect(nodes).toHaveLength(1);
+      const sf = nodes[0];
+      expect(sf.locationGeo).toBeTruthy();
+      expect(sf.locationGeo.srid).toBe(4326);
+      // GeoJSON is serialized as a string by the postgis plugin.
+      const geojson =
+        typeof sf.locationGeo.geojson === 'string'
+          ? JSON.parse(sf.locationGeo.geojson)
+          : sf.locationGeo.geojson;
+      expect(geojson.type).toBe('Point');
+      expect(geojson.coordinates[0]).toBeCloseTo(-122.4194, 3);
+      expect(geojson.coordinates[1]).toBeCloseTo(37.7749, 3);
+    });
+
+    it('locationGeo: { isNull: false } returns the geo-tagged memories', async () => {
+      const result = await orm.memory
+        .findMany({
+          where: { locationGeo: { isNull: false } },
+          select: {
+            id: true,
+            title: true,
+            locationGeo: { select: { srid: true } },
+          },
+        })
+        .execute();
+      expectOk(result, 'memory.findMany(isNull:false)');
+      const nodes = unwrapData(result.data).nodes;
+      // Every returned row must actually have geometry attached.
+      for (const n of nodes) {
+        expect(n.locationGeo).toBeTruthy();
+        expect(n.locationGeo.srid).toBe(4326);
+      }
+      const ids = nodes.map((n: any) => n.id);
+      expect(ids).toEqual(
+        expect.arrayContaining([MEMORY_SF, MEMORY_OAKLAND, MEMORY_NYC]),
+      );
+    });
+
+    // Regression-guard: make the upstream bug explicit so that if a future
+    // graphile-postgis release fixes it, this test will start failing and
+    // we'll know we can promote these operators to "supported".
+    it('bboxIntersects2D is currently broken upstream (graphile-postgis@2.9.7)', async () => {
+      const result = await orm.memory
+        .findMany({
+          where: { locationGeo: { bboxIntersects2D: BAY_AREA_POLYGON } },
+          select: { id: true, title: true },
+        })
+        .execute();
+      expect(result.ok).toBe(false);
+      const err = JSON.stringify(result.errors ?? result);
+      expect(err).toMatch(/parse error - invalid geometry/i);
+    });
+  });
+
   // =========================================================================
   // Test: Conversation + Message (1:N) with message ordering via orderBy
   // =========================================================================