@fluidframework/routerlicious-driver 0.59.4000-71130 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "0.59.4000-71130",
+  "version": "1.0.0",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,14 +62,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-base": "0.59.4000-71130",
-    "@fluidframework/driver-definitions": "^0.46.2000-0",
-    "@fluidframework/driver-utils": "0.59.4000-71130",
-    "@fluidframework/gitresources": "^0.1036.4000-0",
-    "@fluidframework/protocol-base": "^0.1036.4000-0",
-    "@fluidframework/protocol-definitions": "^0.1028.2000-0",
-    "@fluidframework/server-services-client": "^0.1036.4000-0",
-    "@fluidframework/telemetry-utils": "0.59.4000-71130",
+    "@fluidframework/driver-base": "^1.0.0",
+    "@fluidframework/driver-definitions": "^1.0.0",
+    "@fluidframework/driver-utils": "^1.0.0",
+    "@fluidframework/gitresources": "^0.1036.4000",
+    "@fluidframework/protocol-base": "^0.1036.4000",
+    "@fluidframework/protocol-definitions": "^0.1028.2000",
+    "@fluidframework/server-services-client": "^0.1036.4000",
+    "@fluidframework/telemetry-utils": "^1.0.0",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "querystring": "^0.2.0",
@@ -79,34 +79,21 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "0.59.4000-71130",
-    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@0.59.3000",
+    "@fluidframework/mocha-test-setup": "^1.0.0",
+    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@^0.59.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "@types/nock": "^9.3.0",
     "@types/url-parse": "1.4.4",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "axios": "^0.26.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-jsdoc": "~39.3.0",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
-    "eslint-plugin-unused-imports": "~2.0.0",
     "mocha": "^10.0.0",
     "nock": "^10.0.1",
     "nyc": "^15.0.0",
@@ -115,7 +102,14 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.4000",
-    "broken": {}
+    "version": "1.0.0",
+    "broken": {
+      "ClassDeclaration_DocumentStorageService": {
+        "backCompat": false
+      },
+      "ClassDeclaration_NullBlobStorageService": {
+        "backCompat": false
+      }
+    }
   }
 }

package/src/documentServiceFactory.ts

@@ -59,6 +59,12 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         };
     }
 
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
+     *
+     * @throws {@link DocumentPostCreateError}
+     * If an exception is thrown while invoking the provided {@link ITokenProvider.documentPostCreateCallback}.
+     */
     public async createContainer(
         createNewSummary: ISummaryTree | undefined,
         resolvedUrl: IResolvedUrl,
@@ -133,7 +139,11 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
         // is sufficient to determine if the token will be undefined or not.
         if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {
-            await this.tokenProvider.documentPostCreateCallback(documentId, token);
+            try {
+                await this.tokenProvider.documentPostCreateCallback(documentId, token);
+            } catch (error: any) {
+                throw new DocumentPostCreateError(error);
+            }
         }
 
         parsedUrl.set("pathname", replaceDocumentIdInPath(parsedUrl.pathname, documentId));
@@ -162,9 +172,8 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
     }
 
     /**
-     * Creates the document service after extracting different endpoints URLs from a resolved URL.
+     * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
      *
-     * @param resolvedUrl - URL containing different endpoint URLs.
      * @returns Routerlicious document service.
      */
     public async createDocumentService(
@@ -227,3 +236,29 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             this.snapshotTreeCache);
     }
 }
+
+/**
+ * Error returned by {@link RouterliciousDocumentServiceFactory.createContainer} when an error is thrown
+ * in {@link ITokenProvider.documentPostCreateCallback}.
+ * It is the consumer's responsibility to ensure that any state related to container creation is appropriately
+ * cleaned up in the event of failure.
+ * This includes the document itself, which will have been created by the time this error was thrown.
+ *
+ * @remarks TODO: examples of suggested actions for recovery.
+ * - How would a user delete the created document?
+ * - What would a retry pattern look like here?
+ */
+ export class DocumentPostCreateError extends Error {
+    public constructor(
+        /**
+         * Inner error being wrapped.
+         */
+        private readonly innerError: Error,
+    ) {
+        super(innerError.message);
+    }
+
+    public readonly name = "DocumentPostCreateError";
+
+    public get stack() { return this.innerError.stack; }
+}

package/src/nullBlobStorageService.ts

@@ -23,10 +23,6 @@ export class NullBlobStorageService implements IDocumentStorageService {
         return [];
     }
 
-    public async write(tree: api.ITree, parents: string[], message: string, ref: string): Promise<api.IVersion> {
-        return Promise.reject(new Error("Null blob storage can not write commit"));
-    }
-
     public async uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string> {
         return Promise.reject(new Error("Invalid operation"));
     }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "0.59.4000-71130";
+export const pkgVersion = "1.0.0";

package/src/shreddedSummaryDocumentStorageService.ts

@@ -19,7 +19,6 @@ import {
     ISnapshotTreeEx,
     ISummaryHandle,
     ISummaryTree,
-    ITree,
     IVersion,
 } from "@fluidframework/protocol-definitions";
 import {
@@ -150,19 +149,6 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
         return bufferContent;
     }
 
-    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {
-        const branch = ref ? `datastores/${this.id}/${ref}` : this.id;
-        const commit = await PerformanceEvent.timedExecAsync(
-            this.logger,
-            {
-                eventName: "write",
-                id: branch,
-            },
-            async () => this.manager.write(branch, tree, parents, message),
-        );
-        return { date: commit.committer.date, id: commit.sha, treeId: commit.tree.sha };
-    }
-
     public async uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string> {
         const summaryHandle = await PerformanceEvent.timedExecAsync(
             this.logger,

package/src/tokens.ts

@@ -50,9 +50,10 @@ export interface ITokenProvider {
      * verify against an authorization service, if the user who claims to create the document is the same user who
      * created it.
      *
-     * Note:
+     * Notes:
      * * Using the callback may have performance impact on the document creation process.
-     * * Any exceptions thrown in the callback would fail the creation workflow.
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
      * @param documentId - Document ID.
      * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
      * and document id. It can be used to validate the identity of the document creator.

package/src/wholeSummaryDocumentStorageService.ts

@@ -22,7 +22,6 @@ import {
     ISnapshotTree,
     ISummaryHandle,
     ISummaryTree,
-    ITree,
     IVersion,
 } from "@fluidframework/protocol-definitions";
 import {
@@ -169,10 +168,6 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
         return convertSnapshotAndBlobsToSummaryTree(snapshotTree, blobs);
     }
 
-    public async write(tree: ITree, parents: string[], message: string, ref: string): Promise<IVersion> {
-        throw new Error("NOT IMPLEMENTED!");
-    }
-
     public async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {
         const uint8ArrayFile = new Uint8Array(file);
         return PerformanceEvent.timedExecAsync(

package/tsconfig.json

@@ -6,7 +6,8 @@
     "compilerOptions": {
         "rootDir": "./src",
         "outDir": "./dist",
-        "composite": true
+        "composite": true,
+        "types": ["node"]
     },
     "include": [
         "src/**/*"