@fluidframework/local-driver 2.0.0-internal.3.0.2 → 2.0.0-internal.3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/local-driver",
-  "version": "2.0.0-internal.3.0.2",
+  "version": "2.0.0-internal.3.2.0",
   "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 eslint",
-    "lint: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,30 +37,30 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/driver-base": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/driver-utils": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/common-utils": "^1.1.1",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/driver-base": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
+    "@fluidframework/driver-utils": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
     "@fluidframework/protocol-base": "^0.1038.2000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/routerlicious-driver": ">=2.0.0-internal.3.0.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/routerlicious-driver": ">=2.0.0-internal.3.2.0 <2.0.0-internal.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-internal.3.0.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
     "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.10.0",
     "@fluidframework/build-common": "^1.1.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-internal.3.0.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/local-driver-previous": "npm:@fluidframework/local-driver@2.0.0-internal.3.1.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.3.2.0 <2.0.0-internal.4.0.0",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/jsrsasign": "^8.0.8",
     "@types/mocha": "^9.1.1",
@@ -97,9 +76,31 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.3.0.1",
-    "previousVersionStyle": "previousPatch",
-    "baselineRange": "2.0.0-internal.3.0.0",
+    "version": "2.0.0-internal.3.2.0",
+    "previousVersionStyle": "~previousMinor",
+    "baselineRange": ">=2.0.0-internal.3.1.0 <2.0.0-internal.3.2.0",
+    "baselineVersion": "2.0.0-internal.3.1.0",
     "broken": {}
+  },
+  "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"
   }
-}
+}

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/auth.ts

@@ -13,40 +13,46 @@ import { getRandomName } from "@fluidframework/server-services-client";
  * services-client since it cannot run in the browser without polyfills.
  */
 export function generateToken(
-    tenantId: string,
-    documentId: string,
-    key: string,
-    scopes: ScopeType[],
-    user?: IUser,
-    lifetime: number = 60 * 60,
-    ver: string = "1.0"): string {
-    let userClaim = (user) ? user : generateUser();
-    if (userClaim.id === "" || userClaim.id === undefined) {
-        userClaim = generateUser();
-    }
+	tenantId: string,
+	documentId: string,
+	key: string,
+	scopes: ScopeType[],
+	user?: IUser,
+	lifetime: number = 60 * 60,
+	ver: string = "1.0",
+): string {
+	let userClaim = user ? user : generateUser();
+	if (userClaim.id === "" || userClaim.id === undefined) {
+		userClaim = generateUser();
+	}
 
-    // Current time in seconds
-    const now = Math.round((new Date()).getTime() / 1000);
+	// Current time in seconds
+	const now = Math.round(new Date().getTime() / 1000);
 
-    const claims: ITokenClaims = {
-        documentId,
-        scopes,
-        tenantId,
-        user: userClaim,
-        iat: now,
-        exp: now + lifetime,
-        ver,
-    };
+	const claims: ITokenClaims = {
+		documentId,
+		scopes,
+		tenantId,
+		user: userClaim,
+		iat: now,
+		exp: now + lifetime,
+		ver,
+	};
 
-    const utf8Key = { utf8: key };
-    return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: "HS256", typ: "JWT" }), claims, utf8Key);
+	const utf8Key = { utf8: key };
+	return jsrsasign.jws.JWS.sign(
+		null,
+		JSON.stringify({ alg: "HS256", typ: "JWT" }),
+		claims,
+		utf8Key,
+	);
 }
 
 export function generateUser(): IUser {
-    const randomUser = {
-        id: uuid(),
-        name: getRandomName(" ", true),
-    };
+	const randomUser = {
+		id: uuid(),
+		name: getRandomName(" ", true),
+	};
 
-    return randomUser;
+	return randomUser;
 }

package/src/localDeltaStorageService.ts

@@ -3,10 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import {
-    IDocumentDeltaStorageService,
-    IStream,
-} from "@fluidframework/driver-definitions";
+import { IDocumentDeltaStorageService, IStream } from "@fluidframework/driver-definitions";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IDatabaseManager } from "@fluidframework/server-services-core";
 import { streamFromMessages } from "@fluidframework/driver-utils";
