Add correlation id in routerlicious-driver (#4734)

* bug fix to change from fixed uuid to random ones every time

* fix eslint issue

* added correlation id in the header

* reverted changes in bindCorrelationId

* fixed lint issues

* reverted historian client to be without getCorrelationId

* added correlation id in historian client

* clean up and removed else condition

* recover

* recover again

* added lerna lock

* added logger into driver

* fixed version error

Co-authored-by: Ping Zhu <pizh@Pings-MacBook-Pro.local>

packages/drivers/routerlicious-driver/package.json

@@ -37,12 +37,14 @@
     "@fluidframework/protocol-base": "^0.1017.1",
     "@fluidframework/protocol-definitions": "^0.1017.1",
     "@fluidframework/server-services-client": "^0.1017.1",
+    "@fluidframework/telemetry-utils": "^0.33.0",
     "assert": "^2.0.0",
     "axios": "^0.21.1",
     "debug": "^4.1.1",
     "isomorphic-ws": "^4.0.1",
     "jwt-decode": "^2.2.0",
     "socket.io-client": "^2.1.1",
+    "uuid": "^8.3.1",
     "ws": "^6.1.2"
   },
   "devDependencies": {
@@ -55,6 +57,7 @@
     "@types/mocha": "^5.2.5",
     "@types/nock": "^9.3.0",
     "@types/socket.io-client": "^1.4.32",
+    "@types/uuid": "^8.3.0",
     "@types/ws": "^6.0.1",
     "@typescript-eslint/eslint-plugin": "~4.2.0",
     "@typescript-eslint/parser": "~4.2.0",

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

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IDocumentService, IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IErrorTrackingService } from "@fluidframework/protocol-definitions";
 import { ICredentials } from "@fluidframework/server-services-client";
