Client Changes in Fluid Server Cluster Discovery Feature

api-report/routerlicious-driver.api.md

@@ -76,7 +76,7 @@ export class DocumentService implements api.IDocumentService {
 
 // @public (undocumented)
 export class DocumentStorageService extends DocumentStorageServiceProxy {
-    constructor(id: string, manager: GitManager, logger: ITelemetryLogger, policies?: IDocumentStorageServicePolicies, driverPolicies?: IRouterliciousDriverPolicies, blobCache?: ICache<ArrayBufferLike>, snapshotTreeCache?: ICache<ISnapshotTreeVersion>);
+    constructor(id: string, manager: GitManager, logger: ITelemetryLogger, policies?: IDocumentStorageServicePolicies, driverPolicies?: IRouterliciousDriverPolicies, blobCache?: ICache<ArrayBufferLike>, snapshotTreeCache?: ICache<ISnapshotTreeVersion>, noCacheGitManager?: GitManager | undefined);
     // (undocumented)
     getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
     // (undocumented)
@@ -85,11 +85,14 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
     get logTailSha(): string | undefined;
     // (undocumented)
     manager: GitManager;
+    // (undocumented)
+    noCacheGitManager?: GitManager | undefined;
 }
 
 // @public (undocumented)
 export interface IRouterliciousDriverPolicies {
     aggregateBlobsSmallerThanBytes: number | undefined;
+    enableDiscovery?: boolean;
     enablePrefetch: boolean;
     enableRestLess: boolean;
     enableWholeSummaryUpload: boolean;
@@ -143,7 +146,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
     constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
     // (undocumented)
     createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean, isCreateContainer?: boolean): Promise<IDocumentService>;
     // (undocumented)
     readonly protocolName = "fluid:";
     }

packages/drivers/local-driver/src/localDocumentService.ts

@@ -33,7 +33,7 @@ export class LocalDocumentService implements api.IDocumentService {
         private readonly innerDocumentService?: api.IDocumentService,
     ) { }
 
-    public dispose() {}
+    public dispose() { }
 
     /**
      * Creates and returns a document storage service for local use.
@@ -43,7 +43,12 @@ export class LocalDocumentService implements api.IDocumentService {
             this.documentId,
             new GitManager(new TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase)),
             new TelemetryNullLogger(),
-            { minBlobSize: 2048 }); // Test blob aggregation.
+            { minBlobSize: 2048 },
+            undefined,
+            undefined,
+            undefined,
+            new GitManager(new TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase)));
+        // Test blob aggregation.
     }
 
     /**

packages/drivers/routerlicious-driver/package.json

@@ -110,4 +110,4 @@
     "version": "0.59.1000",
     "broken": {}
   }
-}
+}

packages/drivers/routerlicious-driver/src/contracts.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export interface ISession {
+    ordererUrl: string;
+
+    historianUrl: string;
+
+    isSessionAlive: boolean;
+}

packages/drivers/routerlicious-driver/src/documentService.ts

@@ -74,6 +74,12 @@ export class DocumentService implements api.IDocumentService {
             false,
             storageRestWrapper);
         const gitManager = new GitManager(historian);
+        const noCacheHistorian = new Historian(
+            this.gitUrl,
+            true,
+            true,
+            storageRestWrapper);
+        const noCacheGitManager = new GitManager(noCacheHistorian);
         const documentStorageServicePolicies: api.IDocumentStorageServicePolicies = {
             caching: this.driverPolicies.enablePrefetch
                 ? api.LoaderCachingPolicy.Prefetch
@@ -88,7 +94,8 @@ export class DocumentService implements api.IDocumentService {
             documentStorageServicePolicies,
             this.driverPolicies,
             this.blobCache,
-            this.snapshotTreeCache);
+            this.snapshotTreeCache,
+            noCacheGitManager);
         return this.documentStorageService;
     }
 

packages/drivers/routerlicious-driver/src/documentServiceFactory.ts

@@ -23,16 +23,18 @@ import { IRouterliciousDriverPolicies } from "./policies";
 import { ITokenProvider } from "./tokens";
 import { RouterliciousOrdererRestWrapper } from "./restWrapper";
 import { convertSummaryToCreateNewSummary } from "./createNewUtils";
-import { parseFluidUrl, replaceDocumentIdInPath } from "./urlUtils";
+import { parseFluidUrl, replaceDocumentIdInPath, replaceWithDiscoveredUrl } from "./urlUtils";
 import { InMemoryCache } from "./cache";
 import { pkgVersion as driverVersion } from "./packageVersion";
 import { ISnapshotTreeVersion } from "./definitions";
+import { ISession } from "./contracts";
 
 const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
     enablePrefetch: true,
     maxConcurrentStorageRequests: 100,
     maxConcurrentOrdererRequests: 100,
     aggregateBlobsSmallerThanBytes: undefined,
+    enableDiscovery: false,
     enableWholeSummaryUpload: false,
     enableRestLess: true,
 };
@@ -66,7 +68,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         ensureFluidResolvedUrl(resolvedUrl);
         assert(!!createNewSummary, 0x204 /* "create empty file not supported" */);
         assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* "Missing orderer URL!" */);
