@fluidframework/driver-utils 0.49.1 → 0.50.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "0.49.1",
+  "version": "0.50.0",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -57,20 +57,20 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^0.39.7",
-    "@fluidframework/driver-definitions": "^0.40.0",
-    "@fluidframework/gitresources": "^0.1032.0",
-    "@fluidframework/protocol-base": "^0.1032.0",
+    "@fluidframework/core-interfaces": "^0.40.0",
+    "@fluidframework/driver-definitions": "^0.41.0",
+    "@fluidframework/gitresources": "^0.1033.0",
+    "@fluidframework/protocol-base": "^0.1033.0",
     "@fluidframework/protocol-definitions": "^0.1025.0",
-    "@fluidframework/telemetry-utils": "^0.49.1",
+    "@fluidframework/telemetry-utils": "^0.50.0",
     "axios": "^0.21.1",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "^0.49.1",
-    "@fluidframework/runtime-utils": "^0.49.1",
+    "@fluidframework/mocha-test-setup": "^0.50.0",
+    "@fluidframework/runtime-utils": "^0.50.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
     "@types/node": "^12.19.0",

package/src/insecureUrlResolver.ts

@@ -44,14 +44,9 @@ export class InsecureUrlResolver implements IUrlResolver {
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         if (request.headers?.[DriverHeader.createNew]) {
             const [, queryString] = request.url.split("?");
-
             const searchParams = new URLSearchParams(queryString);
             const fileName = searchParams.get("fileName");
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-            if (!fileName) {
-                throw new Error("FileName should be there!!");
-            }
-            return this.resolveHelper(fileName, "");
+            return this.resolveHelper(fileName);
         }
         const parsedUrl = new URL(request.url);
         // If hosts match then we use the local tenant information. Otherwise we make a REST call out to the hosting
@@ -88,10 +83,28 @@ export class InsecureUrlResolver implements IUrlResolver {
         }
     }
 