@@ -27,6 +28,7 @@ export const createDocumentService2 = (
     errorTracking: IErrorTrackingService = new DefaultErrorTracking(),
     disableCache = false,
     historianApi = true,
+    logger: ITelemetryLogger,
     credentials?: ICredentials): IDocumentService => new DocumentService2(
         resolvedUrl,
         ordererUrl,
@@ -36,6 +38,7 @@ export const createDocumentService2 = (
         disableCache,
         historianApi,
         credentials,
+        logger,
         tokenProvider,
         tenantId,
         documentId);

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

@@ -3,12 +3,15 @@
  * Licensed under the MIT License.
  */
 
+import { OutgoingHttpHeaders } from "http";
 import querystring from "querystring";
 import { fromUtf8ToBase64 } from "@fluidframework/common-utils";
 import { IDeltaStorageService, IDocumentDeltaStorageService } from "@fluidframework/driver-definitions";
 import Axios from "axios";
+import * as uuid from "uuid";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { ITokenProvider } from "./tokens";
 import { DocumentStorageService } from "./documentStorageService";
 
@@ -44,7 +47,10 @@ export class DocumentDeltaStorageService implements IDocumentDeltaStorageService
  * Provides access to the underlying delta storage on the server for routerlicious driver.
  */
 export class DeltaStorageService implements IDeltaStorageService {
-    constructor(private readonly url: string, private readonly tokenProvider: ITokenProvider) {
+    constructor(
+        private readonly url: string,
+        private readonly tokenProvider: ITokenProvider,
+        private readonly logger: ITelemetryLogger | undefined) {
     }
 
     public async get(
@@ -54,22 +60,29 @@ export class DeltaStorageService implements IDeltaStorageService {
         to?: number): Promise<ISequencedDocumentMessage[]> {
         const query = querystring.stringify({ from, to });
 
-        let headers: { Authorization: string } | null = null;
+        const headers: OutgoingHttpHeaders = {
+            "x-correlation-id": uuid.v4(),
+        };
 
         const storageToken = await this.tokenProvider.fetchStorageToken(
             tenantId,
             id,
         );
 
         if (storageToken) {
-            headers = {
-                Authorization: `Basic ${fromUtf8ToBase64(`${tenantId}:${storageToken.jwt}`)}`,
-            };
+            headers.Authorization = `Basic ${fromUtf8ToBase64(`${tenantId}:${storageToken.jwt}`)}`;
         }
 
         const ops = await Axios.get<ISequencedDocumentMessage[]>(
             `${this.url}?${query}`, { headers });
 
+        if (this.logger) {
+            this.logger.sendTelemetryEvent({
+                eventName: "R11sDriverToServer",
+                correlationId: headers["x-correlation-id"] as string,
+            });
+        }
+
         return ops.data;
     }
 }

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

@@ -8,6 +8,7 @@ import * as api from "@fluidframework/driver-definitions";
 import { IClient, IErrorTrackingService } from "@fluidframework/protocol-definitions";
 import { GitManager, Historian, ICredentials, IGitCache } from "@fluidframework/server-services-client";
 import io from "socket.io-client";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { DeltaStorageService, DocumentDeltaStorageService } from "./deltaStorageService";
 import { DocumentStorageService } from "./documentStorageService";
 import { R11sDocumentDeltaConnection } from "./documentDeltaConnection";
@@ -29,6 +30,7 @@ export class DocumentService implements api.IDocumentService {
         private readonly historianApi: boolean,
         private readonly directCredentials: ICredentials | undefined,
         private readonly gitCache: IGitCache | undefined,
+        private readonly logger: ITelemetryLogger | undefined,
         protected tokenProvider: ITokenProvider,
         protected tenantId: string,
         protected documentId: string,
@@ -101,7 +103,7 @@ export class DocumentService implements api.IDocumentService {
     public async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {
         assert(this.documentStorageService, "Storage service not initialized");
 
-        const deltaStorage = new DeltaStorageService(this.deltaStorageUrl, this.tokenProvider);
+        const deltaStorage = new DeltaStorageService(this.deltaStorageUrl, this.tokenProvider, this.logger);
         return new DocumentDeltaStorageService(this.tenantId, this.documentId,
             deltaStorage, this.documentStorageService);
     }

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

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IDocumentDeltaConnection, IResolvedUrl } from "@fluidframework/driver-definitions";
 import * as api from "@fluidframework/protocol-definitions";
 import { ICredentials } from "@fluidframework/server-services-client";
@@ -23,6 +24,7 @@ export class DocumentService2 extends DocumentService {
         errorTracking: api.IErrorTrackingService,
         disableCache: boolean, historianApi: boolean,
         directCredentials: ICredentials | undefined,
+        logger: ITelemetryLogger,
         tokenProvider: ITokenProvider,
         tenantId: string,
         documentId: string) {
@@ -36,6 +38,7 @@ export class DocumentService2 extends DocumentService {
             historianApi,
             directCredentials,
             undefined,
+            logger,
             tokenProvider,
             tenantId,
             documentId);

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

@@ -19,6 +19,7 @@ import {
     getQuorumValuesFromProtocolSummary,
 } from "@fluidframework/driver-utils";
 import Axios from "axios";
+import { ChildLogger } from "@fluidframework/telemetry-utils";
 import { DocumentService } from "./documentService";
 import { DocumentService2 } from "./documentService2";
 import { DefaultErrorTracking } from "./errorTracking";
@@ -99,6 +100,8 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                 `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);
         }
 
+        const logger2 = ChildLogger.create(logger, "RouterliciousDriver");
+
         if (this.useDocumentService2) {
             return new DocumentService2(
                 fluidResolvedUrl,
@@ -109,6 +112,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                 this.disableCache,
                 this.historianApi,
                 this.credentials,
+                logger2,
                 this.tokenProvider,
                 tenantId,
                 documentId);
@@ -123,6 +127,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                 this.historianApi,
                 this.credentials,
                 this.gitCache,
+                logger2,
                 this.tokenProvider,
                 tenantId,
                 documentId);

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

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IDocumentService, IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IErrorTrackingService } from "@fluidframework/protocol-definitions";
 import { IGitCache } from "@fluidframework/server-services-client";
@@ -28,7 +29,8 @@ export function createDocumentService(
     disableCache = false,
     historianApi = true,
     credentials?,
-    seedData?: IGitCache): IDocumentService {
+    seedData?: IGitCache,
+    logger?: ITelemetryLogger): IDocumentService {
     const service = new DocumentService(
         resolvedUrl,
         ordererUrl,
@@ -39,6 +41,7 @@ export function createDocumentService(
         historianApi,
         credentials,
         seedData,
+        logger,
         tokenProvider,
         tenantId,
         documentId);