IdCompressor in the runtime

api-report/container-runtime.api.md

@@ -29,6 +29,8 @@ import { IFluidHandle } from '@fluidframework/core-interfaces';
 import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
+import { IIdCompressorCore } from '@fluidframework/runtime-definitions';
 import { ILoader } from '@fluidframework/container-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
@@ -47,6 +49,8 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
 import { ITelemetryLogger } from '@fluidframework/common-definitions';
 import { MessageType } from '@fluidframework/protocol-definitions';
 import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
+import { SerializedIdCompressorWithNoSession } from '@fluidframework/runtime-definitions';
+import { StableId } from '@fluidframework/runtime-definitions';
 import { TypedEventEmitter } from '@fluidframework/common-utils';
 
 // @public
@@ -55,6 +59,9 @@ export const agentSchedulerId = "_scheduler";
 // @public
 export const AllowTombstoneRequestHeaderKey = "allowTombstone";
 
+// @public
+export function assertIsStableId(stableId: string): StableId;
+
 // @public
 export enum CompressionAlgorithms {
     // (undocumented)
@@ -73,6 +80,7 @@ export enum ContainerMessageType {
     ChunkedOp = "chunkedOp",
     // (undocumented)
     FluidDataStoreOp = "component",
+    IdAllocation = "idAllocation",
     // (undocumented)
     Rejoin = "rejoin"
 }
@@ -84,7 +92,7 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
     // Warning: (ae-forgotten-export) The symbol "IBlobManagerLoadInfo" needs to be exported by the entry point index.d.ts
     //
     // @internal
-    protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, logger: ITelemetryLogger, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration, initializeEntryPoint?: (containerRuntime: IContainerRuntime) => Promise<FluidObject>);
+    protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, logger: ITelemetryLogger, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, serializedIdCompressor: SerializedIdCompressorWithNoSession | undefined, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration, initializeEntryPoint?: (containerRuntime: IContainerRuntime) => Promise<FluidObject>);
     // (undocumented)
     protected addContainerStateToSummary(summaryTree: ISummaryTreeWithStats, fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext): void;
     addedGCOutboundReference(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
@@ -148,6 +156,8 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
     // (undocumented)
     get IContainerRuntime(): this;
     // (undocumented)
+    idCompressor: (IIdCompressor & IIdCompressorCore) | undefined;
+    // (undocumented)
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
     // (undocumented)
     get IFluidHandleContext(): IFluidHandleContext;
@@ -251,6 +261,9 @@ export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
     get IFluidDataStoreRegistry(): this;
 }
 
