@fluidframework/local-driver 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/local-driver",
-  "version": "2.0.0-dev.3.1.0.125672",
+  "version": "2.0.0-dev.4.2.0.153917",
   "description": "Fluid local driver",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,27 +15,6 @@
     "moniker": "@fluidframework/server-services-client/dist/generateNames.js"
   },
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint",
-    "build:compile": "npm run tsc && npm run build:test",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
-    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc"
-  },
   "nyc": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -58,49 +37,78 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/driver-base": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/driver-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/protocol-base": "^0.1038.2000",
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/driver-base": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/driver-utils": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/routerlicious-driver": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/server-local-server": "^0.1038.2000",
-    "@fluidframework/server-services-client": "^0.1038.2000",
-    "@fluidframework/server-services-core": "^0.1038.2000",
-    "@fluidframework/server-test-utils": "^0.1038.2000",
-    "@fluidframework/telemetry-utils": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
+    "@fluidframework/routerlicious-driver": "2.0.0-dev.4.2.0.153917",
+    "@fluidframework/server-local-server": "^0.1039.1000",
+    "@fluidframework/server-services-client": "^0.1039.1000",
+    "@fluidframework/server-services-core": "^0.1039.1000",
+    "@fluidframework/server-test-utils": "^0.1039.1000",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.2.0.153917",
     "events": "^3.1.0",
     "jsrsasign": "^10.5.25",
     "url": "^0.11.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
+    "@fluid-tools/build-cli": "^0.15.0",
     "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.15.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/local-driver-previous": "npm:@fluidframework/local-driver@2.0.0-internal.3.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@fluidframework/local-driver-previous": "npm:@fluidframework/local-driver@2.0.0-internal.4.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.2.0.153917",
+    "@microsoft/api-extractor": "^7.34.4",
     "@types/jsrsasign": "^8.0.8",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.36",
-    "concurrently": "^6.2.0",
-    "cross-env": "^7.0.2",
+    "@types/node": "^14.18.38",
+    "concurrently": "^7.6.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
     "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "nyc": "^15.1.0",
     "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^4.4.0",
     "socket.io-client": "^4.4.1",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.3.1.0",
-    "previousVersionStyle": "~previousMinor",
-    "baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
-    "baselineVersion": "2.0.0-internal.3.0.0",
     "broken": {}
+  },
+  "scripts": {
+    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:esnext": "tsc --project ./tsconfig.esnext.json",
+    "build:full": "npm run build",
+    "build:full:compile": "npm run build:compile",
+    "build:genver": "gen-version",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha:multireport": "cross-env FLUID_TEST_MULTIREPORT=1 npm run test:mocha",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
-}
+}

package/src/localCreateDocument.ts

@@ -0,0 +1,49 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
+import {
+	getDocAttributesFromProtocolSummary,
+	getQuorumValuesFromProtocolSummary,
+	isCombinedAppAndProtocolSummary,
+} from "@fluidframework/driver-utils";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { LocalDeltaConnectionServer } from "@fluidframework/server-local-server";
+import { defaultHash } from "@fluidframework/server-services-client";
+
+export async function createDocument(
+	localDeltaConnectionServer,
+	resolvedUrl: IFluidResolvedUrl,
+	summary: ISummaryTree,
+) {
+	const pathName = new URL(resolvedUrl.url).pathname;
+	const pathArr = pathName.split("/");
+	const tenantId = pathArr[pathArr.length - 2];
+	const id = pathArr[pathArr.length - 1];
+	const documentStorage = (localDeltaConnectionServer as LocalDeltaConnectionServer)
+		.documentStorage;
+	if (!isCombinedAppAndProtocolSummary(summary)) {
+		throw new Error("Protocol and App Summary required in the full summary");
+	}
+	const protocolSummary = summary.tree[".protocol"];
+	const appSummary = summary.tree[".app"];
+	const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);
+	const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);
+	const sequenceNumber = documentAttributes.sequenceNumber;
+	await documentStorage.createDocument(
+		tenantId,
+		id,
+		appSummary,
+		sequenceNumber,
+		// "term" was an experimental feature that is being removed.  The only safe value to use is 1.
+		1, // term
+		defaultHash,
+		resolvedUrl.endpoints.ordererUrl ?? "",
+		resolvedUrl.endpoints.storageUrl ?? "",
+		resolvedUrl.endpoints.deltaStorageUrl ?? "",
+		quorumValues,
+		false /* enableDiscovery */,
+	);
+}

package/src/localDocumentService.ts

@@ -57,6 +57,8 @@ export class LocalDocumentService implements IDocumentService {
 				minBlobSize: 2048, // Test blob aggregation
 				maximumCacheDurationMs: 432_000_000, // 5 days in ms. Not actually enforced but shouldn't matter for any local driver scenario
 			},
+			this.localDeltaConnectionServer,
+			this.resolvedUrl,
 		);
 	}
 

package/src/localDocumentServiceFactory.ts

@@ -12,26 +12,17 @@ import {
 } from "@fluidframework/driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import { DefaultTokenProvider } from "@fluidframework/routerlicious-driver";
-import {
-	ILocalDeltaConnectionServer,
-	LocalDeltaConnectionServer,
-} from "@fluidframework/server-local-server";
-import {
-	ensureFluidResolvedUrl,
-	getDocAttributesFromProtocolSummary,
-	getQuorumValuesFromProtocolSummary,
-} from "@fluidframework/driver-utils";
+import { ILocalDeltaConnectionServer } from "@fluidframework/server-local-server";
+import { ensureFluidResolvedUrl } from "@fluidframework/driver-utils";
 import { ISummaryTree, NackErrorType } from "@fluidframework/protocol-definitions";
