@fluidframework/runtime-utils 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "1.4.0-121020",
+  "version": "2.0.0-dev-rc.1.0.0.225277",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,44 +11,72 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
-  "types": "dist/index.d.ts",
-  "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",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "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",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/runtime-utils-alpha.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/runtime-utils-alpha.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./beta": {
+      "import": {
+        "types": "./lib/runtime-utils-beta.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/runtime-utils-beta.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/runtime-utils-public.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/runtime-utils-public.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
-  "nyc": {
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
+  "types": "dist/index.d.ts",
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
     "report-dir": "nyc/report",
     "reporter": [
@@ -59,44 +87,85 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "1.4.0-121020",
-    "@fluidframework/container-runtime-definitions": "1.4.0-121020",
-    "@fluidframework/core-interfaces": "1.4.0-121020",
-    "@fluidframework/datastore-definitions": "1.4.0-121020",
-    "@fluidframework/garbage-collector": "1.4.0-121020",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "1.4.0-121020",
-    "@fluidframework/telemetry-utils": "1.4.0-121020"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.225277"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "1.4.0-121020",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@1.3.1",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.8.0.0",
+    "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "cross-env": "^7.0.2",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
-    "rimraf": "^2.6.2",
+    "@types/node": "^18.19.0",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.50.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
-    "ts-node": "^7.0.1",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "ts-node": "^10.9.1",
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
     "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "fluid-build . --task api",
+    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "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 check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/dataStoreHandleContextUtils.ts

@@ -10,22 +10,30 @@ import { IFluidHandleContext } from "@fluidframework/core-interfaces";
  * @param path - The path to the Fluid object relative to the route context.
  * @param routeContext - The route context that contains the Fluid object.
  * @returns The absolute path to the Fluid object from the root of the Container.
+ * @internal
  */
-export function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string {
-    if (path === "") {
-        // The `path` is empty.
-        // If the routeContext does not exist, this is the root.
-        // If the routeContext exists, the absolute path is the same as that of the routeContext.
-        return routeContext === undefined ? "" : routeContext.absolutePath;
-    } else {
-        // Remove beginning and trailing slashes, if any, from the path.
-        let normalizedPath = path.startsWith("/") ? path.slice(1) : path;
-        normalizedPath = normalizedPath.endsWith("/") ? normalizedPath.slice(0, -1) : normalizedPath;
+export function generateHandleContextPath(
+	path: string,
+	routeContext?: IFluidHandleContext,
+): string {
+	if (path === "") {
+		// The `path` is empty.
+		// If the routeContext does not exist, this is the root.
+		// If the routeContext exists, the absolute path is the same as that of the routeContext.
+		return routeContext === undefined ? "" : routeContext.absolutePath;
+	} else {
+		// Remove beginning and trailing slashes, if any, from the path.
+		let normalizedPath = path.startsWith("/") ? path.slice(1) : path;
+		normalizedPath = normalizedPath.endsWith("/")
+			? normalizedPath.slice(0, -1)
+			: normalizedPath;
 
-        // If the routeContext does not exist, path is the absolute path.
-        // If the routeContext exists, absolute path is routeContext's absolute path plus the path.
-        return routeContext === undefined
-            ? `/${normalizedPath}`
-            : `${routeContext.absolutePath === "/" ? "" : routeContext.absolutePath}/${normalizedPath}`;
-    }
+		// If the routeContext does not exist, path is the absolute path.
+		// If the routeContext exists, absolute path is routeContext's absolute path plus the path.
+		return routeContext === undefined
+			? `/${normalizedPath}`
+			: `${
+					routeContext.absolutePath === "/" ? "" : routeContext.absolutePath
+			  }/${normalizedPath}`;
+	}
 }

package/src/dataStoreHelpers.ts

@@ -3,106 +3,129 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
+import { IRequest, IResponse } from "@fluidframework/core-interfaces";
 import {
-    FluidObject,
-    IFluidRouter,
-    IRequest,
-    IResponse,
-} from "@fluidframework/core-interfaces";
-import {
-    IFluidDataStoreFactory,
-    IFluidDataStoreRegistry,
-    IProvideFluidDataStoreRegistry,
+	IFluidDataStoreFactory,
+	IFluidDataStoreRegistry,
+	IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
 import { generateErrorWithStack } from "@fluidframework/telemetry-utils";
 
 interface IResponseException extends Error {
-    errorFromRequestFluidObject: true;
-    message: string;
-    code: number;
-    stack?: string;
+	errorFromRequestFluidObject: true;
+	message: string;
+	code: number;
+	stack?: string;
+	underlyingResponseHeaders?: { [key: string]: any };
 }
 
+/**
+ * @internal
+ */
 export function exceptionToResponse(err: any): IResponse {
-    const status = 500;
-    if (err !== null && typeof err === "object" && err.errorFromRequestFluidObject === true) {
-        const responseErr: IResponseException = err;
-        return {
-            mimeType: "text/plain",
-            status: responseErr.code,
-            value: responseErr.message,
-            get stack() { return responseErr.stack; },
-        };
-    }
-
-    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it
-    const errWithStack = generateErrorWithStack();
-
-    return {
-        mimeType: "text/plain",
-        status,
-        value: `${err}`,
-        get stack() { return ((err?.stack) as (string | undefined)) ?? errWithStack.stack; },
-    };
+	const status = 500;
+	if (err !== null && typeof err === "object" && err.errorFromRequestFluidObject === true) {
+		const responseErr: IResponseException = err;
+		return {
+			mimeType: "text/plain",
+			status: responseErr.code,
+			value: responseErr.message,
+			get stack() {
+				return responseErr.stack;
+			},
+			headers: responseErr.underlyingResponseHeaders,
+		};
+	}
+
+	// Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it
+	const errWithStack = generateErrorWithStack();
+
+	return {
+		mimeType: "text/plain",
+		status,
+		value: `${err}`,
+		get stack() {
+			return (err?.stack as string | undefined) ?? errWithStack.stack;
+		},
+	};
 }
 
+/**
+ * @internal
+ */
 export function responseToException(response: IResponse, request: IRequest): Error {
-    const message = response.value;
-    const errWithStack = generateErrorWithStack();
-    const responseErr: Error & IResponseException = {
-        errorFromRequestFluidObject: true,
-        message,
-        name: "Error",
-        code: response.status,
-        get stack() { return response.stack ?? errWithStack.stack; },
-    };
-
-    return responseErr;
-}
-
-export async function requestFluidObject<T = FluidObject>(
-    router: IFluidRouter, url: string | IRequest): Promise<T> {
-    const request = typeof url === "string" ? { url } : url;
-    const response = await router.request(request);
-
-    if (response.status !== 200 || response.mimeType !== "fluid/object") {
-        throw responseToException(response, request);
-    }
-
-    assert(response.value, 0x19a /* "Invalid response value for Fluid object request" */);
-    return response.value as T;
+	const message = response.value;
+	const errWithStack = generateErrorWithStack();
+	const responseErr: Error & IResponseException = {
+		errorFromRequestFluidObject: true,
+		message,
+		name: "Error",
+		code: response.status,
+		get stack() {
+			return response.stack ?? errWithStack.stack;
+		},
+		underlyingResponseHeaders: response.headers,
+	};
+
+	return responseErr;
 }
 
-export const create404Response = (request: IRequest) => createResponseError(404, "not found", request);
-
-export function createResponseError(status: number, value: string, request: IRequest): IResponse {
-    assert(status !== 200, 0x19b /* "Cannot not create response error on 200 status" */);
-    // Omit query string which could contain personal data (aka "PII")
-    const urlNoQuery = request.url?.split("?")[0];
-
-    // Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it
-    const errWithStack = generateErrorWithStack();
+/**
+ * @internal
+ */
+export const create404Response = (request: IRequest) =>
+	createResponseError(404, "not found", request);
 
-    return {
-        mimeType: "text/plain",
-        status,
-        value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,
-        get stack() { return errWithStack.stack; },
-    };
+/**
+ * @internal
+ */
+export function createResponseError(
+	status: number,
+	value: string,
+	request: IRequest,
+	headers?: { [key: string]: any },
+): IResponse {
+	assert(status !== 200, 0x19b /* "Cannot not create response error on 200 status" */);
+	// Omit query string which could contain personal data unfit for logging
+	const urlNoQuery = request.url?.split("?")[0];
+
+	// Capture error objects, not stack itself, as stack retrieval is very expensive operation, so we delay it
+	const errWithStack = generateErrorWithStack();
+
+	return {
+		mimeType: "text/plain",
+		status,
+		value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,
+		get stack() {
+			return errWithStack.stack;
+		},
+		headers,
+	};
 }
 
+/**
+ * @internal
+ */
 export type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
 
+/**
+ * @internal
+ */
 export function createDataStoreFactory(
-    type: string,
-    factory: Factory | Promise<Factory>,
-    ): IFluidDataStoreFactory & IFluidDataStoreRegistry {
-    return {
-        type,
-        get IFluidDataStoreFactory() { return this; },
-        get IFluidDataStoreRegistry() { return this; },
-        instantiateDataStore: async (context, existing) => (await factory).instantiateDataStore(context, existing),
-        get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),
-    };
+	type: string,
+	factory: Factory | Promise<Factory>,
+): IFluidDataStoreFactory & IFluidDataStoreRegistry {
+	return {
+		type,
+		get IFluidDataStoreFactory() {
+			return this;
+		},
+		get IFluidDataStoreRegistry() {
+			return this;
+		},
+		instantiateDataStore: async (context, existing) =>
+			(await factory).instantiateDataStore(context, existing),
+		get: async (name: string) => (await factory).IFluidDataStoreRegistry?.get(name),
+	};
 }

package/src/index.ts

@@ -3,12 +3,34 @@
  * Licensed under the MIT License.
  */
 
-export * from "./dataStoreHandleContextUtils";
-export * from "./dataStoreHelpers";
-export * from "./objectstoragepartition";
-export * from "./objectstorageutils";
-export * from "./requestParser";
-export * from "./runtimeFactoryHelper";
-export * from "./summarizerNode";
-export * from "./summaryUtils";
-export * from "./utils";
+export { generateHandleContextPath } from "./dataStoreHandleContextUtils";
+export {
+	create404Response,
+	createDataStoreFactory,
+	createResponseError,
+	exceptionToResponse,
+	Factory,
+	responseToException,
+} from "./dataStoreHelpers";
+export { ObjectStoragePartition } from "./objectstoragepartition";
+export { getNormalizedObjectStoragePathParts, listBlobsAtTreePath } from "./objectstorageutils";
+export { RequestParser } from "./requestParser";
+export { RuntimeFactoryHelper } from "./runtimeFactoryHelper";
+export {
+	addBlobToSummary,
+	addSummarizeResultToSummary,
+	addTreeToSummary,
+	calculateStats,
+	convertSnapshotTreeToSummaryTree,
+	convertSummaryTreeToITree,
+	convertToSummaryTree,
+	convertToSummaryTreeWithStats,
+	GCDataBuilder,
+	getBlobSize,
+	mergeStats,
+	SummaryTreeBuilder,
+	TelemetryContext,
+	utf8ByteLength,
+} from "./summaryUtils";
+export { unpackChildNodesUsedRoutes } from "./unpackUsedRoutes";
+export { ReadAndParseBlob, seqFromTree } from "./utils";

package/src/objectstoragepartition.ts

@@ -3,27 +3,31 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import { IChannelStorageService } from "@fluidframework/datastore-definitions";
 
 /**
  * Returns a new IChannelStorageService that resolves the given `path` as root.
+ * @internal
  */
 export class ObjectStoragePartition implements IChannelStorageService {
-    constructor(private readonly storage: IChannelStorageService, private readonly path: string) {
-        // `path` must not include the trailing separator.
-        assert(!path.endsWith("/"), 0x19c /* "storage service path has trailing separator" */);
-    }
+	constructor(
+		private readonly storage: IChannelStorageService,
+		private readonly path: string,
+	) {
+		// `path` must not include the trailing separator.
+		assert(!path.endsWith("/"), 0x19c /* "storage service path has trailing separator" */);
+	}
 
-    public async readBlob(path: string): Promise<ArrayBufferLike> {
-        return this.storage.readBlob(`${this.path}/${path}`);
-    }
+	public async readBlob(path: string): Promise<ArrayBufferLike> {
+		return this.storage.readBlob(`${this.path}/${path}`);
+	}
 
-    public async contains(path: string): Promise<boolean> {
-        return this.storage.contains(`${this.path}/${path}`);
-    }
+	public async contains(path: string): Promise<boolean> {
+		return this.storage.contains(`${this.path}/${path}`);
+	}
 
-    public async list(path: string): Promise<string[]> {
-        return this.storage.list(`${this.path}/${path}`);
-    }
+	public async list(path: string): Promise<string[]> {
+		return this.storage.list(`${this.path}/${path}`);
+	}
 }