@fluidframework/datastore - npm Package Compare versions

Comparing version 2.1.0-274160 to 2.1.0-276326

dist/dataStoreRuntime.d.ts

@@ -18,2 +18,3 @@ /*!
 /**
+ * @legacy
  * @alpha
@@ -26,2 +27,3 @@ */
 /**
+ * @legacy
  * @alpha
@@ -34,2 +36,3 @@ */
  * Base data store class
+ * @legacy
  * @alpha
@@ -253,2 +256,3 @@ */
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
@@ -262,2 +266,3 @@ */
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
@@ -264,0 +269,0 @@ */

dist/dataStoreRuntime.js

@@ -23,2 +23,3 @@ "use strict";
 /**
+ * @legacy
  * @alpha
@@ -34,2 +35,3 @@ */
  * Base data store class
+ * @legacy
  * @alpha
@@ -270,17 +272,27 @@ */
         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 !== internal_3.VisibilityState.GloballyVisible) {
-                // container is detached, only one client observes content, no way to hit collisions with other clients.
-                id = (0, internal_4.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 !== internal_3.VisibilityState.GloballyVisible) {
+                    // container is detached, only one client observes content, no way to hit collisions with other clients.
+                    id = (0, internal_4.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?.() ?? (0, uuid_1.v4)();
+                    id = typeof res === "number" ? (0, internal_4.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?.() ?? (0, uuid_1.v4)();
-                id = typeof res === "number" ? (0, internal_4.encodeCompactIdToString)(2 * res + 1, "_") : res;
+                id = (0, uuid_1.v4)();
             }
@@ -855,2 +867,3 @@ (0, internal_1.assert)(!id.includes("/"), 0x8fc /* slash */);
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
@@ -873,2 +886,3 @@ */
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
@@ -875,0 +889,0 @@ */

dist/fluidHandle.d.ts

@@ -11,2 +11,3 @@ /*!
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
@@ -13,0 +14,0 @@ */

dist/fluidHandle.js

@@ -11,2 +11,3 @@ "use strict";
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
@@ -13,0 +14,0 @@ */

dist/legacy.d.ts

@@ -12,3 +12,3 @@ /*!
 export {
-	// @alpha APIs
+	// @legacy APIs
 	DataStoreMessageType, 
@@ -15,0 +15,0 @@ FluidDataStoreRuntime,

dist/packageVersion.d.ts

@@ -8,3 +8,3 @@ /*!
 export declare const pkgName = "@fluidframework/datastore";
-export declare const pkgVersion = "2.1.0-274160";
+export declare const pkgVersion = "2.1.0-276326";
 //# sourceMappingURL=packageVersion.d.ts.map

dist/packageVersion.js

@@ -11,3 +11,3 @@ "use strict";
 exports.pkgName = "@fluidframework/datastore";
-exports.pkgVersion = "2.1.0-274160";
+exports.pkgVersion = "2.1.0-276326";
 //# sourceMappingURL=packageVersion.js.map

lib/dataStoreRuntime.d.ts

@@ -18,2 +18,3 @@ /*!
 /**
+ * @legacy
  * @alpha
@@ -26,2 +27,3 @@ */
 /**
+ * @legacy
  * @alpha
@@ -34,2 +36,3 @@ */
  * Base data store class
+ * @legacy
  * @alpha
@@ -253,2 +256,3 @@ */
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
@@ -262,2 +266,3 @@ */
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
@@ -264,0 +269,0 @@ */

lib/dataStoreRuntime.js

@@ -11,3 +11,3 @@ /*!
 import { CreateSummarizerNodeSource, VisibilityState, gcDataBlobKey, } from "@fluidframework/runtime-definitions/internal";
-import { GCDataBuilder, RequestParser, SummaryTreeBuilder, addBlobToSummary, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, create404Response, createResponseError, encodeCompactIdToString, exceptionToResponse, generateHandleContextPath, processAttachMessageGCData, toFluidHandleInternal, unpackChildNodesUsedRoutes, toDeltaManagerErased, } from "@fluidframework/runtime-utils/internal";
+import { GCDataBuilder, RequestParser, SummaryTreeBuilder, addBlobToSummary, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, create404Response, createResponseError, exceptionToResponse, generateHandleContextPath, processAttachMessageGCData, toFluidHandleInternal, unpackChildNodesUsedRoutes, toDeltaManagerErased, encodeCompactIdToString, } from "@fluidframework/runtime-utils/internal";
 import { DataProcessingError, LoggingError, UsageError, createChildMonitoringContext, generateStack, raiseConnectedEvent, tagCodeArtifacts, } from "@fluidframework/telemetry-utils/internal";
@@ -21,2 +21,3 @@ import { v4 as uuid } from "uuid";
 /**
+ * @legacy
  * @alpha
@@ -32,2 +33,3 @@ */
  * Base data store class
+ * @legacy
  * @alpha
@@ -268,17 +270,27 @@ */
         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();
             }
@@ -852,2 +864,3 @@ assert(!id.includes("/"), 0x8fc /* slash */);
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
@@ -869,2 +882,3 @@ */
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
@@ -871,0 +885,0 @@ */

lib/fluidHandle.d.ts

@@ -11,2 +11,3 @@ /*!
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
@@ -13,0 +14,0 @@ */

lib/fluidHandle.js

@@ -8,2 +8,3 @@ /*!
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
@@ -10,0 +11,0 @@ */

lib/legacy.d.ts

@@ -12,3 +12,3 @@ /*!
 export {
-	// @alpha APIs
+	// @legacy APIs
 	DataStoreMessageType, 
@@ -15,0 +15,0 @@ FluidDataStoreRuntime,

lib/packageVersion.d.ts

@@ -8,3 +8,3 @@ /*!
 export declare const pkgName = "@fluidframework/datastore";
-export declare const pkgVersion = "2.1.0-274160";
+export declare const pkgVersion = "2.1.0-276326";
 //# sourceMappingURL=packageVersion.d.ts.map

lib/packageVersion.js

@@ -8,3 +8,3 @@ /*!
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.1.0-274160";
+export const pkgVersion = "2.1.0-276326";
 //# sourceMappingURL=packageVersion.js.map

package.json

 {
   "name": "@fluidframework/datastore",
-  "version": "2.1.0-274160",
+  "version": "2.1.0-276326",
   "description": "Fluid data store implementation",
@@ -70,13 +70,13 @@ "homepage": "https://fluidframework.com",
   "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-276326",
+    "@fluidframework/container-definitions": "2.1.0-276326",
+    "@fluidframework/core-interfaces": "2.1.0-276326",
+    "@fluidframework/core-utils": "2.1.0-276326",
+    "@fluidframework/datastore-definitions": "2.1.0-276326",
+    "@fluidframework/driver-definitions": "2.1.0-276326",
+    "@fluidframework/driver-utils": "2.1.0-276326",
+    "@fluidframework/id-compressor": "2.1.0-276326",
+    "@fluidframework/runtime-definitions": "2.1.0-276326",
+    "@fluidframework/runtime-utils": "2.1.0-276326",
+    "@fluidframework/telemetry-utils": "2.1.0-276326",
     "uuid": "^9.0.0"
@@ -87,3 +87,3 @@ },
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-274160",
+    "@fluid-internal/mocha-test-setup": "2.1.0-276326",
     "@fluid-tools/build-cli": "^0.39.0",
@@ -94,3 +94,3 @@ "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/test-runtime-utils": "2.1.0-274160",
+    "@fluidframework/test-runtime-utils": "2.1.0-276326",
     "@microsoft/api-extractor": "^7.45.1",
@@ -119,4 +119,4 @@ "@types/lodash": "^4.14.118",
     "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",
@@ -123,0 +123,0 @@ "build:commonjs": "fluid-build . --task commonjs",

src/dataStoreRuntime.ts

@@ -67,3 +67,2 @@ /*!
 	createResponseError,
-	encodeCompactIdToString,
 	exceptionToResponse,
@@ -75,2 +74,3 @@ generateHandleContextPath,
 	toDeltaManagerErased,
+	encodeCompactIdToString,
 } from "@fluidframework/runtime-utils/internal";
@@ -101,2 +101,3 @@ import {
 /**
+ * @legacy
  * @alpha
@@ -111,2 +112,3 @@ */
 /**
+ * @legacy
  * @alpha
@@ -122,2 +124,3 @@ */
  * Base data store class
+ * @legacy
  * @alpha
@@ -447,17 +450,26 @@ */
 		} 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();
 			}
