Support service client containers in Devtools by CraigMacomber · Pull Request #28260 · microsoft/FluidFramework

Craig Macomber (Microsoft) (CraigMacomber) · 2026-09-19T22:53:03Z

Description

Follow up on #28259 by letting the text-editor example use supported alpha APIs instead of accessing internal container implementations.

Add initializeDevtoolsAlpha, FluidDevtoolsAlpha, and FluidContainerDevtoolsProps to register service client containers directly with Devtools, preserving the existing beta registration signature.
Return SharedObjectKindAlpha<ITree> from fluid-framework's configuredSharedTree so configured trees work with service client registries without internal imports.
Update the text-editor example, add registration regression tests, and document the changes in changesets.

Validation

Compilation passed for devtools, fluid-framework, and text-editor.
All 9 FluidDevtools unit tests and 2 text-editor app tests passed.
Changed-file formatting and ESLint passed.
Changeset check passed; working tree is clean.
The quick readiness script scheduled zero check tasks, so policy and syncpack validation remain unverified.
Full CI, CommonJS validation, and browser integration tests were not run.

Reviewer Guidance

The review process is outlined in the pull request guidelines.

API Council review is needed for removing @sealed from the beta ContainerDevtoolsProps input interface. The new APIs are alpha, and no consumer migration is required.

github-actions · 2026-09-19T22:53:58Z

Hi! Thank you for opening this PR. Want me to review it?

Based on the diff (369 lines, 16 files), I've queued these reviewers:

Correctness — logic errors, race conditions, lifecycle issues
Security — vulnerabilities, secret exposure, injection
API Compatibility — breaking changes, release tags, type design
Performance — algorithmic regressions, memory leaks
Testing — coverage gaps, hollow tests

How this works

Adjust the reviewer set by ticking/unticking boxes above. Reviewer toggles alone don't trigger anything.
Tick Start review below to dispatch the review fleet.
After review finishes, tick Start review again to request another run — it auto-resets after each dispatch.
This comment updates as new commits land; your reviewer selections are preserved.
Start review

Copilot

Copilot review overview

🟡 Changes recommended

Restore URL-hash validation before loading containers to preserve the documented error behavior and passing test.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1

Open (1)

Restore URL hash validation before loading containers · New

What changed in this PR

Adds alpha Devtools support for service-client containers and migrates the text-editor example to supported public APIs.

Changes:

Adds service-container registration APIs and regression tests.
Updates configured SharedTree typing and API reports.
Migrates the text-editor example and documents changes.

File	Description
`pnpm-lock.yaml`	Updates workspace dependencies.
`packages/tools/devtools/devtools-core/src/test/FluidDevtools.spec.ts`	Adds registration regression tests.
`packages/tools/devtools/devtools-core/src/index.ts`	Exports new APIs.
`packages/tools/devtools/devtools-core/src/IFluidDevtools.ts`	Defines alpha Devtools interfaces.
`packages/tools/devtools/devtools-core/src/FluidDevtools.ts`	Supports service-container registration.
`packages/tools/devtools/devtools-core/src/ContainerDevtools.ts`	Adds service-container properties.
`packages/tools/devtools/devtools-core/package.json`	Updates dependencies.
`packages/tools/devtools/devtools-core/api-report/devtools-core.beta.api.md`	Updates beta API report.
`packages/tools/devtools/devtools-core/api-report/devtools-core.alpha.api.md`	Updates alpha API report.
`packages/framework/fluid-framework/src/index.ts`	Updates configured SharedTree typing.
`packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md`	Updates alpha API report.
`examples/data-objects/text-editor/src/app.tsx`	Migrates Devtools and tree registration.
`examples/data-objects/text-editor/package.json`	Removes an obsolete dependency.
`.changeset/twenty-buttons-start.md`	Updates ServiceOptions documentation.
`.changeset/devtools-service-containers.md`	Documents Devtools API changes.
`.changeset/configured-tree-registry-type.md`	Documents configured tree typing.

Files not reviewed (1)

pnpm-lock.yaml: Generated file

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

