@envelop/response-cache 6.2.2 → 6.2.3

package/cjs/plugin.js

@@ -184,45 +184,34 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
                     },
                 };
             }
-            function processResult(data) {
-                if (data == null || typeof data !== 'object') {
-                    return;
-                }
-                if (Array.isArray(data)) {
-                    for (const item of data) {
-                        processResult(item);
-                    }
-                    return;
-                }
-                const typename = data.__responseCacheTypeName ?? data.__typename;
-                delete data.__responseCacheTypeName;
-                const idField = typename && idFieldByTypeName.get(typename);
-                const entityId = data.__responseCacheId ?? (idField && data[idField]);
-                delete data.__responseCacheId;
-                // Always process nested objects, even if we are skipping cache, to ensure the result is cleaned up
-                // of metadata fields added to the query document.
-                for (const fieldName in data) {
-                    processResult(data[fieldName]);
-                }
+            function onEntity(entity, data) {
                 if (skip) {
                     return;
                 }
-                if (ignoredTypesMap.has(typename) || (!sessionId && isPrivate(typename, data))) {
+                if (ignoredTypesMap.has(entity.typename) ||
+                    (!sessionId && isPrivate(entity.typename, data))) {
                     skip = true;
                     return;
                 }
-                types.add(typename);
-                if (typename in ttlPerType) {
-                    const maybeTtl = ttlPerType[typename];
+                // in case the entity has no id, we attempt to extract it from the data
+                if (!entity.id) {
+                    const idField = idFieldByTypeName.get(entity.typename);
+                    if (idField) {
+                        entity.id = data[idField];
+                    }
+                }
+                types.add(entity.typename);
+                if (entity.typename in ttlPerType) {
+                    const maybeTtl = ttlPerType[entity.typename];
                     currentTtl = calculateTtl(maybeTtl, currentTtl);
                 }
-                if (entityId != null) {
-                    identifier.set(`${typename}:${entityId}`, { typename, id: entityId });
+                if (entity.id != null) {
+                    identifier.set(`${entity.typename}:${entity.id}`, entity);
                 }
                 for (const fieldName in data) {
                     const fieldData = data[fieldName];
                     if (fieldData == null || (Array.isArray(fieldData) && fieldData.length === 0)) {
-                        const inferredTypes = typePerSchemaCoordinateMap.get(`${typename}.${fieldName}`);
+                        const inferredTypes = typePerSchemaCoordinateMap.get(`${entity.typename}.${fieldName}`);
                         inferredTypes?.forEach(inferredType => {
                             if (inferredType in ttlPerType) {
                                 const maybeTtl = ttlPerType[inferredType];
@@ -234,7 +223,10 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
                 }
             }
             function invalidateCache(result, setResult) {
-                processResult(result.data);
+                result = { ...result };
+                if (result.data) {
+                    result.data = removeMetadataFieldsFromResult(result.data, onEntity);
+                }
                 const cacheInstance = cacheFactory(onExecuteParams.args.contextValue);
                 if (cacheInstance == null) {
                     // eslint-disable-next-line no-console
@@ -286,7 +278,9 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
                 });
             }
             function maybeCacheResult(result, setResult) {
-                processResult(result.data);
+                if (result.data) {
+                    result.data = removeMetadataFieldsFromResult(result.data, onEntity);
+                }
                 // we only use the global ttl if no currentTtl has been determined.
                 const finalTtl = currentTtl ?? globalTtl;
                 if (skip || !shouldCacheResult({ cacheKey, result }) || finalTtl === 0) {
@@ -347,9 +341,28 @@ function handleAsyncIterableResult(handler) {
                 }
             }
             const newResult = { ...payload.result };
+            // Handle initial/single result
             if (newResult.data) {
                 newResult.data = removeMetadataFieldsFromResult(newResult.data);
             }
+            // Handle Incremental results
+            if ('hasNext' in newResult && newResult.incremental) {
+                newResult.incremental = newResult.incremental.map(value => {
+                    if ('items' in value && value.items) {
+                        return {
+                            ...value,
+                            items: removeMetadataFieldsFromResult(value.items),
+                        };
+                    }
+                    if ('data' in value && value.data) {
+                        return {
+                            ...value,
+                            data: removeMetadataFieldsFromResult(value.data),
+                        };
+                    }
+                    return value;
+                });
+            }
             payload.setResult(newResult);
         },
     };
@@ -376,14 +389,17 @@ function calculateTtl(typeTtl, currentTtl) {
     }
     return currentTtl;
 }
-function unwrapTypenames(type) {
-    if (type.ofType) {
-        return unwrapTypenames(type.ofType);
+function unwrapTypenames(ttype) {
+    if ((0, graphql_1.isListType)(ttype) || (0, graphql_1.isNonNullType)(ttype)) {
+        return unwrapTypenames(ttype.ofType);
     }
-    if (type._types) {
-        return type._types.map((t) => unwrapTypenames(t)).flat();
+    if ((0, graphql_1.isUnionType)(ttype)) {
+        return ttype
+            .getTypes()
+            .map(ttype => unwrapTypenames(ttype))
+            .flat();
     }
-    return [type.name];
+    return [ttype.name];
 }
 exports.cacheControlDirective = `
   enum CacheControlScope {
@@ -393,17 +409,30 @@ exports.cacheControlDirective = `
 
   directive @cacheControl(maxAge: Int, scope: CacheControlScope) on FIELD_DEFINITION | OBJECT
 `;
-function removeMetadataFieldsFromResult(data) {
+function removeMetadataFieldsFromResult(data, onEntity) {
     if (Array.isArray(data)) {
-        return data.map(removeMetadataFieldsFromResult);
+        return data.map(record => removeMetadataFieldsFromResult(record, onEntity));
     }
     // clone the data to avoid mutation
     data = { ...data };
-    delete data.__responseCacheTypeName;
-    delete data.__responseCacheId;
+    const typename = data.__responseCacheTypeName ?? data.__typename;
+    if (typeof typename === 'string') {
+        const entity = { typename };
+        delete data.__responseCacheTypeName;
+        if (data.__responseCacheId &&
+            (typeof data.__responseCacheId === 'string' || typeof data.__responseCacheId === 'number')) {
+            entity.id = data.__responseCacheId;
+            delete data.__responseCacheId;
+        }
+        onEntity?.(entity, data);
+    }
     for (const key in data) {
-        if (typeof data[key] === 'object') {
-            data[key] = removeMetadataFieldsFromResult(data[key]);
+        const value = data[key];
+        if (Array.isArray(value)) {
+            data[key] = removeMetadataFieldsFromResult(value, onEntity);
+        }
+        if (value !== null && typeof value === 'object') {
+            data[key] = removeMetadataFieldsFromResult(value, onEntity);
         }
     }
     return data;

package/esm/plugin.js

@@ -1,5 +1,5 @@
 import jsonStableStringify from 'fast-json-stable-stringify';
-import { getOperationAST, Kind, print, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
+import { getOperationAST, isListType, isNonNullType, isUnionType, Kind, print, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
 import { getDocumentString, isAsyncIterable, } from '@envelop/core';
 import { getDirective, MapperKind, mapSchema, memoize1, memoize4, mergeIncrementalResult, } from '@graphql-tools/utils';
 import { hashSHA256 } from './hash-sha256.js';
@@ -177,45 +177,34 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
                     },
                 };
             }
-            function processResult(data) {
-                if (data == null || typeof data !== 'object') {
-                    return;
-                }
-                if (Array.isArray(data)) {
-                    for (const item of data) {
-                        processResult(item);
-                    }
-                    return;
-                }
-                const typename = data.__responseCacheTypeName ?? data.__typename;
-                delete data.__responseCacheTypeName;
-                const idField = typename && idFieldByTypeName.get(typename);
-                const entityId = data.__responseCacheId ?? (idField && data[idField]);
-                delete data.__responseCacheId;
-                // Always process nested objects, even if we are skipping cache, to ensure the result is cleaned up
-                // of metadata fields added to the query document.
-                for (const fieldName in data) {
-                    processResult(data[fieldName]);
-                }
+            function onEntity(entity, data) {
                 if (skip) {
                     return;
                 }
-                if (ignoredTypesMap.has(typename) || (!sessionId && isPrivate(typename, data))) {
+                if (ignoredTypesMap.has(entity.typename) ||
+                    (!sessionId && isPrivate(entity.typename, data))) {
                     skip = true;
                     return;
                 }
-                types.add(typename);
-                if (typename in ttlPerType) {
-                    const maybeTtl = ttlPerType[typename];
+                // in case the entity has no id, we attempt to extract it from the data
+                if (!entity.id) {
+                    const idField = idFieldByTypeName.get(entity.typename);
+                    if (idField) {
+                        entity.id = data[idField];
+                    }
+                }
+                types.add(entity.typename);
+                if (entity.typename in ttlPerType) {
+                    const maybeTtl = ttlPerType[entity.typename];
                     currentTtl = calculateTtl(maybeTtl, currentTtl);
                 }
-                if (entityId != null) {
-                    identifier.set(`${typename}:${entityId}`, { typename, id: entityId });
+                if (entity.id != null) {
+                    identifier.set(`${entity.typename}:${entity.id}`, entity);
                 }
                 for (const fieldName in data) {
                     const fieldData = data[fieldName];
                     if (fieldData == null || (Array.isArray(fieldData) && fieldData.length === 0)) {
-                        const inferredTypes = typePerSchemaCoordinateMap.get(`${typename}.${fieldName}`);
+                        const inferredTypes = typePerSchemaCoordinateMap.get(`${entity.typename}.${fieldName}`);
                         inferredTypes?.forEach(inferredType => {
                             if (inferredType in ttlPerType) {
                                 const maybeTtl = ttlPerType[inferredType];
@@ -227,7 +216,10 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
                 }
             }
             function invalidateCache(result, setResult) {
-                processResult(result.data);
+                result = { ...result };
+                if (result.data) {
+                    result.data = removeMetadataFieldsFromResult(result.data, onEntity);
+                }
                 const cacheInstance = cacheFactory(onExecuteParams.args.contextValue);
                 if (cacheInstance == null) {
                     // eslint-disable-next-line no-console
@@ -279,7 +271,9 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
                 });
             }
             function maybeCacheResult(result, setResult) {
-                processResult(result.data);
+                if (result.data) {
+                    result.data = removeMetadataFieldsFromResult(result.data, onEntity);
+                }
                 // we only use the global ttl if no currentTtl has been determined.
                 const finalTtl = currentTtl ?? globalTtl;
                 if (skip || !shouldCacheResult({ cacheKey, result }) || finalTtl === 0) {
@@ -339,9 +333,28 @@ function handleAsyncIterableResult(handler) {
                 }
             }
             const newResult = { ...payload.result };
+            // Handle initial/single result
             if (newResult.data) {
                 newResult.data = removeMetadataFieldsFromResult(newResult.data);
             }
+            // Handle Incremental results
+            if ('hasNext' in newResult && newResult.incremental) {
+                newResult.incremental = newResult.incremental.map(value => {
+                    if ('items' in value && value.items) {
+                        return {
+                            ...value,
+                            items: removeMetadataFieldsFromResult(value.items),
+                        };
+                    }
+                    if ('data' in value && value.data) {
+                        return {
+                            ...value,
+                            data: removeMetadataFieldsFromResult(value.data),
+                        };
+                    }
+                    return value;
+                });
+            }
             payload.setResult(newResult);
         },
     };
@@ -367,14 +380,17 @@ function calculateTtl(typeTtl, currentTtl) {
     }
     return currentTtl;
 }
-function unwrapTypenames(type) {
-    if (type.ofType) {
-        return unwrapTypenames(type.ofType);
+function unwrapTypenames(ttype) {
+    if (isListType(ttype) || isNonNullType(ttype)) {
+        return unwrapTypenames(ttype.ofType);
     }
-    if (type._types) {
-        return type._types.map((t) => unwrapTypenames(t)).flat();
+    if (isUnionType(ttype)) {
+        return ttype
+            .getTypes()
+            .map(ttype => unwrapTypenames(ttype))
+            .flat();
     }
-    return [type.name];
+    return [ttype.name];
 }
 export const cacheControlDirective = /* GraphQL */ `
   enum CacheControlScope {
@@ -384,17 +400,30 @@ export const cacheControlDirective = /* GraphQL */ `
 
   directive @cacheControl(maxAge: Int, scope: CacheControlScope) on FIELD_DEFINITION | OBJECT
 `;
-function removeMetadataFieldsFromResult(data) {
+function removeMetadataFieldsFromResult(data, onEntity) {
     if (Array.isArray(data)) {
-        return data.map(removeMetadataFieldsFromResult);
+        return data.map(record => removeMetadataFieldsFromResult(record, onEntity));
     }
     // clone the data to avoid mutation
     data = { ...data };
-    delete data.__responseCacheTypeName;
-    delete data.__responseCacheId;
+    const typename = data.__responseCacheTypeName ?? data.__typename;
+    if (typeof typename === 'string') {
+        const entity = { typename };
+        delete data.__responseCacheTypeName;
+        if (data.__responseCacheId &&
+            (typeof data.__responseCacheId === 'string' || typeof data.__responseCacheId === 'number')) {
+            entity.id = data.__responseCacheId;
+            delete data.__responseCacheId;
+        }
+        onEntity?.(entity, data);
+    }
     for (const key in data) {
-        if (typeof data[key] === 'object') {
-            data[key] = removeMetadataFieldsFromResult(data[key]);
+        const value = data[key];
+        if (Array.isArray(value)) {
+            data[key] = removeMetadataFieldsFromResult(value, onEntity);
+        }
+        if (value !== null && typeof value === 'object') {
+            data[key] = removeMetadataFieldsFromResult(value, onEntity);
         }
     }
     return data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/response-cache",
-  "version": "6.2.2",
+  "version": "6.2.3",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^5.0.2",