MergeTree `Client` Legacy API Removed by anthony-murphy · Pull Request #22697 · microsoft/FluidFramework

anthony-murphy · 2024-10-01T01:38:40Z

The Client class in the merge-tree package has been removed. Additionally, types that directly or indirectly expose the merge-tree Client class have also been removed.

The removed types were not meant to be used directly, and direct usage was not supported:

AttributionPolicy
IClientEvents
IMergeTreeAttributionOptions
SharedSegmentSequence
SharedStringClass

Some classes that referenced the Client class have been transitioned to interfaces. Direct instantiation of these classes was not supported or necessary for any supported scenario, so the change to an interface should not impact usage. This applies to the following types:

SequenceInterval
SequenceEvent
SequenceDeltaEvent
SequenceMaintenanceEvent

The initial deprecations of the now changed or removed types were announced in Fluid Framework v2.4.0:
Several MergeTree Client Legacy APIs are now deprecated

…to prototype-deprecate-client

…to test/internal-merge-tree-client

msfluid-bot · 2024-10-01T02:23:18Z

⯆ @fluid-example/bundle-size-tests: -123 Bytes

Metric Name	Baseline Size	Compare Size	Size Diff
aqueduct.js	464.21 KB	464.06 KB	⯆ -149 Bytes
azureClient.js	562.45 KB	562.5 KB	⯅ +49 Bytes
connectionState.js	724 Bytes	724 Bytes	■ No change
containerRuntime.js	261.86 KB	261.87 KB	⯅ +14 Bytes
fluidFramework.js	424.82 KB	424.84 KB	⯅ +14 Bytes
loader.js	134.17 KB	134.19 KB	⯅ +14 Bytes
map.js	42.71 KB	42.71 KB	⯅ +7 Bytes
matrix.js	148.54 KB	148.55 KB	⯅ +7 Bytes
odspClient.js	528.3 KB	528.34 KB	⯅ +49 Bytes
odspDriver.js	97.84 KB	97.86 KB	⯅ +21 Bytes
odspPrefetchSnapshot.js	42.81 KB	42.83 KB	⯅ +14 Bytes
sharedString.js	164.76 KB	164.58 KB	⯆ -177 Bytes
sharedTree.js	415.28 KB	415.29 KB	⯅ +7 Bytes
Total Size	3.36 MB	3.36 MB	⯆ -123 Bytes

Baseline commit: 99fbaf4

Generated by 🚫 dangerJS against 02adda5

…to test/internal-merge-tree-client

anthony-murphy · 2024-10-16T23:11:44Z

#22827

…to test/internal-merge-tree-client

Abe27342 · 2024-11-04T18:29:56Z

 } from "@fluidframework/sequence/internal";

