From cdb46825deea03976df1eae9b86f0fe038b9f480 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Tue, 5 Nov 2024 15:41:23 -0800 Subject: [PATCH 01/10] Remove _createDataStoreWithProps api --- packages/framework/aqueduct/package.json | 4 +++- .../validateAqueductPrevious.generated.ts | 1 + .../package.json | 12 +++++++++++- ...nerRuntimeDefinitionsPrevious.generated.ts | 3 +++ .../runtime/container-runtime/package.json | 6 +++++- .../container-runtime/src/containerRuntime.ts | 19 ------------------- ...idateContainerRuntimePrevious.generated.ts | 2 ++ packages/runtime/datastore/package.json | 6 +++++- .../validateDatastorePrevious.generated.ts | 1 + .../runtime/runtime-definitions/package.json | 15 ++++++++++++++- .../src/dataStoreContext.ts | 9 --------- ...ateRuntimeDefinitionsPrevious.generated.ts | 4 ++++ .../runtime/test-runtime-utils/package.json | 15 ++++++++++++++- ...idateTestRuntimeUtilsPrevious.generated.ts | 4 ++++ .../src/test/rootDatastores.spec.ts | 11 ----------- packages/test/test-utils/package.json | 5 ++++- .../validateTestUtilsPrevious.generated.ts | 2 ++ 17 files changed, 73 insertions(+), 46 deletions(-) diff --git a/packages/framework/aqueduct/package.json b/packages/framework/aqueduct/package.json index 2b5f33a28ed6..1818ca7fdcf4 100644 --- a/packages/framework/aqueduct/package.json +++ b/packages/framework/aqueduct/package.json @@ -156,7 +156,9 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Interface_IDataObjectProps": {"backCompat": false} + }, "entrypoint": "legacy" } } diff --git a/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts b/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts index ca578b870142..8684174e0234 100644 --- a/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts +++ b/packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts @@ -247,4 +247,5 @@ declare type old_as_current_for_Interface_IDataObjectProps = requireAssignableTo * typeValidation.broken: * "Interface_IDataObjectProps": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IDataObjectProps = requireAssignableTo, TypeOnly> diff --git a/packages/runtime/container-runtime-definitions/package.json b/packages/runtime/container-runtime-definitions/package.json index 217058aa776a..1af6ea7464ed 100644 --- a/packages/runtime/container-runtime-definitions/package.json +++ b/packages/runtime/container-runtime-definitions/package.json @@ -103,7 +103,17 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Interface_IContainerRuntime": { + "backCompat": false + }, + "Interface_IContainerRuntimeWithResolveHandle_Deprecated": { + "backCompat": false + }, + "TypeAlias_IContainerRuntimeBaseWithCombinedEvents": { + "backCompat": false + } + }, "entrypoint": "legacy" } } diff --git a/packages/runtime/container-runtime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts b/packages/runtime/container-runtime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts index 078369017175..a36fb56249ed 100644 --- a/packages/runtime/container-runtime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts +++ b/packages/runtime/container-runtime-definitions/src/test/types/validateContainerRuntimeDefinitionsPrevious.generated.ts @@ -22,6 +22,7 @@ declare type MakeUnusedImportErrorsGoAway = TypeOnly | MinimalType | Fu * typeValidation.broken: * "Interface_IContainerRuntime": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IContainerRuntime = requireAssignableTo, TypeOnly> /* @@ -49,6 +50,7 @@ declare type old_as_current_for_Interface_IContainerRuntimeWithResolveHandle_Dep * typeValidation.broken: * "Interface_IContainerRuntimeWithResolveHandle_Deprecated": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IContainerRuntimeWithResolveHandle_Deprecated = requireAssignableTo, TypeOnly> /* @@ -58,4 +60,5 @@ declare type current_as_old_for_Interface_IContainerRuntimeWithResolveHandle_Dep * typeValidation.broken: * "TypeAlias_IContainerRuntimeBaseWithCombinedEvents": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_TypeAlias_IContainerRuntimeBaseWithCombinedEvents = requireAssignableTo, TypeOnly> diff --git a/packages/runtime/container-runtime/package.json b/packages/runtime/container-runtime/package.json index baa9b10635dc..ca247809fc07 100644 --- a/packages/runtime/container-runtime/package.json +++ b/packages/runtime/container-runtime/package.json @@ -231,7 +231,11 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Class_ContainerRuntime": {"backCompat": false}, + "Class_DocumentsSchemaController": {"forwardCompat": false}, + "ClassStatics_ContainerRuntime": {"backCompat": false} + }, "entrypoint": "legacy" } } diff --git a/packages/runtime/container-runtime/src/containerRuntime.ts b/packages/runtime/container-runtime/src/containerRuntime.ts index dc82fa259830..f60f8f223d5a 100644 --- a/packages/runtime/container-runtime/src/containerRuntime.ts +++ b/packages/runtime/container-runtime/src/containerRuntime.ts @@ -3377,25 +3377,6 @@ export class ContainerRuntime ); } - /** - * @deprecated 0.16 Issue #1537, #3631 - */ - public async _createDataStoreWithProps( - pkg: Readonly, - props?: any, - ): Promise { - const context = this.channelCollection.createDataStoreContext( - Array.isArray(pkg) ? pkg : [pkg], - props, - ); - return channelToDataStore( - await context.realize(), - context.id, - this.channelCollection, - this.mc.logger, - ); - } - private canSendOps() { // Note that the real (non-proxy) delta manager is needed here to get the readonly info. This is because // container runtime's ability to send ops depend on the actual readonly state of the delta manager. diff --git a/packages/runtime/container-runtime/src/test/types/validateContainerRuntimePrevious.generated.ts b/packages/runtime/container-runtime/src/test/types/validateContainerRuntimePrevious.generated.ts index 00512c6b07be..a68a29a07691 100644 --- a/packages/runtime/container-runtime/src/test/types/validateContainerRuntimePrevious.generated.ts +++ b/packages/runtime/container-runtime/src/test/types/validateContainerRuntimePrevious.generated.ts @@ -31,6 +31,7 @@ declare type old_as_current_for_Class_ContainerRuntime = requireAssignableTo, TypeOnly> /* @@ -85,6 +86,7 @@ declare type current_as_old_for_Class_SummaryCollection = requireAssignableTo, TypeOnly> /* diff --git a/packages/runtime/datastore/package.json b/packages/runtime/datastore/package.json index 562e34959121..589db4bfd618 100644 --- a/packages/runtime/datastore/package.json +++ b/packages/runtime/datastore/package.json @@ -160,7 +160,11 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Class_FluidDataStoreRuntime": { + "forwardCompat": false + } + }, "entrypoint": "legacy" } } diff --git a/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts b/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts index bab8d7182452..5fe3440cb5cc 100644 --- a/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts +++ b/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts @@ -22,6 +22,7 @@ declare type MakeUnusedImportErrorsGoAway = TypeOnly | MinimalType | Fu * typeValidation.broken: * "Class_FluidDataStoreRuntime": {"forwardCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_FluidDataStoreRuntime = requireAssignableTo, TypeOnly> /* diff --git a/packages/runtime/runtime-definitions/package.json b/packages/runtime/runtime-definitions/package.json index 958e745d7a6f..00e59f9a6b26 100644 --- a/packages/runtime/runtime-definitions/package.json +++ b/packages/runtime/runtime-definitions/package.json @@ -111,7 +111,20 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Interface_IContainerRuntimeBase": { + "backCompat": false + }, + "Interface_IFluidDataStoreContext": { + "backCompat": false + }, + "Interface_IFluidDataStoreContextDetached": { + "backCompat": false + }, + "Interface_IFluidParentContext": { + "backCompat": false + } + }, "entrypoint": "legacy" } } diff --git a/packages/runtime/runtime-definitions/src/dataStoreContext.ts b/packages/runtime/runtime-definitions/src/dataStoreContext.ts index 0ae2c6a91aa2..4bd8eba57b11 100644 --- a/packages/runtime/runtime-definitions/src/dataStoreContext.ts +++ b/packages/runtime/runtime-definitions/src/dataStoreContext.ts @@ -217,15 +217,6 @@ export interface IContainerRuntimeBase extends IEventProvider void; - /** - * @deprecated 0.16 Issue #1537, #3631 - */ - _createDataStoreWithProps( - pkg: Readonly, - props?: any, - id?: string, - ): Promise; - /** * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves * as the data store's router. The data store is not bound to a container, and in such state is not persisted to diff --git a/packages/runtime/runtime-definitions/src/test/types/validateRuntimeDefinitionsPrevious.generated.ts b/packages/runtime/runtime-definitions/src/test/types/validateRuntimeDefinitionsPrevious.generated.ts index d4b13e2a2af8..86cdec07560b 100644 --- a/packages/runtime/runtime-definitions/src/test/types/validateRuntimeDefinitionsPrevious.generated.ts +++ b/packages/runtime/runtime-definitions/src/test/types/validateRuntimeDefinitionsPrevious.generated.ts @@ -112,6 +112,7 @@ declare type current_as_old_for_Interface_IAttachMessage = requireAssignableTo, TypeOnly> /* @@ -211,6 +212,7 @@ declare type old_as_current_for_Interface_IFluidDataStoreContext = requireAssign * typeValidation.broken: * "Interface_IFluidDataStoreContext": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IFluidDataStoreContext = requireAssignableTo, TypeOnly> /* @@ -229,6 +231,7 @@ declare type old_as_current_for_Interface_IFluidDataStoreContextDetached = requi * typeValidation.broken: * "Interface_IFluidDataStoreContextDetached": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IFluidDataStoreContextDetached = requireAssignableTo, TypeOnly> /* @@ -283,6 +286,7 @@ declare type old_as_current_for_Interface_IFluidParentContext = requireAssignabl * typeValidation.broken: * "Interface_IFluidParentContext": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IFluidParentContext = requireAssignableTo, TypeOnly> /* diff --git a/packages/runtime/test-runtime-utils/package.json b/packages/runtime/test-runtime-utils/package.json index d1cc3be4c93e..e95cd2ca451e 100644 --- a/packages/runtime/test-runtime-utils/package.json +++ b/packages/runtime/test-runtime-utils/package.json @@ -157,7 +157,20 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Class_MockDeltaConnection": { + "forwardCompat": false + }, + "Class_MockFluidDataStoreContext": { + "backCompat": false + }, + "Class_MockFluidDataStoreRuntime": { + "forwardCompat": false + }, + "ClassStatics_MockFluidDataStoreContext": { + "backCompat": false + } + }, "entrypoint": "legacy" } } diff --git a/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts b/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts index bb782e3a2aa2..43a6ca5850f4 100644 --- a/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts +++ b/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts @@ -112,6 +112,7 @@ declare type current_as_old_for_Class_MockContainerRuntimeForReconnection = requ * typeValidation.broken: * "Class_MockDeltaConnection": {"forwardCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_MockDeltaConnection = requireAssignableTo, TypeOnly> /* @@ -175,6 +176,7 @@ declare type old_as_current_for_Class_MockFluidDataStoreContext = requireAssigna * typeValidation.broken: * "Class_MockFluidDataStoreContext": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Class_MockFluidDataStoreContext = requireAssignableTo, TypeOnly> /* @@ -184,6 +186,7 @@ declare type current_as_old_for_Class_MockFluidDataStoreContext = requireAssigna * typeValidation.broken: * "Class_MockFluidDataStoreRuntime": {"forwardCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_MockFluidDataStoreRuntime = requireAssignableTo, TypeOnly> /* @@ -364,6 +367,7 @@ declare type current_as_old_for_ClassStatics_MockDeltaQueue = requireAssignableT * typeValidation.broken: * "ClassStatics_MockFluidDataStoreContext": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_ClassStatics_MockFluidDataStoreContext = requireAssignableTo, TypeOnly> /* diff --git a/packages/test/test-end-to-end-tests/src/test/rootDatastores.spec.ts b/packages/test/test-end-to-end-tests/src/test/rootDatastores.spec.ts index b52afcc247b6..fd949e81b098 100644 --- a/packages/test/test-end-to-end-tests/src/test/rootDatastores.spec.ts +++ b/packages/test/test-end-to-end-tests/src/test/rootDatastores.spec.ts @@ -61,9 +61,6 @@ describeCompat("Named root data stores", "FullCompat", (getTestObjectProvider) = const runtimeOf = (dataObject: ITestFluidObject): IContainerRuntime => dataObject.context.containerRuntime as IContainerRuntime; - const createDataStoreWithProps = async (dataObject: ITestFluidObject, id: string) => - runtimeOf(dataObject)._createDataStoreWithProps(packageName, {}, id); - /** * Gets an aliased data store with the given id. Throws an error if the data store cannot be retrieved. */ @@ -78,14 +75,6 @@ describeCompat("Named root data stores", "FullCompat", (getTestObjectProvider) = return dataStore; } - describe("Legacy APIs", () => { - it("Datastore creation with legacy API returns datastore which can be aliased", async () => { - const ds = await createDataStoreWithProps(dataObject1, "1"); - const aliasResult = await ds.trySetAlias("2"); - assert.equal(aliasResult, "Success"); - }); - }); - describe("Aliasing", () => { const alias = "alias"; diff --git a/packages/test/test-utils/package.json b/packages/test/test-utils/package.json index a8f19e0c8286..4e116ecde00a 100644 --- a/packages/test/test-utils/package.json +++ b/packages/test/test-utils/package.json @@ -167,7 +167,10 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": {}, + "broken": { + "Interface_IProvideTestFluidObject": {"backCompat": false}, + "Interface_ITestFluidObject": {"backCompat": false} + }, "entrypoint": "legacy" } } diff --git a/packages/test/test-utils/src/test/types/validateTestUtilsPrevious.generated.ts b/packages/test/test-utils/src/test/types/validateTestUtilsPrevious.generated.ts index 23bb8b2365d0..d14180f98964 100644 --- a/packages/test/test-utils/src/test/types/validateTestUtilsPrevious.generated.ts +++ b/packages/test/test-utils/src/test/types/validateTestUtilsPrevious.generated.ts @@ -85,6 +85,7 @@ declare type old_as_current_for_Interface_IProvideTestFluidObject = requireAssig * typeValidation.broken: * "Interface_IProvideTestFluidObject": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_IProvideTestFluidObject = requireAssignableTo, TypeOnly> /* @@ -103,4 +104,5 @@ declare type old_as_current_for_Interface_ITestFluidObject = requireAssignableTo * typeValidation.broken: * "Interface_ITestFluidObject": {"backCompat": false} */ +// @ts-expect-error compatibility expected to be broken declare type current_as_old_for_Interface_ITestFluidObject = requireAssignableTo, TypeOnly> From ac3069bf1bee617fe2a903fe674301dbcd6f94b0 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Tue, 5 Nov 2024 15:57:15 -0800 Subject: [PATCH 02/10] Create changeset --- .changeset/gold-maps-cut.md | 100 ++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 .changeset/gold-maps-cut.md diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md new file mode 100644 index 000000000000..d9651ba71f5f --- /dev/null +++ b/.changeset/gold-maps-cut.md @@ -0,0 +1,100 @@ +--- +"@fluidframework/agent-scheduler": minor +"@fluid-experimental/ai-collab": minor +"@fluidframework/app-insights-logger": minor +"@fluidframework/aqueduct": minor +"@fluid-experimental/attributable-map": minor +"@fluid-experimental/attributor": minor +"@fluidframework/azure-client": minor +"@fluidframework/azure-end-to-end-tests": minor +"@fluidframework/azure-local-service": minor +"@fluid-experimental/azure-scenario-runner": minor +"@fluidframework/azure-service-utils": minor +"@fluidframework/cell": minor +"@fluidframework/container-definitions": minor +"@fluidframework/container-loader": minor +"@fluidframework/container-runtime": minor +"@fluidframework/container-runtime-definitions": minor +"@fluidframework/core-interfaces": minor +"@fluidframework/core-utils": minor +"@fluidframework/counter": minor +"@fluid-experimental/data-object-base": minor +"@fluid-experimental/data-objects": minor +"@fluidframework/datastore": minor +"@fluidframework/datastore-definitions": minor +"@fluid-experimental/dds-interceptions": minor +"@fluidframework/debugger": minor +"@fluidframework/devtools": minor +"@fluidframework/devtools-core": minor +"@fluidframework/driver-base": minor +"@fluidframework/driver-definitions": minor +"@fluidframework/driver-utils": minor +"@fluidframework/driver-web-cache": minor +"@fluid-tools/fetch-tool": minor +"@fluidframework/file-driver": minor +"fluid-framework": minor +"@fluidframework/fluid-runner": minor +"@fluidframework/fluid-static": minor +"@fluidframework/fluid-telemetry": minor +"@fluidframework/id-compressor": minor +"@fluid-experimental/ink": minor +"@fluid-experimental/last-edited": minor +"@fluidframework/local-driver": minor +"@fluidframework/map": minor +"@fluidframework/matrix": minor +"@fluidframework/merge-tree": minor +"@fluidframework/odsp-client": minor +"@fluidframework/odsp-doclib-utils": minor +"@fluidframework/odsp-driver": minor +"@fluidframework/odsp-driver-definitions": minor +"@fluid-experimental/odsp-end-to-end-tests": minor +"@fluidframework/odsp-urlresolver": minor +"@fluid-experimental/oldest-client-observer": minor +"@fluidframework/ordered-collection": minor +"@fluid-experimental/ot": minor +"@fluid-experimental/pact-map": minor +"@fluid-experimental/presence": minor +"@fluid-experimental/property-changeset": minor +"@fluid-experimental/property-common": minor +"@fluid-experimental/property-dds": minor +"@fluid-experimental/property-properties": minor +"@fluidframework/register-collection": minor +"@fluidframework/replay-driver": minor +"@fluidframework/request-handler": minor +"@fluidframework/routerlicious-driver": minor +"@fluidframework/routerlicious-urlresolver": minor +"@fluidframework/runtime-definitions": minor +"@fluidframework/runtime-utils": minor +"@fluidframework/sequence": minor +"@fluid-experimental/sequence-deprecated": minor +"@fluidframework/shared-object-base": minor +"@fluidframework/shared-summary-block": minor +"@fluid-experimental/sharejs-json1": minor +"@fluid-private/stochastic-test-utils": minor +"@fluidframework/synthesize": minor +"@fluidframework/task-manager": minor +"@fluidframework/telemetry-utils": minor +"@fluid-private/test-dds-utils": minor +"@fluid-private/test-drivers": minor +"@fluid-private/test-end-to-end-tests": minor +"@fluid-private/test-loader-utils": minor +"@fluid-private/test-pairwise-generator": minor +"@fluidframework/test-runtime-utils": minor +"@fluidframework/test-utils": minor +"@fluid-private/test-version-utils": minor +"@fluidframework/tinylicious-client": minor +"@fluidframework/tinylicious-driver": minor +"@fluidframework/tool-utils": minor +"@fluid-experimental/tree": minor +"@fluidframework/tree": minor +"@fluid-experimental/tree-react-api": minor +"@fluidframework/undo-redo": minor +--- + +# Removed `_createDataStoreWithProps` + +Removed two main APIs, `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` +has been removed. + +For alternative solutions use `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState` +parameter. From f98563e70d084d7592952f59c2b82b9f37d604a9 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Tue, 5 Nov 2024 16:26:34 -0800 Subject: [PATCH 03/10] PR comment and build fixes --- .changeset/gold-maps-cut.md | 84 ------------------- packages/framework/aqueduct/package.json | 4 +- .../container-runtime.legacy.alpha.api.md | 2 - .../runtime/container-runtime/package.json | 12 ++- .../runtime-definitions.legacy.alpha.api.md | 2 - packages/test/test-utils/package.json | 8 +- 6 files changed, 18 insertions(+), 94 deletions(-) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index d9651ba71f5f..f72ea81f005d 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -1,94 +1,10 @@ --- -"@fluidframework/agent-scheduler": minor -"@fluid-experimental/ai-collab": minor -"@fluidframework/app-insights-logger": minor "@fluidframework/aqueduct": minor -"@fluid-experimental/attributable-map": minor -"@fluid-experimental/attributor": minor -"@fluidframework/azure-client": minor -"@fluidframework/azure-end-to-end-tests": minor -"@fluidframework/azure-local-service": minor -"@fluid-experimental/azure-scenario-runner": minor -"@fluidframework/azure-service-utils": minor -"@fluidframework/cell": minor -"@fluidframework/container-definitions": minor -"@fluidframework/container-loader": minor "@fluidframework/container-runtime": minor "@fluidframework/container-runtime-definitions": minor -"@fluidframework/core-interfaces": minor -"@fluidframework/core-utils": minor -"@fluidframework/counter": minor -"@fluid-experimental/data-object-base": minor -"@fluid-experimental/data-objects": minor "@fluidframework/datastore": minor -"@fluidframework/datastore-definitions": minor -"@fluid-experimental/dds-interceptions": minor -"@fluidframework/debugger": minor -"@fluidframework/devtools": minor -"@fluidframework/devtools-core": minor -"@fluidframework/driver-base": minor -"@fluidframework/driver-definitions": minor -"@fluidframework/driver-utils": minor -"@fluidframework/driver-web-cache": minor -"@fluid-tools/fetch-tool": minor -"@fluidframework/file-driver": minor -"fluid-framework": minor -"@fluidframework/fluid-runner": minor -"@fluidframework/fluid-static": minor -"@fluidframework/fluid-telemetry": minor -"@fluidframework/id-compressor": minor -"@fluid-experimental/ink": minor -"@fluid-experimental/last-edited": minor -"@fluidframework/local-driver": minor -"@fluidframework/map": minor -"@fluidframework/matrix": minor -"@fluidframework/merge-tree": minor -"@fluidframework/odsp-client": minor -"@fluidframework/odsp-doclib-utils": minor -"@fluidframework/odsp-driver": minor -"@fluidframework/odsp-driver-definitions": minor -"@fluid-experimental/odsp-end-to-end-tests": minor -"@fluidframework/odsp-urlresolver": minor -"@fluid-experimental/oldest-client-observer": minor -"@fluidframework/ordered-collection": minor -"@fluid-experimental/ot": minor -"@fluid-experimental/pact-map": minor -"@fluid-experimental/presence": minor -"@fluid-experimental/property-changeset": minor -"@fluid-experimental/property-common": minor -"@fluid-experimental/property-dds": minor -"@fluid-experimental/property-properties": minor -"@fluidframework/register-collection": minor -"@fluidframework/replay-driver": minor -"@fluidframework/request-handler": minor -"@fluidframework/routerlicious-driver": minor -"@fluidframework/routerlicious-urlresolver": minor "@fluidframework/runtime-definitions": minor -"@fluidframework/runtime-utils": minor -"@fluidframework/sequence": minor -"@fluid-experimental/sequence-deprecated": minor -"@fluidframework/shared-object-base": minor -"@fluidframework/shared-summary-block": minor -"@fluid-experimental/sharejs-json1": minor -"@fluid-private/stochastic-test-utils": minor -"@fluidframework/synthesize": minor -"@fluidframework/task-manager": minor -"@fluidframework/telemetry-utils": minor -"@fluid-private/test-dds-utils": minor -"@fluid-private/test-drivers": minor -"@fluid-private/test-end-to-end-tests": minor -"@fluid-private/test-loader-utils": minor -"@fluid-private/test-pairwise-generator": minor "@fluidframework/test-runtime-utils": minor -"@fluidframework/test-utils": minor -"@fluid-private/test-version-utils": minor -"@fluidframework/tinylicious-client": minor -"@fluidframework/tinylicious-driver": minor -"@fluidframework/tool-utils": minor -"@fluid-experimental/tree": minor -"@fluidframework/tree": minor -"@fluid-experimental/tree-react-api": minor -"@fluidframework/undo-redo": minor --- # Removed `_createDataStoreWithProps` diff --git a/packages/framework/aqueduct/package.json b/packages/framework/aqueduct/package.json index 1818ca7fdcf4..511228d46324 100644 --- a/packages/framework/aqueduct/package.json +++ b/packages/framework/aqueduct/package.json @@ -157,7 +157,9 @@ }, "typeValidation": { "broken": { - "Interface_IDataObjectProps": {"backCompat": false} + "Interface_IDataObjectProps": { + "backCompat": false + } }, "entrypoint": "legacy" } diff --git a/packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md b/packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md index eb8c2099ef1a..38551ef7c391 100644 --- a/packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md +++ b/packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md @@ -59,8 +59,6 @@ export class ContainerRuntime extends TypedEventEmitter, loadingGroupId?: string): Promise; - // @deprecated (undocumented) - _createDataStoreWithProps(pkg: Readonly, props?: any): Promise; // (undocumented) createDetachedDataStore(pkg: Readonly, loadingGroupId?: string): IFluidDataStoreContextDetached; createSummary(blobRedirectTable?: Map, telemetryContext?: ITelemetryContext): ISummaryTree; diff --git a/packages/runtime/container-runtime/package.json b/packages/runtime/container-runtime/package.json index ca247809fc07..0894cd118344 100644 --- a/packages/runtime/container-runtime/package.json +++ b/packages/runtime/container-runtime/package.json @@ -232,9 +232,15 @@ }, "typeValidation": { "broken": { - "Class_ContainerRuntime": {"backCompat": false}, - "Class_DocumentsSchemaController": {"forwardCompat": false}, - "ClassStatics_ContainerRuntime": {"backCompat": false} + "Class_ContainerRuntime": { + "backCompat": false + }, + "Class_DocumentsSchemaController": { + "forwardCompat": false + }, + "ClassStatics_ContainerRuntime": { + "backCompat": false + } }, "entrypoint": "legacy" } diff --git a/packages/runtime/runtime-definitions/api-report/runtime-definitions.legacy.alpha.api.md b/packages/runtime/runtime-definitions/api-report/runtime-definitions.legacy.alpha.api.md index 7f570d37f6ed..1c8cd0563a4c 100644 --- a/packages/runtime/runtime-definitions/api-report/runtime-definitions.legacy.alpha.api.md +++ b/packages/runtime/runtime-definitions/api-report/runtime-definitions.legacy.alpha.api.md @@ -72,8 +72,6 @@ export interface IContainerRuntimeBase extends IEventProvider, loadingGroupId?: string): Promise; - // @deprecated (undocumented) - _createDataStoreWithProps(pkg: Readonly, props?: any, id?: string): Promise; createDetachedDataStore(pkg: Readonly, loadingGroupId?: string): IFluidDataStoreContextDetached; // (undocumented) readonly disposed: boolean; diff --git a/packages/test/test-utils/package.json b/packages/test/test-utils/package.json index 4e116ecde00a..4782c891b666 100644 --- a/packages/test/test-utils/package.json +++ b/packages/test/test-utils/package.json @@ -168,8 +168,12 @@ }, "typeValidation": { "broken": { - "Interface_IProvideTestFluidObject": {"backCompat": false}, - "Interface_ITestFluidObject": {"backCompat": false} + "Interface_IProvideTestFluidObject": { + "backCompat": false + }, + "Interface_ITestFluidObject": { + "backCompat": false + } }, "entrypoint": "legacy" } From f5849d1b9b7cd0eb8c7c260c98b6b7e2e1d81c60 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Tue, 5 Nov 2024 16:45:43 -0800 Subject: [PATCH 04/10] build fixes --- packages/runtime/test-runtime-utils/package.json | 6 ------ .../types/validateTestRuntimeUtilsPrevious.generated.ts | 2 -- 2 files changed, 8 deletions(-) diff --git a/packages/runtime/test-runtime-utils/package.json b/packages/runtime/test-runtime-utils/package.json index e95cd2ca451e..420f56b9fcc7 100644 --- a/packages/runtime/test-runtime-utils/package.json +++ b/packages/runtime/test-runtime-utils/package.json @@ -158,15 +158,9 @@ }, "typeValidation": { "broken": { - "Class_MockDeltaConnection": { - "forwardCompat": false - }, "Class_MockFluidDataStoreContext": { "backCompat": false }, - "Class_MockFluidDataStoreRuntime": { - "forwardCompat": false - }, "ClassStatics_MockFluidDataStoreContext": { "backCompat": false } diff --git a/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts b/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts index 43a6ca5850f4..d6f765fb97e6 100644 --- a/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts +++ b/packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts @@ -112,7 +112,6 @@ declare type current_as_old_for_Class_MockContainerRuntimeForReconnection = requ * typeValidation.broken: * "Class_MockDeltaConnection": {"forwardCompat": false} */ -// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_MockDeltaConnection = requireAssignableTo, TypeOnly> /* @@ -186,7 +185,6 @@ declare type current_as_old_for_Class_MockFluidDataStoreContext = requireAssigna * typeValidation.broken: * "Class_MockFluidDataStoreRuntime": {"forwardCompat": false} */ -// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_MockFluidDataStoreRuntime = requireAssignableTo, TypeOnly> /* From 3d3591b57bd0b6fa400c815263b15267f9b1ff20 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Tue, 5 Nov 2024 17:26:11 -0800 Subject: [PATCH 05/10] More build fixes --- packages/runtime/datastore/package.json | 6 +----- .../src/test/types/validateDatastorePrevious.generated.ts | 1 - 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/packages/runtime/datastore/package.json b/packages/runtime/datastore/package.json index 589db4bfd618..562e34959121 100644 --- a/packages/runtime/datastore/package.json +++ b/packages/runtime/datastore/package.json @@ -160,11 +160,7 @@ "typescript": "~5.4.5" }, "typeValidation": { - "broken": { - "Class_FluidDataStoreRuntime": { - "forwardCompat": false - } - }, + "broken": {}, "entrypoint": "legacy" } } diff --git a/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts b/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts index 5fe3440cb5cc..bab8d7182452 100644 --- a/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts +++ b/packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts @@ -22,7 +22,6 @@ declare type MakeUnusedImportErrorsGoAway = TypeOnly | MinimalType | Fu * typeValidation.broken: * "Class_FluidDataStoreRuntime": {"forwardCompat": false} */ -// @ts-expect-error compatibility expected to be broken declare type old_as_current_for_Class_FluidDataStoreRuntime = requireAssignableTo, TypeOnly> /* From b4fc1fa167ce2f6f327634b70bbc59d67aa11742 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft <90650728+tyler-cai-microsoft@users.noreply.github.com> Date: Wed, 6 Nov 2024 10:44:23 -0800 Subject: [PATCH 06/10] Update .changeset/gold-maps-cut.md Co-authored-by: Tyler Butler --- .changeset/gold-maps-cut.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index f72ea81f005d..d1315dcee898 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -7,7 +7,7 @@ "@fluidframework/test-runtime-utils": minor --- -# Removed `_createDataStoreWithProps` +# The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed Removed two main APIs, `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` has been removed. From 3f5334f1d3ce43b16265594886528b518f4a6197 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft <90650728+tyler-cai-microsoft@users.noreply.github.com> Date: Wed, 6 Nov 2024 10:44:32 -0800 Subject: [PATCH 07/10] Update .changeset/gold-maps-cut.md Co-authored-by: Tyler Butler --- .changeset/gold-maps-cut.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index d1315dcee898..1c450bd07f29 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -12,5 +12,5 @@ Removed two main APIs, `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` has been removed. -For alternative solutions use `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState` +Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState` parameter. From 2cef339a42b4d609ab9374273fe79adbd590280b Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Wed, 6 Nov 2024 10:50:58 -0800 Subject: [PATCH 08/10] PR Comments --- .changeset/gold-maps-cut.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index 1c450bd07f29..9fe20bec502f 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -14,3 +14,8 @@ has been removed. Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState` parameter. + +# Initial deprecation/removal announcement + +The initial deprecations of the now changed or removed types were announced [#1537](https://github.com/microsoft/FluidFramework/issues/1537) +in Fluid Framework v0.25 [#2931](https://github.com/microsoft/FluidFramework/pull/2931) From e916246a0f662ae3380792b880ac6c83f6e76004 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Wed, 8 Jan 2025 11:43:05 -0800 Subject: [PATCH 09/10] PR review comments --- .changeset/gold-maps-cut.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index 9fe20bec502f..6deec2ddb337 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -10,7 +10,7 @@ # The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed Removed two main APIs, `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` -has been removed. +have been removed. Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState` parameter. From 6b41513c2f0310728faca255359abf34f1452ad9 Mon Sep 17 00:00:00 2001 From: tyler-cai-microsoft Date: Wed, 8 Jan 2025 14:22:00 -0800 Subject: [PATCH 10/10] Remove redundant text --- .changeset/gold-maps-cut.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/gold-maps-cut.md b/.changeset/gold-maps-cut.md index 6deec2ddb337..3790848acb57 100644 --- a/.changeset/gold-maps-cut.md +++ b/.changeset/gold-maps-cut.md @@ -9,7 +9,7 @@ # The createDataStoreWithProps APIs on ContainerRuntime and IContainerRuntimeBase have been removed -Removed two main APIs, `ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` +`ContainerRuntime.createDataStoreWithProps` and `IContainerRuntimeBase.createDataStoreWithProps` have been removed. Replace uses of these APIs with `PureDataObjectFactory.createInstanceWithDataStore` and pass in props via the `initialState`