-			"Invalid container ID in URL hash. Expected 3-64 alphanumeric or '-' characters.",
-		);
-	}
 	const container = await createOrLoadExampleContainer(client, TextEditorDataStore);


github-actions · 2026-09-19T23:08:49Z

Bundle size comparison

Base commit: unresolved
Head commit: 523e2b690e7f78e59bad760022599f635e1d6d20

⚠️ Comparison unavailable.

The PR's CI build failed — fix the build and the comment will update once the next run succeeds.

github-actions · 2026-09-19T23:10:04Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output

$ start-server-and-test "npm run serve -- --host 127.0.0.1 --no-open" http://127.0.0.1:3000 check-links
1: starting server using command "npm run serve -- --host 127.0.0.1 --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-website@0.0.0 serve
> docusaurus serve --host 127.0.0.1 --no-open

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

> fluid-framework-website@0.0.0 check-links
> linkcheck http://127.0.0.1:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  658102 links
    3579 destination URLs
    3898 URLs ignored
       0 warnings
       0 errors

Joshua Smithrud (Josmithr) · 2026-09-20T02:50:52Z

-// eslint-disable-next-line import-x/no-internal-modules
-import { ServiceContainerBase } from "@fluidframework/runtime-utils/internal";
-import { TreeViewConfiguration, type ITree } from "@fluidframework/tree";
+// eslint-disable-next-line import-x/no-internal-modules -- FormattedTextDefault has no public export.


We should restore some sort of TODO here. Our examples shouldn't be using internal APIs.

Joshua Smithrud (Josmithr) · 2026-09-20T02:52:55Z

+ * after initialization.
+ * @alpha
+ */
+export function initializeDevtoolsAlpha(props?: FluidDevtoolsProps): FluidDevtoolsAlpha {


Any reason this function couldn't preserve support for the non-service-client-based props?

Improvements based on feedback from PR 28259

f4115f1

refactor(text-editor): rely on shared container loading

523e2b6

Craig Macomber (Microsoft) (CraigMacomber) marked this pull request as ready for review September 19, 2026 22:57

Craig Macomber (Microsoft) (CraigMacomber) requested review from a team as code owners September 19, 2026 22:57

Copilot AI lite review requested due to automatic review settings September 19, 2026 22:57

Copilot started reviewing on behalf of Craig Macomber (Microsoft) (CraigMacomber) September 19, 2026 22:57 View session

Craig Macomber (Microsoft) (CraigMacomber) mentioned this pull request Sep 19, 2026

Port text-editor to shared example setup #28259

Merged

Copilot AI reviewed Sep 19, 2026

View reviewed changes

Comment thread examples/data-objects/text-editor/src/app.tsx

"Invalid container ID in URL hash. Expected 3-64 alphanumeric or '-' characters.",

);

}

const container = await createOrLoadExampleContainer(client, TextEditorDataStore);

Joshua Smithrud (Josmithr) reviewed Sep 20, 2026

View reviewed changes

Navigation Menu

Support service client containers in Devtools - #28260

Support service client containers in Devtools#28260
Craig Macomber (Microsoft) (CraigMacomber) wants to merge 2 commits into
microsoft:mainfrom
CraigMacomber:text-follow

Craig Macomber (Microsoft) (CraigMacomber) commented Sep 19, 2026

Uh oh!

github-actions Bot commented Sep 19, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Sep 19, 2026

Uh oh!

github-actions Bot commented Sep 19, 2026

Uh oh!

Joshua Smithrud (Josmithr) Sep 20, 2026

Uh oh!

Joshua Smithrud (Josmithr) Sep 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Craig Macomber (Microsoft) (CraigMacomber) commented Sep 19, 2026

Description

Validation

Reviewer Guidance

Uh oh!

github-actions Bot commented Sep 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

github-actions Bot commented Sep 19, 2026

Bundle size comparison

Uh oh!

github-actions Bot commented Sep 19, 2026

linkcheck output

Uh oh!

Joshua Smithrud (Josmithr) Sep 20, 2026

Choose a reason for hiding this comment

Uh oh!

Joshua Smithrud (Josmithr) Sep 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Sep 19, 2026 •

edited

Loading