/*! * Copyright (c) Microsoft Corporation and contributors. All rights reserved. * Licensed under the MIT License. */ import { strict as assert } from "node:assert"; import { FluidErrorTypes } from "@fluidframework/core-interfaces/internal"; import { isPromiseLike, LazyPromise } from "@fluidframework/core-utils/internal"; import type { IFluidDataStoreChannel, IFluidDataStoreFactory, IFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries, IContainerRuntimeBase, ISummarizerNodeWithGC, IRuntimeStorageService, } from "@fluidframework/runtime-definitions/internal"; import { isFluidError } from "@fluidframework/telemetry-utils/internal"; import { MockDeltaManager, MockFluidDataStoreRuntime, } from "@fluidframework/test-runtime-utils/internal"; import type { IFluidParentContextPrivate } from "../channelCollection.js"; import { FluidDataStoreContext, LocalDetachedFluidDataStoreContext, } from "../dataStoreContext.js"; describe("createChildDataStore", () => { const throwNYI = () => { throw new Error("Method not implemented."); }; const testContext = class TestContext extends FluidDataStoreContext { protected pkg = ["ParentDataStore"]; // This is a override of a protected property to expose it publicly, however TypeScript does not allow override to be used here to make this explicit. // This TypeScript issue is tracked by https://github.com/microsoft/TypeScript/issues/51515. // When targeting ES2022 or newer, TypeScript uses ESM properties here, which would overwrite the base property giving the error: // "Property 'registry' will overwrite the base property in 'FluidDataStoreContext'. If this is intentional, add an initializer. Otherwise, add a 'declare' modifier or remove the redundant declaration.ts(2612)" // This is mitigated using `declare` to indicate that this property is only here for TypeScript typing reasons, and its declaration should have no effect at runtime. public declare registry: IFluidDataStoreRegistry | undefined; public getInitialSnapshotDetails = throwNYI; public setAttachState = throwNYI; public getAttachSummary = throwNYI; public getAttachGCData = throwNYI; protected channel = new Proxy({} as unknown as IFluidDataStoreChannel, { get: throwNYI }); protected channelP = new LazyPromise(async () => this.channel); }; const createRegistry = ( namedEntries?: NamedFluidDataStoreRegistryEntries, ): IFluidDataStoreRegistry => ({ get IFluidDataStoreRegistry() { return this; }, async get(name) { return new Map(namedEntries).get(name); }, getSync(name) { const entry = new Map(namedEntries).get(name); return isPromiseLike(entry) ? undefined : entry; }, }); const createContext = (namedEntries?: NamedFluidDataStoreRegistryEntries) => { const registry = createRegistry(namedEntries); const createSummarizerNodeFn = () => new Proxy({} as unknown as ISummarizerNodeWithGC, { get: throwNYI }); const storage = new Proxy({} as unknown as IRuntimeStorageService, { get: throwNYI }); const parentContext = { clientDetails: { capabilities: { interactive: true }, }, isReadOnly: () => false, containerRuntime: { createDetachedDataStore(pkg, loadingGroupId) { return new LocalDetachedFluidDataStoreContext({ channelToDataStoreFn: (channel) => ({ entryPoint: channel.entryPoint, trySetAlias: throwNYI, }), createSummarizerNodeFn, id: "child", makeLocallyVisibleFn: throwNYI, parentContext, pkg, scope: {}, snapshotTree: undefined, storage, loadingGroupId, }); }, } satisfies Partial as unknown as IContainerRuntimeBase, deltaManager: new MockDeltaManager(), } satisfies Partial as unknown as IFluidParentContextPrivate; const context = new testContext( { createSummarizerNodeFn, id: "parent", parentContext, scope: {}, storage, }, false, false, throwNYI, ); context.registry = registry; return context; }; const createFactory = ( createDataStore?: IFluidDataStoreFactory["createDataStore"], ): IFluidDataStoreFactory => ({ type: "ChildDataStore", get IFluidDataStoreFactory() { return this; }, instantiateDataStore: throwNYI, createDataStore, }); it("Child factory does not support synchronous creation", async () => { const factory = createFactory(); const context = createContext([[factory.type, factory]]); try { context.createChildDataStore(factory); assert.fail("should fail"); } catch (error) { assert(isFluidError(error)); assert(error.errorType === FluidErrorTypes.usageError); assert(error.getTelemetryProperties().noCreateDataStore === true); } }); it("Child factory not registered", async () => { const factory = createFactory(); const context = createContext(); try { context.createChildDataStore(factory); assert.fail("should fail"); } catch (error) { assert(isFluidError(error)); assert(error.errorType === FluidErrorTypes.usageError); assert(error.getTelemetryProperties().isUndefined === true); } }); it("Child factory is a different instance", async () => { const factory = createFactory(); const context = createContext([[factory.type, createFactory()]]); try { context.createChildDataStore(factory); assert.fail("should fail"); } catch (error) { assert(isFluidError(error)); assert(error.errorType === FluidErrorTypes.usageError); assert(error.getTelemetryProperties().diffInstance === true); } }); it("createChildDataStore", async () => { const factory = createFactory(() => ({ runtime: new MockFluidDataStoreRuntime() })); const context = createContext([[factory.type, factory]]); context.createChildDataStore(factory); }); });