@fluidframework/container-runtime 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +50 -0
- package/api-extractor-lint.json +13 -0
- package/api-extractor.json +9 -1
- package/api-report/container-runtime.api.md +123 -123
- package/dist/blobManager.d.ts +4 -4
- package/dist/blobManager.d.ts.map +1 -1
- package/dist/blobManager.js.map +1 -1
- package/dist/container-runtime-alpha.d.ts +1444 -0
- package/dist/container-runtime-beta.d.ts +292 -0
- package/dist/container-runtime-public.d.ts +292 -0
- package/dist/container-runtime-untrimmed.d.ts +1792 -0
- package/dist/containerRuntime.d.ts +36 -66
- package/dist/containerRuntime.d.ts.map +1 -1
- package/dist/containerRuntime.js +68 -104
- package/dist/containerRuntime.js.map +1 -1
- package/dist/dataStore.js +0 -12
- package/dist/dataStore.js.map +1 -1
- package/dist/dataStoreRegistry.d.ts +1 -1
- package/dist/dataStoreRegistry.js +1 -1
- package/dist/dataStoreRegistry.js.map +1 -1
- package/dist/dataStores.d.ts +10 -15
- package/dist/dataStores.d.ts.map +1 -1
- package/dist/dataStores.js +77 -40
- package/dist/dataStores.js.map +1 -1
- package/dist/gc/garbageCollection.d.ts +41 -13
- package/dist/gc/garbageCollection.d.ts.map +1 -1
- package/dist/gc/garbageCollection.js +215 -78
- package/dist/gc/garbageCollection.js.map +1 -1
- package/dist/gc/gcConfigs.d.ts.map +1 -1
- package/dist/gc/gcConfigs.js +34 -37
- package/dist/gc/gcConfigs.js.map +1 -1
- package/dist/gc/gcDefinitions.d.ts +121 -46
- package/dist/gc/gcDefinitions.d.ts.map +1 -1
- package/dist/gc/gcDefinitions.js +26 -18
- package/dist/gc/gcDefinitions.js.map +1 -1
- package/dist/gc/gcHelpers.d.ts +18 -25
- package/dist/gc/gcHelpers.d.ts.map +1 -1
- package/dist/gc/gcHelpers.js +29 -45
- package/dist/gc/gcHelpers.js.map +1 -1
- package/dist/gc/gcTelemetry.d.ts +0 -5
- package/dist/gc/gcTelemetry.d.ts.map +1 -1
- package/dist/gc/gcTelemetry.js +14 -42
- package/dist/gc/gcTelemetry.js.map +1 -1
- package/dist/gc/gcUnreferencedStateTracker.d.ts +11 -5
- package/dist/gc/gcUnreferencedStateTracker.d.ts.map +1 -1
- package/dist/gc/gcUnreferencedStateTracker.js +43 -19
- package/dist/gc/gcUnreferencedStateTracker.js.map +1 -1
- package/dist/gc/index.d.ts +1 -1
- package/dist/gc/index.d.ts.map +1 -1
- package/dist/gc/index.js +4 -5
- package/dist/gc/index.js.map +1 -1
- package/dist/index.d.ts +15 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -6
- package/dist/index.js.map +1 -1
- package/dist/messageTypes.d.ts +15 -7
- package/dist/messageTypes.d.ts.map +1 -1
- package/dist/messageTypes.js +6 -1
- package/dist/messageTypes.js.map +1 -1
- package/dist/opLifecycle/definitions.d.ts +1 -1
- package/dist/opLifecycle/definitions.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/pendingStateManager.d.ts +1 -0
- package/dist/pendingStateManager.d.ts.map +1 -1
- package/dist/pendingStateManager.js +1 -0
- package/dist/pendingStateManager.js.map +1 -1
- package/dist/summary/orderedClientElection.d.ts +1 -1
- package/dist/summary/orderedClientElection.js.map +1 -1
- package/dist/summary/runWhileConnectedCoordinator.d.ts +2 -2
- package/dist/summary/runWhileConnectedCoordinator.js +1 -1
- package/dist/summary/runWhileConnectedCoordinator.js.map +1 -1
- package/dist/summary/summarizer.d.ts +1 -13
- package/dist/summary/summarizer.d.ts.map +1 -1
- package/dist/summary/summarizer.js +1 -47
- package/dist/summary/summarizer.js.map +1 -1
- package/dist/summary/summarizerTypes.d.ts +30 -30
- package/dist/summary/summarizerTypes.js.map +1 -1
- package/dist/summary/summaryCollection.d.ts +10 -10
- package/dist/summary/summaryCollection.js +1 -1
- package/dist/summary/summaryCollection.js.map +1 -1
- package/dist/summary/summaryFormat.d.ts +3 -3
- package/dist/summary/summaryFormat.js.map +1 -1
- package/lib/blobManager.d.ts +4 -4
- package/lib/blobManager.d.ts.map +1 -1
- package/lib/blobManager.js.map +1 -1
- package/lib/container-runtime-alpha.d.ts +1444 -0
- package/lib/container-runtime-beta.d.ts +292 -0
- package/lib/container-runtime-public.d.ts +292 -0
- package/lib/container-runtime-untrimmed.d.ts +1792 -0
- package/lib/containerRuntime.d.ts +36 -66
- package/lib/containerRuntime.d.ts.map +1 -1
- package/lib/containerRuntime.js +69 -104
- package/lib/containerRuntime.js.map +1 -1
- package/lib/dataStore.js +0 -12
- package/lib/dataStore.js.map +1 -1
- package/lib/dataStoreRegistry.d.ts +1 -1
- package/lib/dataStoreRegistry.js +1 -1
- package/lib/dataStoreRegistry.js.map +1 -1
- package/lib/dataStores.d.ts +10 -15
- package/lib/dataStores.d.ts.map +1 -1
- package/lib/dataStores.js +80 -43
- package/lib/dataStores.js.map +1 -1
- package/lib/gc/garbageCollection.d.ts +41 -13
- package/lib/gc/garbageCollection.d.ts.map +1 -1
- package/lib/gc/garbageCollection.js +217 -80
- package/lib/gc/garbageCollection.js.map +1 -1
- package/lib/gc/gcConfigs.d.ts.map +1 -1
- package/lib/gc/gcConfigs.js +37 -40
- package/lib/gc/gcConfigs.js.map +1 -1
- package/lib/gc/gcDefinitions.d.ts +121 -46
- package/lib/gc/gcDefinitions.d.ts.map +1 -1
- package/lib/gc/gcDefinitions.js +25 -17
- package/lib/gc/gcDefinitions.js.map +1 -1
- package/lib/gc/gcHelpers.d.ts +18 -25
- package/lib/gc/gcHelpers.d.ts.map +1 -1
- package/lib/gc/gcHelpers.js +27 -43
- package/lib/gc/gcHelpers.js.map +1 -1
- package/lib/gc/gcTelemetry.d.ts +0 -5
- package/lib/gc/gcTelemetry.d.ts.map +1 -1
- package/lib/gc/gcTelemetry.js +15 -43
- package/lib/gc/gcTelemetry.js.map +1 -1
- package/lib/gc/gcUnreferencedStateTracker.d.ts +11 -5
- package/lib/gc/gcUnreferencedStateTracker.d.ts.map +1 -1
- package/lib/gc/gcUnreferencedStateTracker.js +43 -19
- package/lib/gc/gcUnreferencedStateTracker.js.map +1 -1
- package/lib/gc/index.d.ts +1 -1
- package/lib/gc/index.d.ts.map +1 -1
- package/lib/gc/index.js +1 -1
- package/lib/gc/index.js.map +1 -1
- package/lib/index.d.ts +15 -3
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -2
- package/lib/index.js.map +1 -1
- package/lib/messageTypes.d.ts +15 -7
- package/lib/messageTypes.d.ts.map +1 -1
- package/lib/messageTypes.js +6 -1
- package/lib/messageTypes.js.map +1 -1
- package/lib/opLifecycle/definitions.d.ts +1 -1
- package/lib/opLifecycle/definitions.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/lib/pendingStateManager.d.ts +1 -0
- package/lib/pendingStateManager.d.ts.map +1 -1
- package/lib/pendingStateManager.js +1 -0
- package/lib/pendingStateManager.js.map +1 -1
- package/lib/summary/orderedClientElection.d.ts +1 -1
- package/lib/summary/orderedClientElection.js.map +1 -1
- package/lib/summary/runWhileConnectedCoordinator.d.ts +2 -2
- package/lib/summary/runWhileConnectedCoordinator.js +1 -1
- package/lib/summary/runWhileConnectedCoordinator.js.map +1 -1
- package/lib/summary/summarizer.d.ts +1 -13
- package/lib/summary/summarizer.d.ts.map +1 -1
- package/lib/summary/summarizer.js +1 -47
- package/lib/summary/summarizer.js.map +1 -1
- package/lib/summary/summarizerTypes.d.ts +30 -30
- package/lib/summary/summarizerTypes.js.map +1 -1
- package/lib/summary/summaryCollection.d.ts +10 -10
- package/lib/summary/summaryCollection.js +1 -1
- package/lib/summary/summaryCollection.js.map +1 -1
- package/lib/summary/summaryFormat.d.ts +3 -3
- package/lib/summary/summaryFormat.js.map +1 -1
- package/package.json +46 -19
- package/src/blobManager.ts +5 -5
- package/src/containerRuntime.ts +93 -141
- package/src/dataStore.ts +1 -15
- package/src/dataStoreRegistry.ts +1 -1
- package/src/dataStores.ts +140 -69
- package/src/gc/garbageCollection.md +14 -15
- package/src/gc/garbageCollection.ts +256 -96
- package/src/gc/gcConfigs.ts +50 -52
- package/src/gc/gcDefinitions.ts +137 -52
- package/src/gc/gcHelpers.ts +31 -52
- package/src/gc/gcTelemetry.ts +16 -57
- package/src/gc/gcUnreferencedStateTracker.ts +61 -22
- package/src/gc/index.ts +6 -4
- package/src/index.ts +19 -2
- package/src/messageTypes.ts +19 -4
- package/src/opLifecycle/definitions.ts +1 -1
- package/src/packageVersion.ts +1 -1
- package/src/pendingStateManager.ts +1 -0
- package/src/summary/orderedClientElection.ts +1 -1
- package/src/summary/runWhileConnectedCoordinator.ts +2 -2
- package/src/summary/summarizer.ts +2 -51
- package/src/summary/summarizerTypes.ts +30 -30
- package/src/summary/summaryCollection.ts +10 -10
- package/src/summary/summaryFormat.ts +3 -3
- package/dist/id-compressor/appendOnlySortedMap.d.ts +0 -124
- package/dist/id-compressor/appendOnlySortedMap.d.ts.map +0 -1
- package/dist/id-compressor/appendOnlySortedMap.js +0 -318
- package/dist/id-compressor/appendOnlySortedMap.js.map +0 -1
- package/dist/id-compressor/finalSpace.d.ts +0 -29
- package/dist/id-compressor/finalSpace.d.ts.map +0 -1
- package/dist/id-compressor/finalSpace.js +0 -62
- package/dist/id-compressor/finalSpace.js.map +0 -1
- package/dist/id-compressor/idCompressor.d.ts +0 -54
- package/dist/id-compressor/idCompressor.d.ts.map +0 -1
- package/dist/id-compressor/idCompressor.js +0 -495
- package/dist/id-compressor/idCompressor.js.map +0 -1
- package/dist/id-compressor/identifiers.d.ts +0 -32
- package/dist/id-compressor/identifiers.d.ts.map +0 -1
- package/dist/id-compressor/identifiers.js +0 -15
- package/dist/id-compressor/identifiers.js.map +0 -1
- package/dist/id-compressor/index.d.ts +0 -13
- package/dist/id-compressor/index.d.ts.map +0 -1
- package/dist/id-compressor/index.js +0 -32
- package/dist/id-compressor/index.js.map +0 -1
- package/dist/id-compressor/persistanceUtilities.d.ts +0 -22
- package/dist/id-compressor/persistanceUtilities.d.ts.map +0 -1
- package/dist/id-compressor/persistanceUtilities.js +0 -43
- package/dist/id-compressor/persistanceUtilities.js.map +0 -1
- package/dist/id-compressor/sessionSpaceNormalizer.d.ts +0 -46
- package/dist/id-compressor/sessionSpaceNormalizer.d.ts.map +0 -1
- package/dist/id-compressor/sessionSpaceNormalizer.js +0 -80
- package/dist/id-compressor/sessionSpaceNormalizer.js.map +0 -1
- package/dist/id-compressor/sessions.d.ts +0 -115
- package/dist/id-compressor/sessions.d.ts.map +0 -1
- package/dist/id-compressor/sessions.js +0 -305
- package/dist/id-compressor/sessions.js.map +0 -1
- package/dist/id-compressor/utilities.d.ts +0 -52
- package/dist/id-compressor/utilities.d.ts.map +0 -1
- package/dist/id-compressor/utilities.js +0 -169
- package/dist/id-compressor/utilities.js.map +0 -1
- package/lib/id-compressor/appendOnlySortedMap.d.ts +0 -124
- package/lib/id-compressor/appendOnlySortedMap.d.ts.map +0 -1
- package/lib/id-compressor/appendOnlySortedMap.js +0 -314
- package/lib/id-compressor/appendOnlySortedMap.js.map +0 -1
- package/lib/id-compressor/finalSpace.d.ts +0 -29
- package/lib/id-compressor/finalSpace.d.ts.map +0 -1
- package/lib/id-compressor/finalSpace.js +0 -58
- package/lib/id-compressor/finalSpace.js.map +0 -1
- package/lib/id-compressor/idCompressor.d.ts +0 -54
- package/lib/id-compressor/idCompressor.d.ts.map +0 -1
- package/lib/id-compressor/idCompressor.js +0 -491
- package/lib/id-compressor/idCompressor.js.map +0 -1
- package/lib/id-compressor/identifiers.d.ts +0 -32
- package/lib/id-compressor/identifiers.d.ts.map +0 -1
- package/lib/id-compressor/identifiers.js +0 -11
- package/lib/id-compressor/identifiers.js.map +0 -1
- package/lib/id-compressor/index.d.ts +0 -13
- package/lib/id-compressor/index.d.ts.map +0 -1
- package/lib/id-compressor/index.js +0 -13
- package/lib/id-compressor/index.js.map +0 -1
- package/lib/id-compressor/persistanceUtilities.d.ts +0 -22
- package/lib/id-compressor/persistanceUtilities.d.ts.map +0 -1
- package/lib/id-compressor/persistanceUtilities.js +0 -34
- package/lib/id-compressor/persistanceUtilities.js.map +0 -1
- package/lib/id-compressor/sessionSpaceNormalizer.d.ts +0 -46
- package/lib/id-compressor/sessionSpaceNormalizer.d.ts.map +0 -1
- package/lib/id-compressor/sessionSpaceNormalizer.js +0 -76
- package/lib/id-compressor/sessionSpaceNormalizer.js.map +0 -1
- package/lib/id-compressor/sessions.d.ts +0 -115
- package/lib/id-compressor/sessions.d.ts.map +0 -1
- package/lib/id-compressor/sessions.js +0 -290
- package/lib/id-compressor/sessions.js.map +0 -1
- package/lib/id-compressor/utilities.d.ts +0 -52
- package/lib/id-compressor/utilities.d.ts.map +0 -1
- package/lib/id-compressor/utilities.js +0 -151
- package/lib/id-compressor/utilities.js.map +0 -1
- package/src/id-compressor/README.md +0 -3
- package/src/id-compressor/appendOnlySortedMap.ts +0 -366
- package/src/id-compressor/finalSpace.ts +0 -67
- package/src/id-compressor/idCompressor.ts +0 -630
- package/src/id-compressor/identifiers.ts +0 -42
- package/src/id-compressor/index.ts +0 -26
- package/src/id-compressor/persistanceUtilities.ts +0 -58
- package/src/id-compressor/sessionSpaceNormalizer.ts +0 -83
- package/src/id-compressor/sessions.ts +0 -405
- package/src/id-compressor/utilities.ts +0 -190
|
@@ -4,11 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
|
+
import { assertIsStableId } from '@fluidframework/id-compressor';
|
|
7
8
|
import { AttachState } from '@fluidframework/container-definitions';
|
|
8
9
|
import { ContainerWarning } from '@fluidframework/container-definitions';
|
|
9
10
|
import { FluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions';
|
|
10
11
|
import { FluidObject } from '@fluidframework/core-interfaces';
|
|
11
12
|
import { FlushMode } from '@fluidframework/runtime-definitions';
|
|
13
|
+
import { generateStableId } from '@fluidframework/id-compressor';
|
|
12
14
|
import { IAudience } from '@fluidframework/container-definitions';
|
|
13
15
|
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
14
16
|
import { IContainerContext } from '@fluidframework/container-definitions';
|
|
@@ -26,12 +28,10 @@ import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definiti
|
|
|
26
28
|
import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
|
|
27
29
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
28
30
|
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
29
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
30
31
|
import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
|
|
31
32
|
import { IGetPendingLocalStateProps } from '@fluidframework/container-definitions';
|
|
32
|
-
import { IIdCompressor } from '@fluidframework/
|
|
33
|
-
import { IIdCompressorCore } from '@fluidframework/
|
|
34
|
-
import { ILoader } from '@fluidframework/container-definitions';
|
|
33
|
+
import type { IIdCompressor } from '@fluidframework/id-compressor';
|
|
34
|
+
import type { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
35
35
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
36
36
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
37
37
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
@@ -40,6 +40,7 @@ import { IResponse } from '@fluidframework/core-interfaces';
|
|
|
40
40
|
import { IRuntime } from '@fluidframework/container-definitions';
|
|
41
41
|
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
42
42
|
import { ISignalMessage } from '@fluidframework/protocol-definitions';
|
|
43
|
+
import { isStableId } from '@fluidframework/id-compressor';
|
|
43
44
|
import { ISummaryAck } from '@fluidframework/protocol-definitions';
|
|
44
45
|
import { ISummaryContent } from '@fluidframework/protocol-definitions';
|
|
45
46
|
import { ISummaryNack } from '@fluidframework/protocol-definitions';
|
|
@@ -50,20 +51,18 @@ import { ITelemetryContext } from '@fluidframework/runtime-definitions';
|
|
|
50
51
|
import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
|
|
51
52
|
import { MessageType } from '@fluidframework/protocol-definitions';
|
|
52
53
|
import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
|
|
53
|
-
import { StableId } from '@fluidframework/runtime-definitions';
|
|
54
54
|
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
55
55
|
|
|
56
|
-
// @
|
|
56
|
+
// @internal
|
|
57
57
|
export const agentSchedulerId = "_scheduler";
|
|
58
58
|
|
|
59
|
-
// @
|
|
59
|
+
// @internal
|
|
60
60
|
export const AllowInactiveRequestHeaderKey = "allowInactive";
|
|
61
61
|
|
|
62
|
-
// @
|
|
62
|
+
// @internal
|
|
63
63
|
export const AllowTombstoneRequestHeaderKey = "allowTombstone";
|
|
64
64
|
|
|
65
|
-
|
|
66
|
-
export function assertIsStableId(stableId: string): StableId;
|
|
65
|
+
export { assertIsStableId }
|
|
67
66
|
|
|
68
67
|
// @internal
|
|
69
68
|
export type CompatModeBehavior =
|
|
@@ -72,13 +71,13 @@ export type CompatModeBehavior =
|
|
|
72
71
|
/** Fail processing immediately. (The container will close) */
|
|
73
72
|
| "FailToProcess";
|
|
74
73
|
|
|
75
|
-
// @
|
|
74
|
+
// @alpha
|
|
76
75
|
export enum CompressionAlgorithms {
|
|
77
76
|
// (undocumented)
|
|
78
77
|
lz4 = "lz4"
|
|
79
78
|
}
|
|
80
79
|
|
|
81
|
-
// @
|
|
80
|
+
// @internal (undocumented)
|
|
82
81
|
export enum ContainerMessageType {
|
|
83
82
|
// (undocumented)
|
|
84
83
|
Alias = "alias",
|
|
@@ -90,14 +89,14 @@ export enum ContainerMessageType {
|
|
|
90
89
|
ChunkedOp = "chunkedOp",
|
|
91
90
|
// (undocumented)
|
|
92
91
|
FluidDataStoreOp = "component",
|
|
92
|
+
GC = "GC",
|
|
93
93
|
IdAllocation = "idAllocation",
|
|
94
94
|
// (undocumented)
|
|
95
95
|
Rejoin = "rejoin"
|
|
96
96
|
}
|
|
97
97
|
|
|
98
|
-
// @
|
|
98
|
+
// @alpha
|
|
99
99
|
export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
|
|
100
|
-
// @internal
|
|
101
100
|
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: ITelemetryLoggerExt, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, idCompressor: (IIdCompressor & IIdCompressorCore) | undefined, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration);
|
|
102
101
|
// (undocumented)
|
|
103
102
|
protected addContainerStateToSummary(summaryTree: ISummaryTreeWithStats, fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext): void;
|
|
@@ -119,16 +118,16 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
|
|
|
119
118
|
get connected(): boolean;
|
|
120
119
|
// (undocumented)
|
|
121
120
|
createDataStore(pkg: string | string[]): Promise<IDataStore>;
|
|
122
|
-
// @
|
|
121
|
+
// @deprecated (undocumented)
|
|
123
122
|
_createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
|
|
124
123
|
// (undocumented)
|
|
125
124
|
createDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;
|
|
126
125
|
// (undocumented)
|
|
127
126
|
createDetachedRootDataStore(pkg: Readonly<string[]>, rootDataStoreId: string): IFluidDataStoreContextDetached;
|
|
128
127
|
createSummary(blobRedirectTable?: Map<string, string>, telemetryContext?: ITelemetryContext): ISummaryTree;
|
|
129
|
-
deleteSweepReadyNodes(sweepReadyRoutes: string[]): string[];
|
|
128
|
+
deleteSweepReadyNodes(sweepReadyRoutes: readonly string[]): readonly string[];
|
|
130
129
|
// @deprecated (undocumented)
|
|
131
|
-
deleteUnusedNodes(unusedRoutes: string[]): string[];
|
|
130
|
+
deleteUnusedNodes(unusedRoutes: readonly string[]): string[];
|
|
132
131
|
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
133
132
|
// (undocumented)
|
|
134
133
|
dispose(error?: Error): void;
|
|
@@ -158,19 +157,13 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
|
|
|
158
157
|
getPendingLocalState(props?: IGetPendingLocalStateProps): Promise<unknown>;
|
|
159
158
|
// (undocumented)
|
|
160
159
|
getQuorum(): IQuorumClients;
|
|
161
|
-
// @deprecated
|
|
162
|
-
getRootDataStore(id: string, wait?: boolean): Promise<IFluidRouter>;
|
|
163
160
|
// (undocumented)
|
|
164
161
|
idCompressor: (IIdCompressor & IIdCompressorCore) | undefined;
|
|
165
162
|
// (undocumented)
|
|
166
163
|
get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
|
|
167
164
|
// (undocumented)
|
|
168
165
|
get IFluidHandleContext(): IFluidHandleContext;
|
|
169
|
-
// @deprecated (undocumented)
|
|
170
|
-
get IFluidRouter(): this;
|
|
171
166
|
get isDirty(): boolean;
|
|
172
|
-
// @deprecated (undocumented)
|
|
173
|
-
static load(context: IContainerContext, registryEntries: NamedFluidDataStoreRegistryEntries, requestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>, runtimeOptions?: IContainerRuntimeOptions, containerScope?: FluidObject, existing?: boolean, containerRuntimeCtor?: typeof ContainerRuntime): Promise<ContainerRuntime>;
|
|
174
167
|
static loadRuntime(params: {
|
|
175
168
|
context: IContainerContext;
|
|
176
169
|
registryEntries: NamedFluidDataStoreRegistryEntries;
|
|
@@ -184,8 +177,6 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
|
|
|
184
177
|
// (undocumented)
|
|
185
178
|
readonly logger: ITelemetryLoggerExt;
|
|
186
179
|
// (undocumented)
|
|
187
|
-
notifyAttaching(): void;
|
|
188
|
-
// (undocumented)
|
|
189
180
|
notifyOpReplay(message: ISequencedDocumentMessage): Promise<void>;
|
|
190
181
|
// (undocumented)
|
|
191
182
|
readonly options: ILoaderOptions;
|
|
@@ -196,8 +187,6 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
|
|
|
196
187
|
// (undocumented)
|
|
197
188
|
processSignal(message: ISignalMessage, local: boolean): void;
|
|
198
189
|
refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
|
|
199
|
-
// @deprecated
|
|
200
|
-
request(request: IRequest): Promise<IResponse>;
|
|
201
190
|
resolveHandle(request: IRequest): Promise<IResponse>;
|
|
202
191
|
// (undocumented)
|
|
203
192
|
get scope(): FluidObject;
|
|
@@ -226,9 +215,9 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents
|
|
|
226
215
|
summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
|
|
227
216
|
get summarizerClientId(): string | undefined;
|
|
228
217
|
updateStateBeforeGC(): Promise<void>;
|
|
229
|
-
updateTombstonedRoutes(tombstonedRoutes: string[]): void;
|
|
230
|
-
updateUnusedRoutes(unusedRoutes: string[]): void;
|
|
231
|
-
updateUsedRoutes(usedRoutes: string[]): void;
|
|
218
|
+
updateTombstonedRoutes(tombstonedRoutes: readonly string[]): void;
|
|
219
|
+
updateUnusedRoutes(unusedRoutes: readonly string[]): void;
|
|
220
|
+
updateUsedRoutes(usedRoutes: readonly string[]): void;
|
|
232
221
|
// (undocumented)
|
|
233
222
|
uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
|
|
234
223
|
}
|
|
@@ -240,10 +229,10 @@ export interface ContainerRuntimeMessage {
|
|
|
240
229
|
type: ContainerMessageType;
|
|
241
230
|
}
|
|
242
231
|
|
|
243
|
-
// @
|
|
232
|
+
// @internal (undocumented)
|
|
244
233
|
export const DefaultSummaryConfiguration: ISummaryConfiguration;
|
|
245
234
|
|
|
246
|
-
// @
|
|
235
|
+
// @alpha (undocumented)
|
|
247
236
|
export type EnqueueSummarizeResult = (ISummarizeResults & {
|
|
248
237
|
readonly alreadyEnqueued?: undefined;
|
|
249
238
|
}) | (ISummarizeResults & {
|
|
@@ -254,7 +243,7 @@ export type EnqueueSummarizeResult = (ISummarizeResults & {
|
|
|
254
243
|
readonly overridden?: undefined;
|
|
255
244
|
};
|
|
256
245
|
|
|
257
|
-
// @
|
|
246
|
+
// @internal (undocumented)
|
|
258
247
|
export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
|
|
259
248
|
constructor(namedEntries: NamedFluidDataStoreRegistryEntries);
|
|
260
249
|
// (undocumented)
|
|
@@ -263,13 +252,15 @@ export class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
|
|
|
263
252
|
get IFluidDataStoreRegistry(): this;
|
|
264
253
|
}
|
|
265
254
|
|
|
266
|
-
// @
|
|
267
|
-
export
|
|
268
|
-
|
|
269
|
-
tombstoneGeneration?:
|
|
270
|
-
}
|
|
255
|
+
// @alpha (undocumented)
|
|
256
|
+
export type GCFeatureMatrix = {
|
|
257
|
+
gcGeneration?: number;
|
|
258
|
+
tombstoneGeneration?: undefined;
|
|
259
|
+
} | {
|
|
260
|
+
tombstoneGeneration: number;
|
|
261
|
+
};
|
|
271
262
|
|
|
272
|
-
// @
|
|
263
|
+
// @alpha
|
|
273
264
|
export const GCNodeType: {
|
|
274
265
|
DataStore: string;
|
|
275
266
|
SubDataStore: string;
|
|
@@ -277,16 +268,15 @@ export const GCNodeType: {
|
|
|
277
268
|
Other: string;
|
|
278
269
|
};
|
|
279
270
|
|
|
280
|
-
// @
|
|
271
|
+
// @alpha (undocumented)
|
|
281
272
|
export type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
|
|
282
273
|
|
|
283
|
-
// @
|
|
274
|
+
// @alpha (undocumented)
|
|
284
275
|
export type GCVersion = number;
|
|
285
276
|
|
|
286
|
-
|
|
287
|
-
export function generateStableId(): StableId;
|
|
277
|
+
export { generateStableId }
|
|
288
278
|
|
|
289
|
-
// @
|
|
279
|
+
// @internal
|
|
290
280
|
export interface IAckedSummary {
|
|
291
281
|
// (undocumented)
|
|
292
282
|
readonly summaryAck: ISummaryAckMessage;
|
|
@@ -294,7 +284,7 @@ export interface IAckedSummary {
|
|
|
294
284
|
readonly summaryOp: ISummaryOpMessage;
|
|
295
285
|
}
|
|
296
286
|
|
|
297
|
-
// @
|
|
287
|
+
// @alpha (undocumented)
|
|
298
288
|
export interface IAckSummaryResult {
|
|
299
289
|
// (undocumented)
|
|
300
290
|
readonly ackNackDuration: number;
|
|
@@ -302,7 +292,7 @@ export interface IAckSummaryResult {
|
|
|
302
292
|
readonly summaryAckOp: ISummaryAckMessage;
|
|
303
293
|
}
|
|
304
294
|
|
|
305
|
-
// @
|
|
295
|
+
// @alpha
|
|
306
296
|
export interface IBaseSummarizeResult {
|
|
307
297
|
readonly error: any;
|
|
308
298
|
// (undocumented)
|
|
@@ -312,7 +302,7 @@ export interface IBaseSummarizeResult {
|
|
|
312
302
|
readonly stage: "base";
|
|
313
303
|
}
|
|
314
304
|
|
|
315
|
-
// @
|
|
305
|
+
// @alpha
|
|
316
306
|
export interface IBlobManagerLoadInfo {
|
|
317
307
|
// (undocumented)
|
|
318
308
|
ids?: string[];
|
|
@@ -320,7 +310,7 @@ export interface IBlobManagerLoadInfo {
|
|
|
320
310
|
redirectTable?: [string, string][];
|
|
321
311
|
}
|
|
322
312
|
|
|
323
|
-
// @
|
|
313
|
+
// @alpha (undocumented)
|
|
324
314
|
export interface IBroadcastSummaryResult {
|
|
325
315
|
// (undocumented)
|
|
326
316
|
readonly broadcastDuration: number;
|
|
@@ -328,19 +318,19 @@ export interface IBroadcastSummaryResult {
|
|
|
328
318
|
readonly summarizeOp: ISummaryOpMessage;
|
|
329
319
|
}
|
|
330
320
|
|
|
331
|
-
// @
|
|
321
|
+
// @internal
|
|
332
322
|
export interface ICancellableSummarizerController extends ISummaryCancellationToken {
|
|
333
323
|
// (undocumented)
|
|
334
324
|
stop(reason: SummarizerStopReason): void;
|
|
335
325
|
}
|
|
336
326
|
|
|
337
|
-
// @
|
|
327
|
+
// @alpha
|
|
338
328
|
export interface ICancellationToken<T> {
|
|
339
329
|
readonly cancelled: boolean;
|
|
340
330
|
readonly waitCancelled: Promise<T>;
|
|
341
331
|
}
|
|
342
332
|
|
|
343
|
-
// @
|
|
333
|
+
// @internal (undocumented)
|
|
344
334
|
export interface IChunkedOp {
|
|
345
335
|
// (undocumented)
|
|
346
336
|
chunkId: number;
|
|
@@ -356,7 +346,7 @@ export interface IChunkedOp {
|
|
|
356
346
|
totalChunks: number;
|
|
357
347
|
}
|
|
358
348
|
|
|
359
|
-
// @
|
|
349
|
+
// @internal
|
|
360
350
|
export interface IClientSummaryWatcher extends IDisposable {
|
|
361
351
|
// (undocumented)
|
|
362
352
|
waitFlushed(): Promise<IAckedSummary | undefined>;
|
|
@@ -364,13 +354,13 @@ export interface IClientSummaryWatcher extends IDisposable {
|
|
|
364
354
|
watchSummary(clientSequenceNumber: number): ISummary;
|
|
365
355
|
}
|
|
366
356
|
|
|
367
|
-
// @
|
|
357
|
+
// @alpha
|
|
368
358
|
export interface ICompressionRuntimeOptions {
|
|
369
359
|
readonly compressionAlgorithm: CompressionAlgorithms;
|
|
370
360
|
readonly minimumBatchSizeInBytes: number;
|
|
371
361
|
}
|
|
372
362
|
|
|
373
|
-
// @
|
|
363
|
+
// @alpha (undocumented)
|
|
374
364
|
export interface IConnectableRuntime {
|
|
375
365
|
// (undocumented)
|
|
376
366
|
readonly clientId: string | undefined;
|
|
@@ -387,7 +377,7 @@ export interface IContainerRuntimeMessageCompatDetails {
|
|
|
387
377
|
behavior: CompatModeBehavior;
|
|
388
378
|
}
|
|
389
379
|
|
|
390
|
-
// @
|
|
380
|
+
// @alpha (undocumented)
|
|
391
381
|
export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
|
|
392
382
|
readonly disableIsolatedChannels?: true;
|
|
393
383
|
readonly idCompressorEnabled?: boolean;
|
|
@@ -398,7 +388,7 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
|
|
|
398
388
|
readonly telemetryDocumentId?: string;
|
|
399
389
|
}
|
|
400
390
|
|
|
401
|
-
// @
|
|
391
|
+
// @alpha
|
|
402
392
|
export interface IContainerRuntimeOptions {
|
|
403
393
|
readonly chunkSizeInBytes?: number;
|
|
404
394
|
readonly compressionOptions?: ICompressionRuntimeOptions;
|
|
@@ -414,19 +404,19 @@ export interface IContainerRuntimeOptions {
|
|
|
414
404
|
readonly summaryOptions?: ISummaryRuntimeOptions;
|
|
415
405
|
}
|
|
416
406
|
|
|
417
|
-
// @
|
|
407
|
+
// @alpha (undocumented)
|
|
418
408
|
export interface ICreateContainerMetadata {
|
|
419
409
|
createContainerRuntimeVersion?: string;
|
|
420
410
|
createContainerTimestamp?: number;
|
|
421
411
|
}
|
|
422
412
|
|
|
423
|
-
// @
|
|
413
|
+
// @alpha
|
|
424
414
|
export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
|
|
425
415
|
readonly afterSequenceNumber?: number;
|
|
426
416
|
readonly override?: boolean;
|
|
427
417
|
}
|
|
428
418
|
|
|
429
|
-
// @
|
|
419
|
+
// @alpha (undocumented)
|
|
430
420
|
export interface IGCMetadata {
|
|
431
421
|
readonly gcFeature?: GCVersion;
|
|
432
422
|
readonly gcFeatureMatrix?: GCFeatureMatrix;
|
|
@@ -436,29 +426,22 @@ export interface IGCMetadata {
|
|
|
436
426
|
readonly sweepTimeoutMs?: number;
|
|
437
427
|
}
|
|
438
428
|
|
|
439
|
-
// @
|
|
429
|
+
// @alpha (undocumented)
|
|
440
430
|
export interface IGCRuntimeOptions {
|
|
441
431
|
[key: string]: any;
|
|
442
432
|
disableGC?: boolean;
|
|
433
|
+
enableGCSweep?: true;
|
|
443
434
|
gcAllowed?: boolean;
|
|
444
435
|
runFullGC?: boolean;
|
|
445
436
|
sessionExpiryTimeoutMs?: number;
|
|
437
|
+
sweepGracePeriodMs?: number;
|
|
446
438
|
}
|
|
447
439
|
|
|
448
|
-
// @
|
|
449
|
-
export interface IGCStats {
|
|
450
|
-
attachmentBlobCount: number;
|
|
451
|
-
dataStoreCount: number;
|
|
452
|
-
nodeCount: number;
|
|
453
|
-
unrefAttachmentBlobCount: number;
|
|
454
|
-
unrefDataStoreCount: number;
|
|
455
|
-
unrefNodeCount: number;
|
|
456
|
-
updatedAttachmentBlobCount: number;
|
|
457
|
-
updatedDataStoreCount: number;
|
|
458
|
-
updatedNodeCount: number;
|
|
440
|
+
// @alpha
|
|
441
|
+
export interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
|
|
459
442
|
}
|
|
460
443
|
|
|
461
|
-
// @
|
|
444
|
+
// @alpha
|
|
462
445
|
export interface IGeneratedSummaryStats extends ISummaryStats {
|
|
463
446
|
readonly dataStoreCount: number;
|
|
464
447
|
readonly gcBlobNodeCount?: number;
|
|
@@ -468,7 +451,7 @@ export interface IGeneratedSummaryStats extends ISummaryStats {
|
|
|
468
451
|
readonly summaryNumber: number;
|
|
469
452
|
}
|
|
470
453
|
|
|
471
|
-
// @
|
|
454
|
+
// @alpha
|
|
472
455
|
export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
|
|
473
456
|
readonly forcedFullTree: boolean;
|
|
474
457
|
readonly generateDuration: number;
|
|
@@ -478,7 +461,20 @@ export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "
|
|
|
478
461
|
readonly summaryTree: ISummaryTree;
|
|
479
462
|
}
|
|
480
463
|
|
|
481
|
-
// @
|
|
464
|
+
// @alpha
|
|
465
|
+
export interface IMarkPhaseStats {
|
|
466
|
+
attachmentBlobCount: number;
|
|
467
|
+
dataStoreCount: number;
|
|
468
|
+
nodeCount: number;
|
|
469
|
+
unrefAttachmentBlobCount: number;
|
|
470
|
+
unrefDataStoreCount: number;
|
|
471
|
+
unrefNodeCount: number;
|
|
472
|
+
updatedAttachmentBlobCount: number;
|
|
473
|
+
updatedDataStoreCount: number;
|
|
474
|
+
updatedNodeCount: number;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
// @alpha (undocumented)
|
|
482
478
|
export interface INackSummaryResult extends IRetriableFailureResult {
|
|
483
479
|
// (undocumented)
|
|
484
480
|
readonly ackNackDuration: number;
|
|
@@ -486,15 +482,15 @@ export interface INackSummaryResult extends IRetriableFailureResult {
|
|
|
486
482
|
readonly summaryNackOp: ISummaryNackMessage;
|
|
487
483
|
}
|
|
488
484
|
|
|
489
|
-
// @
|
|
485
|
+
// @internal
|
|
490
486
|
export const InactiveResponseHeaderKey = "isInactive";
|
|
491
487
|
|
|
492
|
-
// @
|
|
488
|
+
// @alpha (undocumented)
|
|
493
489
|
export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
|
|
494
490
|
readonly reason: string;
|
|
495
491
|
}
|
|
496
492
|
|
|
497
|
-
// @
|
|
493
|
+
// @alpha
|
|
498
494
|
export interface IRefreshSummaryAckOptions {
|
|
499
495
|
readonly ackHandle: string;
|
|
500
496
|
readonly proposalHandle: string | undefined;
|
|
@@ -502,26 +498,25 @@ export interface IRefreshSummaryAckOptions {
|
|
|
502
498
|
readonly summaryRefSeq: number;
|
|
503
499
|
}
|
|
504
500
|
|
|
505
|
-
// @
|
|
501
|
+
// @alpha
|
|
506
502
|
export interface IRetriableFailureResult {
|
|
507
503
|
// (undocumented)
|
|
508
504
|
readonly retryAfterSeconds?: number;
|
|
509
505
|
}
|
|
510
506
|
|
|
511
|
-
// @
|
|
507
|
+
// @alpha
|
|
512
508
|
export interface ISerializedElection {
|
|
513
509
|
readonly electedClientId: string | undefined;
|
|
514
510
|
readonly electedParentId: string | undefined;
|
|
515
511
|
readonly electionSequenceNumber: number;
|
|
516
512
|
}
|
|
517
513
|
|
|
518
|
-
// @
|
|
514
|
+
// @internal @deprecated (undocumented)
|
|
519
515
|
export function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
|
|
520
516
|
|
|
521
|
-
|
|
522
|
-
export function isStableId(str: string): str is StableId;
|
|
517
|
+
export { isStableId }
|
|
523
518
|
|
|
524
|
-
// @
|
|
519
|
+
// @alpha
|
|
525
520
|
export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
|
|
526
521
|
readonly clientSequenceNumber: number;
|
|
527
522
|
// (undocumented)
|
|
@@ -529,14 +524,14 @@ export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stag
|
|
|
529
524
|
readonly submitOpDuration: number;
|
|
530
525
|
}
|
|
531
526
|
|
|
532
|
-
// @
|
|
527
|
+
// @alpha (undocumented)
|
|
533
528
|
export interface ISubmitSummaryOptions extends ISummarizeOptions {
|
|
534
529
|
readonly cancellationToken: ISummaryCancellationToken;
|
|
535
530
|
readonly finalAttempt?: boolean;
|
|
536
531
|
readonly summaryLogger: ITelemetryLoggerExt;
|
|
537
532
|
}
|
|
538
533
|
|
|
539
|
-
// @
|
|
534
|
+
// @alpha (undocumented)
|
|
540
535
|
export interface ISummarizeEventProps {
|
|
541
536
|
// (undocumented)
|
|
542
537
|
currentAttempt: number;
|
|
@@ -548,14 +543,14 @@ export interface ISummarizeEventProps {
|
|
|
548
543
|
result: "success" | "failure" | "canceled";
|
|
549
544
|
}
|
|
550
545
|
|
|
551
|
-
// @
|
|
546
|
+
// @alpha
|
|
552
547
|
export interface ISummarizeOptions {
|
|
553
548
|
readonly fullTree?: boolean;
|
|
554
549
|
// @deprecated
|
|
555
550
|
readonly refreshLatestAck?: boolean;
|
|
556
551
|
}
|
|
557
552
|
|
|
558
|
-
// @
|
|
553
|
+
// @internal (undocumented)
|
|
559
554
|
export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
|
|
560
555
|
// (undocumented)
|
|
561
556
|
close(): void;
|
|
@@ -568,26 +563,26 @@ export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
|
|
|
568
563
|
summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
|
|
569
564
|
}
|
|
570
565
|
|
|
571
|
-
// @
|
|
566
|
+
// @alpha (undocumented)
|
|
572
567
|
export interface ISummarizeResults {
|
|
573
568
|
readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;
|
|
574
569
|
readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;
|
|
575
570
|
readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>;
|
|
576
571
|
}
|
|
577
572
|
|
|
578
|
-
// @
|
|
573
|
+
// @alpha (undocumented)
|
|
579
574
|
export interface ISummarizerEvents extends IEvent {
|
|
580
575
|
// (undocumented)
|
|
581
576
|
(event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
|
|
582
577
|
}
|
|
583
578
|
|
|
584
|
-
// @
|
|
579
|
+
// @alpha (undocumented)
|
|
585
580
|
export interface ISummarizerInternalsProvider {
|
|
586
581
|
refreshLatestSummaryAck(options: IRefreshSummaryAckOptions): Promise<void>;
|
|
587
582
|
submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
|
|
588
583
|
}
|
|
589
584
|
|
|
590
|
-
// @
|
|
585
|
+
// @alpha (undocumented)
|
|
591
586
|
export interface ISummarizerRuntime extends IConnectableRuntime {
|
|
592
587
|
// (undocumented)
|
|
593
588
|
closeFn(): void;
|
|
@@ -604,7 +599,7 @@ export interface ISummarizerRuntime extends IConnectableRuntime {
|
|
|
604
599
|
readonly summarizerClientId: string | undefined;
|
|
605
600
|
}
|
|
606
601
|
|
|
607
|
-
// @
|
|
602
|
+
// @internal (undocumented)
|
|
608
603
|
export interface ISummarizingWarning extends ContainerWarning {
|
|
609
604
|
// (undocumented)
|
|
610
605
|
readonly errorType: "summarizingError";
|
|
@@ -612,7 +607,7 @@ export interface ISummarizingWarning extends ContainerWarning {
|
|
|
612
607
|
readonly logged: boolean;
|
|
613
608
|
}
|
|
614
609
|
|
|
615
|
-
// @
|
|
610
|
+
// @internal
|
|
616
611
|
export interface ISummary {
|
|
617
612
|
// (undocumented)
|
|
618
613
|
readonly clientId: string;
|
|
@@ -624,7 +619,7 @@ export interface ISummary {
|
|
|
624
619
|
waitBroadcast(): Promise<ISummaryOpMessage>;
|
|
625
620
|
}
|
|
626
621
|
|
|
627
|
-
// @
|
|
622
|
+
// @alpha
|
|
628
623
|
export interface ISummaryAckMessage extends ISequencedDocumentMessage {
|
|
629
624
|
// (undocumented)
|
|
630
625
|
contents: ISummaryAck;
|
|
@@ -632,38 +627,38 @@ export interface ISummaryAckMessage extends ISequencedDocumentMessage {
|
|
|
632
627
|
type: MessageType.SummaryAck;
|
|
633
628
|
}
|
|
634
629
|
|
|
635
|
-
// @
|
|
630
|
+
// @alpha (undocumented)
|
|
636
631
|
export interface ISummaryBaseConfiguration {
|
|
637
632
|
initialSummarizerDelayMs: number;
|
|
638
633
|
maxAckWaitTime: number;
|
|
639
634
|
maxOpsSinceLastSummary: number;
|
|
640
635
|
}
|
|
641
636
|
|
|
642
|
-
// @
|
|
637
|
+
// @alpha
|
|
643
638
|
export type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
|
|
644
639
|
|
|
645
|
-
// @
|
|
640
|
+
// @internal (undocumented)
|
|
646
641
|
export interface ISummaryCollectionOpEvents extends IEvent {
|
|
647
642
|
// (undocumented)
|
|
648
643
|
(event: OpActionEventName, listener: OpActionEventListener): any;
|
|
649
644
|
}
|
|
650
645
|
|
|
651
|
-
// @
|
|
646
|
+
// @alpha (undocumented)
|
|
652
647
|
export type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
|
|
653
648
|
|
|
654
|
-
// @
|
|
649
|
+
// @alpha (undocumented)
|
|
655
650
|
export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
|
|
656
651
|
// (undocumented)
|
|
657
652
|
state: "disableHeuristics";
|
|
658
653
|
}
|
|
659
654
|
|
|
660
|
-
// @
|
|
655
|
+
// @alpha (undocumented)
|
|
661
656
|
export interface ISummaryConfigurationDisableSummarizer {
|
|
662
657
|
// (undocumented)
|
|
663
658
|
state: "disabled";
|
|
664
659
|
}
|
|
665
660
|
|
|
666
|
-
// @
|
|
661
|
+
// @alpha (undocumented)
|
|
667
662
|
export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
|
|
668
663
|
maxIdleTime: number;
|
|
669
664
|
maxOps: number;
|
|
@@ -677,10 +672,10 @@ export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfigurati
|
|
|
677
672
|
state: "enabled";
|
|
678
673
|
}
|
|
679
674
|
|
|
680
|
-
// @
|
|
675
|
+
// @alpha
|
|
681
676
|
export type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
|
|
682
677
|
|
|
683
|
-
// @
|
|
678
|
+
// @alpha
|
|
684
679
|
export interface ISummaryNackMessage extends ISequencedDocumentMessage {
|
|
685
680
|
// (undocumented)
|
|
686
681
|
contents: ISummaryNack;
|
|
@@ -688,7 +683,7 @@ export interface ISummaryNackMessage extends ISequencedDocumentMessage {
|
|
|
688
683
|
type: MessageType.SummaryNack;
|
|
689
684
|
}
|
|
690
685
|
|
|
691
|
-
// @
|
|
686
|
+
// @alpha
|
|
692
687
|
export interface ISummaryOpMessage extends ISequencedDocumentMessage {
|
|
693
688
|
// (undocumented)
|
|
694
689
|
contents: ISummaryContent;
|
|
@@ -696,14 +691,24 @@ export interface ISummaryOpMessage extends ISequencedDocumentMessage {
|
|
|
696
691
|
type: MessageType.Summarize;
|
|
697
692
|
}
|
|
698
693
|
|
|
699
|
-
// @
|
|
694
|
+
// @alpha (undocumented)
|
|
700
695
|
export interface ISummaryRuntimeOptions {
|
|
701
696
|
// @deprecated
|
|
702
697
|
initialSummarizerDelayMs?: number;
|
|
703
698
|
summaryConfigOverrides?: ISummaryConfiguration;
|
|
704
699
|
}
|
|
705
700
|
|
|
706
|
-
// @
|
|
701
|
+
// @alpha
|
|
702
|
+
export interface ISweepPhaseStats {
|
|
703
|
+
deletedAttachmentBlobCount: number;
|
|
704
|
+
deletedDataStoreCount: number;
|
|
705
|
+
deletedNodeCount: number;
|
|
706
|
+
lifetimeAttachmentBlobCount: number;
|
|
707
|
+
lifetimeDataStoreCount: number;
|
|
708
|
+
lifetimeNodeCount: number;
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
// @alpha
|
|
707
712
|
export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
|
|
708
713
|
readonly handle: string;
|
|
709
714
|
// (undocumented)
|
|
@@ -711,13 +716,13 @@ export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "
|
|
|
711
716
|
readonly uploadDuration: number;
|
|
712
717
|
}
|
|
713
718
|
|
|
714
|
-
// @
|
|
719
|
+
// @internal
|
|
715
720
|
export const neverCancelledSummaryToken: ISummaryCancellationToken;
|
|
716
721
|
|
|
717
|
-
// @
|
|
722
|
+
// @internal (undocumented)
|
|
718
723
|
export type OpActionEventListener = (op: ISequencedDocumentMessage) => void;
|
|
719
724
|
|
|
720
|
-
// @
|
|
725
|
+
// @internal (undocumented)
|
|
721
726
|
export type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | "default";
|
|
722
727
|
|
|
723
728
|
// @internal
|
|
@@ -725,13 +730,13 @@ export interface RecentlyAddedContainerRuntimeMessageDetails {
|
|
|
725
730
|
compatDetails: IContainerRuntimeMessageCompatDetails;
|
|
726
731
|
}
|
|
727
732
|
|
|
728
|
-
// @
|
|
733
|
+
// @internal
|
|
729
734
|
export enum RuntimeHeaders {
|
|
730
735
|
viaHandle = "viaHandle",
|
|
731
736
|
wait = "wait"
|
|
732
737
|
}
|
|
733
738
|
|
|
734
|
-
// @
|
|
739
|
+
// @internal @deprecated (undocumented)
|
|
735
740
|
export enum RuntimeMessage {
|
|
736
741
|
// (undocumented)
|
|
737
742
|
Alias = "alias",
|
|
@@ -749,24 +754,22 @@ export enum RuntimeMessage {
|
|
|
749
754
|
Rejoin = "rejoin"
|
|
750
755
|
}
|
|
751
756
|
|
|
752
|
-
// @
|
|
757
|
+
// @alpha
|
|
753
758
|
export interface SubmitSummaryFailureData extends IRetriableFailureResult {
|
|
754
759
|
// (undocumented)
|
|
755
760
|
stage: SummaryStage;
|
|
756
761
|
}
|
|
757
762
|
|
|
758
|
-
// @
|
|
763
|
+
// @alpha
|
|
759
764
|
export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
|
|
760
765
|
|
|
761
|
-
// @
|
|
766
|
+
// @internal
|
|
762
767
|
export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
|
|
763
768
|
constructor(
|
|
764
769
|
runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration,
|
|
765
770
|
internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);
|
|
766
771
|
// (undocumented)
|
|
767
772
|
close(): void;
|
|
768
|
-
// @deprecated
|
|
769
|
-
static create(loader: ILoader, url: string): Promise<ISummarizer>;
|
|
770
773
|
dispose(): void;
|
|
771
774
|
// (undocumented)
|
|
772
775
|
enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
|
|
@@ -784,7 +787,7 @@ export class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements
|
|
|
784
787
|
readonly summaryCollection: SummaryCollection;
|
|
785
788
|
}
|
|
786
789
|
|
|
787
|
-
// @
|
|
790
|
+
// @alpha (undocumented)
|
|
788
791
|
export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
|
|
789
792
|
success: true;
|
|
790
793
|
data: TSuccess;
|
|
@@ -795,7 +798,7 @@ export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
|
|
|
795
798
|
error: any;
|
|
796
799
|
};
|
|
797
800
|
|
|
798
|
-
// @
|
|
801
|
+
// @alpha (undocumented)
|
|
799
802
|
export type SummarizerStopReason =
|
|
800
803
|
/** Summarizer client failed to summarize in all 3 consecutive attempts. */
|
|
801
804
|
"failToSummarize"
|
|
@@ -822,7 +825,7 @@ export type SummarizerStopReason =
|
|
|
822
825
|
*/
|
|
823
826
|
| "latestSummaryStateStale";
|
|
824
827
|
|
|
825
|
-
// @
|
|
828
|
+
// @internal
|
|
826
829
|
export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
|
|
827
830
|
constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, logger: ITelemetryLoggerExt);
|
|
828
831
|
// (undocumented)
|
|
@@ -846,13 +849,10 @@ export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEve
|
|
|
846
849
|
waitSummaryAck(referenceSequenceNumber: number): Promise<IAckedSummary>;
|
|
847
850
|
}
|
|
848
851
|
|
|
849
|
-
// @
|
|
852
|
+
// @alpha
|
|
850
853
|
export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
|
|
851
854
|
|
|
852
855
|
// @internal
|
|
853
|
-
export function TEST_requestSummarizer(loader: ILoader, url: string): Promise<ISummarizer>;
|
|
854
|
-
|
|
855
|
-
// @public
|
|
856
856
|
export const TombstoneResponseHeaderKey = "isTombstoned";
|
|
857
857
|
|
|
858
858
|
// @internal
|