Releases: microsoft/FluidFramework
Fluid Framework v2.0.0-internal.5.0.0 (major)
This is a major release that includes breaking changes in addition to deprecations that will take effect in a future major release.
💥 Breaking changes
This release contains the following breaking changes:
IResolvedUrl equivalent to IFluidResolvedUrl
In @fluidframework/driver-definitions IResolvedUrlBase and IWebResolvedUrl have now been removed.
This makes IResolvedUrl and IFluidResolvedUrl equivalent. Since all ResolvedUrls are now FluidResolvedUrls we no longer need to differentiate them. In @fluidframework/driver-utils isFluidResolvedUrl and ensureFluidResolvedUrl have been removed due to this.
@fluidframework/garbage-collector removed
The @fluidframework/garbage-collector
package was deprecated in 2.0.0-internal.4.1.0. It has now been removed with the following functions, interfaces, and types in it.
runGarbageCollection
trimLeadingAndTrailingSlashes
trimLeadingSlashes
trimTrailingSlashes
cloneGCData
unpackChildNodesGCDetails
unpackChildNodesUsedRoutes
removeRouteFromAllNodes
concatGarbageCollectionStates
concatGarbageCollectionData
GCDataBuilder
getGCDataFromSnapshot
IGCResult
GC interfaces removed from runtime-definitions
The following interfaces available in @fluidframework/runtime-definitions
were deprecated in 2.0.0-internal.4.1.0 and are now removed.
IGarbageCollectionNodeData
IGarbageCollectionState
IGarbageCollectionSnapshotData
IGarbageCollectionSummaryDetailsLegacy
ensureSynchronizedWithTimeout removed from LoaderContainerTracker
LoaderContainerTracker.ensureSynchronizedWithTimeout
has been removed as it is equivalent to LoaderContainerTracker.ensureSynchronized
. The timeoutDuration
parameter from TestObjectProvider.ensureSynchronized
will also be removed. Configure the timeout for the test instead.
Container-loader deprecation removals
The following types in the @fluidframework/container-loader package are not used by, or necessary to use our public api, so have been removed from export in this release:
- IContainerLoadOptions
- IContainerConfig
- IPendingContainerState
- ISerializableBlobContents
Closing Container no longer disposes
Calling IContainer.close(...)
will no longer dispose the container runtime, document service, or document storage service.
If the container is not expected to be used after the close(...)
call, replace it instead with a IContainer.dispose(...)
call (this should be the most common case). Using IContainer.dispose(...)
will no longer switch the container to "readonly" mode and relevant code should instead listen to the Container's "disposed" event.
If you intend to pass your own critical error to the container, use IContainer.close(...)
. Once you are done using the container, call IContainer.dispose(...)
.
Please see the Closure section of Loader README.md for more details.
IContainer.dispose
is now required
IContainer.dispose
is now a required method. This method should dispose any resources and switch the container to a permanently disconnected state.
Please see the Closure section of Loader README.md for more details.
ISummarizerRuntime on/off op required
The on("op")
and off("op")
methods on ISummarizerRuntime
are now required. These listener methods are needed to accurately run summary heuristics.
Driver param removed from appendToMergeTreeDeltaRevertibles
The first parameter, driver, of the function appendToMergeTreeDeltaRevertibles has been removed. Additionally, the interface MergeTreeRevertibleDriver has been simplified, and no longer requires:
- createLocalReferencePosition
- localReferencePositionToPosition
- getPosition
- getContainingSegment
PureDataObject.getFluidObjectFromDirectory removed
PureDataObject.getFluidObjectFromDirectory
was deprecated in a previous release and has been removed.
IProvideContainerRuntime and IContainerRuntime member removed
IProvideContainerRuntime
and its IContainerRuntime
member were deprecated in a previous release and have been removed. This applies to the ContainerRuntime
class as well.
IntervalCollection removed
The exports deprecated in IntervalCollection public export deprecated have been removed.
Internal ITelemetryLogger interface upgraded to ITelemetryLoggerExt
ITelemetryLoggerExt
is a replacement for ITelemetryLogger
, which adds additional types that can be logged as property values.
This interface is not expected to be used outside the codebase, and all Logger implementations already use the new interface.
In this release, the new type is used throughout the codebase to allow richer instrumentation.
Deprecations
IFluidResolvedUrl Deprecated
IFluidResolvedUrl is now deprecated, all usages should move to IResolvedUrl instead.
Fluid Framework v2.0.0-internal.4.4.0 (minor)
This is a minor release.
It contains bug fixes and other internal improvements.
What's Changed
Deprecations
IntervalCollection public export deprecated in @fluidframework/sequence
IntervalCollection
has been deprecated in favor of an interface (IIntervalCollection
) containing its public API. Several types transitively referenced by IntervalCollection
implementation details have also been deprecated: CompressedSerializedInterval
, IntervalCollectionIterator
, and ISerializedIntervalCollectionV2
.
build-tools v0.18.0 (minor)
This is a minor release.
Fluid Framework v2.0.0-internal.4.3.0 (minor)
This is a minor release.
It contains bug fixes and other internal improvements.
What's Changed
💥 Breaking changes
-
bigBlobs request handling removed from DataObject
bigBlobs request handling removed from DataObject
Previously,
DataObject
would perform undocumented special handling for requests to it starting withbigBlobs/
to pull objects out of its
root
directory. This special handling has been removed.
2.0.0-internal.4.3.0 Upcoming changes
PureDataObject.getFluidObjectFromDirectory deprecated
`PureDataObject.getFluidObjectFromDirectory` has been deprecated and will be removed in an upcoming release. Instead prefer to
interface directly with the directory and handles.
Fluid Framework v2.0.0-internal.4.2.1 (patch)
What's Changed
- [Port v2int 4.2] Remove the peer dependencies for @fluidframework/tinylicious-client as they are wrong
#15567
Full Changelog: client_v2.0.0-internal.4.2.0...client_v2.0.0-internal.4.2.1
Fluid Framework v2.0.0-internal.4.2.0 (minor)
This is a minor release.
It contains bug fixes and other internal improvements.
There are no new deprecations in this release.
build-tools v0.17.0 (minor)
This is a minor release.
patch release client_v2.0.0-internal.3.4.5
What's Changed
- [v2int/3.4] Fix a bug where child summarizer node's paths are incorrectly set to parent's paths by @markfields in #15433
Full Changelog: client_v2.0.0-internal.3.4.4...client_v2.0.0-internal.3.4.5
client_v2.0.0-internal.4.1.2
What's Changed
Other changes
- [v2int4.1 Port] Fix submit blobAttach ops (#15360) by @kian-thompson in #15361
- [v2int/4.1] Revert to shallow clone to reduce bundle size by @alexvy86 in #15364
Full Changelog: client_v2.0.0-internal.4.1.1...client_v2.0.0-internal.4.1.2
Fluid Framework v2.0.0-internal.4.1.1 (patch)
What's Changed
- [v2int/4.1] Summarizer: Log SummarizeTelemetry even if something fails by @markfields in #15316
- [v2int/4.1] Set default GC version to 2 instead of 3 by @markfields in #15317
Full Changelog: client_v2.0.0-internal.4.1.0...client_v2.0.0-internal.4.1.1