@common-stack/store-redis 8.3.1-alpha.6 → 8.3.1-alpha.7

package/lib/config/env-config.d.ts

@@ -0,0 +1,4 @@
+import * as envalid from 'envalid';
+export declare const config: Readonly<{
+    APP_NAME: string;
+} & envalid.CleanedEnvAccessors>;

package/lib/config/env-config.js

@@ -0,0 +1,51 @@
+import*as envalid from'envalid';const { str, bool, json, num } = envalid;
+const config = envalid.cleanEnv(process.env, {
+    APP_NAME: str({ default: 'CDMBASE' }),
+    // NODE_ENV: str({ default: 'production', choices: ['production', 'staging', 'development', 'test'] }),
+    // NATS_URL: str(),
+    // NATS_USER: str(),
+    // NATS_PW: str(),
+    // GRAPHQL_ENDPOINT: str({ default: '/graphql' }),
+    // BACKEND_URL: str(),
+    // GRAPHQL_URL: str(),
+    // CLIENT_URL: str(),
+    // MONGO_URL: str(),
+    // REDIS_CLUSTER_URL: json({
+    //     devDefault: '[{"port":6379,"host":"localhost"}]',
+    //     example: '[{"port":6379,"host":"localhost"}]',
+    // }),
+    // REDIS_URL: str({ devDefault: 'localhost' }),
+    // REDIS_CLUSTER_ENABLED: bool({ devDefault: false }),
+    // REDIS_SENTINEL_ENABLED: bool({ devDefault: true }),
+    // CONNECTION_ID: str({ devDefault: 'CONNECTION_ID' }),
+    // NAMESPACE: str({ default: 'default' }),
+    // // Comma-separated list of namespaces to enable cross-namespace communication with
+    // // e.g., "api-admin,travel-api,billing-api"
+    // CROSS_NAMESPACES: str({ default: 'api-admin-12, api-admin' }),
+    // LOG_LEVEL: str({ default: 'info', choices: ['info', 'debug', 'trace'] }),
+    // METRICS_CONFIG: json({
+    //     default: JSON.stringify({
+    //         enabled: false,
+    //         port: 3030,
+    //         path: '/metrics',
+    //     }),
+    //     devDefault: JSON.stringify({
+    //         enabled: false,
+    //         port: 3031,
+    //         path: '/metrics',
+    //     }),
+    //     example: '{"enabled":true,"port":3030,"path":"/metrics"}',
+    // }),
+    // INNGEST_EVENT_KEY: str({ devDefault: 'dummy' }),
+    // INNGEST_SIGNING_KEY: str({ devDefault: 'dummy' }),
+    // INNGEST_IS_DEV: bool({ devDefault: true, default: false }),
+    // INNGEST_ENVIRONMENT: str({ devDefault: 'development', default: 'production' }),
+    // INNGEST_BASE_URL: str({ devDefault: 'http://localhost:8288', default: 'https://api.inngest.com' }),
+    // INNGEST_CLIENT_ID: str({ devDefault: '', default: '' }),
+    // // Stable application ID used for Inngest client registration across deployments
+    // APPLICATION_ID: str({ devDefault: '', default: '' }),
+    // // WebSocket connection limits per pod instance
+    // // Recommended: ~20000 per 1Gi memory
+    // WEBSOCKET_MAX_CONNECTIONS: num({ default: 20000, devDefault: 10000 }),
+    // WEBSOCKET_LIMIT_ENABLED: bool({ default: true, devDefault: false }),
+});export{config};//# sourceMappingURL=env-config.js.map