-        const parsedUrl = parseFluidUrl(resolvedUrl.url);
+        let parsedUrl = parseFluidUrl(resolvedUrl.url);
         if (!parsedUrl.pathname) {
             throw new Error("Parsed url should contain tenant and doc Id!!");
         }
@@ -92,15 +94,14 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             resolvedUrl.endpoints.ordererUrl,
         );
 
-        // the backend responds with the actual document ID associated with the new container.
-
         // @TODO: Remove returned "string" type when removing back-compat code
-        const res = await ordererRestWrapper.post<{ id: string, token?: string } | string>(
+        const res = await ordererRestWrapper.post<{ id: string, token?: string, session?: ISession } | string>(
             `/documents/${tenantId}`,
             {
                 summary: convertSummaryToCreateNewSummary(appSummary),
                 sequenceNumber: documentAttributes.sequenceNumber,
                 values: quorumValues,
+                enableDiscovery: this.driverPolicies.enableDiscovery,
                 generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,
             },
         );
@@ -111,12 +112,19 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
 
         let documentId: string;
         let token: string | undefined;
+        let session: ISession | undefined;
 
         if (typeof res === "string") {
             documentId = res;
         } else {
             documentId = res.id;
             token = res.token;
+            session = res.session;
+        }
+
+        if (session && this.driverPolicies.enableDiscovery) {
+            replaceWithDiscoveredUrl(resolvedUrl, session, parsedUrl);
+            parsedUrl = parseFluidUrl(resolvedUrl.url);
         }
 
         // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
@@ -146,6 +154,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             },
             logger,
             clientIsSummarizer,
+            true,
         );
     }
 
@@ -159,9 +168,37 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         resolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
         clientIsSummarizer?: boolean,
+        isCreateContainer?: boolean,
     ): Promise<IDocumentService> {
         ensureFluidResolvedUrl(resolvedUrl);
 
+        const parsedUrl = parseFluidUrl(resolvedUrl.url);
+        const [, tenantId, documentId] = parsedUrl.pathname.split("/");
+        if (!documentId || !tenantId) {
+            throw new Error(
+                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);
+        }
+        const logger2 = ChildLogger.create(logger, "RouterliciousDriver", { all: { driverVersion }});
+
+        if (!isCreateContainer && this.driverPolicies.enableDiscovery) {
+            const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);
+            const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(
+                tenantId,
+                documentId,
+                this.tokenProvider,
+                logger2,
+                rateLimiter,
+                this.driverPolicies.enableRestLess,
+                resolvedUrl.endpoints.ordererUrl,
+            );
+
+            // the backend responds with the actual document session associated with the container.
+            const session: ISession = await ordererRestWrapper.get<ISession>(
+                `/documents/${tenantId}/session/${documentId}`,
+            );
+            replaceWithDiscoveredUrl(resolvedUrl, session, parsedUrl);
+        }
+
         const fluidResolvedUrl = resolvedUrl;
         const storageUrl = fluidResolvedUrl.endpoints.storageUrl;
         const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;
