@envelop/response-cache 2.3.4-alpha-fae0892.0 → 2.3.4-alpha-f55cd76.0

package/index.js

@@ -154,7 +154,6 @@ const hashSHA256 = async (text) => {
 };
 
 const contextSymbol = Symbol('responseCache');
-const rawDocumentStringSymbol = Symbol('rawDocumentString');
 /**
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
@@ -184,18 +183,16 @@ const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-// @deprecated This will be removed in the next major
-const defaultGetDocumentStringFromContext = context => context[rawDocumentStringSymbol];
 const documentStringByDocument = new WeakMap();
-function getDocumentStringFromDocument(documentNode) {
-    let documentString = documentStringByDocument.get(documentNode);
+function defaultGetDocumentStringFromContext(_context, args) {
+    let documentString = documentStringByDocument.get(args.document);
     if (!documentString) {
-        documentString = graphql.print(documentNode);
-        documentStringByDocument.set(documentNode, documentString);
+        documentString = graphql.print(args.document);
+        documentStringByDocument.set(args.document, documentString);
     }
     return documentString;
 }
-function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
+function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext = defaultGetDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
 includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
@@ -264,7 +261,8 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     },
                 };
             }
-            const documentString = (_a = getDocumentStringFromContext === null || getDocumentStringFromContext === void 0 ? void 0 : getDocumentStringFromContext(ctx.args.contextValue)) !== null && _a !== void 0 ? _a : getDocumentStringFromDocument(ctx.args.document);
+            // Return a document string even if the user provided function doesn't return a valid result.
+            const documentString = (_a = getDocumentStringFromContext(ctx.args.contextValue, ctx.args)) !== null && _a !== void 0 ? _a : defaultGetDocumentStringFromContext(ctx.args.contextValue, ctx.args);
             const operationId = await buildResponseCacheKey({
                 documentString,
                 variableValues: ctx.args.variableValues,

package/index.mjs

@@ -1,7 +1,7 @@
 import LRU from 'lru-cache';
 import { isAsyncIterable } from '@envelop/core';
 import { mapSchema, MapperKind } from '@graphql-tools/utils';
-import { defaultFieldResolver, TypeInfo, visit, visitWithTypeInfo, print } from 'graphql';
+import { print, defaultFieldResolver, TypeInfo, visit, visitWithTypeInfo } from 'graphql';
 import jsonStableStringify from 'fast-json-stable-stringify';
 
 const createInMemoryCache = (params) => {
@@ -148,7 +148,6 @@ const hashSHA256 = async (text) => {
 };
 
 const contextSymbol = Symbol('responseCache');
-const rawDocumentStringSymbol = Symbol('rawDocumentString');
 /**
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
@@ -178,18 +177,16 @@ const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-// @deprecated This will be removed in the next major
-const defaultGetDocumentStringFromContext = context => context[rawDocumentStringSymbol];
 const documentStringByDocument = new WeakMap();
-function getDocumentStringFromDocument(documentNode) {
-    let documentString = documentStringByDocument.get(documentNode);
+function defaultGetDocumentStringFromContext(_context, args) {
+    let documentString = documentStringByDocument.get(args.document);
     if (!documentString) {
-        documentString = print(documentNode);
-        documentStringByDocument.set(documentNode, documentString);
+        documentString = print(args.document);
+        documentStringByDocument.set(args.document, documentString);
     }
     return documentString;
 }
-function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
+function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext = defaultGetDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
 includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
@@ -258,7 +255,8 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     },
                 };
             }
-            const documentString = (_a = getDocumentStringFromContext === null || getDocumentStringFromContext === void 0 ? void 0 : getDocumentStringFromContext(ctx.args.contextValue)) !== null && _a !== void 0 ? _a : getDocumentStringFromDocument(ctx.args.document);
+            // Return a document string even if the user provided function doesn't return a valid result.
+            const documentString = (_a = getDocumentStringFromContext(ctx.args.contextValue, ctx.args)) !== null && _a !== void 0 ? _a : defaultGetDocumentStringFromContext(ctx.args.contextValue, ctx.args);
             const operationId = await buildResponseCacheKey({
                 documentString,
                 variableValues: ctx.args.variableValues,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/response-cache",
-  "version": "2.3.4-alpha-fae0892.0",
+  "version": "2.3.4-alpha-f55cd76.0",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^2.3.3",

package/plugin.d.ts

@@ -14,7 +14,7 @@ export declare type BuildResponseCacheKeyFunction = (params: {
     /** optional sessionId for make unique cache keys based on the session.  */
     sessionId?: Maybe<string>;
 }) => Promise<string>;
-export declare type GetDocumentStringFromContextFunction = (params: DefaultContext) => Maybe<string>;
+export declare type GetDocumentStringFromContextFunction = (context: DefaultContext, executionArgs: ExecutionArgs) => Maybe<string>;
 export declare type ShouldCacheResultFunction = (params: {
     result: ExecutionResult;
 }) => Boolean;
@@ -73,11 +73,10 @@ export declare type UseResponseCacheParameter<C = any> = {
     buildResponseCacheKey?: BuildResponseCacheKeyFunction;
     /**
      * Function used for reading the document string that is used for building the response cache key from the context object.
-     * By default, the useResponseCache plugin hooks into onParse and writes the original operation string to the context.
+     * By default, the useResponseCache plugin hooks into onParse and caches the original operation string in a WeakMap.
      * If you are hard overriding parse you need to set this function, otherwise responses will not be cached or served from the cache.
      * Defaults to `defaultGetDocumentStringFromContext`
      *
-     * @deprecated No longer being used in the next major version.
      */
     getDocumentStringFromContext?: GetDocumentStringFromContextFunction;
     /**
@@ -106,5 +105,5 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
-export declare const defaultGetDocumentStringFromContext: GetDocumentStringFromContextFunction;
+export declare function defaultGetDocumentStringFromContext(_context: DefaultContext, args: ExecutionArgs): string;
 export declare function useResponseCache({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentStringFromContext, shouldCacheResult, includeExtensionMetadata, }?: UseResponseCacheParameter): Plugin;