package/lib/config/env-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-config.js","sources":["../../src/config/env-config.ts"],"sourcesContent":["import * as envalid from 'envalid';\n\nconst { str, bool, json, num } = envalid;\n\nexport const config = envalid.cleanEnv(process.env, {\n    APP_NAME: str({ default: 'CDMBASE' }),\n\n    // NODE_ENV: str({ default: 'production', choices: ['production', 'staging', 'development', 'test'] }),\n    // NATS_URL: str(),\n    // NATS_USER: str(),\n    // NATS_PW: str(),\n    // GRAPHQL_ENDPOINT: str({ default: '/graphql' }),\n    // BACKEND_URL: str(),\n    // GRAPHQL_URL: str(),\n    // CLIENT_URL: str(),\n    // MONGO_URL: str(),\n    // REDIS_CLUSTER_URL: json({\n    //     devDefault: '[{\"port\":6379,\"host\":\"localhost\"}]',\n    //     example: '[{\"port\":6379,\"host\":\"localhost\"}]',\n    // }),\n    // REDIS_URL: str({ devDefault: 'localhost' }),\n    // REDIS_CLUSTER_ENABLED: bool({ devDefault: false }),\n    // REDIS_SENTINEL_ENABLED: bool({ devDefault: true }),\n    // CONNECTION_ID: str({ devDefault: 'CONNECTION_ID' }),\n\n    // NAMESPACE: str({ default: 'default' }),\n    // // Comma-separated list of namespaces to enable cross-namespace communication with\n    // // e.g., \"api-admin,travel-api,billing-api\"\n    // CROSS_NAMESPACES: str({ default: 'api-admin-12, api-admin' }),\n    // LOG_LEVEL: str({ default: 'info', choices: ['info', 'debug', 'trace'] }),\n    // METRICS_CONFIG: json({\n    //     default: JSON.stringify({\n    //         enabled: false,\n    //         port: 3030,\n    //         path: '/metrics',\n    //     }),\n    //     devDefault: JSON.stringify({\n    //         enabled: false,\n    //         port: 3031,\n    //         path: '/metrics',\n    //     }),\n    //     example: '{\"enabled\":true,\"port\":3030,\"path\":\"/metrics\"}',\n    // }),\n    // INNGEST_EVENT_KEY: str({ devDefault: 'dummy' }),\n    // INNGEST_SIGNING_KEY: str({ devDefault: 'dummy' }),\n    // INNGEST_IS_DEV: bool({ devDefault: true, default: false }),\n    // INNGEST_ENVIRONMENT: str({ devDefault: 'development', default: 'production' }),\n    // INNGEST_BASE_URL: str({ devDefault: 'http://localhost:8288', default: 'https://api.inngest.com' }),\n    // INNGEST_CLIENT_ID: str({ devDefault: '', default: '' }),\n    // // Stable application ID used for Inngest client registration across deployments\n    // APPLICATION_ID: str({ devDefault: '', default: '' }),\n\n    // // WebSocket connection limits per pod instance\n    // // Recommended: ~20000 per 1Gi memory\n    // WEBSOCKET_MAX_CONNECTIONS: num({ default: 20000, devDefault: 10000 }),\n    // WEBSOCKET_LIMIT_ENABLED: bool({ default: true, devDefault: false }),\n});\n"],"names":[],"mappings":"gCAEA,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;AAE5B,MAAA,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE;IAChD,QAAQ,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDxC,CAAA"}

package/lib/config/index.d.ts

@@ -0,0 +1 @@
+export * from './env-config';

package/lib/index.d.ts

@@ -12,3 +12,4 @@
 export * from './core/index.js';
 export * from './services';
 export * from './services';
+export * from './plugins';

package/lib/index.js

@@ -1 +1 @@
-export{__esModule}from'./core/index.js';export{RedisCacheManager}from'./services/RedisCacheManager.js';export{IORedisClient}from'./core/ioredis.js';export{UpstashRedisClient}from'./core/upstash-redis.js';export{escapeRedisPattern,isHashLikeTenantId,isValidRedisKey,sanitizeRedisKey,sanitizeRedisKeyComponent}from'./core/keyBuilder/sanitize-redis-key.js';export{buildRedisKey,buildRedisKeyPattern}from'./core/keyBuilder/index.js';export{RedisNamespace,buildRedisKeyPatternWithNamespace,buildRedisKeyWithNamespace,extractNamespaceFromRedisKey,extractTenantIdFromRedisKey,isValidRedisKeyWithNamespace,parseRedisKey}from'./core/keyBuilder/redis-key-builder.js';export{generateQueryCacheKey}from'./core/keyBuilder/generate-query-cache-key.js';//# sourceMappingURL=index.js.map
+export{__esModule}from'./core/index.js';export{RedisCacheManager}from'./services/RedisCacheManager.js';export{invalidateCachePlugin}from'./plugins/invalidateCachePlugin.js';export{responseCachePlugin}from'./plugins/responseCachePlugin.js';export{IORedisClient}from'./core/ioredis.js';export{UpstashRedisClient}from'./core/upstash-redis.js';export{escapeRedisPattern,isHashLikeTenantId,isValidRedisKey,sanitizeRedisKey,sanitizeRedisKeyComponent}from'./core/keyBuilder/sanitize-redis-key.js';export{buildRedisKey,buildRedisKeyPattern}from'./core/keyBuilder/index.js';export{RedisNamespace,buildRedisKeyPatternWithNamespace,buildRedisKeyWithNamespace,extractNamespaceFromRedisKey,extractTenantIdFromRedisKey,isValidRedisKeyWithNamespace,parseRedisKey}from'./core/keyBuilder/redis-key-builder.js';export{generateQueryCacheKey}from'./core/keyBuilder/generate-query-cache-key.js';//# sourceMappingURL=index.js.map

package/lib/plugins/index.d.ts

@@ -0,0 +1,2 @@
+export * from './invalidateCachePlugin';
+export { responseCachePlugin } from './responseCachePlugin';

package/lib/plugins/invalidateCachePlugin.d.ts

@@ -0,0 +1,8 @@
+import { Redis, Cluster } from 'ioredis';
+import type { BaseContext, GraphQLRequestContextWillSendResponse } from '@apollo/server';
+import { ApolloServerOptions, GraphQLRequestContext } from '@apollo/server';
+export type InvalidationKeyGenerator = (requestContext: GraphQLRequestContext<unknown>, responseContext: GraphQLRequestContextWillSendResponse<unknown>, cacheKey?: string) => string;
+export declare const invalidateCachePlugin: ({ cache: redisClient, invalidateCacheKeyGenerator, }: {
+    cache: Redis | Cluster;
+    invalidateCacheKeyGenerator: InvalidationKeyGenerator;
+}) => ApolloServerOptions<BaseContext>["plugins"][0];

package/lib/plugins/invalidateCachePlugin.js

@@ -0,0 +1,63 @@
+import {uniq}from'lodash-es';import {extractTenantId,getDirectiveArgsFromSchema,CACHE_CONTROL_DIRECTIVE}from'@common-stack/server-core';import {config}from'../config/env-config.js';const invalidateCachePlugin = ({ cache: redisClient, invalidateCacheKeyGenerator, }) => ({
+    requestDidStart(requestContext) {
+        return {
+            willSendResponse: async (responseContext) => {
+                // in case of websocket request initially the requestContext comes empty
+                if (!requestContext) {
+                    return;
+                }
+                try {
+                    const hasErrors = !!requestContext.errors?.length;
+                    const { schema } = requestContext;
+                    const { queriesToInvalidate, user, req } = requestContext.contextValue;
+                    const tenantId = extractTenantId(req?.currentPageUriSegments?.authority);
+                    const [{ operation }] = responseContext.document.definitions;
+                    const isMutation = operation === 'mutation';
+                    if (hasErrors || !queriesToInvalidate?.length || !isMutation) {
+                        return;
+                    }
+                    const nestedKeys = await Promise.all(queriesToInvalidate.map(async (query) => {
+                        // Build keys in order of specificity
+                        let keys = [];
+                        const cachePolicy = getDirectiveArgsFromSchema({
+                            schema,
+                            queryName: query,
+                            directiveName: CACHE_CONTROL_DIRECTIVE,
+                        });
+                        const isPrivate = cachePolicy.scope?.toLowerCase() === 'private';
+                        // Add tenant-specific key if tenant exists
+                        if (tenantId) {
+                            keys.push(`${config.APP_NAME}:${tenantId}:${query}:*`);
+                            // Add user-specific key if user exists
+                            if (user?.sub && isPrivate) {
+                                keys.push(`${config.APP_NAME}:${tenantId}:${user.sub}:${query}:*`);
+                            }
+                        }
+                        // Add global key as fallback
+                        keys.push(`${config.APP_NAME}:${query}:*`);
+                        // Allow custom key generation if provided
+                        if (typeof invalidateCacheKeyGenerator === 'function') {
+                            keys = keys.map((key) => invalidateCacheKeyGenerator(requestContext, responseContext, key));
+                        }
+                        const matchedKeys = await Promise.all(keys.map(async (key) => {
+                            const matchingKeys = await redisClient.keys(key);
+                            if (matchingKeys.length) {
+                                return matchingKeys;
+                            }
+                            return [];
+                        }));
+                        return matchedKeys.flat();
+                    }));
+                    const keys = nestedKeys.flat();
+                    if (keys?.length) {
+                        await redisClient.del(uniq(keys));
+                    }
+                }
+                catch (e) {
+                    requestContext.logger.error('Error occurred in invalidateCachePlugin');
+                    requestContext.logger.error(e);
+                }
+            },
+        };
+    },
+});export{invalidateCachePlugin};//# sourceMappingURL=invalidateCachePlugin.js.map

package/lib/plugins/invalidateCachePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalidateCachePlugin.js","sources":["../../src/plugins/invalidateCachePlugin.ts"],"sourcesContent":["import { Redis, Cluster } from 'ioredis';\nimport { uniq } from 'lodash-es';\nimport { OperationDefinitionNode } from 'graphql/language/ast.js';\nimport type { BaseContext, GraphQLRequestContextWillSendResponse } from '@apollo/server';\nimport { ApolloServerOptions, GraphQLRequestContext } from '@apollo/server';\nimport { CACHE_CONTROL_DIRECTIVE, extractTenantId, getDirectiveArgsFromSchema } from '@common-stack/server-core';\nimport { IGraphQLCacheContext } from 'common/server';\nimport { config } from '../config';\n\nexport type InvalidationKeyGenerator = (\n    requestContext: GraphQLRequestContext<unknown>,\n    responseContext: GraphQLRequestContextWillSendResponse<unknown>,\n    cacheKey?: string,\n) => string;\nexport const invalidateCachePlugin = ({\n    cache: redisClient,\n    invalidateCacheKeyGenerator,\n}: {\n    cache: Redis | Cluster;\n    invalidateCacheKeyGenerator: InvalidationKeyGenerator;\n}) =>\n    ({\n        requestDidStart(requestContext: GraphQLRequestContext<IGraphQLCacheContext>) {\n            return {\n                willSendResponse: async (responseContext: GraphQLRequestContextWillSendResponse<unknown>) => {\n                    // in case of websocket request initially the requestContext comes empty\n                    if (!requestContext) {\n                        return;\n                    }\n                    try {\n                        const hasErrors = !!requestContext.errors?.length;\n                        const { schema } = requestContext;\n                        const { queriesToInvalidate, user, req } = requestContext.contextValue;\n                        const tenantId = extractTenantId(req?.currentPageUriSegments?.authority);\n                        const [{ operation }] = responseContext.document.definitions as OperationDefinitionNode[];\n                        const isMutation = operation === 'mutation';\n                        if (hasErrors || !queriesToInvalidate?.length || !isMutation) {\n                            return;\n                        }\n\n                        const nestedKeys = await Promise.all<string[]>(\n                            queriesToInvalidate.map(async (query: string) => {\n                                // Build keys in order of specificity\n                                let keys: string[] = [];\n                                const cachePolicy: { scope: string } = getDirectiveArgsFromSchema({\n                                    schema,\n                                    queryName: query,\n                                    directiveName: CACHE_CONTROL_DIRECTIVE,\n                                });\n                                const isPrivate = cachePolicy.scope?.toLowerCase() === 'private';\n                                // Add tenant-specific key if tenant exists\n                                if (tenantId) {\n                                    keys.push(`${config.APP_NAME}:${tenantId}:${query}:*`);\n                                    // Add user-specific key if user exists\n                                    if (user?.sub && isPrivate) {\n                                        keys.push(`${config.APP_NAME}:${tenantId}:${user.sub}:${query}:*`);\n                                    }\n                                }\n                                // Add global key as fallback\n                                keys.push(`${config.APP_NAME}:${query}:*`);\n\n                                // Allow custom key generation if provided\n                                if (typeof invalidateCacheKeyGenerator === 'function') {\n                                    keys = keys.map((key) =>\n                                        invalidateCacheKeyGenerator(requestContext, responseContext, key),\n                                    );\n                                }\n                                const matchedKeys = await Promise.all(\n                                    keys.map(async (key) => {\n                                        const matchingKeys = await redisClient.keys(key);\n                                        if (matchingKeys.length) {\n                                            return matchingKeys;\n                                        }\n                                        return [];\n                                    }),\n                                );\n                                return matchedKeys.flat();\n                            }),\n                        );\n                        const keys = nestedKeys.flat();\n                        if (keys?.length) {\n                            await redisClient.del(uniq(keys));\n                        }\n                    } catch (e) {\n                        requestContext.logger.error('Error occurred in invalidateCachePlugin');\n                        requestContext.logger.error(e);\n                    }\n                },\n            };\n        },\n    }) as unknown as ApolloServerOptions<BaseContext>['plugins'][0];\n"],"names":[],"mappings":"qLAcO,MAAM,qBAAqB,GAAG,CAAC,EAClC,KAAK,EAAE,WAAW,EAClB,2BAA2B,GAI9B,MACI;AACG,IAAA,eAAe,CAAC,cAA2D,EAAA;QACvE,OAAO;AACH,YAAA,gBAAgB,EAAE,OAAO,eAA+D,KAAI;;gBAExF,IAAI,CAAC,cAAc,EAAE;oBACjB,OAAO;iBACV;AACD,gBAAA,IAAI;oBACA,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC;AAClD,oBAAA,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;oBAClC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC;oBACvE,MAAM,QAAQ,GAAG,eAAe,CAAC,GAAG,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAC;oBACzE,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,WAAwC,CAAC;AAC1F,oBAAA,MAAM,UAAU,GAAG,SAAS,KAAK,UAAU,CAAC;oBAC5C,IAAI,SAAS,IAAI,CAAC,mBAAmB,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE;wBAC1D,OAAO;qBACV;AAED,oBAAA,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,mBAAmB,CAAC,GAAG,CAAC,OAAO,KAAa,KAAI;;wBAE5C,IAAI,IAAI,GAAa,EAAE,CAAC;wBACxB,MAAM,WAAW,GAAsB,0BAA0B,CAAC;4BAC9D,MAAM;AACN,4BAAA,SAAS,EAAE,KAAK;AAChB,4BAAA,aAAa,EAAE,uBAAuB;AACzC,yBAAA,CAAC,CAAC;wBACH,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,SAAS,CAAC;;wBAEjE,IAAI,QAAQ,EAAE;AACV,4BAAA,IAAI,CAAC,IAAI,CAAC,CAAA,EAAG,MAAM,CAAC,QAAQ,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA,EAAI,KAAK,CAAA,EAAA,CAAI,CAAC,CAAC;;AAEvD,4BAAA,IAAI,IAAI,EAAE,GAAG,IAAI,SAAS,EAAE;AACxB,gCAAA,IAAI,CAAC,IAAI,CAAC,CAAG,EAAA,MAAM,CAAC,QAAQ,CAAA,CAAA,EAAI,QAAQ,CAAA,CAAA,EAAI,IAAI,CAAC,GAAG,IAAI,KAAK,CAAA,EAAA,CAAI,CAAC,CAAC;6BACtE;yBACJ;;wBAED,IAAI,CAAC,IAAI,CAAC,CAAG,EAAA,MAAM,CAAC,QAAQ,CAAI,CAAA,EAAA,KAAK,CAAI,EAAA,CAAA,CAAC,CAAC;;AAG3C,wBAAA,IAAI,OAAO,2BAA2B,KAAK,UAAU,EAAE;AACnD,4BAAA,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAChB,2BAA2B,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,CAAC,CACpE,CAAC;yBACL;AACD,wBAAA,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,KAAI;4BACnB,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjD,4BAAA,IAAI,YAAY,CAAC,MAAM,EAAE;AACrB,gCAAA,OAAO,YAAY,CAAC;6BACvB;AACD,4BAAA,OAAO,EAAE,CAAC;yBACb,CAAC,CACL,CAAC;AACF,wBAAA,OAAO,WAAW,CAAC,IAAI,EAAE,CAAC;qBAC7B,CAAC,CACL,CAAC;AACF,oBAAA,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;AAC/B,oBAAA,IAAI,IAAI,EAAE,MAAM,EAAE;wBACd,MAAM,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;qBACrC;iBACJ;gBAAC,OAAO,CAAC,EAAE;AACR,oBAAA,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;AACvE,oBAAA,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAClC;aACJ;SACJ,CAAC;KACL;AACJ,CAAA"}

package/lib/plugins/responseCachePlugin.d.ts

@@ -0,0 +1,11 @@
+import { GraphQLRequestContext } from '@apollo/server';
+import { ILogger } from '@cdm-logger/core/lib/interface';
+import { IGraphQLCacheContext, IGraphqlCacheKeyGenerator } from 'common/server';
+type ApolloCachePluginOptions = {
+    logger: ILogger;
+    cacheKeyGenerator: IGraphqlCacheKeyGenerator;
+};
+export declare const isCacheable: (requestContext: GraphQLRequestContext<IGraphQLCacheContext>) => boolean;
+export declare const generateCacheKey: ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) => (requestContext: GraphQLRequestContext<IGraphQLCacheContext>) => string;
+export declare const responseCachePlugin: ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) => any;
+export {};

package/lib/plugins/responseCachePlugin.js

@@ -0,0 +1,63 @@
+import {getDirectiveArgsFromSchema,CACHE_CONTROL_DIRECTIVE,extractTenantId}from'@common-stack/server-core';import {isEmpty}from'lodash-es';import apolloCachePlugin from'@apollo/server-plugin-response-cache';import {generateQueryCacheKey}from'../core/keyBuilder/generate-query-cache-key.js';const cachePlugin = apolloCachePlugin.default ?? apolloCachePlugin;
+const isCacheable = (requestContext) => {
+    const { document, schema } = requestContext;
+    const cache = getDirectiveArgsFromSchema({
+        schema,
+        document,
+        directiveName: CACHE_CONTROL_DIRECTIVE,
+    });
+    if (!cache)
+        return false;
+    if (cache.scope && !cache.maxAge) {
+        cache.maxAge = 86400;
+    }
+    if (!requestContext.overallCachePolicy) {
+        // eslint-disable-next-line no-param-reassign
+        // to support test cases
+        requestContext.overallCachePolicy = {};
+    }
+    // eslint-disable-next-line no-param-reassign
+    requestContext.overallCachePolicy.maxAge = cache.maxAge;
+    return cache.maxAge > 0;
+};
+const generateCacheKey = ({ logger, cacheKeyGenerator }) => (requestContext) => {
+    if (!isCacheable(requestContext)) {
+        return null;
+    }
+    const { request, contextValue, document, schema } = requestContext;
+    const { user, req } = contextValue ?? {};
+    const { query, variables } = request;
+    const cacheControlDirective = getDirectiveArgsFromSchema({
+        schema,
+        document,
+        directiveName: CACHE_CONTROL_DIRECTIVE,
+    });
+    const { scope } = cacheControlDirective ?? {};
+    const isPrivate = scope?.toLowerCase() === 'private';
+    const tenantId = req.tenant ?? extractTenantId(req?.currentPageUriSegments?.authority);
+    const cacheKey = generateQueryCacheKey({
+        query,
+        variables,
+        logger,
+        userId: isPrivate ? user?.sub || null : null,
+        tenantId,
+    });
+    try {
+        if (typeof cacheKeyGenerator === 'function') {
+            const generatedKey = cacheKeyGenerator(requestContext, cacheKey);
+            return generatedKey || cacheKey;
+        }
+        return cacheKey;
+    }
+    catch (e) {
+        console.warn('GenerateCacheKey Failed %s', e.message);
+        return cacheKey;
+    }
+};
+const responseCachePlugin = ({ logger, cacheKeyGenerator }) => cachePlugin({
+    sessionId: ({ contextValue }) => Promise.resolve(contextValue?.user?.sub ?? null),
+    generateCacheKey: generateCacheKey({ logger, cacheKeyGenerator }),
+    shouldWriteToCache: (ctx) => 
+    // Cache only successful responses
+    isCacheable(ctx) && isEmpty(ctx?.response?.body?.singleResult.errors),
+});export{generateCacheKey,isCacheable,responseCachePlugin};//# sourceMappingURL=responseCachePlugin.js.map

package/lib/plugins/responseCachePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseCachePlugin.js","sources":["../../src/plugins/responseCachePlugin.ts"],"sourcesContent":["/* eslint-disable no-param-reassign */\nimport { GraphQLRequestContext } from '@apollo/server';\nimport { CACHE_CONTROL_DIRECTIVE, extractTenantId, getDirectiveArgsFromSchema } from '@common-stack/server-core';\nimport { isEmpty } from 'lodash-es';\nimport apolloCachePlugin from '@apollo/server-plugin-response-cache';\nimport { ILogger } from '@cdm-logger/core/lib/interface';\nimport { IGraphQLCacheContext, IGraphqlCacheKeyGenerator } from 'common/server';\nimport { generateQueryCacheKey } from '../core/keyBuilder/generate-query-cache-key';\n\n\nconst cachePlugin = (apolloCachePlugin as any).default ?? apolloCachePlugin;\n\ntype ApolloCachePluginOptions = {\n    logger: ILogger;\n    cacheKeyGenerator: IGraphqlCacheKeyGenerator;\n};\n\nexport const isCacheable = (requestContext: GraphQLRequestContext<IGraphQLCacheContext>) => {\n    const { document, schema } = requestContext;\n    const cache = getDirectiveArgsFromSchema({\n        schema,\n        document,\n        directiveName: CACHE_CONTROL_DIRECTIVE,\n    });\n    if (!cache) return false;\n    if (cache.scope && !cache.maxAge) {\n        cache.maxAge = 86400;\n    }\n    if (!requestContext.overallCachePolicy) {\n        // eslint-disable-next-line no-param-reassign\n        // to support test cases\n        (requestContext as any).overallCachePolicy = {};\n    }\n    // eslint-disable-next-line no-param-reassign\n    requestContext.overallCachePolicy.maxAge = cache.maxAge;\n    return cache.maxAge > 0;\n};\n\nexport const generateCacheKey =\n    ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) =>\n    (requestContext: GraphQLRequestContext<IGraphQLCacheContext>): string => {\n        if (!isCacheable(requestContext)) {\n            return null;\n        }\n        const { request, contextValue, document, schema } = requestContext;\n        const { user, req } = contextValue ?? {};\n        const { query, variables } = request;\n        const cacheControlDirective = getDirectiveArgsFromSchema({\n            schema,\n            document,\n            directiveName: CACHE_CONTROL_DIRECTIVE,\n        });\n        const { scope } = cacheControlDirective ?? {};\n        const isPrivate = scope?.toLowerCase() === 'private';\n        const tenantId = req.tenant ?? extractTenantId(req?.currentPageUriSegments?.authority);\n        const cacheKey = generateQueryCacheKey({\n            query,\n            variables,\n            logger,\n            userId: isPrivate ? user?.sub || null : null,\n            tenantId,\n        });\n        try {\n            if (typeof cacheKeyGenerator === 'function') {\n                const generatedKey = cacheKeyGenerator(requestContext, cacheKey);\n                return generatedKey || cacheKey;\n            }\n            return cacheKey;\n        } catch (e) {\n            console.warn('GenerateCacheKey Failed %s', e.message);\n            return cacheKey;\n        }\n    };\nexport const responseCachePlugin = ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) =>\n    cachePlugin({\n        sessionId: ({ contextValue }) => Promise.resolve(contextValue?.user?.sub ?? null),\n        generateCacheKey: generateCacheKey({ logger, cacheKeyGenerator }),\n        shouldWriteToCache: (ctx) =>\n            // Cache only successful responses\n            isCacheable(ctx) && isEmpty(ctx?.response?.body?.singleResult.errors),\n    });\n"],"names":[],"mappings":"kSAUA,MAAM,WAAW,GAAI,iBAAyB,CAAC,OAAO,IAAI,iBAAiB,CAAC;AAO/D,MAAA,WAAW,GAAG,CAAC,cAA2D,KAAI;AACvF,IAAA,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IAC5C,MAAM,KAAK,GAAG,0BAA0B,CAAC;QACrC,MAAM;QACN,QAAQ;AACR,QAAA,aAAa,EAAE,uBAAuB;AACzC,KAAA,CAAC,CAAC;AACH,IAAA,IAAI,CAAC,KAAK;AAAE,QAAA,OAAO,KAAK,CAAC;IACzB,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AAC9B,QAAA,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;KACxB;AACD,IAAA,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE;;;AAGnC,QAAA,cAAsB,CAAC,kBAAkB,GAAG,EAAE,CAAC;KACnD;;IAED,cAAc,CAAC,kBAAkB,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;AACxD,IAAA,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAC5B,EAAE;AAEW,MAAA,gBAAgB,GACzB,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAA4B,KACxD,CAAC,cAA2D,KAAY;AACpE,IAAA,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE;AAC9B,QAAA,OAAO,IAAI,CAAC;KACf;IACD,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IACnE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,YAAY,IAAI,EAAE,CAAC;AACzC,IAAA,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACrC,MAAM,qBAAqB,GAAG,0BAA0B,CAAC;QACrD,MAAM;QACN,QAAQ;AACR,QAAA,aAAa,EAAE,uBAAuB;AACzC,KAAA,CAAC,CAAC;AACH,IAAA,MAAM,EAAE,KAAK,EAAE,GAAG,qBAAqB,IAAI,EAAE,CAAC;IAC9C,MAAM,SAAS,GAAG,KAAK,EAAE,WAAW,EAAE,KAAK,SAAS,CAAC;AACrD,IAAA,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,IAAI,eAAe,CAAC,GAAG,EAAE,sBAAsB,EAAE,SAAS,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,qBAAqB,CAAC;QACnC,KAAK;QACL,SAAS;QACT,MAAM;AACN,QAAA,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,IAAI,IAAI,GAAG,IAAI;QAC5C,QAAQ;AACX,KAAA,CAAC,CAAC;AACH,IAAA,IAAI;AACA,QAAA,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;YACzC,MAAM,YAAY,GAAG,iBAAiB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YACjE,OAAO,YAAY,IAAI,QAAQ,CAAC;SACnC;AACD,QAAA,OAAO,QAAQ,CAAC;KACnB;IAAC,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;AACtD,QAAA,OAAO,QAAQ,CAAC;KACnB;AACL,EAAE;AACC,MAAM,mBAAmB,GAAG,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAA4B,KACvF,WAAW,CAAC;AACR,IAAA,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,CAAC;IACjF,gBAAgB,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACjE,IAAA,kBAAkB,EAAE,CAAC,GAAG;;AAEpB,IAAA,WAAW,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;AAC5E,CAAA"}

package/lib/templates/repositories/GraphQLCacheContext.ts.template

@@ -0,0 +1,14 @@
+import type { ServiceBroker } from 'moleculer';
+import { GraphQLRequestContext } from '@apollo/server';
+
+export type IGraphQLCacheContext = {
+    overallCachePolicy: { scope: string; maxAge: number };
+    user: { sub: string };
+    req: { currentPageUriSegments: { authority: string }; tenant?: string };
+    queriesToInvalidate: string[];
+    tenantId?: string;
+    accountId?: string;
+    moleculerBroker?: ServiceBroker;
+};
+
+export type IGraphqlCacheKeyGenerator = (context: GraphQLRequestContext<IGraphQLCacheContext>, cacheKey?: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@common-stack/store-redis",
-    "version": "8.3.1-alpha.6",
+    "version": "8.3.1-alpha.7",
     "description": "Redis store utilities and services for common-stack",
     "license": "UNLICENSED",
     "author": "CDMBase LLC",
@@ -24,10 +24,10 @@
         "watch": "npm run build:lib:watch"
     },
     "dependencies": {
-        "@common-stack/core": "8.3.1-alpha.4"
+        "@common-stack/core": "8.3.1-alpha.7"
     },
     "devDependencies": {
-        "common": "8.3.1-alpha.4",
+        "common": "8.3.1-alpha.7",
         "ioredis": "^5.3.2"
     },
     "peerDependencies": {
@@ -46,14 +46,15 @@
             "repositories": [
                 "./${libDir}/templates/repositories/RedisKeyBuilder.ts.template",
                 "./${libDir}/templates/repositories/RedisClient.ts.template",
-                "./${libDir}/templates/repositories/redisCommonTypes.ts.template"
+                "./${libDir}/templates/repositories/redisCommonTypes.ts.template",
+                "./${libDir}/templates/repositories/GraphQLCacheContext.ts.template"
             ],
             "services": [
                 "./${libDir}/templates/services/RedisCacheManager.ts.template"
             ]
         }
     },
-    "gitHead": "fb84350cf08d0ecab5689c99c8cc03e151fd3ace",
+    "gitHead": "4bb669b7168f95f0a0ebe05100545ea5fd353cf4",
     "typescript": {
         "definition": "lib/index.d.ts"
     }

package/lib/__tests__/redis-key-builder.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/__tests__/redis-key-sanitizer.test.d.ts

@@ -1 +0,0 @@
-export {};