@@ -171,15 +208,6 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                 `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);
         }
 
-        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);
-        const [, tenantId, documentId] = parsedUrl.pathname.split("/");
-        if (!documentId || !tenantId) {
-            throw new Error(
-                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);
-        }
-
-        const logger2 = ChildLogger.create(logger, "RouterliciousDriver", { all: { driverVersion }});
-
         return new DocumentService(
             fluidResolvedUrl,
             ordererUrl,

packages/drivers/routerlicious-driver/src/documentStorageService.ts

@@ -37,7 +37,8 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
         policies: IDocumentStorageServicePolicies,
         driverPolicies?: IRouterliciousDriverPolicies,
         blobCache?: ICache<ArrayBufferLike>,
-        snapshotTreeCache?: ICache<ISnapshotTreeVersion>): IDocumentStorageService {
+        snapshotTreeCache?: ICache<ISnapshotTreeVersion>,
+        noCacheGitManager?: GitManager): IDocumentStorageService {
         const storageService = driverPolicies?.enableWholeSummaryUpload ?
             new WholeSummaryDocumentStorageService(
                 id,
@@ -46,6 +47,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
                 policies,
                 blobCache,
                 snapshotTreeCache,
+                noCacheGitManager,
             ) :
             new ShreddedSummaryDocumentStorageService(
                 id,
@@ -70,7 +72,8 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
         policies: IDocumentStorageServicePolicies = {},
         driverPolicies?: IRouterliciousDriverPolicies,
         blobCache?: ICache<ArrayBufferLike>,
-        snapshotTreeCache?: ICache<ISnapshotTreeVersion>) {
+        snapshotTreeCache?: ICache<ISnapshotTreeVersion>,
+        public noCacheGitManager?: GitManager) {
         super(DocumentStorageService.loadInternalDocumentStorageService(
             id,
             manager,
@@ -79,6 +82,7 @@ export class DocumentStorageService extends DocumentStorageServiceProxy {
             driverPolicies,
             blobCache,
             snapshotTreeCache,
+            noCacheGitManager,
         ));
     }
 

packages/drivers/routerlicious-driver/src/policies.ts

@@ -32,6 +32,11 @@ export interface IRouterliciousDriverPolicies {
      * Default: false
      */
     enableWholeSummaryUpload: boolean;
+    /**
+     * Enable discovery for the routerlicious service
+     * Default: false
+     */
+    enableDiscovery?: boolean;
     /**
      * Enable using RestLess which avoids CORS preflight requests.
      * Default: true

packages/drivers/routerlicious-driver/src/urlUtils.ts

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 
+import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
 import URLParse from "url-parse";
+import { ISession } from "./contracts";
 
 export const parseFluidUrl = (fluidUrl: string): URLParse => {
     return new URLParse(fluidUrl, true);
@@ -17,3 +19,25 @@ export const parseFluidUrl = (fluidUrl: string): URLParse => {
  */
 export const replaceDocumentIdInPath = (urlPath: string, documentId: string): string =>
     urlPath.split("/").slice(0, -1).concat([documentId]).join("/");
+
+export const createFluidUrl = (domain: string, pathname: string): string =>
+    "fluid://".concat(domain, pathname);
+
+export const replaceWithDiscoveredUrl = (resolvedUrl: IFluidResolvedUrl,
+    session: ISession,
+    parsedUrl: URLParse): void => {
+    if (session && session.ordererUrl.includes("https")) {
+        resolvedUrl.url = createFluidUrl(session.ordererUrl.replace(/^https?:\/\//, ""), parsedUrl.pathname);
+        resolvedUrl.endpoints.ordererUrl = session.ordererUrl;
+
+        const discoveredOrdererUrl = new URL(session.ordererUrl);
+        const deltaStorageUrl = new URL(resolvedUrl.endpoints.deltaStorageUrl);
+        deltaStorageUrl.host = discoveredOrdererUrl.host;
+        resolvedUrl.endpoints.deltaStorageUrl = deltaStorageUrl.toString();
+
+        const discoveredHistorianUrl = new URL(session.historianUrl);
+        const storageUrl = new URL(resolvedUrl.endpoints.storageUrl);
+        storageUrl.host = discoveredHistorianUrl.host;
+        resolvedUrl.endpoints.storageUrl = storageUrl.toString();
+    }
+};

packages/drivers/routerlicious-driver/src/wholeSummaryDocumentStorageService.ts

@@ -48,7 +48,8 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         protected readonly logger: ITelemetryLogger,
         public readonly policies: IDocumentStorageServicePolicies = {},
         private readonly blobCache: ICache<ArrayBufferLike> = new InMemoryCache(),
-        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache()) {
+        private readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> = new InMemoryCache(),
+        protected readonly noCacheGitManager?: GitManager) {
         this.summaryUploadManager = new WholeSummaryUploadManager(manager);
     }
 
@@ -64,7 +65,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         // Fetch latest summary, cache it, and return its id.
         if (this.firstVersionsCall && count === 1) {
             this.firstVersionsCall = false;
-            const { id: _id, snapshotTree } = await this.fetchAndCacheSnapshotTree(latestSnapshotId);
+            const { id: _id, snapshotTree } = await this.fetchAndCacheSnapshotTree(latestSnapshotId, true);
             return [{
                 id: _id,
                 treeId: snapshotTree.id!,
@@ -170,7 +171,7 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         );
     }
 
-    private async fetchAndCacheSnapshotTree(versionId: string): Promise<ISnapshotTreeVersion> {
+    private async fetchAndCacheSnapshotTree(versionId: string, disableCache?: boolean): Promise<ISnapshotTreeVersion> {
         const cachedSnapshotTreeVersion = await this.snapshotTreeCache.get(versionId);
         if (cachedSnapshotTreeVersion !== undefined) {
             return { id: cachedSnapshotTreeVersion.id, snapshotTree: cachedSnapshotTreeVersion.snapshotTree };
@@ -183,7 +184,9 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
                 treeId: versionId,
             },
             async (event) => {
-                const response = await this.manager.getSummary(versionId);
+                const response = disableCache !== undefined && disableCache && this.noCacheGitManager !== undefined ?
+                await this.noCacheGitManager.getSummary(versionId) :
+                await this.manager.getSummary(versionId);
                 event.end({
                     size: response.trees[0]?.entries.length,
                 });

packages/test/test-drivers/src/routerliciousTestDriver.ts

@@ -31,13 +31,26 @@ const dockerConfig = (driverPolicies?: IRouterliciousDriverPolicies) => ({
 });
 
 function getConfig(
+    discoveryEndpoint?: string,
     fluidHost?: string,
     tenantId?: string,
     tenantSecret?: string,
     driverPolicies?: IRouterliciousDriverPolicies) {
-    assert(fluidHost, "Missing Fluid host");
     assert(tenantId, "Missing tenantId");
     assert(tenantSecret, "Missing tenant secret");
+    if (discoveryEndpoint !== undefined) {
+        return {
+            serviceEndpoint: {
+                hostUrl: "",
+                ordererUrl: discoveryEndpoint,
+                deltaStorageUrl: "https://dummy-historian",
+            },
+            tenantId,
+            tenantSecret,
+            driverPolicies,
+        };
+    }
+    assert(fluidHost, "Missing Fluid host");
     return {
         serviceEndpoint: {
             hostUrl: fluidHost,
@@ -51,10 +64,11 @@ function getConfig(
 }
 
 function getLegacyConfigFromEnv() {
+    const discoveryEndpoint = process.env.fluid__webpack__discoveryEndpoint;
     const fluidHost = process.env.fluid__webpack__fluidHost;
     const tenantSecret = process.env.fluid__webpack__tenantSecret;
     const tenantId = process.env.fluid__webpack__tenantId ?? "fluid";
-    return getConfig(fluidHost, tenantId, tenantSecret);
+    return getConfig(discoveryEndpoint, fluidHost, tenantId, tenantSecret);
 }
 
 function getEndpointConfigFromEnv(r11sEndpointName: string) {