+// @public
+export function generateStableId(): StableId;
+
 // @public
 export interface IAckedSummary {
     // (undocumented)
@@ -345,6 +358,7 @@ export interface IContainerRuntimeOptions {
     readonly compressionOptions?: ICompressionRuntimeOptions;
     readonly enableGroupedBatching?: boolean;
     readonly enableOpReentryCheck?: boolean;
+    readonly enableRuntimeIdCompressor?: boolean;
     readonly flushMode?: FlushMode;
     // (undocumented)
     readonly gcOptions?: IGCRuntimeOptions;
@@ -433,6 +447,9 @@ export interface IRootSummaryTreeWithStats extends ISummaryTreeWithStats {
 // @public @deprecated (undocumented)
 export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
 
+// @public
+export function isStableId(str: string): str is StableId;
+
 // @public
 export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
     readonly clientSequenceNumber: number;

api-report/datastore-definitions.api.md

@@ -18,6 +18,7 @@ import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IFluidLoadable } from '@fluidframework/core-interfaces';
 import { IFluidRouter } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
 import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
@@ -111,6 +112,8 @@ export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFl
     // (undocumented)
     readonly id: string;
     // (undocumented)
+    readonly idCompressor?: IIdCompressor;
+    // (undocumented)
     readonly IFluidHandleContext: IFluidHandleContext;
     // (undocumented)
     readonly logger: ITelemetryLogger;

api-report/datastore.api.md

@@ -19,6 +19,7 @@ import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definiti
 import { IFluidHandle } from '@fluidframework/core-interfaces';
 import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
 import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
@@ -85,6 +86,8 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
     // (undocumented)
     readonly id: string;
     // (undocumented)
+    get idCompressor(): IIdCompressor | undefined;
+    // (undocumented)
     get IFluidHandleContext(): this;
     // (undocumented)
     get IFluidRouter(): this;

api-report/runtime-definitions.api.md

@@ -49,6 +49,9 @@ export const blobCountPropertyName = "BlobCount";
 // @public (undocumented)
 export const channelsTreeName = ".channels";
 
+// @alpha
+export type CompressedId = FinalCompressedId | LocalCompressedId;
+
 // @public (undocumented)
 export type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
 getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
@@ -81,6 +84,12 @@ export interface DetachedAttributionKey {
     type: "detached";
 }
 
+// @alpha
+export type FinalCompressedId = number & {
+    readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
+    readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
+};
+
 // @public
 export type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
 
@@ -152,6 +161,40 @@ export interface IDataStore extends IFluidRouter {
     trySetAlias(alias: string): Promise<AliasResult>;
 }
 
+// @public
+export interface IdCreationRange {
+    // (undocumented)
+    readonly ids?: IdCreationRange.Ids;
+    // (undocumented)
+    readonly sessionId: SessionId;
+}
+
+// @public (undocumented)
+export namespace IdCreationRange {
+    // (undocumented)
+    export interface HasOverrides {
+        // (undocumented)
+        readonly overrides: Overrides;
+    }
+    // (undocumented)
+    export type Ids = {
+        readonly first: UnackedLocalId;
+        readonly last: UnackedLocalId;
+    } | ({
+        readonly first?: UnackedLocalId;
+        readonly last?: UnackedLocalId;
+    } & HasOverrides);
+    // (undocumented)
+    export type Override = readonly [id: UnackedLocalId, override: string];
+    // (undocumented)
+    export type Overrides = readonly [Override, ...Override[]];
+}
+
+// @public (undocumented)
+export type IdCreationRangeWithStashedState = IdCreationRange & {
+    stashedState: SerializedIdCompressorWithOngoingSession;
+};
+
 // @public
 export interface IEnvelope {
     address: string;
@@ -221,6 +264,8 @@ export interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreCo
     getQuorum(): IQuorumClients;
     // (undocumented)
     readonly id: string;
+    // (undocumented)
+    readonly idCompressor?: IIdCompressor;
     readonly isLocalDataStore: boolean;
     // (undocumented)
     readonly logger: ITelemetryBaseLogger;
@@ -311,6 +356,41 @@ export interface IGarbageCollectionSummaryDetailsLegacy {
     usedRoutes?: string[];
 }
 
+// @public
+export interface IIdCompressor {
+    // Warning: (ae-incompatible-release-tags) The symbol "decompress" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    // Warning: (ae-incompatible-release-tags) The symbol "decompress" is marked as @public, but its signature references "FinalCompressedId" which is marked as @alpha
+    decompress(id: SessionSpaceCompressedId | FinalCompressedId): StableId | string;
+    // Warning: (ae-incompatible-release-tags) The symbol "generateCompressedId" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    generateCompressedId(override?: string): SessionSpaceCompressedId;
+    // (undocumented)
+    localSessionId: SessionId;
+    // Warning: (ae-incompatible-release-tags) The symbol "normalizeToOpSpace" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
+    // Warning: (ae-incompatible-release-tags) The symbol "normalizeToSessionSpace" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
+    // Warning: (ae-incompatible-release-tags) The symbol "normalizeToSessionSpace" is marked as @public, but its signature references "FinalCompressedId" which is marked as @alpha
+    // Warning: (ae-incompatible-release-tags) The symbol "normalizeToSessionSpace" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    normalizeToSessionSpace(id: FinalCompressedId): SessionSpaceCompressedId;
+    // Warning: (ae-incompatible-release-tags) The symbol "recompress" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    recompress(uncompressed: string): SessionSpaceCompressedId;
+    // Warning: (ae-incompatible-release-tags) The symbol "tryDecompress" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    // Warning: (ae-incompatible-release-tags) The symbol "tryDecompress" is marked as @public, but its signature references "FinalCompressedId" which is marked as @alpha
+    tryDecompress(id: SessionSpaceCompressedId | FinalCompressedId): StableId | string | undefined;
+    // Warning: (ae-incompatible-release-tags) The symbol "tryRecompress" is marked as @public, but its signature references "SessionSpaceCompressedId" which is marked as @alpha
+    tryRecompress(uncompressed: string): SessionSpaceCompressedId | undefined;
+}
+
+// @public (undocumented)
+export interface IIdCompressorCore {
+    // (undocumented)
+    clusterCapacity: number;
+    finalizeCreationRange(range: IdCreationRange): void;
+    serialize(withSession: true): SerializedIdCompressorWithOngoingSession;
+    serialize(withSession: false): SerializedIdCompressorWithNoSession;
+    takeNextCreationRange(): IdCreationRange;
+}
+
 // @public
 export interface IInboundSignalMessage extends ISignalMessage {
     // (undocumented)
@@ -439,6 +519,11 @@ export interface LocalAttributionKey {
     type: "local";
 }
 
+// @alpha
+export type LocalCompressedId = number & {
+    readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";
+} & SessionUnique;
+
 // @public
 export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
@@ -451,12 +536,134 @@ export interface OpAttributionKey {
     type: "op";
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "OpSpaceCompressedId" is marked as @public, but its signature references "CompressedId" which is marked as @alpha
+//
+// @public
+export type OpSpaceCompressedId = CompressedId & {
+    readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
+};
+
+// @public
+export type SerializedCluster = readonly [
+sessionIndex: number,
+capacity: number,
+countOrOverrides?: number | SerializedClusterOverrides,
+overrides?: SerializedClusterOverrides
+];
+
+// Warning: (ae-incompatible-release-tags) The symbol "SerializedClusterOverrides" is marked as @public, but its signature references "FinalCompressedId" which is marked as @alpha
+//
+// @public (undocumented)
+export type SerializedClusterOverrides = readonly [
+overriddenFinalIndex: number,
+override: string,
+overriddenId?: FinalCompressedId
+][];
+
+// @public
+export interface SerializedIdCompressor extends VersionedSerializedIdCompressor {
+    readonly clusterCapacity: number;
+    readonly clusters: readonly SerializedCluster[];
+    readonly sessions: readonly SerializedSessionData[];
+}
+
+// @public
+export interface SerializedIdCompressorWithNoSession extends SerializedIdCompressor {
+    // (undocumented)
+    readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
+}
+
+// @public
+export interface SerializedIdCompressorWithOngoingSession extends SerializedIdCompressor {
+    // (undocumented)
+    readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
+    readonly localSessionIndex: number;
+    readonly localState?: SerializedLocalState;
+}
+
+// Warning: (ae-incompatible-release-tags) The symbol "SerializedLocalOverrides" is marked as @public, but its signature references "LocalCompressedId" which is marked as @alpha
+//
+// @public (undocumented)
+export type SerializedLocalOverrides = readonly (readonly [LocalCompressedId, string])[];
+
+// @public (undocumented)
+export interface SerializedLocalState {
+    // Warning: (ae-incompatible-release-tags) The symbol "lastTakenLocalId" is marked as @public, but its signature references "LocalCompressedId" which is marked as @alpha
+    readonly lastTakenLocalId: LocalCompressedId | undefined;
+    readonly localIdCount: number;
+    readonly overrides?: SerializedLocalOverrides;
+    readonly sessionNormalizer: SerializedSessionIdNormalizer;
+}
+
+// @public
+export type SerializedSessionData = readonly [
+sessionId: SessionId
+];
+
+// @public
+export interface SerializedSessionIdNormalizer {
+    // Warning: (ae-incompatible-release-tags) The symbol "localRanges" is marked as @public, but its signature references "LocalCompressedId" which is marked as @alpha
+    // Warning: (ae-incompatible-release-tags) The symbol "localRanges" is marked as @public, but its signature references "FinalCompressedId" which is marked as @alpha
+    //
+    // (undocumented)
+    readonly localRanges: readonly (readonly [
+    firstLocal: LocalCompressedId,
+    lastLocal: LocalCompressedId,
+    finalRanges?: readonly (readonly [
+    alignedLocal: LocalCompressedId,
+    firstFinal: FinalCompressedId,
+    lastFinal: FinalCompressedId
+    ])[]
+    ])[];
+    // Warning: (ae-incompatible-release-tags) The symbol "nextLocalId" is marked as @public, but its signature references "LocalCompressedId" which is marked as @alpha
+    //
+    // (undocumented)
+    readonly nextLocalId: LocalCompressedId;
+}
+
+// @public
+export type SessionId = StableId & {
+    readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
+};
+
+// @alpha
+export type SessionSpaceCompressedId = CompressedId & SessionUnique;
+
+// @public
+export interface SessionUnique {
+    // (undocumented)
+    readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
+}
+
+// @public
+export type StableId = UuidString & {
+    readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
+};
+
 // @public (undocumented)
 export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
 
 // @public (undocumented)
 export const totalBlobSizePropertyName = "TotalBlobSize";
 
+// Warning: (ae-incompatible-release-tags) The symbol "UnackedLocalId" is marked as @public, but its signature references "LocalCompressedId" which is marked as @alpha
+//
+// @public (undocumented)
+export type UnackedLocalId = LocalCompressedId & OpSpaceCompressedId;
+
+// @public
+export type UuidString = string & {
+    readonly UuidString: "9d40d0ae-90d9-44b1-9482-9f55d59d5465";
+};
+
+// @public
+export interface VersionedSerializedIdCompressor {
+    // (undocumented)
+    readonly version: string;
+    // (undocumented)
+    readonly _versionedSerializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
+}
+
 // @public
 const VisibilityState_2: {
     NotVisible: string;

api-report/test-runtime-utils.api.md

@@ -33,6 +33,8 @@ import { IFluidHandle } from '@fluidframework/core-interfaces';
 import { IFluidHandleContext } from '@fluidframework/core-interfaces';
 import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
 import { IGarbageCollectionDetailsBase } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
+import { IIdCompressorCore } from '@fluidframework/runtime-definitions';
 import { ILoader } from '@fluidframework/container-definitions';
 import { ILoaderOptions } from '@fluidframework/container-definitions';
 import { IQuorumClients } from '@fluidframework/protocol-definitions';
@@ -325,6 +327,8 @@ export class MockFluidDataStoreContext implements IFluidDataStoreContext {
     // (undocumented)
     readonly id: string;
     // (undocumented)
+    idCompressor: IIdCompressorCore & IIdCompressor;
+    // (undocumented)
     IFluidDataStoreRegistry: IFluidDataStoreRegistry;
     // (undocumented)
     IFluidHandleContext: IFluidHandleContext;