@fluidframework/id-compressor 2.0.0-internal.7.4.0 → 2.0.0-internal.8.0.0

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/id-compressor";
-exports.pkgVersion = "2.0.0-internal.7.4.0";
+exports.pkgVersion = "2.0.0-internal.8.0.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/id-compressor\";\nexport const pkgVersion = \"2.0.0-internal.7.4.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/id-compressor\";\nexport const pkgVersion = \"2.0.0-internal.8.0.0\";\n"]}

package/dist/types/index.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { IdCreationRange, SerializedIdCompressor, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession, initialClusterCapacity, } from "./persisted-types";
+export { IdCreationRange, SerializedIdCompressor, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession, } from "./persisted-types";
 export { IIdCompressorCore, IIdCompressor } from "./idCompressor";
 export { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from "./identifiers";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,sBAAsB,EACtB,mCAAmC,EACnC,wCAAwC,EACxC,sBAAsB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAElE,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,sBAAsB,EACtB,mCAAmC,EACnC,wCAAwC,GACxC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAElE,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}

package/dist/types/index.js

@@ -4,7 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialClusterCapacity = void 0;
-var persisted_types_1 = require("./persisted-types");
-Object.defineProperty(exports, "initialClusterCapacity", { enumerable: true, get: function () { return persisted_types_1.initialClusterCapacity; } });
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qDAM2B;AAD1B,yHAAA,sBAAsB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIdCreationRange,\n\tSerializedIdCompressor,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n\tinitialClusterCapacity,\n} from \"./persisted-types\";\n\nexport { IIdCompressorCore, IIdCompressor } from \"./idCompressor\";\n\nexport { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from \"./identifiers\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIdCreationRange,\n\tSerializedIdCompressor,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n} from \"./persisted-types\";\n\nexport { IIdCompressorCore, IIdCompressor } from \"./idCompressor\";\n\nexport { SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId } from \"./identifiers\";\n"]}

package/dist/types/persisted-types/0.0.1.d.ts

@@ -33,14 +33,20 @@ export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor &
 export interface IdCreationRange {
     readonly sessionId: SessionId;
     readonly ids?: {
+        /**
+         * The gen count of the first ID in the range created by `sessionId.`
+         */
         readonly firstGenCount: number;
+        /**
+         * The number of IDs created in the range created by `sessionId.`
+         */
         readonly count: number;
+        /**
+         * The size of the ID cluster to create if `count` overflows the existing cluster for
+         * `sessionId`, if one exists. This request will be respected, and the size of the cluster
+         * will be equal to overflow + `requestedClusterSize`.
+         */
+        readonly requestedClusterSize: number;
     };
 }
-/**
- * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
- * This value must *NOT* change without careful consideration to compatibility.
- * @internal
- */
-export declare const initialClusterCapacity = 512;
 //# sourceMappingURL=0.0.1.d.ts.map

