@fluidframework/routerlicious-driver 1.2.7 → 2.0.0-dev.1.3.0.96595

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "1.2.7",
+  "version": "2.0.0-dev.1.3.0.96595",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -61,15 +61,15 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-base": "^1.2.7",
-    "@fluidframework/driver-definitions": "^1.2.7",
-    "@fluidframework/driver-utils": "^1.2.7",
-    "@fluidframework/gitresources": "^0.1036.5000",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/server-services-client": "^0.1036.5000",
-    "@fluidframework/telemetry-utils": "^1.2.7",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/driver-base": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/driver-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/driver-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/gitresources": "^0.1037.2001",
+    "@fluidframework/protocol-base": "^0.1037.2001",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/server-services-client": "^0.1037.2001",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.1.3.0.96595",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "querystring": "^0.2.0",
@@ -78,11 +78,11 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.2.7",
-    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@1.2.1",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.6000",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@^1.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -91,7 +91,7 @@
     "@types/uuid": "^8.3.0",
     "axios": "^0.26.0",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
     "mocha": "^10.0.0",
@@ -102,7 +102,11 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.2",
-    "broken": {}
+    "version": "2.0.0",
+    "broken": {
+      "InterfaceDeclaration_IRouterliciousDriverPolicies": {
+        "forwardCompat": false
+      }
+    }
   }
 }

package/src/cache.ts

@@ -19,3 +19,12 @@ export class InMemoryCache<T> implements ICache<T> {
         this.cache.set(key, value);
     }
 }
+
+export class NullCache<T> implements ICache<T> {
+    public async get(key: string): Promise<T | undefined> {
+        return undefined;
+    }
+
+    public async put(key: string, value: T): Promise<void> {
+    }
+}

package/src/documentDeltaConnection.ts

@@ -65,10 +65,8 @@ export class R11sDocumentDeltaConnection extends DocumentDeltaConnection {
         // Note: we suspect the incoming error object is either:
         // - a socketError: add it to the R11sError object for driver to be able to parse it and reason over it.
         // - anything else: let base class handle it
-        if (canRetry && Number.isInteger(error?.code) && typeof error?.message === "string") {
-            return errorObjectFromSocketError(error as IR11sSocketError, handler);
-        } else {
-            return super.createErrorObject(handler, error, canRetry);
-        }
+        return canRetry && Number.isInteger(error?.code) && typeof error?.message === "string"
+            ? errorObjectFromSocketError(error as IR11sSocketError, handler)
+            : super.createErrorObject(handler, error, canRetry);
     }
 }

package/src/documentService.ts

@@ -49,6 +49,7 @@ export class DocumentService implements api.IDocumentService {
         private _resolvedUrl: api.IResolvedUrl,
         protected ordererUrl: string,
         private deltaStorageUrl: string,
+        private deltaStreamUrl: string,
         private storageUrl: string,
         private readonly logger: ITelemetryLogger,
         protected tokenProvider: ITokenProvider,
@@ -192,13 +193,14 @@ export class DocumentService implements api.IDocumentService {
                 this.documentId,
                 refreshToken,
             );
+
             return R11sDocumentDeltaConnection.create(
                 this.tenantId,
                 this.documentId,
                 ordererToken.jwt,
                 io,
                 client,
-                this.ordererUrl,
+                this.deltaStreamUrl,
                 this.logger,
             );
         };
@@ -240,6 +242,7 @@ export class DocumentService implements api.IDocumentService {
         this.storageUrl = fluidResolvedUrl.endpoints.storageUrl;
         this.ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;
         this.deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;
+        this.deltaStreamUrl = fluidResolvedUrl.endpoints.deltaStreamUrl || this.ordererUrl;
         this.lastDiscoveredAt = Date.now();
     }
 

package/src/documentServiceFactory.ts

@@ -26,7 +26,7 @@ import { ITokenProvider } from "./tokens";
 import { RouterliciousOrdererRestWrapper } from "./restWrapper";
 import { convertSummaryToCreateNewSummary } from "./createNewUtils";
 import { parseFluidUrl, replaceDocumentIdInPath, getDiscoveredFluidResolvedUrl } from "./urlUtils";
