@fluidframework/datastore 2.1.0-274160 → 2.1.0-276985

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.1.0-274160",
+  "version": "2.1.0-276985",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -67,29 +67,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.1.0-274160",
-    "@fluidframework/container-definitions": "2.1.0-274160",
-    "@fluidframework/core-interfaces": "2.1.0-274160",
-    "@fluidframework/core-utils": "2.1.0-274160",
-    "@fluidframework/datastore-definitions": "2.1.0-274160",
-    "@fluidframework/driver-definitions": "2.1.0-274160",
-    "@fluidframework/driver-utils": "2.1.0-274160",
-    "@fluidframework/id-compressor": "2.1.0-274160",
-    "@fluidframework/runtime-definitions": "2.1.0-274160",
-    "@fluidframework/runtime-utils": "2.1.0-274160",
-    "@fluidframework/telemetry-utils": "2.1.0-274160",
+    "@fluid-internal/client-utils": "2.1.0-276985",
+    "@fluidframework/container-definitions": "2.1.0-276985",
+    "@fluidframework/core-interfaces": "2.1.0-276985",
+    "@fluidframework/core-utils": "2.1.0-276985",
+    "@fluidframework/datastore-definitions": "2.1.0-276985",
+    "@fluidframework/driver-definitions": "2.1.0-276985",
+    "@fluidframework/driver-utils": "2.1.0-276985",
+    "@fluidframework/id-compressor": "2.1.0-276985",
+    "@fluidframework/runtime-definitions": "2.1.0-276985",
+    "@fluidframework/runtime-utils": "2.1.0-276985",
+    "@fluidframework/telemetry-utils": "2.1.0-276985",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-274160",
+    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
     "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0",
     "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.0.0-rc.5.0.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/test-runtime-utils": "2.1.0-274160",
+    "@fluidframework/test-runtime-utils": "2.1.0-276985",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^9.1.1",
@@ -113,8 +113,8 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",

package/src/dataStoreRuntime.ts

@@ -64,13 +64,13 @@ import {
 	convertSummaryTreeToITree,
 	create404Response,
 	createResponseError,
-	encodeCompactIdToString,
 	exceptionToResponse,
 	generateHandleContextPath,
 	processAttachMessageGCData,
 	toFluidHandleInternal,
 	unpackChildNodesUsedRoutes,
 	toDeltaManagerErased,
+	encodeCompactIdToString,
 } from "@fluidframework/runtime-utils/internal";
 import {
 	ITelemetryLoggerExt,
@@ -96,6 +96,7 @@ import { pkgVersion } from "./packageVersion.js";
 import { RemoteChannelContext } from "./remoteChannelContext.js";
 
 /**
+ * @legacy
  * @alpha
  */
 export enum DataStoreMessageType {
@@ -105,6 +106,7 @@ export enum DataStoreMessageType {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISharedObjectRegistry {
@@ -115,6 +117,7 @@ export interface ISharedObjectRegistry {
 
 /**
  * Base data store class
+ * @legacy
  * @alpha
  */
 export class FluidDataStoreRuntime
@@ -439,21 +442,30 @@ export class FluidDataStoreRuntime
 			id = idArg;
 			this.validateChannelId(id);
 		} else {
-			// We use three non-overlapping namespaces:
-			// - detached state: even numbers
-			// - attached state: odd numbers
-			// - uuids
-			// In first two cases we will encode result as strings in more compact form, with leading underscore,
-			// to ensure no overlap with user-provided DDS names (see validateChannelId())
-			if (this.visibilityState !== VisibilityState.GloballyVisible) {
-				// container is detached, only one client observes content, no way to hit collisions with other clients.
-				id = encodeCompactIdToString(2 * this.contexts.size, "_");
+			/**
+			 * There is currently a bug where certain data store ids such as "[" are getting converted to ASCII characters
+			 * in the snapshot.
+			 * So, return short ids only if explicitly enabled via feature flags. Else, return uuid();
+			 */
+			if (this.mc.config.getBoolean("Fluid.Runtime.UseShortIds") === true) {
+				// We use three non-overlapping namespaces:
+				// - detached state: even numbers
+				// - attached state: odd numbers
+				// - uuids
+				// In first two cases we will encode result as strings in more compact form, with leading underscore,
+				// to ensure no overlap with user-provided DDS names (see validateChannelId())
+				if (this.visibilityState !== VisibilityState.GloballyVisible) {
+					// container is detached, only one client observes content, no way to hit collisions with other clients.
+					id = encodeCompactIdToString(2 * this.contexts.size, "_");
+				} else {
+					// Due to back-compat, we could not depend yet on generateDocumentUniqueId() being there.
+					// We can remove the need to leverage uuid() as fall-back in couple releases.
+					const res =
+						this.dataStoreContext.containerRuntime.generateDocumentUniqueId?.() ?? uuid();
+					id = typeof res === "number" ? encodeCompactIdToString(2 * res + 1, "_") : res;
+				}
 			} else {
-				// Due to back-compat, we could not depend yet on generateDocumentUniqueId() being there.
-				// We can remove the need to leverage uuid() as fall-back in couple releases.
-				const res =
-					this.dataStoreContext.containerRuntime.generateDocumentUniqueId?.() ?? uuid();
-				id = typeof res === "number" ? encodeCompactIdToString(2 * res + 1, "_") : res;
+				id = uuid();
 			}
 			assert(!id.includes("/"), 0x8fc /* slash */);
 		}
@@ -1234,6 +1246,7 @@ export class FluidDataStoreRuntime
  * Request handler is only called when data store can't resolve request, i.e. for custom requests.
  * @param Base - base class, inherits from FluidDataStoreRuntime
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
  */
 export const mixinRequestHandler = (
@@ -1255,6 +1268,7 @@ export const mixinRequestHandler = (
  * @param handler - handler that returns info about blob to be added to summary.
  * Or undefined not to add anything to summary.
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
  */
 export const mixinSummaryHandler = (

package/src/fluidHandle.ts

@@ -13,6 +13,7 @@ import {
 
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
  */
 export class FluidObjectHandle<

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.1.0-274160";
+export const pkgVersion = "2.1.0-276985";