Deprecate creating root datastores

[andre4i]

Deprecated API

IContainerRuntime.createRootDataStore and IContainerRuntimeBase._createDataStoreWithProps with isRoot set to true. The latter has already been deprecated (0.16 Issue #1537, #3631)

Context

The APIs are vulnerable to name conflicts, which lead to invalid documents. See #6465

Approach

The replacement API has two parts:

• Creating a regular datastore using the IContainerRuntimeBase.createDataStore(pkg: string | string[]): Promise<IDataStore> function
• Aliasing the datastore by using the IDataStore.trySetAlias(alias: string): Promise<AliasResult> function and specifying a string value to serve as the alias to which the datastore needs to be bound. If successful, "Success" will be returned, and a call to getRootDataStore with the alias as parameter will return the same datastore.

Dependencies

Currently, the API is used across the Fluid examples and in some Bohemia use-cases.

Compatibility Concerns

The migration can be started after runtime version >= 0.56.0 reaches full/reasonable saturation.

Phases

• Add telemetry to the _createDataStoreWithProps to measure who/what is calling it with isRoot set to true Identify when the legacy _createDataStoreWithProps API is used to create root datastores #9796
• Mark the existing APIs as deprecated Mark createRootDataStore as deprecated, migrate examples #9829
• Migrate the Fluid examples to the new API Mark createRootDataStore as deprecated, migrate examples #9829
• Migrate Bohemia off the old API Help migrate Bohemia off the createRootDataStore API #9831
• Remove the old API from the codebase Remove createRootDataStore #9832

Expected Timeline

TBD

Open Questions

TBD

[andre4i]

https://dev.azure.com/fluidframework/internal/_workitems/edit/359