Skip to content

Commit

Permalink
id-compressor: Remove deprecated compressor types from runtime defini…
Browse files Browse the repository at this point in the history
…tions (#19031)

## Description

This removes re-exported/deprecated compressor types from the runtime
definitions public API. They were moved to the id-compressor package
earlier.

## Breaking Changes

The removed APIs were technically public but are very unlikely to ever
have been used. They were moved to a publicly available package in
#18749.
  • Loading branch information
taylorsw04 authored and sonalideshpandemsft committed Apr 15, 2024
1 parent 40d217a commit f03200a
Show file tree
Hide file tree
Showing 24 changed files with 96 additions and 264 deletions.
7 changes: 7 additions & 0 deletions .changeset/small-cups-shine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@fluidframework/runtime-definitions": minor
---

Deprecated ID compressor related types have been removed.

This change should be a no-op for consumers, as these types were almost certainly unused and are also available in the standalone package id-compressor (https://github.com/microsoft/FluidFramework/pull/18749).
1 change: 1 addition & 0 deletions experimental/dds/tree/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"@fluidframework/core-interfaces": "workspace:~",
"@fluidframework/core-utils": "workspace:~",
"@fluidframework/datastore-definitions": "workspace:~",
"@fluidframework/id-compressor": "workspace:~",
"@fluidframework/protocol-definitions": "^3.1.0-223007",
"@fluidframework/runtime-definitions": "workspace:~",
"@fluidframework/shared-object-base": "workspace:~",
Expand Down
3 changes: 1 addition & 2 deletions experimental/dds/tree/src/migration-shim/migrationShim.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,13 @@ import {
type IGarbageCollectionData,
type ITelemetryContext,
type ISummaryTreeWithStats,
IIdCompressorCore,
SessionId,
} from '@fluidframework/runtime-definitions';
import { type ITree } from '@fluidframework/tree';
import { assert } from '@fluidframework/core-utils';
import { MessageType, type ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { type EventEmitterEventType } from '@fluid-internal/client-utils';
import { DataProcessingError, EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
import type { SessionId, IIdCompressorCore } from '@fluidframework/id-compressor';
import { type SharedTreeFactory as LegacySharedTreeFactory, type SharedTree as LegacySharedTree } from '../SharedTree';
import { type IShimChannelServices, NoDeltasChannelServices } from './shimChannelServices.js';
import { MigrationShimDeltaHandler } from './migrationDeltaHandler.js';
Expand Down
4 changes: 2 additions & 2 deletions packages/dds/tree/api-report/tree.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
import { ISharedObject } from '@fluidframework/shared-object-base';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
import { ITelemetryContext } from '@fluidframework/runtime-definitions';
import { SessionSpaceCompressedId } from '@fluidframework/runtime-definitions';
import { StableId } from '@fluidframework/runtime-definitions';
import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
import { StableId } from '@fluidframework/id-compressor';
import type { Static } from '@sinclair/typebox';
import type { TSchema } from '@sinclair/typebox';

Expand Down
2 changes: 1 addition & 1 deletion packages/dds/tree/src/core/rebase/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
OpSpaceCompressedId,
SessionId,
SessionSpaceCompressedId,
} from "@fluidframework/runtime-definitions";
} from "@fluidframework/id-compressor";
import {
Brand,
NestedMap,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*/

import { assert } from "@fluidframework/core-utils";
import { StableId } from "@fluidframework/runtime-definitions";
import { StableId } from "@fluidframework/id-compressor";
import {
FieldKey,
TreeNavigationResult,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import {
ITelemetryContext,
ISummaryTreeWithStats,
IGarbageCollectionData,
IIdCompressor,
} from "@fluidframework/runtime-definitions";
import { createSingleBlobSummary } from "@fluidframework/shared-object-base";
import { assert } from "@fluidframework/core-utils";
import { IIdCompressor } from "@fluidframework/id-compressor";
import {
applyDelta,
DeltaFieldChanges,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Licensed under the MIT License.
*/

import { SessionSpaceCompressedId, StableId } from "@fluidframework/runtime-definitions";
import { SessionSpaceCompressedId, StableId } from "@fluidframework/id-compressor";
import { Brand, Opaque, brand } from "../../util/index.js";
import { TreeNodeSchemaIdentifier } from "../../core/index.js";

Expand Down
2 changes: 1 addition & 1 deletion packages/dds/tree/src/shared-tree/treeCheckout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Licensed under the MIT License.
*/
import { assert } from "@fluidframework/core-utils";
import { IIdCompressor } from "@fluidframework/runtime-definitions";
import { IIdCompressor } from "@fluidframework/id-compressor";
import {
AnchorLocator,
IForestSubscription,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { strict as assert, fail } from "assert";
import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
import { IIdCompressor } from "@fluidframework/runtime-definitions";
import { IIdCompressor } from "@fluidframework/id-compressor";
import {
LocalNodeKey,
StableNodeKey,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Licensed under the MIT License.
*/

import { SessionId } from "@fluidframework/runtime-definitions";
import { SessionId } from "@fluidframework/id-compressor";
import { makeCodecFamily, withDefaultBinaryEncoding } from "../../../codec/index.js";
import { typeboxValidator } from "../../../external-utilities/index.js";
import { TestChange } from "../../testChange.js";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { fail, strict as assert } from "assert";
import { unreachableCase } from "@fluidframework/core-utils";
import { SessionId } from "@fluidframework/runtime-definitions";
import { SessionId } from "@fluidframework/id-compressor";
import { ChangeRebaser, ChangeFamilyEditor, emptyDelta } from "../../../core/index.js";
import { TestChangeFamily, TestChange, asDelta } from "../../testChange.js";
import { Commit, EditManager, SeqNumber } from "../../../shared-tree-core/index.js";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
* Licensed under the MIT License.
*/

import { createIdCompressor } from "@fluidframework/id-compressor";
import { SessionId } from "@fluidframework/runtime-definitions";
import { createIdCompressor, SessionId } from "@fluidframework/id-compressor";
import {
ChangeFamily,
ChangeRebaser,
Expand Down
3 changes: 1 addition & 2 deletions packages/runtime/container-runtime/src/dataStoreContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ import {
ISummarizerNodeWithGC,
SummarizeInternalFn,
ITelemetryContext,
IIdCompressor,
IIdCompressorCore,
VisibilityState,
} from "@fluidframework/runtime-definitions";
import { addBlobToSummary, convertSummaryTreeToITree } from "@fluidframework/runtime-utils";
Expand All @@ -67,6 +65,7 @@ import {
tagCodeArtifacts,
ThresholdCounter,
} from "@fluidframework/telemetry-utils";
import { IIdCompressor, IIdCompressorCore } from "@fluidframework/id-compressor";
import {
dataStoreAttributesBlobName,
hasIsolatedChannels,
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime/datastore/api-report/datastore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definiti
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
import { IIdCompressor } from '@fluidframework/runtime-definitions';
import { IIdCompressor } from '@fluidframework/id-compressor';
import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
import { ILoaderOptions } from '@fluidframework/container-definitions';
import { IQuorumClients } from '@fluidframework/protocol-definitions';
Expand Down
1 change: 1 addition & 0 deletions packages/runtime/datastore/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
"@fluidframework/datastore-definitions": "workspace:~",
"@fluidframework/driver-definitions": "workspace:~",
"@fluidframework/driver-utils": "workspace:~",
"@fluidframework/id-compressor": "workspace:~",
"@fluidframework/protocol-definitions": "^3.1.0-223007",
"@fluidframework/runtime-definitions": "workspace:~",
"@fluidframework/runtime-utils": "workspace:~",
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime/datastore/src/dataStoreRuntime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ import {
ISummaryTreeWithStats,
VisibilityState,
ITelemetryContext,
IIdCompressor,
} from "@fluidframework/runtime-definitions";
import {
convertSnapshotTreeToSummaryTree,
Expand All @@ -72,6 +71,7 @@ import {
IChannelFactory,
} from "@fluidframework/datastore-definitions";
import { v4 as uuid } from "uuid";
import { IIdCompressor } from "@fluidframework/id-compressor";
import { IChannelContext, summarizeChannel } from "./channelContext";
import {
LocalChannelContext,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import { AttachState } from '@fluidframework/container-definitions';
import { FluidObject } from '@fluidframework/core-interfaces';
import { IAudience } from '@fluidframework/container-definitions';
import { IClientDetails } from '@fluidframework/protocol-definitions';
import { IdCompressor } from '@fluidframework/id-compressor';
import { IdCreationRange } from '@fluidframework/id-compressor';
import { IDeltaManager } from '@fluidframework/container-definitions';
import { IDisposable } from '@fluidframework/core-interfaces';
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
Expand All @@ -18,7 +16,6 @@ import { IEvent } from '@fluidframework/core-interfaces';
import { IEventProvider } from '@fluidframework/core-interfaces';
import { IFluidHandle } from '@fluidframework/core-interfaces';
import { IIdCompressor } from '@fluidframework/id-compressor';
import { IIdCompressorCore } from '@fluidframework/id-compressor';
import { ILoaderOptions } from '@fluidframework/container-definitions';
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
import { IQuorumClients } from '@fluidframework/protocol-definitions';
Expand All @@ -31,13 +28,6 @@ import { ISummaryTree } from '@fluidframework/protocol-definitions';
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
import { ITree } from '@fluidframework/protocol-definitions';
import type { IUser } from '@fluidframework/protocol-definitions';
import { OpSpaceCompressedId } from '@fluidframework/id-compressor';
import { SerializedIdCompressor } from '@fluidframework/id-compressor';
import { SerializedIdCompressorWithNoSession } from '@fluidframework/id-compressor';
import { SerializedIdCompressorWithOngoingSession } from '@fluidframework/id-compressor';
import { SessionId } from '@fluidframework/id-compressor';
import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
import { StableId } from '@fluidframework/id-compressor';
import { SummaryTree } from '@fluidframework/protocol-definitions';
import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';

Expand Down Expand Up @@ -161,10 +151,6 @@ export interface IDataStore {
trySetAlias(alias: string): Promise<AliasResult>;
}

export { IdCompressor }

export { IdCreationRange }

// @alpha
export interface IEnvelope {
address: string;
Expand Down Expand Up @@ -296,10 +282,6 @@ export interface IGarbageCollectionDetailsBase {
usedRoutes?: string[];
}

export { IIdCompressor }

export { IIdCompressorCore }

// @public
export interface IInboundSignalMessage extends ISignalMessage {
// (undocumented)
Expand Down Expand Up @@ -439,20 +421,6 @@ export interface OpAttributionKey {
type: "op";
}

export { OpSpaceCompressedId }

export { SerializedIdCompressor }

export { SerializedIdCompressorWithNoSession }

export { SerializedIdCompressorWithOngoingSession }

export { SessionId }

export { SessionSpaceCompressedId }

export { StableId }

// @alpha (undocumented)
export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;

Expand Down
46 changes: 42 additions & 4 deletions packages/runtime/runtime-definitions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,49 @@
},
"typeValidation": {
"broken": {
"InterfaceDeclaration_IIdCompressorCore": {
"forwardCompat": false
"RemovedInterfaceDeclaration_IIdCompressorCore": {
"forwardCompat": false,
"backCompat": false
},
"ClassDeclaration_IdCompressor": {
"forwardCompat": false
"RemovedClassDeclaration_IdCompressor": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IIdCompressor": {
"forwardCompat": false,
"backCompat": false
},
"RemovedInterfaceDeclaration_IdCreationRange": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_OpSpaceCompressedId": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_SerializedIdCompressor": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_SerializedIdCompressorWithNoSession": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_SerializedIdCompressorWithOngoingSession": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_SessionId": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_SessionSpaceCompressedId": {
"forwardCompat": false,
"backCompat": false
},
"RemovedTypeAliasDeclaration_StableId": {
"forwardCompat": false,
"backCompat": false
}
}
}
Expand Down
49 changes: 0 additions & 49 deletions packages/runtime/runtime-definitions/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,52 +65,3 @@ export {
SummarizeInternalFn,
totalBlobSizePropertyName,
} from "./summary";

// Re-exports for backwards compatibility.
// Will be removed in the future.
export {
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
IdCompressor,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
IIdCompressor,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
IIdCompressorCore,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
IdCreationRange,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
OpSpaceCompressedId,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
SerializedIdCompressor,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
SerializedIdCompressorWithNoSession,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
SerializedIdCompressorWithOngoingSession,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
SessionId,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
SessionSpaceCompressedId,
/**
* @deprecated Import from `@fluidframework/id-compressor` instead.
*/
StableId,
} from "@fluidframework/id-compressor";
Loading

0 comments on commit f03200a

Please sign in to comment.