@@ -1243,2 +1255,3 @@ assert(!id.includes("/"), 0x8fc /* slash */);
  * @param requestHandler - request handler to mix in
+ * @legacy
  * @alpha
@@ -1265,2 +1278,3 @@ */
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @legacy
  * @alpha
@@ -1267,0 +1281,0 @@ */

src/fluidHandle.ts

@@ -16,2 +16,3 @@ /*!
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ * @legacy
  * @alpha
@@ -18,0 +19,0 @@ */

src/packageVersion.ts

@@ -9,2 +9,2 @@ /*!
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.1.0-274160";
+export const pkgVersion = "2.1.0-276326";

No alert changes

Improved metrics

Total package byte prevSize

665540

increased by0.46%

Lines of code

6906

increased by0.83%

Dependency changes

• + Added@fluid-internal/client-utils@2.1.0-276326(transitive)

• + Added@fluidframework/container-definitions@2.1.0-276326(transitive)

• + Added@fluidframework/container-runtime-definitions@2.1.0-276326(transitive)

• + Added@fluidframework/core-interfaces@2.1.0-276326(transitive)

• + Added@fluidframework/core-utils@2.1.0-276326(transitive)

• + Added@fluidframework/datastore-definitions@2.1.0-276326(transitive)

• + Added@fluidframework/driver-definitions@2.1.0-276326(transitive)

• + Added@fluidframework/driver-utils@2.1.0-276326(transitive)

• + Added@fluidframework/id-compressor@2.1.0-276326(transitive)

• + Added@fluidframework/runtime-definitions@2.1.0-276326(transitive)

• + Added@fluidframework/runtime-utils@2.1.0-276326(transitive)

• + Added@fluidframework/telemetry-utils@2.1.0-276326(transitive)

• - Removed@fluid-internal/client-utils@2.1.0-274160(transitive)

• - Removed@fluidframework/container-definitions@2.1.0-274160(transitive)

• - Removed@fluidframework/container-runtime-definitions@2.1.0-274160(transitive)

• - Removed@fluidframework/core-interfaces@2.1.0-274160(transitive)

• - Removed@fluidframework/core-utils@2.1.0-274160(transitive)

• - Removed@fluidframework/datastore-definitions@2.1.0-274160(transitive)

• - Removed@fluidframework/driver-definitions@2.1.0-274160(transitive)

• - Removed@fluidframework/driver-utils@2.1.0-274160(transitive)

• - Removed@fluidframework/id-compressor@2.1.0-274160(transitive)

• - Removed@fluidframework/runtime-definitions@2.1.0-274160(transitive)

• - Removed@fluidframework/runtime-utils@2.1.0-274160(transitive)

• - Removed@fluidframework/telemetry-utils@2.1.0-274160(transitive)

• Updated@fluid-internal/client-utils@2.1.0-276326

• Updated@fluidframework/container-definitions@2.1.0-276326

• Updated@fluidframework/core-interfaces@2.1.0-276326

• Updated@fluidframework/core-utils@2.1.0-276326

• Updated@fluidframework/datastore-definitions@2.1.0-276326

• Updated@fluidframework/driver-definitions@2.1.0-276326

• Updated@fluidframework/driver-utils@2.1.0-276326

• Updated@fluidframework/id-compressor@2.1.0-276326

• Updated@fluidframework/runtime-definitions@2.1.0-276326

• Updated@fluidframework/runtime-utils@2.1.0-276326

• Updated@fluidframework/telemetry-utils@2.1.0-276326