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

Deprecate types in tree #23313

Merged

Conversation

sonalideshpandemsft
Copy link
Contributor

@sonalideshpandemsft sonalideshpandemsft commented Dec 12, 2024

Add a changeset to deprecate types from @fluidframework/tree. Modify fluid-framework to re-export the non-deprecated APIs from core-interfaces.

Added basic test cases which covers importing a type from the three packages: tree, core-interfaces, and fluid-framework. These tests are added under examples.

Prior PR: #23183

ADO#25440

@sonalideshpandemsft sonalideshpandemsft requested review from a team as code owners December 12, 2024 06:33
@github-actions github-actions bot added base: main PRs targeted against main branch area: dds Issues related to distributed data structures area: dds: tree area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct changeset-present labels Dec 12, 2024

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (5)

packages/framework/fluid-framework/src/index.ts:57

  • [nitpick] The comment explaining the ESLint disable directive is quite long and could be split into multiple lines for better readability.
/* eslint-disable import/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */

packages/dds/tree/src/index.ts:21

  • The type name 'Listeners' is too generic and can cause confusion. Consider renaming it to something more specific like 'EventListeners'.
Listeners,

packages/dds/tree/src/index.ts:25

  • The type name 'IsListener' is ambiguous. Consider renaming it to something more descriptive like 'IsEventListener'.
IsListener,

packages/dds/tree/src/index.ts:29

  • The type name 'Listenable' is too generic and can cause confusion. Consider renaming it to something more specific like 'EventListenable'.
Listenable,

packages/dds/tree/src/index.ts:33

  • The type name 'Off' is too generic and can cause confusion. Consider renaming it to something more specific like 'EventOff'.
Off,

Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more

@github-actions github-actions bot added area: examples Changes that focus on our examples dependencies Pull requests that update a dependency file labels Dec 16, 2024
packages/dds/tree/src/index.ts Outdated Show resolved Hide resolved
@sonalideshpandemsft sonalideshpandemsft requested a review from a team as a code owner December 17, 2024 10:52
@github-actions github-actions bot added the public api change Changes to a public API label Dec 17, 2024
@sonalideshpandemsft sonalideshpandemsft force-pushed the deprecate-events-types branch 2 times, most recently from 0594542 to c6455be Compare December 17, 2024 17:37
@github-actions github-actions bot removed the public api change Changes to a public API label Dec 17, 2024
@github-actions github-actions bot added the public api change Changes to a public API label Jan 3, 2025
Copy link
Contributor

@jason-ha jason-ha left a comment

Choose a reason for hiding this comment

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

Should be mostly ready with test relocated to examples/utils/import-testing

Copy link
Contributor

github-actions bot commented Jan 9, 2025

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170508 links
    1603 destination URLs
    1842 URLs ignored
       0 warnings
       0 errors


@sonalideshpandemsft sonalideshpandemsft merged commit 69a755e into microsoft:main Jan 13, 2025
36 checks passed
@sonalideshpandemsft sonalideshpandemsft deleted the deprecate-events-types branch January 13, 2025 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: dds: tree area: dds Issues related to distributed data structures area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch changeset-present dependencies Pull requests that update a dependency file public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants