Skip immutable data structures

Author: SamyPesse

packages/gitbook/src/lib/api.ts

@@ -178,6 +178,7 @@ export const getUserById = cache({
             tag: 'user',
             user: userId,
         }),
+    tagImmutable: true,
     get: async (userId: string, options: CacheFunctionOptions) => {
         try {
             const apiCtx = await api();
@@ -379,6 +380,7 @@ export const getRevision = cache({
     name: 'api.getRevision.v2',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
         spaceId: string,
@@ -411,6 +413,7 @@ export const getRevisionPages = cache({
     name: 'api.getRevisionPages.v4',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
         spaceId: string,
@@ -446,6 +449,7 @@ export const getRevisionPageByPath = cache({
     name: 'api.getRevisionPageByPath.v3',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
         spaceId: string,
@@ -492,6 +496,7 @@ const getRevisionFileById = cache({
     name: 'api.getRevisionFile.v3',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     get: async (
         spaceId: string,
         revisionId: string,
@@ -528,6 +533,7 @@ const getRevisionReusableContentById = cache({
     name: 'api.getRevisionReusableContentById.v1',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
         spaceId: string,
@@ -569,6 +575,7 @@ const getRevisionAllFiles = cache({
     name: 'api.getRevisionAllFiles.v2',
     tag: (spaceId, revisionId) =>
         getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
     get: async (spaceId: string, revisionId: string, options: CacheFunctionOptions) => {
         const response = await getAll(
             async (params) => {
@@ -684,6 +691,7 @@ export const getDocument = cache({
     name: 'api.getDocument.v2',
     tag: (spaceId, documentId) =>
         getCacheTag({ tag: 'document', space: spaceId, document: documentId }),
+    tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (spaceId: string, documentId: string, options: CacheFunctionOptions) => {
         const apiCtx = await api();

packages/gitbook/src/lib/cache/cache.ts

@@ -55,6 +55,9 @@ export interface CacheDefinition<Args extends any[], Result> {
     /** Tag to associate to the entry */
     tag?: (...args: Args) => string;
 
+    /** If true, the tag will not be sent to the HTTP response, as we consider it immutable */
+    tagImmutable?: boolean;
+
     /** Filter the arguments that should be taken into consideration for the cache key */
     getKeyArgs?: (args: Args) => any[];
 
@@ -136,7 +139,7 @@ export function cache<Args extends any[], Result>(
             const tag = cacheDef.tag?.(...args);
 
             // Add the cache tag to the HTTP response
-            if (tag) {
+            if (tag && !cacheDef.tagImmutable) {
                 addResponseCacheTag(tag);
             }