MergeTree Client Legacy API Removed

[anthony-murphy]

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

[msfluid-bot]

⯆ @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

[anthony-murphy]

#22827

[Abe27342]

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)

[anthony-murphy]

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

[anthony-murphy]

[anthony-murphy]

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

[anthony-murphy]

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

[Josmithr]

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.

[anthony-murphy]

@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?

[Josmithr]

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

[tylerbutler]

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.

[tylerbutler]

Minor nit; docs look good.

[github-actions]

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output

> [email protected] 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"


> [email protected] ci:start
> http-server ./public --port 1313 --silent


> [email protected] linkcheck:full
> npm run linkcheck:fast -- --external


> [email protected] 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