Skip to content

Commit

Permalink
Remove Unused and Deprecated IFluidObject augmentations (#9002)
Browse files Browse the repository at this point in the history
The following deprecated provider properties are no longer exposed off of IFluidObject

IFluidMountableView
IAgentScheduler
IContainerRuntime
ISummarizer
The interfaces that correspond to the above properties continue to exist, and can use directly, or with the IFluidObject replacement FluidObject

related to #8077
  • Loading branch information
anthony-murphy committed Feb 4, 2022
1 parent 21a6822 commit c1bca10
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 43 deletions.
10 changes: 10 additions & 0 deletions BREAKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ There are a few steps you can take to write a good change note and avoid needing
- [Removed PureDataObject.requestFluidObject_UNSAFE](#Removed-PureDataObject.requestFluidObject_UNSAFE)
- [Modified PureDataObject.getFluidObjectFromDirectory](#Modified-PureDataObject.getFluidObjectFromDirectory)
- [Remove IFluidObject from Aqueduct](#Remove-IFluidObject-from-Aqueduct)
- [Remove Unused IFluidObject Augmentations](#Remove-Unused-IFluidObject-Augmentations)

### IFluidConfiguration removed

Expand Down Expand Up @@ -68,6 +69,15 @@ This impacts the following public apis:

In general the impact of these changes should be transparent. If you see compile errors related to Fluid object provider types with the above apis, you should transition those usages to [FluidObject](https://github.com/microsoft/FluidFramework/blob/main/common/lib/core-interfaces/src/provider.ts#L61) which is the replacement for the deprecated IFluidObject.

### Remove Unused IFluidObject Augmentations
The following deprecated provider properties are no longer exposed off of IFluidObject
- IFluidMountableView
- IAgentScheduler
- IContainerRuntime
- ISummarizer

The interfaces that correspond to the above properties continue to exist, and can use directly, or with the IFluidObject replacement [FluidObject](https://github.com/microsoft/FluidFramework/blob/main/common/lib/core-interfaces/src/provider.ts#L61)

## 0.56 Breaking changes
- [`MessageType.Save` and code that handled it was removed](#messageType-save-and-code-that-handled-it-was-removed)
- [Removed `IOdspResolvedUrl.sharingLinkToRedeem`](#Removed-IOdspResolvedUrl.sharingLinkToRedeem)
Expand Down
9 changes: 0 additions & 9 deletions examples/data-objects/pond/src/interfaces/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
* Licensed under the MIT License.
*/

declare module "@fluidframework/core-interfaces" {
export interface IFluidObject extends Readonly<Partial<IProvideFluidUserInformation>> {
/**
* @deprecated - Use `FluidObject<IFluidUserInformation>` instead
*/
readonly IFluidUserInformation?: IFluidUserInformation
}
}

export const IFluidUserInformation: keyof IProvideFluidUserInformation = "IFluidUserInformation";

export interface IProvideFluidUserInformation {
Expand Down
6 changes: 0 additions & 6 deletions packages/framework/view-interfaces/src/mountableView.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,3 @@ export interface IFluidMountableView extends IProvideFluidMountableView {
unmount(): void;
}

declare module "@fluidframework/core-interfaces" {
export interface IFluidObject {
/** @deprecated - use `FluidObject<IFluidMountableView> instead */
readonly IFluidMountableView?: IFluidMountableView;
}
}
11 changes: 1 addition & 10 deletions packages/runtime/agent-scheduler/src/agent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,4 @@ export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider<
* Returns a list of all tasks running on this client
*/
pickedTasks(): string[];
}

declare module "@fluidframework/core-interfaces" {
export interface IFluidObject{
/**
* @deprecated - use `FluidObject<IAgentScheduler>` instead
*/
readonly IAgentScheduler?: IAgentScheduler;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,6 @@ import {
IProvideFluidDataStoreRegistry,
} from "@fluidframework/runtime-definitions";

declare module "@fluidframework/core-interfaces" {
export interface IFluidObject {
/**
* @deprecated - use `FluidObject<IContainerRuntime>` instead
*/
readonly IContainerRuntime?: IContainerRuntime;

}
}

/**
* @deprecated - This will be removed in a later release.
*/
Expand Down
8 changes: 0 additions & 8 deletions packages/runtime/container-runtime/src/summarizerTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,6 @@ import {
import { ISummaryStats } from "@fluidframework/runtime-definitions";
import { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from "./summaryCollection";

declare module "@fluidframework/core-interfaces" {
export interface IFluidObject {
/** @deprecated - use `FluidObject<ISummarizer>` instead */
readonly ISummarizer?: ISummarizer;

}
}

/**
* @deprecated - This will be removed in a later release.
*/
Expand Down

0 comments on commit c1bca10

Please sign in to comment.