-import { defaultHash } from "@fluidframework/server-services-client";
 import { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection";
 import { createLocalDocumentService } from "./localDocumentService";
+import { createDocument } from "./localCreateDocument";
 
 /**
  * Implementation of document service factory for local use.
  */
 export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
-	public readonly protocolName = "fluid-test:";
-
 	// A map of clientId to LocalDocumentService.
 	private readonly documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection> =
 		new Map();
@@ -51,41 +42,13 @@ export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
 		logger?: ITelemetryBaseLogger,
 		clientIsSummarizer?: boolean,
 	): Promise<IDocumentService> {
-		ensureFluidResolvedUrl(resolvedUrl);
-		if (createNewSummary === undefined) {
-			throw new Error("Empty file summary creation isn't supported in this driver.");
-		}
-		const pathName = new URL(resolvedUrl.url).pathname;
-		const pathArr = pathName.split("/");
-		const tenantId = pathArr[pathArr.length - 2];
-		const id = pathArr[pathArr.length - 1];
 		if (!this.localDeltaConnectionServer) {
 			throw new Error("Provide the localDeltaConnectionServer!!");
 		}
-		const documentStorage = (this.localDeltaConnectionServer as LocalDeltaConnectionServer)
-			.documentStorage;
-
-		const protocolSummary = createNewSummary.tree[".protocol"] as ISummaryTree;
-		const appSummary = createNewSummary.tree[".app"] as ISummaryTree;
-		if (!(protocolSummary && appSummary)) {
-			throw new Error("Protocol and App Summary required in the full summary");
+		if (createNewSummary !== undefined) {
+			ensureFluidResolvedUrl(resolvedUrl);
+			await createDocument(this.localDeltaConnectionServer, resolvedUrl, createNewSummary);
 		}
-		const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);
-		const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);
-		const sequenceNumber = documentAttributes.sequenceNumber;
-		await documentStorage.createDocument(
-			tenantId,
-			id,
-			appSummary,
-			sequenceNumber,
-			documentAttributes.term ?? 1,
-			defaultHash,
-			resolvedUrl.endpoints.ordererUrl ?? "",
-			resolvedUrl.endpoints.storageUrl ?? "",
-			resolvedUrl.endpoints.deltaStorageUrl ?? "",
-			quorumValues,
-			false /* enableDiscovery */,
-		);
 		return this.createDocumentService(resolvedUrl, logger, clientIsSummarizer);
 	}
 

package/src/localDocumentStorageService.ts

@@ -7,6 +7,7 @@ import { stringToBuffer, Uint8ArrayToString } from "@fluidframework/common-utils
 import {
 	IDocumentStorageService,
 	IDocumentStorageServicePolicies,
+	IResolvedUrl,
 	ISummaryContext,
 } from "@fluidframework/driver-definitions";
 import {
@@ -22,7 +23,11 @@ import {
 	ISummaryUploadManager,
 	SummaryTreeUploadManager,
 } from "@fluidframework/server-services-client";
+import { ILocalDeltaConnectionServer } from "@fluidframework/server-local-server";
+import { ensureFluidResolvedUrl } from "@fluidframework/driver-utils";
+import { createDocument } from "./localCreateDocument";
 
+const minTTLInSeconds = 24 * 60 * 60; // Same TTL as ODSP
 export class LocalDocumentStorageService implements IDocumentStorageService {
 	// The values of this cache is useless. We only need the keys. So we are always putting
 	// empty strings as values.
@@ -37,6 +42,8 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 		private readonly id: string,
 		private readonly manager: GitManager,
 		public readonly policies: IDocumentStorageServicePolicies,
+		private readonly localDeltaConnectionServer?: ILocalDeltaConnectionServer,
+		private readonly resolvedUrl?: IResolvedUrl,
 	) {
 		this.summaryTreeUploadManager = new SummaryTreeUploadManager(
 			manager,
@@ -82,6 +89,17 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 		summary: ISummaryTree,
 		context: ISummaryContext,
 	): Promise<string> {
+		if (context.referenceSequenceNumber === 0) {
+			if (this.localDeltaConnectionServer === undefined || this.resolvedUrl === undefined) {
+				throw new Error(
+					"Insufficient constructor parameters. An ILocalDeltaConnectionServer and IResolvedUrl required",
+				);
+			}
+			ensureFluidResolvedUrl(this.resolvedUrl);
+			await createDocument(this.localDeltaConnectionServer, this.resolvedUrl, summary);
+			const version = await this.getVersions(this.id, 1);
+			return version[0].id;
+		}
 		return this.summaryTreeUploadManager.writeSummaryTree(
 			summary,
 			context.ackHandle ?? "",
@@ -93,7 +111,7 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
 		const uint8ArrayFile = new Uint8Array(file);
 		return this.manager
 			.createBlob(Uint8ArrayToString(uint8ArrayFile, "base64"), "base64")
-			.then((r) => ({ id: r.sha, url: r.url }));
+			.then((r) => ({ id: r.sha, url: r.url, minTTLInSeconds }));
 	}
 
 	public async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {

package/src/localSessionStorageDb.ts

@@ -27,6 +27,9 @@ class LocalSessionStorageCollection<T> implements ICollection<T> {
 	public async distinct(key: any, query: any): Promise<any> {
 		throw new Error("Method Not Implemented");
 	}
+	public async findAndUpdate(query: any, value: T): Promise<{ value: T; existing: boolean }> {
+		throw new Error("Method not implemented.");
+	}
 
 	/**
 	 * {@inheritDoc @fluidframework/server-services-core#ICollection.find}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/local-driver";
-export const pkgVersion = "2.0.0-dev.3.1.0.125672";
+export const pkgVersion = "2.0.0-dev.4.2.0.153917";

package/tsconfig.esnext.json

@@ -0,0 +1,7 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}