-    private resolveHelper(documentId: string, documentRelativePath: string, queryParams: string = "") {
+    private resolveHelper(documentId: string | null, documentRelativePath: string = "", queryParams: string = "") {
         const encodedTenantId = encodeURIComponent(this.tenantId);
-        const encodedDocId = encodeURIComponent(documentId);
         const host = new URL(this.ordererUrl).host;
+        // when the document ID is not provided we need to resolve a special create new document URL.
+        // the actual container ID will be generated by the driver.
+        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+        if (!documentId) {
+            const createNewResponse: IFluidResolvedUrl = {
+                endpoints: {
+                    deltaStorageUrl: `${this.ordererUrl}/deltas/${encodedTenantId}/new`,
+                    ordererUrl: this.ordererUrl,
+                    storageUrl: `${this.storageUrl}/repos/${encodedTenantId}`,
+                },
+                // document ID is ignored by the driver for new container requests
+                id: "",
+                tokens: {},
+                type: "fluid",
+                url: `fluid://${host}/${encodedTenantId}/new`,
+            };
+            return createNewResponse;
+        }
+        const encodedDocId = encodeURIComponent(documentId);
         const relativePath = !documentRelativePath || documentRelativePath.startsWith("/")
             ? documentRelativePath : `/${documentRelativePath}`;
         const documentUrl = `fluid://${host}/${encodedTenantId}/${encodedDocId}${relativePath}${queryParams}`;
@@ -117,7 +130,7 @@ export class InsecureUrlResolver implements IUrlResolver {
         const fluidResolvedUrl = resolvedUrl as IFluidResolvedUrl;
 
         const parsedUrl = parse(fluidResolvedUrl.url);
-        const [, , documentId] = parsedUrl.pathname?.split("/");
+        const [, , documentId] = parsedUrl.pathname?.split("/") ?? [];
         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
         assert(!!documentId, 0x273 /* "Invalid document id from parsed URL" */);
 
@@ -130,9 +143,10 @@ export class InsecureUrlResolver implements IUrlResolver {
             this.tenantId)}/${encodeURIComponent(documentId)}/${url}`;
     }
 
-    public createCreateNewRequest(fileName: string): IRequest {
+    public createCreateNewRequest(fileName?: string): IRequest {
         const createNewRequest: IRequest = {
-            url: `${this.hostUrl}?fileName=${fileName}`,
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            url: fileName ? `${this.hostUrl}?fileName=${fileName}` : this.hostUrl,
             headers: {
                 [DriverHeader.createNew]: true,
             },

package/src/network.ts

@@ -37,10 +37,11 @@ export class GenericNetworkError extends LoggingError implements IDriverErrorBas
 
     constructor(
         readonly fluidErrorCode: string,
+        message: string,
         readonly canRetry: boolean,
         props?: ITelemetryProperties,
     ) {
-        super(fluidErrorCode, props);
+        super(message, props);
     }
 }
 
@@ -67,46 +68,51 @@ export class AuthorizationError extends LoggingError implements IAuthorizationEr
 
     constructor(
         readonly fluidErrorCode: string,
+        message: string,
         readonly claims: string | undefined,
         readonly tenantId: string | undefined,
         props?: ITelemetryProperties,
     ) {
         // don't log claims or tenantId
-        super(fluidErrorCode, props, new Set(["claims", "tenantId"]));
+        super(message, props, new Set(["claims", "tenantId"]));
     }
 }
 
 export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
     constructor(
         readonly fluidErrorCode: string,
+        message: string,
         readonly errorType: T,
         readonly canRetry: boolean,
         props?: ITelemetryProperties,
     ) {
-        super(fluidErrorCode, props);
+        super(message, props);
     }
 }
 
 export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
     constructor(
         fluidErrorCode: string,
+        message: string | undefined,
         readonly errorType: T,
         props?: ITelemetryProperties,
     ) {
-        super(fluidErrorCode, errorType, false, props);
+        super(fluidErrorCode, message ?? fluidErrorCode, errorType, false, props);
     }
 }
 
 export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
     constructor(
         fluidErrorCode: string,
+        message: string | undefined,
         readonly errorType: T,
         props?: ITelemetryProperties,
     ) {
-        super(fluidErrorCode, errorType, true, props);
+        super(fluidErrorCode, message ?? fluidErrorCode, errorType, true, props);
     }
 }
 
+//* Check
 /**
  * Throttling error class - used to communicate all throttling errors
  */
@@ -116,26 +122,28 @@ export class ThrottlingError extends LoggingError implements IThrottlingWarning,
 
     constructor(
         readonly fluidErrorCode: string,
+        message: string,
         readonly retryAfterSeconds: number,
         props?: ITelemetryProperties,
     ) {
-        super(fluidErrorCode, props);
+        super(message, props);
     }
 }
 
-export const createWriteError = (errorMessage: string) =>
-    new NonRetryableError(errorMessage, DriverErrorType.writeError);
+export const createWriteError = (fluidErrorCode: string) =>
+    new NonRetryableError(fluidErrorCode, undefined, DriverErrorType.writeError);
 
 export function createGenericNetworkError(
     fluidErrorCode: string,
+    message: string | undefined,
     canRetry: boolean,
     retryAfterMs?: number,
     props?: ITelemetryProperties,
 ): ThrottlingError | GenericNetworkError {
     if (retryAfterMs !== undefined && canRetry) {
-        return new ThrottlingError(fluidErrorCode, retryAfterMs / 1000, props);
+        return new ThrottlingError(fluidErrorCode, message ?? fluidErrorCode, retryAfterMs / 1000, props);
     }
-    return new GenericNetworkError(fluidErrorCode, canRetry, props);
+    return new GenericNetworkError(fluidErrorCode, message ?? fluidErrorCode, canRetry, props);
 }
 
 /**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "0.49.1";
+export const pkgVersion = "0.50.0";

package/src/parallelRequests.ts

@@ -400,6 +400,7 @@ async function getSingleOpBatch(
                 // current as it can't get ops.
                 throw createGenericNetworkError(
                     "failedToRetrieveOpsFromStorage:TooManyRetries",
+                    undefined,
                     false /* canRetry */,
                     undefined /* retryAfterSeconds */,
                     {

package/src/runWithRetry.ts

@@ -37,7 +37,7 @@ export async function runWithRetry<T>(
             // If it is not retriable, then just throw the error.
             if (!canRetryOnError(err)) {
                 logger.sendErrorEvent({
-                    eventName: fetchCallName,
+                    eventName: `${fetchCallName}_cancel`,
                     retry: numRetries,
                     duration: performance.now() - startTime,
                 }, err);
@@ -57,7 +57,7 @@ export async function runWithRetry<T>(
     } while (!success);
     if (numRetries > 0) {
         logger.sendTelemetryEvent({
-            eventName: fetchCallName,
+            eventName: `${fetchCallName}_lastError`,
             retry: numRetries,
             duration: performance.now() - startTime,
         },