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.

Sign up for GitHub

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

Jump to bottom

Deprecate unnecessary exports of container-runtime package #23607

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Deprecate unnecessary exports of container-runtime package #23607

wants to merge 10 commits into from

Conversation

anthony-murphy
Copy link
Contributor

@anthony-murphy anthony-murphy commented Jan 17, 2025 •
edited
Loading

The following types in the @fluidframework/container-runtime are deprecated. These types are unnecessary for external users of this package.

  • currentDocumentVersionSchema
  • DeletedResponseHeaderKey
  • disabledCompressionConfig
  • DocumentSchemaValueType
  • DocumentsSchemaController
  • GCFeatureMatrix
  • GCNodeType
  • GCVersion
  • IBlobManagerLoadInfo
  • ICancellableSummarizerController
  • ICancellationToken
  • IConnectableRuntime
  • IContainerRuntimeMetadata
  • ICreateContainerMetadata
  • IDocumentSchema
  • IDocumentSchemaChangeMessage
  • IDocumentSchemaCurrent
  • IDocumentSchemaFeatures
  • IGCMetadata
  • IGCStats
  • IMarkPhaseStats
  • IRefreshSummaryAckOptions
  • ISerializedElection
  • ISubmitSummaryOptions
  • ISummarizerInternalsProvider
  • ISummarizerRuntime
  • ISummaryCancellationToken
  • ISummaryMetadataMessage
  • ISweepPhaseStats
  • Summarizer

@github-actions github-actions bot added area: dev experience Improving the experience of devs building on top of fluid area: runtime Runtime related issues area: tests Tests to add, test infrastructure improvements, etc public api change Changes to a public API base: main PRs targeted against main branch labels Jan 17, 2025
@github-actions github-actions bot removed the area: dev experience Improving the experience of devs building on top of fluid label Jan 17, 2025
@anthony-murphy anthony-murphy force-pushed the test/container-runtime-deprecations branch from 4a5f0d5 to ddd4188 Compare January 17, 2025 23:01
@anthony-murphy anthony-murphy force-pushed the test/container-runtime-deprecations branch from a41535b to dfe2e21 Compare January 17, 2025 23:23
@anthony-murphy
Copy link
Contributor Author

once these deprecations are made internal, we will see about a 50% reduction of exported surface area: https://github.com/microsoft/FluidFramework/compare/test/container-runtime-deprecations-removals

anthony-murphy
anthony-murphy commented Jan 17, 2025
View reviewed changes
packages/runtime/container-runtime/src/channelCollection.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/channelCollection.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/channelCollection.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/channelCollection.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/channelCollection.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/summary/summaryManager.ts Outdated
@@ -153,14 +162,17 @@ export class SummaryManager
*/
public start(): void {
this.clientElection.on("electedSummarizerChanged", this.refreshSummarizer);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change

packages/runtime/container-runtime/src/summary/summaryManager.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/summary/summaryManager.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/summary/summaryManager.ts Outdated Show resolved Hide resolved
packages/runtime/container-runtime/src/summary/summaryManager.ts Outdated Show resolved Hide resolved
@anthony-murphy anthony-murphy force-pushed the test/container-runtime-deprecations branch from 67df428 to a483687 Compare January 18, 2025 00:42
@anthony-murphy anthony-murphy force-pushed the test/container-runtime-deprecations branch from a483687 to 1db84ee Compare January 18, 2025 00:59
@github-actions GitHub Actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


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


> [email protected] serve
> docusaurus serve --no-open

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area: runtime Runtime related issues area: tests Tests to add, test infrastructure improvements, etc base: main PRs targeted against main branch changeset-present public api change Changes to a public API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@anthony-murphy