package/dist/types/persisted-types/0.0.1.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"0.0.1.d.ts","sourceRoot":"","sources":["../../../src/types/persisted-types/0.0.1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG;IAC7C,QAAQ,CAAC,uBAAuB,EAAE,sCAAsC,CAAC;CACzE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG,sBAAsB,GAAG;IAC1E,QAAQ,CAAC,aAAa,EAAE,sCAAsC,CAAC;CAC/D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAAG,sBAAsB,GAAG;IAC/E,QAAQ,CAAC,cAAc,EAAE,sCAAsC,CAAC;CAChE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE;QACd,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACvB,CAAC;CACF;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAC"}
+{"version":3,"file":"0.0.1.d.ts","sourceRoot":"","sources":["../../../src/types/persisted-types/0.0.1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG;IAC7C,QAAQ,CAAC,uBAAuB,EAAE,sCAAsC,CAAC;CACzE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG,sBAAsB,GAAG;IAC1E,QAAQ,CAAC,aAAa,EAAE,sCAAsC,CAAC;CAC/D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAAG,sBAAsB,GAAG;IAC/E,QAAQ,CAAC,cAAc,EAAE,sCAAsC,CAAC;CAChE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE;QACd;;WAEG;QACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAEvB;;;;WAIG;QACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;KACtC,CAAC;CACF"}

package/dist/types/persisted-types/0.0.1.js

@@ -4,11 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialClusterCapacity = void 0;
-/**
- * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
- * This value must *NOT* change without careful consideration to compatibility.
- * @internal
- */
-exports.initialClusterCapacity = 512;
 //# sourceMappingURL=0.0.1.js.map

package/dist/types/persisted-types/0.0.1.js.map

@@ -1 +1 @@
-{"version":3,"file":"0.0.1.js","sourceRoot":"","sources":["../../../src/types/persisted-types/0.0.1.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA0CH;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,GAAG,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { SessionId } from \"../identifiers\";\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressor = string & {\n\treadonly _serializedIdCompressor: \"8c73c57c-1cf4-4278-8915-6444cb4f6af5\";\n};\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {\n\treadonly _noLocalState: \"3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb\";\n};\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {\n\treadonly _hasLocalState: \"1281acae-6d14-47e7-bc92-71c8ee0819cb\";\n};\n\n/**\n * Data describing a range of session-local IDs (from a remote or local session).\n *\n * A range is composed of local IDs that were generated.\n * @alpha\n */\nexport interface IdCreationRange {\n\treadonly sessionId: SessionId;\n\treadonly ids?: {\n\t\treadonly firstGenCount: number;\n\t\treadonly count: number;\n\t};\n}\n\n/**\n * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.\n * This value must *NOT* change without careful consideration to compatibility.\n * @internal\n */\nexport const initialClusterCapacity = 512;\n"]}
+{"version":3,"file":"0.0.1.js","sourceRoot":"","sources":["../../../src/types/persisted-types/0.0.1.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { SessionId } from \"../identifiers\";\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressor = string & {\n\treadonly _serializedIdCompressor: \"8c73c57c-1cf4-4278-8915-6444cb4f6af5\";\n};\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {\n\treadonly _noLocalState: \"3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb\";\n};\n\n/**\n * The serialized contents of an IdCompressor, suitable for persistence in a summary.\n * @alpha\n */\nexport type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {\n\treadonly _hasLocalState: \"1281acae-6d14-47e7-bc92-71c8ee0819cb\";\n};\n\n/**\n * Data describing a range of session-local IDs (from a remote or local session).\n *\n * A range is composed of local IDs that were generated.\n * @alpha\n */\nexport interface IdCreationRange {\n\treadonly sessionId: SessionId;\n\treadonly ids?: {\n\t\t/**\n\t\t * The gen count of the first ID in the range created by `sessionId.`\n\t\t */\n\t\treadonly firstGenCount: number;\n\n\t\t/**\n\t\t * The number of IDs created in the range created by `sessionId.`\n\t\t */\n\t\treadonly count: number;\n\n\t\t/**\n\t\t * The size of the ID cluster to create if `count` overflows the existing cluster for\n\t\t * `sessionId`, if one exists. This request will be respected, and the size of the cluster\n\t\t * will be equal to overflow + `requestedClusterSize`.\n\t\t */\n\t\treadonly requestedClusterSize: number;\n\t};\n}\n"]}

package/dist/types/persisted-types/index.d.ts

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { IdCreationRange, SerializedIdCompressor, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession, initialClusterCapacity, } from "./0.0.1";
+export { IdCreationRange, SerializedIdCompressor, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession, } from "./0.0.1";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/persisted-types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/persisted-types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,sBAAsB,EACtB,mCAAmC,EACnC,wCAAwC,EACxC,sBAAsB,GACtB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/persisted-types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,sBAAsB,EACtB,mCAAmC,EACnC,wCAAwC,GACxC,MAAM,SAAS,CAAC"}

package/dist/types/persisted-types/index.js

@@ -4,7 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialClusterCapacity = void 0;
-var _0_0_1_1 = require("./0.0.1");
-Object.defineProperty(exports, "initialClusterCapacity", { enumerable: true, get: function () { return _0_0_1_1.initialClusterCapacity; } });
 //# sourceMappingURL=index.js.map

package/dist/types/persisted-types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/persisted-types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kCAMiB;AADhB,gHAAA,sBAAsB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIdCreationRange,\n\tSerializedIdCompressor,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n\tinitialClusterCapacity,\n} from \"./0.0.1\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/persisted-types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIdCreationRange,\n\tSerializedIdCompressor,\n\tSerializedIdCompressorWithNoSession,\n\tSerializedIdCompressorWithOngoingSession,\n} from \"./0.0.1\";\n"]}

package/lib/id-compressor-alpha.d.ts

@@ -54,9 +54,15 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
     private readonly normalizer;
     private localGenCount;
     private nextRangeBaseGenCount;
-    private newClusterCapacity;
     private readonly sessions;
     private readonly finalSpace;
