@fluidframework/test-utils 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.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 +8 -0
- package/api-extractor-lint.json +13 -0
- package/api-extractor.json +3 -3
- package/api-report/test-utils.api.md +83 -74
- package/dist/DriverWrappers.d.ts +3 -0
- package/dist/DriverWrappers.d.ts.map +1 -1
- package/dist/DriverWrappers.js +3 -0
- package/dist/DriverWrappers.js.map +1 -1
- package/dist/TestConfigs.d.ts +4 -1
- package/dist/TestConfigs.d.ts.map +1 -1
- package/dist/TestConfigs.js +3 -0
- package/dist/TestConfigs.js.map +1 -1
- package/dist/TestSummaryUtils.d.ts +4 -2
- package/dist/TestSummaryUtils.d.ts.map +1 -1
- package/dist/TestSummaryUtils.js +3 -0
- package/dist/TestSummaryUtils.js.map +1 -1
- package/dist/containerUtils.d.ts +17 -0
- package/dist/containerUtils.d.ts.map +1 -1
- package/dist/containerUtils.js +41 -1
- package/dist/containerUtils.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -1
- package/dist/index.js.map +1 -1
- package/dist/interfaces.d.ts +6 -0
- package/dist/interfaces.d.ts.map +1 -1
- package/dist/interfaces.js.map +1 -1
- package/dist/loaderContainerTracker.d.ts +3 -0
- package/dist/loaderContainerTracker.d.ts.map +1 -1
- package/dist/loaderContainerTracker.js +3 -0
- package/dist/loaderContainerTracker.js.map +1 -1
- package/dist/localCodeLoader.d.ts +7 -0
- package/dist/localCodeLoader.d.ts.map +1 -1
- package/dist/localCodeLoader.js +1 -0
- package/dist/localCodeLoader.js.map +1 -1
- package/dist/localLoader.d.ts +2 -0
- package/dist/localLoader.d.ts.map +1 -1
- package/dist/localLoader.js +2 -0
- package/dist/localLoader.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/retry.d.ts +1 -0
- package/dist/retry.d.ts.map +1 -1
- package/dist/retry.js +1 -0
- package/dist/retry.js.map +1 -1
- package/dist/test-utils-alpha.d.ts +140 -0
- package/dist/test-utils-beta.d.ts +228 -0
- package/dist/test-utils-public.d.ts +228 -0
- package/dist/test-utils-untrimmed.d.ts +993 -0
- package/dist/testContainerRuntimeFactory.d.ts +2 -0
- package/dist/testContainerRuntimeFactory.d.ts.map +1 -1
- package/dist/testContainerRuntimeFactory.js +35 -12
- package/dist/testContainerRuntimeFactory.js.map +1 -1
- package/dist/testContainerRuntimeFactoryWithDefaultDataStore.d.ts +1 -0
- package/dist/testContainerRuntimeFactoryWithDefaultDataStore.d.ts.map +1 -1
- package/dist/testContainerRuntimeFactoryWithDefaultDataStore.js +10 -2
- package/dist/testContainerRuntimeFactoryWithDefaultDataStore.js.map +1 -1
- package/dist/testFluidObject.d.ts +5 -0
- package/dist/testFluidObject.d.ts.map +1 -1
- package/dist/testFluidObject.js +6 -3
- package/dist/testFluidObject.js.map +1 -1
- package/dist/testObjectProvider.d.ts +287 -37
- package/dist/testObjectProvider.d.ts.map +1 -1
- package/dist/testObjectProvider.js +310 -25
- package/dist/testObjectProvider.js.map +1 -1
- package/dist/timeoutUtils.d.ts +11 -0
- package/dist/timeoutUtils.d.ts.map +1 -1
- package/dist/timeoutUtils.js +5 -0
- package/dist/timeoutUtils.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/test-utils-alpha.d.ts +140 -0
- package/lib/test-utils-beta.d.ts +228 -0
- package/lib/test-utils-public.d.ts +228 -0
- package/lib/test-utils-untrimmed.d.ts +993 -0
- package/package.json +63 -35
- package/src/DriverWrappers.ts +3 -0
- package/src/TestConfigs.ts +4 -1
- package/src/TestSummaryUtils.ts +9 -2
- package/src/containerUtils.ts +42 -0
- package/src/index.ts +7 -1
- package/src/interfaces.ts +6 -0
- package/src/loaderContainerTracker.ts +3 -0
- package/src/localCodeLoader.ts +7 -0
- package/src/localLoader.ts +2 -0
- package/src/packageVersion.ts +1 -1
- package/src/retry.ts +1 -0
- package/src/testContainerRuntimeFactory.ts +40 -13
- package/src/testContainerRuntimeFactoryWithDefaultDataStore.ts +11 -0
- package/src/testFluidObject.ts +10 -10
- package/src/testObjectProvider.ts +524 -47
- package/src/timeoutUtils.ts +11 -0
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-lint.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: remove once base config has this enabled as an error
|
|
7
|
+
"ae-incompatible-release-tags": {
|
|
8
|
+
"logLevel": "error",
|
|
9
|
+
"addToApiReportFile": false
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
package/api-extractor.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-base.json",
|
|
4
4
|
"messages": {
|
|
5
5
|
"extractorMessageReporting": {
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
// TODO: Add missing documentation and remove this rule override
|
|
7
|
+
"ae-undocumented": {
|
|
8
8
|
"logLevel": "none"
|
|
9
9
|
}
|
|
10
10
|
}
|
|
@@ -4,18 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
|
-
import { ConfigTypes } from '@fluidframework/
|
|
7
|
+
import { ConfigTypes } from '@fluidframework/core-interfaces';
|
|
8
8
|
import { ContainerRuntime } from '@fluidframework/container-runtime';
|
|
9
9
|
import { ContainerRuntimeFactoryWithDefaultDataStore } from '@fluidframework/aqueduct';
|
|
10
10
|
import { FluidDataStoreRuntime } from '@fluidframework/datastore';
|
|
11
11
|
import { FluidObject } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
13
13
|
import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
|
|
14
|
-
import { IConfigProviderBase } from '@fluidframework/
|
|
14
|
+
import { IConfigProviderBase } from '@fluidframework/core-interfaces';
|
|
15
15
|
import { IContainer } from '@fluidframework/container-definitions';
|
|
16
16
|
import { IContainerContext } from '@fluidframework/container-definitions';
|
|
17
17
|
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
18
18
|
import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
|
|
19
|
+
import { IDataStore } from '@fluidframework/runtime-definitions';
|
|
19
20
|
import { IDocumentService } from '@fluidframework/driver-definitions';
|
|
20
21
|
import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
|
|
21
22
|
import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
@@ -54,13 +55,13 @@ import { Loader } from '@fluidframework/container-loader';
|
|
|
54
55
|
import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
|
|
55
56
|
import { RuntimeRequestHandler } from '@fluidframework/request-handler';
|
|
56
57
|
|
|
57
|
-
// @
|
|
58
|
+
// @internal (undocumented)
|
|
58
59
|
export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>;
|
|
59
60
|
|
|
60
|
-
// @
|
|
61
|
+
// @internal
|
|
61
62
|
export function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise<IContainer>;
|
|
62
63
|
|
|
63
|
-
// @
|
|
64
|
+
// @internal
|
|
64
65
|
export const createContainerRuntimeFactoryWithDefaultDataStore: (Base: typeof ContainerRuntimeFactoryWithDefaultDataStore | undefined, ctorArgs: {
|
|
65
66
|
defaultFactory: IFluidDataStoreFactory;
|
|
66
67
|
registryEntries: NamedFluidDataStoreRegistryEntries;
|
|
@@ -70,25 +71,25 @@ export const createContainerRuntimeFactoryWithDefaultDataStore: (Base: typeof Co
|
|
|
70
71
|
provideEntryPoint?: ((runtime: IContainerRuntime) => Promise<FluidObject>) | undefined;
|
|
71
72
|
}) => ContainerRuntimeFactoryWithDefaultDataStore;
|
|
72
73
|
|
|
73
|
-
// @
|
|
74
|
+
// @internal (undocumented)
|
|
74
75
|
export const createDocumentId: () => string;
|
|
75
76
|
|
|
76
|
-
// @
|
|
77
|
+
// @internal
|
|
77
78
|
export function createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, documentServiceFactory: IDocumentServiceFactory, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger, options?: ILoaderOptions): IHostLoader;
|
|
78
79
|
|
|
79
|
-
// @
|
|
80
|
+
// @internal
|
|
80
81
|
export function createSummarizer(provider: ITestObjectProvider, container: IContainer, config?: ITestContainerConfig, summaryVersion?: string, logger?: ITelemetryBaseLogger): Promise<{
|
|
81
82
|
container: IContainer;
|
|
82
83
|
summarizer: ISummarizer;
|
|
83
84
|
}>;
|
|
84
85
|
|
|
85
|
-
// @
|
|
86
|
+
// @internal
|
|
86
87
|
export function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries, logger?: ITelemetryBaseLogger, configProvider?: IConfigProviderBase): Promise<{
|
|
87
88
|
container: IContainer;
|
|
88
89
|
summarizer: ISummarizer;
|
|
89
90
|
}>;
|
|
90
91
|
|
|
91
|
-
// @
|
|
92
|
+
// @internal
|
|
92
93
|
export const createTestContainerRuntimeFactory: (containerRuntimeCtor: typeof ContainerRuntime) => {
|
|
93
94
|
new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
|
|
94
95
|
type: string;
|
|
@@ -104,7 +105,7 @@ export const createTestContainerRuntimeFactory: (containerRuntimeCtor: typeof Co
|
|
|
104
105
|
};
|
|
105
106
|
};
|
|
106
107
|
|
|
107
|
-
// @
|
|
108
|
+
// @internal (undocumented)
|
|
108
109
|
export enum DataObjectFactoryType {
|
|
109
110
|
// (undocumented)
|
|
110
111
|
Primed = 0,
|
|
@@ -112,10 +113,10 @@ export enum DataObjectFactoryType {
|
|
|
112
113
|
Test = 1
|
|
113
114
|
}
|
|
114
115
|
|
|
115
|
-
// @
|
|
116
|
+
// @internal (undocumented)
|
|
116
117
|
export const defaultTimeoutDurationMs = 250;
|
|
117
118
|
|
|
118
|
-
// @
|
|
119
|
+
// @internal
|
|
119
120
|
export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
|
|
120
121
|
constructor(baseLogger: ITelemetryBaseLogger);
|
|
121
122
|
// (undocumented)
|
|
@@ -132,13 +133,26 @@ export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
|
|
|
132
133
|
send(event: ITelemetryBaseEvent): void;
|
|
133
134
|
}
|
|
134
135
|
|
|
135
|
-
// @
|
|
136
|
+
// @internal (undocumented)
|
|
136
137
|
export type fluidEntryPoint = SupportedExportInterfaces | IFluidModule;
|
|
137
138
|
|
|
138
|
-
// @
|
|
139
|
+
// @internal
|
|
140
|
+
export function getContainerEntryPointBackCompat<T>(container: IContainer): Promise<T>;
|
|
141
|
+
|
|
142
|
+
// @internal
|
|
143
|
+
export function getDataStoreEntryPointBackCompat<T>(dataStore: IDataStore): Promise<T>;
|
|
144
|
+
|
|
145
|
+
// @internal (undocumented)
|
|
139
146
|
export function getUnexpectedLogErrorException(logger: EventAndErrorTrackingLogger | undefined, prefix?: string): Error | undefined;
|
|
140
147
|
|
|
141
|
-
// @
|
|
148
|
+
// @internal
|
|
149
|
+
export interface IDocumentIdStrategy {
|
|
150
|
+
get(): string;
|
|
151
|
+
reset(): void;
|
|
152
|
+
update(resolvedUrl?: IResolvedUrl): void;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// @internal (undocumented)
|
|
142
156
|
export interface IOpProcessingController {
|
|
143
157
|
// (undocumented)
|
|
144
158
|
pauseProcessing(...containers: IContainer[]): Promise<void>;
|
|
@@ -150,13 +164,13 @@ export interface IOpProcessingController {
|
|
|
150
164
|
resumeProcessing(...containers: IContainer[]): void;
|
|
151
165
|
}
|
|
152
166
|
|
|
153
|
-
// @
|
|
167
|
+
// @internal (undocumented)
|
|
154
168
|
export interface IProvideTestFluidObject {
|
|
155
169
|
// (undocumented)
|
|
156
170
|
readonly ITestFluidObject: ITestFluidObject;
|
|
157
171
|
}
|
|
158
172
|
|
|
159
|
-
// @
|
|
173
|
+
// @internal (undocumented)
|
|
160
174
|
export interface ITestContainerConfig {
|
|
161
175
|
enableAttribution?: boolean;
|
|
162
176
|
fluidDataObjectType?: DataObjectFactoryType;
|
|
@@ -165,7 +179,7 @@ export interface ITestContainerConfig {
|
|
|
165
179
|
runtimeOptions?: IContainerRuntimeOptions;
|
|
166
180
|
}
|
|
167
181
|
|
|
168
|
-
// @
|
|
182
|
+
// @internal (undocumented)
|
|
169
183
|
export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
|
|
170
184
|
// (undocumented)
|
|
171
185
|
readonly channel: IFluidDataStoreChannel;
|
|
@@ -179,44 +193,30 @@ export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadabl
|
|
|
179
193
|
readonly runtime: IFluidDataStoreRuntime;
|
|
180
194
|
}
|
|
181
195
|
|
|
182
|
-
// @
|
|
196
|
+
// @internal (undocumented)
|
|
183
197
|
export interface ITestObjectProvider {
|
|
184
|
-
// (undocumented)
|
|
185
198
|
createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
|
|
186
|
-
// (undocumented)
|
|
187
199
|
createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
|
|
188
|
-
// (undocumented)
|
|
189
200
|
createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): IHostLoader;
|
|
190
|
-
// (undocumented)
|
|
191
201
|
defaultCodeDetails: IFluidCodeDetails;
|
|
192
|
-
// (undocumented)
|
|
193
202
|
documentId: string;
|
|
194
|
-
// (undocumented)
|
|
195
203
|
documentServiceFactory: IDocumentServiceFactory;
|
|
196
|
-
// (undocumented)
|
|
197
204
|
driver: ITestDriver;
|
|
198
|
-
// (undocumented)
|
|
199
205
|
ensureSynchronized(timeoutDuration?: number): Promise<void>;
|
|
200
|
-
// (undocumented)
|
|
201
206
|
loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
202
|
-
// (undocumented)
|
|
203
207
|
loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
204
|
-
|
|
205
|
-
logger: ITelemetryBaseLogger;
|
|
206
|
-
// (undocumented)
|
|
208
|
+
logger: EventAndErrorTrackingLogger | undefined;
|
|
207
209
|
makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
|
|
208
210
|
makeTestLoader(testContainerConfig?: ITestContainerConfig): IHostLoader;
|
|
209
|
-
// (undocumented)
|
|
210
211
|
opProcessingController: IOpProcessingController;
|
|
211
|
-
// (undocumented)
|
|
212
212
|
reset(): void;
|
|
213
|
-
|
|
213
|
+
resetLoaderContainerTracker(syncSummarizerClients?: boolean): any;
|
|
214
|
+
type: "TestObjectProvider" | "TestObjectProviderWithVersionedLoad";
|
|
214
215
|
updateDocumentId(url: IResolvedUrl | undefined): void;
|
|
215
|
-
// (undocumented)
|
|
216
216
|
urlResolver: IUrlResolver;
|
|
217
217
|
}
|
|
218
218
|
|
|
219
|
-
// @
|
|
219
|
+
// @internal (undocumented)
|
|
220
220
|
export class LoaderContainerTracker implements IOpProcessingController {
|
|
221
221
|
constructor(syncSummarizerClients?: boolean);
|
|
222
222
|
add<LoaderType extends IHostLoader>(loader: LoaderType): void;
|
|
@@ -228,29 +228,29 @@ export class LoaderContainerTracker implements IOpProcessingController {
|
|
|
228
228
|
resumeProcessing(...containers: IContainer[]): IContainer[];
|
|
229
229
|
}
|
|
230
230
|
|
|
231
|
-
// @
|
|
231
|
+
// @internal
|
|
232
232
|
export class LocalCodeLoader implements ICodeDetailsLoader {
|
|
233
233
|
constructor(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, runtimeOptions?: IContainerRuntimeOptions);
|
|
234
234
|
load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
|
|
235
235
|
}
|
|
236
236
|
|
|
237
|
-
// @
|
|
237
|
+
// @internal (undocumented)
|
|
238
238
|
export const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
|
|
239
239
|
|
|
240
|
-
// @
|
|
240
|
+
// @internal
|
|
241
241
|
export const retryWithEventualValue: <T>(callback: () => Promise<T>, check: (value: T) => boolean, defaultValue: T, maxTries?: number, backOffMs?: number) => Promise<T>;
|
|
242
242
|
|
|
243
|
-
// @
|
|
243
|
+
// @internal
|
|
244
244
|
export function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<{
|
|
245
245
|
summaryTree: ISummaryTree;
|
|
246
246
|
summaryVersion: string;
|
|
247
247
|
summaryRefSeq: number;
|
|
248
248
|
}>;
|
|
249
249
|
|
|
250
|
-
// @
|
|
250
|
+
// @internal (undocumented)
|
|
251
251
|
export type SupportedExportInterfaces = Partial<IProvideRuntimeFactory & IProvideFluidDataStoreFactory & IProvideFluidDataStoreRegistry & IProvideFluidCodeDetailsComparer>;
|
|
252
252
|
|
|
253
|
-
// @
|
|
253
|
+
// @internal
|
|
254
254
|
export const TestContainerRuntimeFactory: {
|
|
255
255
|
new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
|
|
256
256
|
type: string;
|
|
@@ -266,7 +266,7 @@ export const TestContainerRuntimeFactory: {
|
|
|
266
266
|
};
|
|
267
267
|
};
|
|
268
268
|
|
|
269
|
-
// @
|
|
269
|
+
// @internal
|
|
270
270
|
export class TestFluidObject implements ITestFluidObject {
|
|
271
271
|
constructor(runtime: IFluidDataStoreRuntime, channel: IFluidDataStoreChannel, context: IFluidDataStoreContext, factoryEntriesMap: Map<string, IChannelFactory>);
|
|
272
272
|
// (undocumented)
|
|
@@ -292,7 +292,7 @@ export class TestFluidObject implements ITestFluidObject {
|
|
|
292
292
|
readonly runtime: IFluidDataStoreRuntime;
|
|
293
293
|
}
|
|
294
294
|
|
|
295
|
-
// @
|
|
295
|
+
// @internal
|
|
296
296
|
export class TestFluidObjectFactory implements IFluidDataStoreFactory {
|
|
297
297
|
constructor(factoryEntries: ChannelFactoryRegistry, type?: string);
|
|
298
298
|
// (undocumented)
|
|
@@ -303,54 +303,63 @@ export class TestFluidObjectFactory implements IFluidDataStoreFactory {
|
|
|
303
303
|
readonly type: string;
|
|
304
304
|
}
|
|
305
305
|
|
|
306
|
-
// @
|
|
306
|
+
// @internal
|
|
307
307
|
export class TestObjectProvider implements ITestObjectProvider {
|
|
308
|
-
constructor(LoaderConstructor: typeof Loader,
|
|
308
|
+
constructor(LoaderConstructor: typeof Loader,
|
|
309
|
+
driver: ITestDriver,
|
|
310
|
+
createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint);
|
|
309
311
|
createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
|
|
310
|
-
// (undocumented)
|
|
311
312
|
readonly createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
|
|
312
313
|
createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): Loader;
|
|
313
|
-
// (undocumented)
|
|
314
314
|
get defaultCodeDetails(): IFluidCodeDetails;
|
|
315
|
-
// (undocumented)
|
|
316
315
|
get documentId(): string;
|
|
317
|
-
// (undocumented)
|
|
318
316
|
get documentServiceFactory(): IDocumentServiceFactory;
|
|
319
|
-
// (undocumented)
|
|
320
317
|
readonly driver: ITestDriver;
|
|
321
|
-
// (undocumented)
|
|
322
318
|
ensureSynchronized(): Promise<void>;
|
|
323
|
-
// (undocumented)
|
|
324
319
|
loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
325
|
-
// (undocumented)
|
|
326
|
-
readonly LoaderConstructor: typeof Loader;
|
|
327
320
|
loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
328
|
-
// (undocumented)
|
|
329
321
|
get logger(): EventAndErrorTrackingLogger;
|
|
330
|
-
set logger(logger: EventAndErrorTrackingLogger);
|
|
331
322
|
makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
|
|
332
323
|
makeTestLoader(testContainerConfig?: ITestContainerConfig): Loader;
|
|
333
|
-
// (undocumented)
|
|
334
324
|
get opProcessingController(): IOpProcessingController;
|
|
335
|
-
// (undocumented)
|
|
336
325
|
reset(): void;
|
|
337
|
-
// (undocumented)
|
|
338
326
|
resetLoaderContainerTracker(syncSummarizerClients?: boolean): void;
|
|
339
|
-
|
|
327
|
+
readonly type = "TestObjectProvider";
|
|
328
|
+
updateDocumentId(resolvedUrl: IResolvedUrl | undefined): void;
|
|
329
|
+
get urlResolver(): IUrlResolver;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
// @internal
|
|
333
|
+
export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider {
|
|
334
|
+
constructor(LoaderConstructorForCreating: typeof Loader, LoaderConstructorForLoading: typeof Loader, driverForCreating: ITestDriver, driverForLoading: ITestDriver, createFluidEntryPointForCreating: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint, createFluidEntryPointForLoading: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint);
|
|
335
|
+
createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
|
|
336
|
+
get createFluidEntryPoint(): (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
|
|
337
|
+
createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): Loader;
|
|
338
|
+
get defaultCodeDetails(): IFluidCodeDetails;
|
|
339
|
+
get documentId(): string;
|
|
340
|
+
get documentServiceFactory(): IDocumentServiceFactory;
|
|
341
|
+
get driver(): ITestDriver;
|
|
342
|
+
ensureSynchronized(): Promise<void>;
|
|
343
|
+
loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
344
|
+
loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
|
|
345
|
+
get logger(): EventAndErrorTrackingLogger;
|
|
346
|
+
makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
|
|
347
|
+
makeTestLoader(testContainerConfig?: ITestContainerConfig): Loader;
|
|
348
|
+
get opProcessingController(): IOpProcessingController;
|
|
349
|
+
reset(): void;
|
|
350
|
+
resetLoaderContainerTracker(syncSummarizerClients?: boolean): void;
|
|
351
|
+
readonly type = "TestObjectProviderWithVersionedLoad";
|
|
340
352
|
updateDocumentId(resolvedUrl: IResolvedUrl | undefined): void;
|
|
341
|
-
// (undocumented)
|
|
342
353
|
get urlResolver(): IUrlResolver;
|
|
343
|
-
// (undocumented)
|
|
344
|
-
waitContainerToCatchUp(container: IContainer): Promise<boolean>;
|
|
345
354
|
}
|
|
346
355
|
|
|
347
|
-
// @
|
|
356
|
+
// @internal
|
|
348
357
|
export function timeoutAwait<T = void>(promise: PromiseLike<T>, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
|
|
349
358
|
|
|
350
|
-
// @
|
|
359
|
+
// @internal
|
|
351
360
|
export function timeoutPromise<T = void>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
|
|
352
361
|
|
|
353
|
-
// @
|
|
362
|
+
// @internal (undocumented)
|
|
354
363
|
export interface TimeoutWithError {
|
|
355
364
|
durationMs?: number;
|
|
356
365
|
// (undocumented)
|
|
@@ -359,7 +368,7 @@ export interface TimeoutWithError {
|
|
|
359
368
|
reject?: true;
|
|
360
369
|
}
|
|
361
370
|
|
|
362
|
-
// @
|
|
371
|
+
// @internal (undocumented)
|
|
363
372
|
export interface TimeoutWithValue<T = void> {
|
|
364
373
|
durationMs?: number;
|
|
365
374
|
// (undocumented)
|
|
@@ -368,16 +377,16 @@ export interface TimeoutWithValue<T = void> {
|
|
|
368
377
|
value: T;
|
|
369
378
|
}
|
|
370
379
|
|
|
371
|
-
// @
|
|
380
|
+
// @internal
|
|
372
381
|
export function waitForContainerConnection(container: IContainer, failOnContainerClose?: boolean, timeoutOptions?: TimeoutWithError): Promise<void>;
|
|
373
382
|
|
|
374
|
-
// @
|
|
383
|
+
// @internal
|
|
375
384
|
export function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
|
|
376
385
|
|
|
377
|
-
// @
|
|
386
|
+
// @internal
|
|
378
387
|
export function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
|
|
379
388
|
|
|
380
|
-
// @
|
|
389
|
+
// @internal
|
|
381
390
|
export function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
|
|
382
391
|
|
|
383
392
|
// (No @packageDocumentation comment for this package)
|
package/dist/DriverWrappers.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ import { ISummaryTree } from "@fluidframework/protocol-definitions";
|
|
|
8
8
|
* Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
|
|
9
9
|
* `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
|
|
10
10
|
* callback before it is uploaded to the server.
|
|
11
|
+
* @internal
|
|
11
12
|
*/
|
|
12
13
|
export declare function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
|
|
13
14
|
/**
|
|
@@ -16,6 +17,7 @@ export declare function wrapDocumentStorageService(innerDocStorageService: IDocu
|
|
|
16
17
|
* the client.
|
|
17
18
|
* The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
|
|
18
19
|
* to pass in the `uploadSummaryCb`.
|
|
20
|
+
* @internal
|
|
19
21
|
*/
|
|
20
22
|
export declare function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
|
|
21
23
|
/**
|
|
@@ -24,6 +26,7 @@ export declare function wrapDocumentService(innerDocService: IDocumentService, u
|
|
|
24
26
|
* uploaded by the client.
|
|
25
27
|
* The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
|
|
26
28
|
* pass in the `uploadSummaryCb`.
|
|
29
|
+
* @internal
|
|
27
30
|
*/
|
|
28
31
|
export declare function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
|
|
29
32
|
//# sourceMappingURL=DriverWrappers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DriverWrappers.d.ts","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EAEvB,eAAe,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE
|
|
1
|
+
{"version":3,"file":"DriverWrappers.d.ts","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EAEvB,eAAe,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACzC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAWzF;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAClC,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,oBAQzF;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACzC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAgBzF"}
|
package/dist/DriverWrappers.js
CHANGED
|
@@ -9,6 +9,7 @@ exports.wrapDocumentServiceFactory = exports.wrapDocumentService = exports.wrapD
|
|
|
9
9
|
* Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
|
|
10
10
|
* `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
|
|
11
11
|
* callback before it is uploaded to the server.
|
|
12
|
+
* @internal
|
|
12
13
|
*/
|
|
13
14
|
function wrapDocumentStorageService(innerDocStorageService, uploadSummaryCb) {
|
|
14
15
|
const outerDocStorageService = Object.create(innerDocStorageService);
|
|
@@ -25,6 +26,7 @@ exports.wrapDocumentStorageService = wrapDocumentStorageService;
|
|
|
25
26
|
* the client.
|
|
26
27
|
* The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
|
|
27
28
|
* to pass in the `uploadSummaryCb`.
|
|
29
|
+
* @internal
|
|
28
30
|
*/
|
|
29
31
|
function wrapDocumentService(innerDocService, uploadSummaryCb) {
|
|
30
32
|
const outerDocService = Object.create(innerDocService);
|
|
@@ -41,6 +43,7 @@ exports.wrapDocumentService = wrapDocumentService;
|
|
|
41
43
|
* uploaded by the client.
|
|
42
44
|
* The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
|
|
43
45
|
* pass in the `uploadSummaryCb`.
|
|
46
|
+
* @internal
|
|
44
47
|
*/
|
|
45
48
|
function wrapDocumentServiceFactory(innerDocServiceFactory, uploadSummaryCb) {
|
|
46
49
|
const outerDocServiceFactory = Object.create(innerDocServiceFactory);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DriverWrappers.js","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH
|
|
1
|
+
{"version":3,"file":"DriverWrappers.js","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH;;;;;GAKG;AACH,SAAgB,0BAA0B,CACzC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,wBAAwB,GAAG,KAAK,EACtD,OAAqB,EACrB,OAAwB,EACN,EAAE;QACpB,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7E,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAC/B,CAAC;AAbD,gEAaC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAClC,eAAiC,EACjC,eAAyF;IAEzF,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAqB,CAAC;IAC3E,eAAe,CAAC,gBAAgB,GAAG,KAAK,IAAsC,EAAE;QAC/E,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;QAChE,OAAO,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACpE,CAAC,CAAC;IACF,OAAO,eAAe,CAAC;AACxB,CAAC;AAVD,kDAUC;AAED;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACzC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,qBAAqB,GAAG,KAAK,EACnD,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B,EACA,EAAE;QAC9B,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,qBAAqB,CACzE,WAAW,EACX,MAAM,EACN,kBAAkB,CAClB,CAAC;QACF,OAAO,mBAAmB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAC9D,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAC/B,CAAC;AAlBD,gEAkBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentStorageService,\n\tIResolvedUrl,\n\tISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the\n * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the\n * callback before it is uploaded to the server.\n * @internal\n */\nexport function wrapDocumentStorageService(\n\tinnerDocStorageService: IDocumentStorageService,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocStorageService = Object.create(innerDocStorageService) as IDocumentStorageService;\n\touterDocStorageService.uploadSummaryWithContext = async (\n\t\tsummary: ISummaryTree,\n\t\tcontext: ISummaryContext,\n\t): Promise<string> => {\n\t\tconst newContext = uploadSummaryCb(summary, context);\n\t\treturn innerDocStorageService.uploadSummaryWithContext(summary, newContext);\n\t};\n\treturn outerDocStorageService;\n}\n\n/**\n * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the\n * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by\n * the client.\n * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`\n * to pass in the `uploadSummaryCb`.\n * @internal\n */\nexport function wrapDocumentService(\n\tinnerDocService: IDocumentService,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocService = Object.create(innerDocService) as IDocumentService;\n\touterDocService.connectToStorage = async (): Promise<IDocumentStorageService> => {\n\t\tconst storageService = await innerDocService.connectToStorage();\n\t\treturn wrapDocumentStorageService(storageService, uploadSummaryCb);\n\t};\n\treturn outerDocService;\n}\n\n/**\n * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb\n * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is\n * uploaded by the client.\n * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to\n * pass in the `uploadSummaryCb`.\n * @internal\n */\nexport function wrapDocumentServiceFactory(\n\tinnerDocServiceFactory: IDocumentServiceFactory,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocServiceFactory = Object.create(innerDocServiceFactory) as IDocumentServiceFactory;\n\touterDocServiceFactory.createDocumentService = async (\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> => {\n\t\tconst documentService = await innerDocServiceFactory.createDocumentService(\n\t\t\tresolvedUrl,\n\t\t\tlogger,\n\t\t\tclientIsSummarizer,\n\t\t);\n\t\treturn wrapDocumentService(documentService, uploadSummaryCb);\n\t};\n\treturn outerDocServiceFactory;\n}\n"]}
|
package/dist/TestConfigs.d.ts
CHANGED
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import { ConfigTypes, IConfigProviderBase } from "@fluidframework/
|
|
5
|
+
import { ConfigTypes, IConfigProviderBase } from "@fluidframework/core-interfaces";
|
|
6
|
+
/**
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
6
9
|
export declare const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
|
|
7
10
|
//# sourceMappingURL=TestConfigs.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TestConfigs.d.ts","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEnF,eAAO,MAAM,kBAAkB,cACpB,OAAO,MAAM,EAAE,WAAW,CAAC,KACnC,mBAIF,CAAC"}
|
|
1
|
+
{"version":3,"file":"TestConfigs.d.ts","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,kBAAkB,cACpB,OAAO,MAAM,EAAE,WAAW,CAAC,KACnC,mBAIF,CAAC"}
|
package/dist/TestConfigs.js
CHANGED
package/dist/TestConfigs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TestConfigs.js","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"TestConfigs.js","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACI,MAAM,kBAAkB,GAAG,CACjC,WAAwC,EAAE,EACpB,EAAE;IACxB,OAAO;QACN,YAAY,EAAE,CAAC,IAAY,EAAe,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;KAC3D,CAAC;AACH,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ConfigTypes, IConfigProviderBase } from \"@fluidframework/core-interfaces\";\n\n/**\n * @internal\n */\nexport const mockConfigProvider = (\n\tsettings: Record<string, ConfigTypes> = {},\n): IConfigProviderBase => {\n\treturn {\n\t\tgetRawConfig: (name: string): ConfigTypes => settings[name],\n\t};\n};\n"]}
|
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqueduct";
|
|
6
6
|
import { IContainer } from "@fluidframework/container-definitions";
|
|
7
7
|
import { IOnDemandSummarizeOptions, ISummarizer } from "@fluidframework/container-runtime";
|
|
8
|
-
import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
|
|
8
|
+
import { ITelemetryBaseLogger, IConfigProviderBase } from "@fluidframework/core-interfaces";
|
|
9
9
|
import { IFluidDataStoreFactory, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
|
|
10
|
-
import { IConfigProviderBase } from "@fluidframework/telemetry-utils";
|
|
11
10
|
import { ITestContainerConfig, ITestObjectProvider } from "./testObjectProvider";
|
|
12
11
|
/**
|
|
13
12
|
* Creates a summarizer client from the given container and data store factory, and returns the summarizer client's
|
|
14
13
|
* IContainer and ISummarizer.
|
|
15
14
|
* The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
|
|
15
|
+
* @internal
|
|
16
16
|
*/
|
|
17
17
|
export declare function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries, logger?: ITelemetryBaseLogger, configProvider?: IConfigProviderBase): Promise<{
|
|
18
18
|
container: IContainer;
|
|
@@ -23,6 +23,7 @@ export declare function createSummarizerFromFactory(provider: ITestObjectProvide
|
|
|
23
23
|
* The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
|
|
24
24
|
*
|
|
25
25
|
* Can pass in a test config provider to enable/disable features.
|
|
26
|
+
* @internal
|
|
26
27
|
*/
|
|
27
28
|
export declare function createSummarizer(provider: ITestObjectProvider, container: IContainer, config?: ITestContainerConfig, summaryVersion?: string, logger?: ITelemetryBaseLogger): Promise<{
|
|
28
29
|
container: IContainer;
|
|
@@ -35,6 +36,7 @@ export declare function createSummarizer(provider: ITestObjectProvider, containe
|
|
|
35
36
|
* @param summarizer - The ISummarizer to use to summarize on demand
|
|
36
37
|
* @param inputs - Either the reason string or the full IOnDemandSummarizeOptions.
|
|
37
38
|
* Defaults to the reason "end-to-end test".
|
|
39
|
+
* @internal
|
|
38
40
|
*/
|
|
39
41
|
export declare function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<{
|
|
40
42
|
summaryTree: import("@fluidframework/protocol-definitions").ISummaryTree;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TestSummaryUtils.d.ts","sourceRoot":"","sources":["../src/TestSummaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EAAE,UAAU,EAA6B,MAAM,uCAAuC,CAAC;AAC9F,OAAO,EACN,yBAAyB,EACzB,WAAW,EAEX,MAAM,mCAAmC,CAAC;AAC3C,OAAO,
|
|
1
|
+
{"version":3,"file":"TestSummaryUtils.d.ts","sourceRoot":"","sources":["../src/TestSummaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EAAE,UAAU,EAA6B,MAAM,uCAAuC,CAAC;AAC9F,OAAO,EACN,yBAAyB,EACzB,WAAW,EAEX,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,oBAAoB,EAGpB,mBAAmB,EACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAEN,sBAAsB,EACtB,kCAAkC,EAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAsDjF;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAChD,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,gBAAgB,EAAE,sBAAsB,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,2BAA2B,qDAA8C,EACzE,eAAe,CAAC,EAAE,kCAAkC,EACpD,MAAM,CAAC,EAAE,oBAAoB,EAC7B,cAAc,GAAE,mBAA0C,GACxD,OAAO,CAAC;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,WAAW,CAAA;CAAE,CAAC,CAoB7D;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACrC,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,WAAW,CAAA;CAAE,CAAC,CAe7D;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CACjC,UAAU,EAAE,WAAW,EACvB,MAAM,GAAE,MAAM,GAAG,yBAA6C;;;;GAoC9D"}
|
package/dist/TestSummaryUtils.js
CHANGED
|
@@ -54,6 +54,7 @@ const defaultSummaryOptions = {
|
|
|
54
54
|
* Creates a summarizer client from the given container and data store factory, and returns the summarizer client's
|
|
55
55
|
* IContainer and ISummarizer.
|
|
56
56
|
* The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
|
|
57
|
+
* @internal
|
|
57
58
|
*/
|
|
58
59
|
async function createSummarizerFromFactory(provider, container, dataStoreFactory, summaryVersion, containerRuntimeFactoryType = aqueduct_1.ContainerRuntimeFactoryWithDefaultDataStore, registryEntries, logger, configProvider = (0, TestConfigs_1.mockConfigProvider)()) {
|
|
59
60
|
const innerRequestHandler = async (request, runtime) => runtime.IFluidHandleContext.resolveHandle(request);
|
|
@@ -77,6 +78,7 @@ exports.createSummarizerFromFactory = createSummarizerFromFactory;
|
|
|
77
78
|
* The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
|
|
78
79
|
*
|
|
79
80
|
* Can pass in a test config provider to enable/disable features.
|
|
81
|
+
* @internal
|
|
80
82
|
*/
|
|
81
83
|
async function createSummarizer(provider, container, config, summaryVersion, logger) {
|
|
82
84
|
const testContainerConfig = {
|
|
@@ -102,6 +104,7 @@ exports.createSummarizer = createSummarizer;
|
|
|
102
104
|
* @param summarizer - The ISummarizer to use to summarize on demand
|
|
103
105
|
* @param inputs - Either the reason string or the full IOnDemandSummarizeOptions.
|
|
104
106
|
* Defaults to the reason "end-to-end test".
|
|
107
|
+
* @internal
|
|
105
108
|
*/
|
|
106
109
|
async function summarizeNow(summarizer, inputs = "end-to-end test") {
|
|
107
110
|
const options = typeof inputs === "string" ? { reason: inputs } : inputs;
|