-import { InMemoryCache } from "./cache";
+import { ICache, InMemoryCache, NullCache } from "./cache";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { ISnapshotTreeVersion } from "./definitions";
 
@@ -38,6 +38,7 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
     enableDiscovery: false,
     enableWholeSummaryUpload: false,
     enableRestLess: true,
+    enableInternalSummaryCaching: true,
 };
 
 /**
@@ -47,8 +48,8 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
 export class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
     public readonly protocolName = "fluid:";
     private readonly driverPolicies: IRouterliciousDriverPolicies;
-    private readonly blobCache = new InMemoryCache<ArrayBufferLike>();
-    private readonly snapshotTreeCache = new InMemoryCache<ISnapshotTreeVersion>();
+    private readonly blobCache: ICache<ArrayBufferLike>;
+    private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion>;
 
     constructor(
         private readonly tokenProvider: ITokenProvider,
@@ -58,6 +59,10 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             ...defaultRouterliciousDriverPolicies,
             ...driverPolicies,
         };
+        this.blobCache = new InMemoryCache<ArrayBufferLike>();
+        this.snapshotTreeCache = this.driverPolicies.enableInternalSummaryCaching
+            ? new InMemoryCache<ISnapshotTreeVersion>()
+            : new NullCache<ISnapshotTreeVersion>();
     }
 
     /**
@@ -214,6 +219,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         const storageUrl = fluidResolvedUrl.endpoints.storageUrl;
         const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;
         const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;
+        const deltaStreamUrl = fluidResolvedUrl.endpoints.deltaStreamUrl || ordererUrl; // backward compatibility
         if (!ordererUrl || !deltaStorageUrl) {
             throw new Error(
                 `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);
@@ -223,6 +229,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             fluidResolvedUrl,
             ordererUrl,
             deltaStorageUrl,
+            deltaStreamUrl,
             storageUrl,
             logger2,
             this.tokenProvider,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "1.2.7";
+export const pkgVersion = "2.0.0-dev.1.3.0.96595";

package/src/policies.ts

@@ -42,4 +42,10 @@ export interface IRouterliciousDriverPolicies {
      * Default: true
      */
     enableRestLess: boolean;
+    /**
+     * Enable internal cache of summaries/snapshots.
+     * Reduces Summarizer boot time and reduces server load in E2E tests.
+     * Default: true
+     */
+    enableInternalSummaryCaching: boolean;
 }

package/src/restWrapper.ts

@@ -106,7 +106,7 @@ export class RouterliciousRestWrapper extends RestWrapper {
     }
 
     private generateHeaders(requestHeaders?: AxiosRequestHeaders | undefined): Record<string, string> {
-        const correlationId = requestHeaders?.["x-correlation-id"] || uuid();
+        const correlationId = requestHeaders?.["x-correlation-id"] ?? uuid();
 
         return {
             ...requestHeaders,

package/src/shreddedSummaryDocumentStorageService.ts

@@ -107,7 +107,7 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
             requestVersion = versions[0];
         }
 
-        const cachedSnapshotTree = await this.snapshotTreeCache?.get(requestVersion.treeId);
+        const cachedSnapshotTree = await this.snapshotTreeCache?.get(this.getCacheKey(requestVersion.treeId));
         if (cachedSnapshotTree) {
             return cachedSnapshotTree.snapshotTree as ISnapshotTreeEx;
         }
@@ -128,12 +128,15 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
             },
         );
         const tree = buildHierarchy(rawTree, this.blobsShaCache, true);
-        await this.snapshotTreeCache?.put(tree.id, { id: requestVersion.id, snapshotTree: tree });
+        await this.snapshotTreeCache?.put(
+            this.getCacheKey(tree.id),
+            { id: requestVersion.id, snapshotTree: tree },
+        );
         return tree;
     }
 
     public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        const cachedBlob = await this.blobCache?.get(blobId);
+        const cachedBlob = await this.blobCache?.get(this.getCacheKey(blobId));
         if (cachedBlob) {
             return cachedBlob;
         }