+    /**
+     * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
+     * Eventually, this can be adjusted dynamically to have cluster reservation policies that
+     * optimize the number of eager finals.
+     * It is not readonly as it is accessed by tests for clear-box testing.
+     */
+    private nextRequestedClusterSize;
     private telemetryLocalIdCount;
     private telemetryEagerFinalIdCount;
     private constructor();
@@ -68,17 +74,10 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
      * @deprecated Use `createIdCompressor` instead.
      */
     static create(sessionId: SessionId, logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
-    /**
-     * The size of each newly created ID cluster.
-     *
-     * @remarks Must only be set with a value upon which consensus has been reached.
-     * Value must be greater than zero and less than {@link IdCompressor.maxClusterSize}.
-     */
-    get clusterCapacity(): number;
-    set clusterCapacity(value: number);
     generateCompressedId(): SessionSpaceCompressedId;
     private generateNextLocalId;
     takeNextCreationRange(): IdCreationRange;
+    private static assertValidRange;
     finalizeCreationRange(range: IdCreationRange): void;
     private addEmptyCluster;
     normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
@@ -102,8 +101,20 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
 export declare interface IdCreationRange {
     readonly sessionId: SessionId;
     readonly ids?: {
+        /**
+         * The gen count of the first ID in the range created by `sessionId.`
+         */
         readonly firstGenCount: number;
+        /**
+         * The number of IDs created in the range created by `sessionId.`
+         */
         readonly count: number;
+        /**
+         * The size of the ID cluster to create if `count` overflows the existing cluster for
+         * `sessionId`, if one exists. This request will be respected, and the size of the cluster
+         * will be equal to overflow + `requestedClusterSize`.
+         */
+        readonly requestedClusterSize: number;
     };
 }
 
@@ -241,8 +252,6 @@ export declare interface IIdCompressorCore {
     serialize(withSession: false): SerializedIdCompressorWithNoSession;
 }
 
-/* Excluded from this release type: initialClusterCapacity */
-
 /* Excluded from this release type: isStableId */
 
 /**

package/lib/id-compressor-beta.d.ts

@@ -18,8 +18,6 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: IIdCompressorCore */
 
-/* Excluded from this release type: initialClusterCapacity */
-
 /* Excluded from this release type: isStableId */
 
 /* Excluded from this release type: ITelemetryBaseLogger */

package/lib/id-compressor-public.d.ts

@@ -18,8 +18,6 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: IIdCompressorCore */
 
-/* Excluded from this release type: initialClusterCapacity */
-
 /* Excluded from this release type: isStableId */
 
 /* Excluded from this release type: ITelemetryBaseLogger */

package/lib/id-compressor-untrimmed.d.ts

@@ -62,9 +62,15 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
     private readonly normalizer;
     private localGenCount;
     private nextRangeBaseGenCount;
-    private newClusterCapacity;
     private readonly sessions;
     private readonly finalSpace;
+    /**
+     * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
+     * Eventually, this can be adjusted dynamically to have cluster reservation policies that
+     * optimize the number of eager finals.
+     * It is not readonly as it is accessed by tests for clear-box testing.
+     */
+    private nextRequestedClusterSize;
     private telemetryLocalIdCount;
     private telemetryEagerFinalIdCount;
     private constructor();
@@ -76,17 +82,10 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
      * @deprecated Use `createIdCompressor` instead.
      */
     static create(sessionId: SessionId, logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
-    /**
-     * The size of each newly created ID cluster.
-     *
-     * @remarks Must only be set with a value upon which consensus has been reached.
-     * Value must be greater than zero and less than {@link IdCompressor.maxClusterSize}.
-     */
-    get clusterCapacity(): number;
-    set clusterCapacity(value: number);
     generateCompressedId(): SessionSpaceCompressedId;
     private generateNextLocalId;
     takeNextCreationRange(): IdCreationRange;
+    private static assertValidRange;
     finalizeCreationRange(range: IdCreationRange): void;
     private addEmptyCluster;
     normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
@@ -110,8 +109,20 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
 export declare interface IdCreationRange {
     readonly sessionId: SessionId;
     readonly ids?: {
+        /**
+         * The gen count of the first ID in the range created by `sessionId.`
+         */
         readonly firstGenCount: number;
+        /**
+         * The number of IDs created in the range created by `sessionId.`
+         */
         readonly count: number;
+        /**
+         * The size of the ID cluster to create if `count` overflows the existing cluster for
+         * `sessionId`, if one exists. This request will be respected, and the size of the cluster
+         * will be equal to overflow + `requestedClusterSize`.
+         */
+        readonly requestedClusterSize: number;
     };
 }
 
@@ -249,13 +260,6 @@ export declare interface IIdCompressorCore {
     serialize(withSession: false): SerializedIdCompressorWithNoSession;
 }
 
-/**
- * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
- * This value must *NOT* change without careful consideration to compatibility.
- * @internal
- */
-export declare const initialClusterCapacity = 512;
-
 /**
  * Returns true iff the given string is a valid Version 4, variant 2 UUID
  * 'xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx'

package/lib/idCompressor.d.ts

@@ -23,9 +23,15 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
     private readonly normalizer;
     private localGenCount;
     private nextRangeBaseGenCount;
-    private newClusterCapacity;
     private readonly sessions;
     private readonly finalSpace;
+    /**
+     * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
+     * Eventually, this can be adjusted dynamically to have cluster reservation policies that
+     * optimize the number of eager finals.
+     * It is not readonly as it is accessed by tests for clear-box testing.
+     */
+    private nextRequestedClusterSize;
     private telemetryLocalIdCount;
     private telemetryEagerFinalIdCount;
     private constructor();
@@ -37,17 +43,10 @@ export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
      * @deprecated Use `createIdCompressor` instead.
      */
     static create(sessionId: SessionId, logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
-    /**
-     * The size of each newly created ID cluster.
-     *
-     * @remarks Must only be set with a value upon which consensus has been reached.
-     * Value must be greater than zero and less than {@link IdCompressor.maxClusterSize}.
-     */
-    get clusterCapacity(): number;
-    set clusterCapacity(value: number);
     generateCompressedId(): SessionSpaceCompressedId;
     private generateNextLocalId;
     takeNextCreationRange(): IdCreationRange;
+    private static assertValidRange;
     finalizeCreationRange(range: IdCreationRange): void;
     private addEmptyCluster;
     normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;

package/lib/idCompressor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"idCompressor.d.ts","sourceRoot":"","sources":["../src/idCompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EACN,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EAEnB,mCAAmC,EACnC,wCAAwC,EACxC,SAAS,EACT,wBAAwB,EACxB,QAAQ,EAER,MAAM,SAAS,CAAC;AAqCjB;;;;;;;GAOG;AACH,qBAAa,YAAa,YAAW,aAAa,EAAE,iBAAiB;IAuCnE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAtCzB;;OAEG;IACH,gBAAuB,cAAc,SAAW;IAIhD,SAAgB,cAAc,EAAE,SAAS,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAE3D,OAAO,CAAC,aAAa,CAAK;IAQ1B,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,kBAAkB,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoB;IAO/C,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,0BAA0B,CAAK;IAIvC,OAAO;IAqBP;;OAEG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,aAAa,GAAG,iBAAiB;IACtF;;OAEG;WACW,MAAM,CACnB,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB;IAyBpC;;;;;OAKG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,IAAW,eAAe,CAAC,KAAK,EAAE,MAAM,EAQvC;IAEM,oBAAoB,IAAI,wBAAwB;IAyBvD,OAAO,CAAC,mBAAmB;IAMpB,qBAAqB,IAAI,eAAe;IAkBxC,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAmF1D,OAAO,CAAC,eAAe;IAWhB,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,GAAG,mBAAmB;IAerE,uBAAuB,CAC7B,EAAE,EAAE,mBAAmB,EACvB,eAAe,EAAE,SAAS,GACxB,wBAAwB;IA4CpB,UAAU,CAAC,EAAE,EAAE,wBAAwB,GAAG,QAAQ;IAwClD,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB;IAQ5D,aAAa,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB,GAAG,SAAS;IAwC3E,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,wCAAwC;IACtE,SAAS,CAAC,WAAW,EAAE,KAAK,GAAG,mCAAmC;WAyE3D,WAAW,CAAC,UAAU,EAAE,wCAAwC,GAAG,YAAY;WAC/E,WAAW,CACxB,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,YAAY;IA2ER,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,OAAO,GAAG,OAAO;CAiBvE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;;GAIG;AACH,wBAAgB,kBAAkB,CACjC,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AAQrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,wCAAwC,GAClD,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,aAAa,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"idCompressor.d.ts","sourceRoot":"","sources":["../src/idCompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EACN,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EAEnB,mCAAmC,EACnC,wCAAwC,EACxC,SAAS,EACT,wBAAwB,EACxB,QAAQ,EACR,MAAM,SAAS,CAAC;AAqCjB;;;;;;;GAOG;AACH,qBAAa,YAAa,YAAW,aAAa,EAAE,iBAAiB;IA6CnE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IA5CzB;;OAEG;IACH,gBAAuB,cAAc,SAAW;IAIhD,SAAgB,cAAc,EAAE,SAAS,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAE3D,OAAO,CAAC,aAAa,CAAK;IAQ1B,OAAO,CAAC,qBAAqB,CAAK;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoB;IAM/C;;;;;OAKG;IAEH,OAAO,CAAC,wBAAwB,CAAe;IAE/C,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,0BAA0B,CAAK;IAIvC,OAAO;IAqBP;;OAEG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,aAAa,GAAG,iBAAiB;IACtF;;OAEG;WACW,MAAM,CACnB,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB;IAyB7B,oBAAoB,IAAI,wBAAwB;IAyBvD,OAAO,CAAC,mBAAmB;IAMpB,qBAAqB,IAAI,eAAe;IAoB/C,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAaxB,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAmF1D,OAAO,CAAC,eAAe;IAWhB,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,GAAG,mBAAmB;IAerE,uBAAuB,CAC7B,EAAE,EAAE,mBAAmB,EACvB,eAAe,EAAE,SAAS,GACxB,wBAAwB;IA4CpB,UAAU,CAAC,EAAE,EAAE,wBAAwB,GAAG,QAAQ;IAwClD,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB;IAQ5D,aAAa,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB,GAAG,SAAS;IAwC3E,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,wCAAwC;IACtE,SAAS,CAAC,WAAW,EAAE,KAAK,GAAG,mCAAmC;WAuE3D,WAAW,CAAC,UAAU,EAAE,wCAAwC,GAAG,YAAY;WAC/E,WAAW,CACxB,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,YAAY;IAyER,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,OAAO,GAAG,OAAO;CAgBvE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;;GAIG;AACH,wBAAgB,kBAAkB,CACjC,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AAQrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,wCAAwC,GAClD,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,aAAa,GAAG,iBAAiB,CAAC"}

package/lib/idCompressor.js

@@ -5,7 +5,6 @@
 import { assert } from "@fluidframework/core-utils";
 import { bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
 import { createChildLogger } from "@fluidframework/telemetry-utils";
-import { initialClusterCapacity, } from "./types";
 import { isFinalId } from "./identifiers";
 import { createSessionId, localIdFromGenCount, genCountFromLocalId, numericUuidFromStableId, offsetNumericUuid, stableIdFromNumericUuid, subtractNumericUuids, } from "./utilities";
 import { readBoolean, readNumber, readNumericUuid, writeBoolean, writeNumber, writeNumericUuid, } from "./persistanceUtilities";
@@ -37,12 +36,18 @@ export class IdCompressor {
         // The gen count to be annotated on the range returned by the next call to `takeNextCreationRange`.
         // This is updated to be equal to `generatedIdCount` + 1 each time it is called.
         this.nextRangeBaseGenCount = 1;
-        // The capacity of the next cluster to be created
-        this.newClusterCapacity = initialClusterCapacity;
         this.sessions = new Sessions();
         this.finalSpace = new FinalSpace();
         // #endregion
-        // #region Telemetry state
+        // #region Ephemeral state
+        /**
+         * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
+         * Eventually, this can be adjusted dynamically to have cluster reservation policies that
+         * optimize the number of eager finals.
+         * It is not readonly as it is accessed by tests for clear-box testing.
+         */
+        // eslint-disable-next-line @typescript-eslint/prefer-readonly
+        this.nextRequestedClusterSize = 512;
         // The number of local IDs generated since the last telemetry was sent.
         this.telemetryLocalIdCount = 0;
         // The number of eager final IDs generated since the last telemetry was sent.
@@ -81,24 +86,6 @@ export class IdCompressor {
         const compressor = new IdCompressor(localSessionId, logger === undefined ? undefined : createChildLogger({ logger }));
         return compressor;
     }
-    /**
-     * The size of each newly created ID cluster.
-     *
-     * @remarks Must only be set with a value upon which consensus has been reached.
-     * Value must be greater than zero and less than {@link IdCompressor.maxClusterSize}.
-     */
-    get clusterCapacity() {
-        return this.newClusterCapacity;
-    }
-    set clusterCapacity(value) {
-        if (value <= 0) {
-            throw new Error("Clusters must have a positive capacity.");
-        }
-        if (value > IdCompressor.maxClusterSize) {
-            throw new Error("Clusters must not exceed max cluster size.");
-        }
-        this.newClusterCapacity = value;
-    }
     generateCompressedId() {
         this.localGenCount++;
         const lastCluster = this.localSession.getLastCluster();
@@ -139,19 +126,30 @@ export class IdCompressor {
             ids: {
                 firstGenCount: this.nextRangeBaseGenCount,
                 count,
+                requestedClusterSize: this.nextRequestedClusterSize,
             },
         };
         this.nextRangeBaseGenCount = this.localGenCount + 1;
+        IdCompressor.assertValidRange(range);
         return range;
     }
+    static assertValidRange(range) {
+        if (range.ids === undefined) {
+            return;
+        }
+        const { count, requestedClusterSize } = range.ids;
+        assert(count > 0, 0x755 /* Malformed ID Range. */);
+        assert(requestedClusterSize > 0, 0x876 /* Clusters must have a positive capacity. */);
+        assert(requestedClusterSize <= IdCompressor.maxClusterSize, 0x877 /* Clusters must not exceed max cluster size. */);
+    }
     finalizeCreationRange(range) {
         // Check if the range has IDs
         if (range.ids === undefined) {
             return;
         }
-        assert(range.ids.count > 0, 0x755 /* Malformed ID Range. */);
+        IdCompressor.assertValidRange(range);
         const { sessionId, ids } = range;
-        const { count, firstGenCount } = ids;
+        const { count, firstGenCount, requestedClusterSize } = ids;
         const session = this.sessions.getOrCreate(sessionId);
         const isLocal = session === this.localSession;
         const rangeBaseLocal = localIdFromGenCount(firstGenCount);
@@ -161,7 +159,7 @@ export class IdCompressor {
             if (rangeBaseLocal !== -1) {
                 throw new Error("Ranges finalized out of order.");
             }
-            lastCluster = this.addEmptyCluster(session, this.clusterCapacity + count);
+            lastCluster = this.addEmptyCluster(session, requestedClusterSize + count);
             if (isLocal) {
                 this.logger?.sendTelemetryEvent({
                     eventName: "RuntimeIdCompressor:FirstCluster",
@@ -179,7 +177,7 @@ export class IdCompressor {
         }
         else {
             const overflow = count - remainingCapacity;
-            const newClaimedFinalCount = overflow + this.clusterCapacity;
+            const newClaimedFinalCount = overflow + requestedClusterSize;
             if (lastCluster === this.finalSpace.getLastCluster()) {
                 // The last cluster in the sessions chain is the last cluster globally, so it can be expanded.
                 lastCluster.capacity += newClaimedFinalCount;
@@ -379,7 +377,6 @@ export class IdCompressor {
         // Layout size, in 8 byte increments
         const totalSize = 1 + // version
             1 + // hasLocalState
-            1 + // cluster capacity
             1 + // session count
             1 + // cluster count
             sessionIndexMap.size * 2 + // session IDs
@@ -390,7 +387,6 @@ export class IdCompressor {
         let index = 0;
         index = writeNumber(serializedFloat, index, currentWrittenVersion);
         index = writeBoolean(serializedFloat, index, hasLocalState);
-        index = writeNumber(serializedFloat, index, this.clusterCapacity);
         index = writeNumber(serializedFloat, index, sessionIndexMap.size);
         index = writeNumber(serializedFloat, index, finalSpace.clusters.length);
         for (const [session] of sessionIndexMap.entries()) {
@@ -429,7 +425,6 @@ export class IdCompressor {
         const version = readNumber(index);
         assert(version === currentWrittenVersion, 0x75c /* Unknown serialized version. */);
         const hasLocalState = readBoolean(index);
-        const clusterCapacity = readNumber(index);
         const sessionCount = readNumber(index);
         const clusterCount = readNumber(index);
         // Sessions
@@ -450,7 +445,6 @@ export class IdCompressor {
             sessions.push([numeric, new Session(numeric)]);
         }
         const compressor = new IdCompressor(new Sessions(sessions));
-        compressor.clusterCapacity = clusterCapacity;
         // Clusters
         let baseFinalId = 0;
         for (let i = 0; i < clusterCount; i++) {
@@ -483,8 +477,7 @@ export class IdCompressor {
                 this.localGenCount !== other.localGenCount)) {
             return false;
         }
-        return (this.newClusterCapacity === other.newClusterCapacity &&
-            this.sessions.equals(other.sessions, includeLocalState) &&
+        return (this.sessions.equals(other.sessions, includeLocalState) &&
             this.finalSpace.equals(other.finalSpace));
     }
 }