Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further MergeTree Client Legacy Deprecations #22629

Merged
merged 7 commits into from
Sep 27, 2024

Conversation

anthony-murphy
Copy link
Contributor

In an effort the reduce exposure of the Client class in the merge-tree package this change additionally deprecates a number of types which either directly or indirectly expose the merge-tree Client class.

Most of these types are not meant to be used directly, and direct use is not supported:

  • AttributionPolicy
  • IClientEvents
  • IMergeTreeAttributionOptions
  • SharedSegmentSequence
  • SharedStringClass

Some of the deprecations are for class constructors and in those cases we plan to replace the class with an interface which has an equivalent API. Direct instantiation of these classes is not currently supported or necessary for any supported scenario, so the change to an interface should not impact usage:

  • SequenceInterval
  • SequenceEvent
  • SequenceDeltaEvent
  • SequenceMaintenanceEvent

@anthony-murphy anthony-murphy requested review from a team as code owners September 25, 2024 20:08
@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: sharedstring changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Sep 25, 2024
@github-actions github-actions bot added the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Sep 25, 2024
.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
packages/dds/sequence/src/intervals/sequenceInterval.ts Outdated Show resolved Hide resolved
packages/dds/sequence/src/sequenceDeltaEvent.ts Outdated Show resolved Hide resolved
packages/dds/sequence/src/sequenceDeltaEvent.ts Outdated Show resolved Hide resolved
Copy link
Member

@tylerbutler tylerbutler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changeset looks great - just wording tweaks and minor formatting. Your level of detail was great.

Typically I would suggest trying to link to the docs for the types, but in this case that seems unnecessary since these types aren't likely to be used right now anyway. Maybe links to docs for deprecations in general is unnecessary. Links to docs make way more sense with new or changed APIs. @microsoft/fluid-cr-docs Curious what others think. We can take that discussion to another forum though.

.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
.changeset/shaggy-pens-occur.md Outdated Show resolved Hide resolved
@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Sep 25, 2024

@fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 461.42 KB 461.45 KB +35 Bytes
azureClient.js 559.03 KB 559.08 KB +49 Bytes
connectionState.js 680 Bytes 680 Bytes No change
containerRuntime.js 261.68 KB 261.69 KB +14 Bytes
fluidFramework.js 404.99 KB 405 KB +14 Bytes
loader.js 134.17 KB 134.19 KB +14 Bytes
map.js 42.43 KB 42.44 KB +7 Bytes
matrix.js 146.8 KB 146.8 KB +7 Bytes
odspClient.js 526.18 KB 526.23 KB +49 Bytes
odspDriver.js 97.8 KB 97.82 KB +21 Bytes
odspPrefetchSnapshot.js 42.76 KB 42.78 KB +14 Bytes
sharedString.js 163.79 KB 163.8 KB +7 Bytes
sharedTree.js 395.45 KB 395.46 KB +7 Bytes
Total Size 3.31 MB 3.31 MB +245 Bytes

Baseline commit: 7febffe

Generated by 🚫 dangerJS against a3a41dd

Copy link
Contributor

🔗 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:
  409152 links
    3178 destination URLs
       2 URLs ignored
       0 warnings
       0 errors


@anthony-murphy anthony-murphy merged commit 0b59ae8 into microsoft:main Sep 27, 2024
33 checks passed
@anthony-murphy anthony-murphy deleted the client-deprecations branch September 27, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: dds: sharedstring area: dds Issues related to distributed data structures area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch changeset-present public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants