test unordered join overlay

Author: tantaman

packages/zql-integration-tests/src/cap.pg.test.ts

@@ -244,3 +244,66 @@ test('re-add comment → issue reappears', () => {
 
   expect(view.data).toEqual(queryDelegate.materialize(q).data);
 });
+
+test('join-level unordered overlay — remove comment triggers overlay for multiple parent issues', () => {
+  // Uses ownerComments: issue.ownerId = comment.authorId
+  // All 4 issues have ownerId='user1', all comments have authorId='user1'
+  // So a single comment change matches ALL 4 issues as parents.
+  // With flip: false, the planner builds a regular Join + Cap(limit=3, unordered).
+  // When Cap pushes a remove+refill to Join, Join iterates all 4 parent issues,
+  // and for issues 2-4, generateWithOverlayUnordered (join-utils.ts) is called.
+  const q = issueQuery.whereExists('ownerComments', {flip: false});
+  const view = queryDelegate.materialize(q);
+
+  // All 4 issues should be present (all have ownerComments via ownerId='user1')
+  const initialData = view.data as ReadonlyArray<{readonly id: string}>;
+  const initialIds = initialData.map(r => r.id);
+  expect(initialIds).toContain('issue1');
+  expect(initialIds).toContain('issue2');
+  expect(initialIds).toContain('issue3');
+  expect(initialIds).toContain('issue4');
+
+  expect(view.data).toEqual(queryDelegate.materialize(q).data);
+
+  // Remove comments to ensure we hit a tracked one.
+  // Cap tracks the first 3 it encounters (unordered). Removing multiple
+  // guarantees at least one hits a tracked comment, triggering Cap refill → Join overlay.
+  // After prior tests, the remaining comments are:
+  // c1b (issue1), c2a (issue2), c3a/c3b/c3c/c3d (issue3), c4b/c4c/c4d (issue4)
+  const commentsToRemove = [
+    {
+      id: 'c2a',
+      authorId: 'user1',
+      issue_id: 'issue2',
+      text: 'Comment 2a',
+      createdAt: 1009843200000,
+    },
+    {
+      id: 'c3a',
+      authorId: 'user1',
+      issue_id: 'issue3',
+      text: 'Comment 3a',
+      createdAt: 1012521600000,
+    },
+    {
+      id: 'c3b',
+      authorId: 'user1',
+      issue_id: 'issue3',
+      text: 'Comment 3b',
+      createdAt: 1012608000000,
+    },
+    {
+      id: 'c4b',
+      authorId: 'user1',
+      issue_id: 'issue4',
+      text: 'Comment 4b',
+      createdAt: 1015113600000,
+    },
+  ];
+
+  const source = must(queryDelegate.getSource('comments'));
+  for (const row of commentsToRemove) {
+    consume(source.push({type: 'remove', row}));
+    expect(view.data).toEqual(queryDelegate.materialize(q).data);
+  }
+});

packages/zql/src/query/test/test-schemas.ts

@@ -84,6 +84,11 @@ const issueRelationships = relationships(issue, ({one, many}) => ({
     destField: ['issueId'],
     destSchema: comment,
   }),
+  ownerComments: many({
+    sourceField: ['ownerId'],
+    destField: ['authorId'],
+    destSchema: comment,
+  }),
   labels: many(
     {
       sourceField: ['id'],