-export {
+export type {


why this change? seems like SharedString still needs to be usable as a value in public api, e.g. in dynamic DDS creation:

const myNewString = await container.create(SharedString)

interesting. i don't think i made an direct modifications to this file, maybe an auto-formatter bug. i'll revert.

this breaks the build. the error doesn't actually call out SharedString. I'll split the import to fix, but odd the autofix does the wrong thing. FYI @Josmithr @tylerbutler

i also don't think we type test fluid-framework, so nothing catches this.

this breaks the build. the error doesn't actually call out SharedString. I'll split the import to fix, but odd the autofix does the wrong thing. FYI @Josmithr @tylerbutler

I don't think I've seen the auto-fixer change an export that was not type-only to a type-export before. If it's doing that, we may want to disable auto-fix for that rule.

i also don't think we type test fluid-framework, so nothing catches this.

This seems like a pretty serious oversight in our tooling. We should schedule work for this.

@Josmithr do you know the right place to file a bug like this, and which team would own it? if you do would you mind filing it, and linking it here?

Ownership of some of this tooling stuff remains pretty ambiguous (something my team has been pushing on in retrospectives). I would love for there to be more clarity around this for the team.

I'm happy to take on the eslint update (I have another update I want to make in that space anyways). https://dev.azure.com/fluidframework/internal/_workitems/edit/22618

I think Team Sasha/Jason has been owning the type-test infra? Is that right? @jason-ha

In the past we haven't worried about type testing fluid-framework since it just re-exports APIs that are type-tested in their "real" packages. But that was a long time ago, and we have since stopped using export * so messing up the exports is more likely now. It was also based on the fact that the entire API surface was type-tested, though, and that's no longer the case for most packages which only type-test a subset of their API. It should still be a super-set of what's exposed in fluid-framework, though.

…to test/internal-merge-tree-client

tylerbutler

Minor nit; docs look good.

Co-authored-by: Tyler Butler <tylerbu@microsoft.com>

…to test/internal-merge-tree-client

github-actions · 2024-11-05T22:36:14Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluidframework-docs@0.25.0 ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start 1313 linkcheck:full

1: starting server using command "npm run ci:start"
and when url "[ 'http://127.0.0.1:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"


> fluidframework-docs@0.25.0 ci:start
> http-server ./public --port 1313 --silent


> fluidframework-docs@0.25.0 linkcheck:full
> npm run linkcheck:fast -- --external


> fluidframework-docs@0.25.0 linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external

Crawling...

Stats:
  447786 links
    3441 destination URLs
       2 URLs ignored
       0 warnings
       0 errors

The `Client` class in the merge-tree package has been removed. Additionally, types that directly or indirectly expose the merge-tree `Client` class have also been removed. The removed types were not meant to be used directly, and direct usage was not supported: - AttributionPolicy - IClientEvents - IMergeTreeAttributionOptions - SharedSegmentSequence - SharedStringClass Some classes that referenced the `Client` class have been transitioned to interfaces. Direct instantiation of these classes was not supported or necessary for any supported scenario, so the change to an interface should not impact usage. This applies to the following types: - SequenceInterval - SequenceEvent - SequenceDeltaEvent - SequenceMaintenanceEvent The initial deprecations of the now changed or removed types were announced in Fluid Framework v2.4.0: [Several MergeTree Client Legacy APIs are now deprecated](https://github.com/microsoft/FluidFramework/blob/main/RELEASE_NOTES/2.4.0.md#several-mergetree-client-legacy-apis-are-now-deprecated-22629) --------- Co-authored-by: Tyler Butler <tylerbu@microsoft.com>

This reverts commit 2aa0b5e.

anthony-murphy added 6 commits September 17, 2024 09:32

Remove Exposure of Client

2cc6221

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

2129908

…to prototype-deprecate-client

update type tests

1c687be

fix tests

8d7ef70

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

620f950

…to test/internal-merge-tree-client

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

00be065

…to test/internal-merge-tree-client

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

2ae3b9e

…to test/internal-merge-tree-client

anthony-murphy force-pushed the test/internal-merge-tree-client branch from 7e8d1c7 to 2ae3b9e Compare October 2, 2024 19:56

anthony-murphy and others added 10 commits October 3, 2024 13:37

Merge branch 'main' into test/internal-merge-tree-client

19691c2

Merge branch 'main' into test/internal-merge-tree-client

8b0ecb3

Merge branch 'main' into test/internal-merge-tree-client

e374f9a

Merge branch 'main' into test/internal-merge-tree-client

1cb5de6

Merge branch 'main' into test/internal-merge-tree-client

488b0d2

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

441a6a9

…to test/internal-merge-tree-client

remove some deprecations

36ae191

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

bc72f79

…to test/internal-merge-tree-client

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

20eb3df

…to test/internal-merge-tree-client

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

f1d2579

…to test/internal-merge-tree-client

jason-ha reviewed Oct 16, 2024

View reviewed changes

Comment thread packages/dds/merge-tree/api-report/merge-tree.legacy.alpha.api.md

anthony-murphy added 2 commits October 17, 2024 10:19

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

6444ced

…to test/internal-merge-tree-client

Add IMergeTreeOptionsInternal

887dfca

jason-ha reviewed Oct 18, 2024

View reviewed changes

Comment thread packages/dds/sequence/package.json Outdated

anthony-murphy requested review from a team as code owners November 2, 2024 00:36

anthony-murphy added the breaking change This PR or issue would introduce a breaking change label Nov 2, 2024

github-actions Bot removed the breaking change This PR or issue would introduce a breaking change label Nov 2, 2024

anthony-murphy added 2 commits November 1, 2024 17:42

improve change set

86c7a6e

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

014c15d

…to test/internal-merge-tree-client

Abe27342 reviewed Nov 4, 2024

View reviewed changes

Comment thread packages/dds/sequence/src/test/overlappingSequenceIntervalsIndex.spec.ts Outdated

split import to work around autofix bug

eabb66e

Abe27342 reviewed Nov 4, 2024

View reviewed changes

Comment thread packages/dds/sequence/src/intervalIndex/overlappingSequenceIntervalsIndex.ts Outdated

fix test import

fbdc77d

Abe27342 reviewed Nov 4, 2024

View reviewed changes

Comment thread packages/dds/merge-tree/src/mergeTreeNodes.ts

Josmithr reviewed Nov 4, 2024

View reviewed changes

Comment thread packages/dds/merge-tree/src/client.ts

anthony-murphy added 2 commits November 4, 2024 11:52

PR feedback

1c798e5

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

72b0fa3

…to test/internal-merge-tree-client

Abe27342 approved these changes Nov 5, 2024

View reviewed changes

tylerbutler approved these changes Nov 5, 2024

View reviewed changes

Comment thread .changeset/rude-views-bake.md Outdated

Update .changeset/rude-views-bake.md

d2fdec1

Co-authored-by: Tyler Butler <tylerbu@microsoft.com>

anthony-murphy enabled auto-merge (squash) November 5, 2024 20:06

anthony-murphy disabled auto-merge November 5, 2024 20:09

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

02adda5

…to test/internal-merge-tree-client

anthony-murphy enabled auto-merge (squash) November 5, 2024 22:31

anthony-murphy merged commit 2aa0b5e into main Nov 5, 2024

anthony-murphy deleted the test/internal-merge-tree-client branch November 5, 2024 23:22

github-actions Bot mentioned this pull request Nov 5, 2024

Upcoming Release: FluidFramework v2.102.0 #22101

Open

github-actions Bot mentioned this pull request Nov 6, 2024

Upcoming Release: FluidFramework v2.102.0 tylerbutler/FluidFramework#26

Closed

sonalideshpandemsft added a commit that referenced this pull request Nov 6, 2024

Revert "MergeTree Client Legacy API Removed (#22697)"

6f30206

This reverts commit 2aa0b5e.

sonalideshpandemsft added a commit that referenced this pull request Nov 6, 2024

Revert "MergeTree Client Legacy API Removed (#22697)"

944677e

This reverts commit 2aa0b5e.

Conversation

anthony-murphy commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msfluid-bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anthony-murphy commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Josmithr Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tylerbutler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Nov 5, 2024

linkcheck output

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

anthony-murphy commented Oct 1, 2024 •

edited

Loading

msfluid-bot commented Oct 1, 2024 •

edited

Loading

anthony-murphy commented Oct 16, 2024 •

edited

Loading

Josmithr Nov 4, 2024 •

edited

Loading