@@ -15,33 +12,33 @@ import { streamFromMessages } from "@fluidframework/driver-utils";
  * Provides access to the underlying delta storage on the server for local driver.
  */
 export class LocalDeltaStorageService implements IDocumentDeltaStorageService {
-    constructor(
-        private readonly tenantId: string,
-        private readonly id: string,
-        private readonly databaseManager: IDatabaseManager) {
-    }
+	constructor(
+		private readonly tenantId: string,
+		private readonly id: string,
+		private readonly databaseManager: IDatabaseManager,
+	) {}
 
-    public fetchMessages(
-        from: number,
-        to: number | undefined,
-        abortSignal?: AbortSignal,
-        cachedOnly?: boolean,
-    ): IStream<ISequencedDocumentMessage[]> {
-            return streamFromMessages(this.getCore(from, to));
-    }
+	public fetchMessages(
+		from: number,
+		to: number | undefined,
+		abortSignal?: AbortSignal,
+		cachedOnly?: boolean,
+	): IStream<ISequencedDocumentMessage[]> {
+		return streamFromMessages(this.getCore(from, to));
+	}
 
-    private async getCore(from: number, to?: number) {
-        const query = { documentId: this.id, tenantId: this.tenantId };
-        query["operation.sequenceNumber"] = {};
-        query["operation.sequenceNumber"].$gt = from - 1; // from is inclusive
+	private async getCore(from: number, to?: number) {
+		const query = { documentId: this.id, tenantId: this.tenantId };
+		query["operation.sequenceNumber"] = {};
+		query["operation.sequenceNumber"].$gt = from - 1; // from is inclusive
 
-        // This looks like a bug. It used to work without setting $lt key. Now it does not
-        // Need follow up
-        query["operation.sequenceNumber"].$lt = to ?? Number.MAX_SAFE_INTEGER;
+		// This looks like a bug. It used to work without setting $lt key. Now it does not
+		// Need follow up
+		query["operation.sequenceNumber"].$lt = to ?? Number.MAX_SAFE_INTEGER;
 
-        const allDeltas = await this.databaseManager.getDeltaCollection(this.tenantId, this.id);
-        const dbDeltas = await allDeltas.find(query, { "operation.sequenceNumber": 1 });
-        const messages = dbDeltas.map((delta) => delta.operation);
-        return messages;
-    }
+		const allDeltas = await this.databaseManager.getDeltaCollection(this.tenantId, this.id);
+		const dbDeltas = await allDeltas.find(query, { "operation.sequenceNumber": 1 });
+		const messages = dbDeltas.map((delta) => delta.operation);
+		return messages;
+	}
 }

package/src/localDocumentDeltaConnection.ts

@@ -5,10 +5,10 @@
 
 import { DocumentDeltaConnection } from "@fluidframework/driver-base";
 import {
-    IClient,
-    IConnect,
-    IDocumentMessage,
-    NackErrorType,
+	IClient,
+	IConnect,
+	IDocumentMessage,
+	NackErrorType,
 } from "@fluidframework/protocol-definitions";
 import { TelemetryNullLogger } from "@fluidframework/telemetry-utils";
 import { LocalWebSocketServer } from "@fluidframework/server-local-server";
