@graphql-box/connection-resolver 5.4.23-unstable-12345.2 → 5.4.23-unstable-12345.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@graphql-box/connection-resolver",
   "description": "The GraphQL Box connection resolver module.",
-  "version": "5.4.23-unstable-12345.2",
+  "version": "5.4.23-unstable-12345.3",
   "author": "miami-man",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/graphql-box",
@@ -32,22 +32,22 @@
     "access": "public"
   },
   "dependencies": {
-    "@cachemap/core": "^5.2.8",
+    "@cachemap/core": "^5.3.0",
     "@types/lodash-es": "^4.17.12",
     "core-js": "^3.43.0",
     "js-base64": "^3.7.7",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.17.23",
     "type-fest": "^4.41.0",
-    "@graphql-box/core": "5.4.14-unstable-12345.2"
+    "@graphql-box/core": "5.4.14-unstable-12345.3"
   },
   "peerDependencies": {
     "graphql": "<17",
     "winston": "<4"
   },
   "devDependencies": {
-    "@cachemap/map": "^5.0.10",
+    "@cachemap/map": "^5.1.0",
     "@jest/globals": "^29.3.1",
-    "cts-types": "^0.0.10",
+    "cts-types": "^0.0.11",
     "del-cli": "^6.0.0",
     "graphql": "^16.11.0",
     "winston": "^3.17.0"

package/src/__testUtils__/generateCursorCache.ts

@@ -29,6 +29,7 @@ export const generateCursorCache = async ({
 
   if (pageRanges.length > 0 && resultsPerPage) {
     const pages = generatePages(pageRanges);
+    let cachedNodeIds: (string | number)[] = [];
 
     await Promise.all(
       pages.map(async page => {
@@ -47,14 +48,16 @@ export const generateCursorCache = async ({
           return { cursor: `${id}::${group}`, node: { id } };
         });
 
-        await cacheCursors(cursorCache, { edges, group, headers, page, totalPages, totalResults });
+        cachedNodeIds = [...cachedNodeIds, ...edges.map(edge => edge.node.id)];
+
+        await cacheCursors(cursorCache, { cachedNodeIds, edges, group, headers, page, totalPages, totalResults });
       }),
     );
   } else {
     await cursorCache.set(
       `${group}-metadata`,
-      { totalPages, totalResults },
-      { cacheHeaders: { cacheControl: headers.get('cache-control') ?? undefined } },
+      { cachedNodeIds: [], totalPages, totalResults },
+      { cacheOptions: { cacheControl: headers.get('cache-control') ?? undefined } },
     );
   }
 

package/src/helpers/cacheCursors.ts

@@ -2,6 +2,7 @@ import { type Core } from '@cachemap/core';
 import { type Edge } from '../types.ts';
 
 export type Params = {
+  cachedNodeIds: (string | number)[];
   edges: Edge[];
   group: string;
   headers: Headers;
@@ -12,14 +13,14 @@ export type Params = {
 
 export const cacheCursors = async (
   cursorCache: Core,
-  { edges, group, headers, page, totalPages, totalResults }: Params,
+  { cachedNodeIds, edges, group, headers, page, totalPages, totalResults }: Params,
 ) => {
   const cacheControl = headers.get('cache-control');
-  const options = cacheControl ? { cacheHeaders: { cacheControl } } : undefined;
+  const options = cacheControl ? { cacheOptions: { cacheControl } } : undefined;
 
   await Promise.all(
     edges.map(async ({ cursor, node }, index) => cursorCache.set(cursor, { group, index, node, page }, options)),
   );
 
-  await cursorCache.set(`${group}-metadata`, { totalPages, totalResults }, options);
+  await cursorCache.set(`${group}-metadata`, { cachedNodeIds, totalPages, totalResults }, options);
 };

package/src/helpers/getIndexesOnCurrentPage.test.ts

@@ -4,7 +4,11 @@ describe('getIndexesOnCurrentPage', () => {
   describe('when current page is last page', () => {
     it('should return the correct value', () => {
       expect(
-        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 6, resultsPerPage: 10 }),
+        getIndexesOnCurrentPage({
+          metadata: { cachedNodeIds: [], totalPages: 6, totalResults: 53 },
+          page: 6,
+          resultsPerPage: 10,
+        }),
       ).toBe(2);
     });
   });
@@ -12,7 +16,11 @@ describe('getIndexesOnCurrentPage', () => {
   describe('when current page is NOT last page', () => {
     it('should return the correct value', () => {
       expect(
-        getIndexesOnCurrentPage({ metadata: { totalPages: 6, totalResults: 53 }, page: 5, resultsPerPage: 10 }),
+        getIndexesOnCurrentPage({
+          metadata: { cachedNodeIds: [], totalPages: 6, totalResults: 53 },
+          page: 5,
+          resultsPerPage: 10,
+        }),
       ).toBe(9);
     });
   });

package/src/helpers/getPageNumbersToRequest.test.ts

@@ -15,6 +15,7 @@ describe('getPageNumbersToRequest', () => {
         page: 2,
       },
       metadata: {
+        cachedNodeIds: [],
         totalPages: 5,
         totalResults: 50,
       },
@@ -41,6 +42,7 @@ describe('getPageNumbersToRequest', () => {
         page: 4,
       },
       metadata: {
+        cachedNodeIds: [],
         totalPages: 5,
         totalResults: 50,
       },

package/src/helpers/getStartAndEndIndexes.test.ts

@@ -146,6 +146,7 @@ describe('getEndIndex', () => {
         page: 3,
       },
       metadata: {
+        cachedNodeIds: [],
         totalPages: 5,
         totalResults: 50,
       },
@@ -172,6 +173,7 @@ describe('getEndIndex', () => {
           page: 6,
         },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 6,
           totalResults: 57,
         },
@@ -197,6 +199,7 @@ describe('getEndIndex', () => {
           page: 6,
         },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 6,
           totalResults: 57,
         },
@@ -223,6 +226,7 @@ describe('getEndIndex', () => {
             page: 4,
           },
           metadata: {
+            cachedNodeIds: [],
             totalPages: 6,
             totalResults: 57,
           },
@@ -248,6 +252,7 @@ describe('getEndIndex', () => {
             page: 4,
           },
           metadata: {
+            cachedNodeIds: [],
             totalPages: 6,
             totalResults: 57,
           },

package/src/helpers/getStartAndEndPageNumbers.test.ts

@@ -93,6 +93,7 @@ describe('getEndPageNumber', () => {
     const ctx = {
       endIndex: { absolute: 5, relative: 5 },
       metadata: {
+        cachedNodeIds: [],
         totalPages: 5,
         totalResults: 50,
       },
@@ -114,6 +115,7 @@ describe('getEndPageNumber', () => {
       const ctx = {
         endIndex: { absolute: 5, relative: 5 },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 5,
           totalResults: 50,
         },
@@ -134,6 +136,7 @@ describe('getEndPageNumber', () => {
       const ctx = {
         endIndex: { absolute: 9, relative: 9 },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 5,
           totalResults: 50,
         },
@@ -154,6 +157,7 @@ describe('getEndPageNumber', () => {
       const ctx = {
         endIndex: { absolute: 37, relative: 6 },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 5,
           totalResults: 50,
         },
@@ -174,6 +178,7 @@ describe('getEndPageNumber', () => {
       const ctx = {
         endIndex: { absolute: 22, relative: 4 },
         metadata: {
+          cachedNodeIds: [],
           totalPages: 5,
           totalResults: 50,
         },

package/src/helpers/requestAndCachePages.ts

@@ -1,6 +1,13 @@
 import { type Core } from '@cachemap/core';
 import { type PlainObject } from '@graphql-box/core';
-import { type Getters, type Node, type ResourceResolver, type SetCacheMetadata } from '../types.ts';
+import {
+  type CachedEdges,
+  type CursorGroupMetadata,
+  type Getters,
+  type Node,
+  type ResourceResolver,
+  type SetCacheMetadata,
+} from '../types.ts';
 import { cacheCursors } from './cacheCursors.ts';
 import { makeEdges } from './makeEdges.ts';
 
@@ -14,6 +21,10 @@ export type Context<Resource extends PlainObject, ResourceNode extends Node> = {
   setCacheMetadata: SetCacheMetadata | undefined;
 };
 
+const filterOutCachedNodes = (nodes: Node[], cachedNodeIds: (string | number)[]): Node[] => {
+  return nodes.filter(node => !cachedNodeIds.includes(node.id));
+};
+
 export const requestAndCachePages = async <Resource extends PlainObject, ResourceNode extends Node>(
   pages: number[],
   {
@@ -27,43 +38,47 @@ export const requestAndCachePages = async <Resource extends PlainObject, Resourc
   }: Context<Resource, ResourceNode>,
 ) => {
   const errors: Error[] = [];
+  const metadata = await cursorCache.get<CursorGroupMetadata>(`${groupCursor}-metadata`);
+  let cachedNodeIds = metadata?.cachedNodeIds ?? [];
+  const cachedEdges: CachedEdges[] = [];
 
-  const cachedEdges = await Promise.all(
-    pages.map(async page => {
-      const {
-        data: pageResultData,
-        errors: pageResultErrors,
-        headers: pageResultHeaders,
-      } = await resourceResolver({
-        page,
-      });
+  for (const page of pages) {
+    const {
+      data: pageResultData,
+      errors: pageResultErrors,
+      headers: pageResultHeaders,
+    } = await resourceResolver({
+      page,
+    });
 
-      if (pageResultData) {
-        setCacheMetadata?.(fieldPath, pageResultHeaders);
-      }
+    if (pageResultData) {
+      setCacheMetadata?.(fieldPath, pageResultHeaders);
+    }
 
-      if (pageResultData && !pageResultErrors?.length) {
-        const edges = makeEdges(getters.nodes(pageResultData), node => makeIDCursor(node.id));
+    if (pageResultData && !pageResultErrors?.length) {
+      const nodes = filterOutCachedNodes(getters.nodes(pageResultData), cachedNodeIds);
+      const edges = makeEdges(nodes, node => makeIDCursor(node.id));
+      cachedNodeIds = [...cachedNodeIds, ...edges.map(edge => edge.node.id)];
 
-        await cacheCursors(cursorCache, {
-          edges,
-          group: groupCursor,
-          headers: pageResultHeaders,
-          page,
-          totalPages: getters.totalPages(pageResultData),
-          totalResults: getters.totalResults(pageResultData),
-        });
-
-        return { edges, pageNumber: page };
-      }
+      await cacheCursors(cursorCache, {
+        cachedNodeIds,
+        edges,
+        group: groupCursor,
+        headers: pageResultHeaders,
+        page,
+        totalPages: getters.totalPages(pageResultData),
+        totalResults: getters.totalResults(pageResultData),
+      });
 
-      if (pageResultErrors?.length) {
-        errors.push(...pageResultErrors);
-      }
+      cachedEdges.push({ edges, pageNumber: page });
+    } else {
+      cachedEdges.push({ edges: [], pageNumber: page });
+    }
 
-      return { edges: [], pageNumber: page };
-    }),
-  );
+    if (pageResultErrors?.length) {
+      errors.push(...pageResultErrors);
+    }
+  }
 
   return { cachedEdges, errors };
 };

package/src/helpers/validateCursor.test.ts

@@ -72,7 +72,7 @@ describe('validateCursor', () => {
 
     it('should return the correct error', async () => {
       const result = await validateCursor(args, info as GraphQLResolveInfo, ctx);
-      expect(result?.message).toBe('Curser cannot be supplied without previously being provided.');
+      expect(result?.message).toBe('Cursor cannot be supplied without previously being provided.');
     });
   });
 

package/src/helpers/validateCursor.ts

@@ -48,7 +48,7 @@ export const validateCursor = async (
   const metadata = await cursorCache.get<CursorGroupMetadata>(`${groupCursor}-metadata`);
 
   if (!metadata) {
-    return new GraphQLError('Curser cannot be supplied without previously being provided.', { nodes: fieldNodes });
+    return new GraphQLError('Cursor cannot be supplied without previously being provided.', { nodes: fieldNodes });
   }
 
   const cursor = getCursor({ after, before });

package/src/types.ts

@@ -16,6 +16,7 @@ export type CursorCacheEntry = {
 export type PartialCursorCacheEntry = SetOptional<CursorCacheEntry, 'group' | 'node'>;
 
 export type CursorGroupMetadata = {
+  cachedNodeIds: (string | number)[];
   totalPages: number;
   totalResults: number;
 };