@@ -155,7 +158,7 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
         );
         this.blobsShaCache.set(value.sha, "");
         const bufferContent = stringToBuffer(value.content, value.encoding);
-        await this.blobCache?.put(value.sha, bufferContent);
+        await this.blobCache?.put(this.getCacheKey(value.sha), bufferContent);
         return bufferContent;
     }
 
@@ -164,6 +167,9 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
             this.logger,
             {
                 eventName: "uploadSummaryWithContext",
+                proposalHandle: context.proposalHandle,
+                ackHandle: context.ackHandle,
+                referenceSequenceNumber: context.referenceSequenceNumber,
             },
             async () => {
                 const summaryUploadManager = await this.getSummaryUploadManager();
@@ -209,4 +215,8 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
                 })
             : undefined;
     }
+
+    private getCacheKey(blobId: string): string {
+        return `${this.id}:${blobId}`;
+    }
 }

package/src/tokens.ts

@@ -13,10 +13,15 @@ export interface ITokenService {
 }
 
 export interface ITokenResponse {
-    // JWT value
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
     jwt: string;
 
-    // Flag indicating whether token was obtained from local cache
+    /**
+     * Flag indicating whether token was obtained from local cache.
+     * Undefined indicates that the source of the token could not be determined.
+     */
     fromCache?: boolean;
 }
 

package/src/wholeSummaryDocumentStorageService.ts

@@ -120,7 +120,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
     }
 
     public async readBlob(blobId: string): Promise<ArrayBufferLike> {
-        const cachedBlob = await this.blobCache.get(blobId);
+        const cachedBlob = await this.blobCache.get(this.getCacheKey(blobId));
         if (cachedBlob !== undefined) {
             return cachedBlob;
         }
@@ -142,7 +142,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         );
         const bufferValue = stringToBuffer(blob.content, blob.encoding);
 
-        await this.blobCache.put(blob.sha, bufferValue);
+        await this.blobCache.put(this.getCacheKey(blob.sha), bufferValue);
 
         return bufferValue;
     }
@@ -152,6 +152,9 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
             this.logger,
             {
                 eventName: "uploadSummaryWithContext",
+                proposalHandle: context.proposalHandle,
+                ackHandle: context.ackHandle,
+                referenceSequenceNumber: context.referenceSequenceNumber,
             },
             async () => {
                 const summaryUploadManager = await this.getSummaryUploadManager();
@@ -205,7 +208,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
     }
 
     private async fetchAndCacheSnapshotTree(versionId: string, disableCache?: boolean): Promise<ISnapshotTreeVersion> {
-        const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(versionId);
+        const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(this.getCacheKey(versionId));
         if (cachedSnapshotTreeVersion !== undefined) {
             return { id: cachedSnapshotTreeVersion.id, snapshotTree: cachedSnapshotTreeVersion.snapshotTree };
         }
@@ -233,7 +236,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 
         const cachePs: Promise<any>[] = [
             this.snapshotTreeCache.put(
-                snapshotTreeId,
+                this.getCacheKey(snapshotTreeId),
                 snapshotTreeVersion,
             ),
             this.initBlobCache(normalizedWholeSummary.blobs),
@@ -244,7 +247,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
             // However, for something like Redis, this will cache the same value twice. Alternatively, could we simply
             // cache with versionId?
             cachePs.push(this.snapshotTreeCache.put(
-                versionId,
+                this.getCacheKey(versionId),
                 snapshotTreeVersion,
             ));
         }
@@ -257,8 +260,13 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
     private async initBlobCache(blobs: Map<string, ArrayBuffer>): Promise<void> {
         const blobCachePutPs: Promise<void>[] = [];
         blobs.forEach((value, id) => {
-            blobCachePutPs.push(this.blobCache.put(id, value));
+            const cacheKey = this.getCacheKey(id);
+            blobCachePutPs.push(this.blobCache.put(cacheKey, value));
         });
         await Promise.all(blobCachePutPs);
     }
+
+    private getCacheKey(blobId: string): string {
+        return `${this.id}:${blobId}`;
+    }
 }