@@ -21,94 +21,98 @@ const testProtocolVersions = ["^0.3.0", "^0.2.0", "^0.1.0"];
  * Represents a connection to a stream of delta updates
  */
 export class LocalDocumentDeltaConnection extends DocumentDeltaConnection {
-    /**
-     * Create a LocalDocumentDeltaConnection
-     * Handle initial messages, contents or signals if they were in queue
-     *
-     * @param tenantId - the ID of the tenant
-     * @param id - document ID
-     * @param token - authorization token for storage service
-     * @param client - information about the client
-     * @param webSocketServer - web socket server to create connection
-     */
-    public static async create(
-        tenantId: string,
-        id: string,
-        token: string,
-        client: IClient,
-        webSocketServer: IWebSocketServer,
-        timeoutMs = 60000,
-    ): Promise<LocalDocumentDeltaConnection> {
-        const socket = (webSocketServer as LocalWebSocketServer).createConnection();
+	/**
+	 * Create a LocalDocumentDeltaConnection
+	 * Handle initial messages, contents or signals if they were in queue
+	 *
+	 * @param tenantId - the ID of the tenant
+	 * @param id - document ID
+	 * @param token - authorization token for storage service
+	 * @param client - information about the client
+	 * @param webSocketServer - web socket server to create connection
+	 */
+	public static async create(
+		tenantId: string,
+		id: string,
+		token: string,
+		client: IClient,
+		webSocketServer: IWebSocketServer,
+		timeoutMs = 60000,
+	): Promise<LocalDocumentDeltaConnection> {
+		const socket = (webSocketServer as LocalWebSocketServer).createConnection();
 
-        // Cast LocalWebSocket to SocketIOClient.Socket which is the socket that the base class needs. This is hacky
-        // but should be fine because this delta connection is for local use only.
-        const socketWithListener = socket as unknown as Socket;
+		// Cast LocalWebSocket to SocketIOClient.Socket which is the socket that the base class needs. This is hacky
+		// but should be fine because this delta connection is for local use only.
+		const socketWithListener = socket as unknown as Socket;
 
-        const deltaConnection = new LocalDocumentDeltaConnection(socketWithListener, id);
+		const deltaConnection = new LocalDocumentDeltaConnection(socketWithListener, id);
 
-        const connectMessage: IConnect = {
-            client,
-            id,
-            mode: client.mode,
-            tenantId,
-            token,  // Token is going to indicate tenant level information, etc...
-            versions: testProtocolVersions,
-        };
-        await deltaConnection.initialize(connectMessage, timeoutMs);
-        return deltaConnection;
-    }
+		const connectMessage: IConnect = {
+			client,
+			id,
+			mode: client.mode,
+			tenantId,
+			token, // Token is going to indicate tenant level information, etc...
+			versions: testProtocolVersions,
+		};
+		await deltaConnection.initialize(connectMessage, timeoutMs);
+		return deltaConnection;
+	}
 
-    constructor(socket: Socket, documentId: string) {
-          super(socket, documentId, new TelemetryNullLogger());
-    }
+	constructor(socket: Socket, documentId: string) {
+		super(socket, documentId, new TelemetryNullLogger());
+	}
 
-    protected submitCore(type: string, messages: IDocumentMessage[]) {
-        this.emitMessages(type, [messages]);
-    }
+	protected submitCore(type: string, messages: IDocumentMessage[]) {
+		this.emitMessages(type, [messages]);
+	}
 
-    /**
-     * Submits a new delta operation to the server
-     */
-    public submit(messages: IDocumentMessage[]): void {
-        // We use a promise resolve to force a turn break given message processing is sync
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        Promise.resolve().then(() => {
-            this.submitCore("submitOp", messages);
-        });
-    }
+	/**
+	 * Submits a new delta operation to the server
+	 */
+	public submit(messages: IDocumentMessage[]): void {
+		// We use a promise resolve to force a turn break given message processing is sync
+		// eslint-disable-next-line @typescript-eslint/no-floating-promises
+		Promise.resolve().then(() => {
+			this.submitCore("submitOp", messages);
+		});
+	}
 
-    /**
-     * Submits a new signal to the server
-     */
-    public submitSignal(message: any): void {
-        this.submitCore("submitSignal", [message]);
-    }
+	/**
+	 * Submits a new signal to the server
+	 */
+	public submitSignal(message: any): void {
+		this.submitCore("submitSignal", [message]);
+	}
 
-    /**
-     * Send a "disconnect" message on the socket.
-     * @param disconnectReason - The reason of the disconnection.
-     */
-    public disconnectClient(disconnectReason: string) {
-        this.socket.emit("disconnect", disconnectReason);
-    }
+	/**
+	 * Send a "disconnect" message on the socket.
+	 * @param disconnectReason - The reason of the disconnection.
+	 */
+	public disconnectClient(disconnectReason: string) {
+		this.socket.emit("disconnect", disconnectReason);
+	}
 
-    /**
-     * * Sends a "nack" message on the socket.
-     * @param code - An error code number that represents the error. It will be a valid HTTP error code.
-     * @param type - Type of the Nack.
-     * @param message - A message about the nack for debugging/logging/telemetry purposes.
-     */
-    public nackClient(code: number = 400, type: NackErrorType = NackErrorType.ThrottlingError, message: any) {
-        const nackMessage = {
-            operation: undefined,
-            sequenceNumber: -1,
-            content: {
-                code,
-                type,
-                message,
-            },
-        };
-        this.socket.emit("nack", "", [nackMessage]);
-    }
+	/**
+	 * * Sends a "nack" message on the socket.
+	 * @param code - An error code number that represents the error. It will be a valid HTTP error code.
+	 * @param type - Type of the Nack.
+	 * @param message - A message about the nack for debugging/logging/telemetry purposes.
+	 */
+	public nackClient(
+		code: number = 400,
+		type: NackErrorType = NackErrorType.ThrottlingError,
+		message: any,
+	) {
+		const nackMessage = {
+			operation: undefined,
+			sequenceNumber: -1,
+			content: {
+				code,
+				type,
+				message,
+			},
+		};
+		this.socket.emit("nack", "", [nackMessage]);
+	}
 }