(compat) Added a new error type for layer incompatibility error by agarwal-navin · Pull Request #25784 · microsoft/FluidFramework

agarwal-navin · 2025-10-31T17:01:22Z

Follow up to #25706.

Added a new error type layerIncompatibilityError which will be used when a layer incompatibility is detected between Fluid layers. This will help applications detect when an error is because of layer incompatibility and take appropriate steps.

The new error type is added as an legacy / alpha API. Since the FluidErrorTypes type is legacy / beta, added a FluidErrorTypesAlpha type where new error types will be added to stage them. Once the breaking change window has passed, error types will be moved to FluidErrorTypes.

AB#51811

Copilot

Pull Request Overview

This PR refactors the LayerIncompatibilityError implementation by introducing a new dedicated error type layerIncompatibilityError in the FluidErrorTypesAlpha enum, replacing the previous approach that used a symbol-based identification mechanism with the generic usageError type.

Key changes:

Introduced FluidErrorTypesAlpha enum with a dedicated layerIncompatibilityError type
Simplified isLayerIncompatibilityError type guard to check the error type directly
Changed LayerIncompatibilityError class to extend LoggingError instead of UsageError

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/common/core-interfaces/src/error.ts	Added `FluidErrorTypesAlpha` enum with `layerIncompatibilityError` type; removed the symbol-based identification; updated `ILayerIncompatibilityError` interface to use the new error type
packages/common/core-interfaces/src/index.ts	Added export for `FluidErrorTypesAlpha` and reorganized exports
packages/utils/telemetry-utils/src/error.ts	Updated `LayerIncompatibilityError` to extend `LoggingError` and use the new `FluidErrorTypesAlpha.layerIncompatibilityError` type; removed symbol import
packages/utils/telemetry-utils/src/fluidErrorBase.ts	Simplified `isLayerIncompatibilityError` to check error type directly; removed symbol-based checks; updated imports
.changeset/sweet-groups-love.md	Added changeset documenting the new error type

Abe27342 · 2025-10-31T17:18:52Z

packages/common/core-interfaces/src/error.ts

Worth specifying when an app author can expect this error to be thrown.

Updated the comment.

anthony-murphy · 2025-10-31T17:43:18Z

packages/common/core-interfaces/src/error.ts


+/**
+ * New error types that are still in alpha stage. Once stabilized, they will be moved to FluidErrorTypes.
+ * @legacy @alpha


it doesn't look like this package is setup for legacy/alpha exports. there should be a api-report generated. look at other packages, and PRs. I don't know if docs ever got writtern.

Added api report for alpha APIs. @jason-ha Could you please take a look if it looks fine.

jason-ha

Can also see #25790 that is adding legacy alpha API as reference.

packages/common/core-interfaces/package.json

github-actions · 2025-11-03T21:30:09Z

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

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

 ELIFECYCLE  Command failed with exit code 1.

Abe27342

Code changes look good. I didn't look closely at added configuration files or changeset.

jzaffiro

One small nit but docs look good

jzaffiro · 2025-11-03T22:20:59Z

.changeset/sweet-groups-love.md

+"@fluidframework/container-definitions": minor
+"__section": legacy
+---
+Added a new Fluid error type layerIncompatibilityError


Suggested change

Added a new Fluid error type layerIncompatibilityError

Add a new Fluid error type layerIncompatibilityError

@legacy

… to @legacy @beta (#26068) This PR upgrades the `layerIncompatibilityError` error type and `ILayerIncompatibilityError` interface from legacy alpha to legacy beta status. The error type was originally introduced by #25784 in release 2.72.0 and is now being promoted to a more stable API level. - Moved `layerIncompatibilityError` from `FluidErrorTypesAlpha` to `FluidErrorTypes`. - Updated the `ILayerIncompatibilityError` interface to reference the beta error type. - Updated all usages across the codebase to use the new beta references. [AB#54417](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/54417)

…osoft#25784) Follow up to microsoft#25706. Added a new error type `layerIncompatibilityError` which will be used when a layer incompatibility is detected between Fluid layers. This will help applications detect when an error is because of layer incompatibility and take appropriate steps. The new error type is added as an legacy / alpha API. Since the `FluidErrorTypes` type is legacy / beta, added a `FluidErrorTypesAlpha` type where new error types will be added to stage them. Once the breaking change window has passed, error types will be moved to `FluidErrorTypes`. [AB#51811](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/51811)

@legacy

… to @legacy @beta (microsoft#26068) This PR upgrades the `layerIncompatibilityError` error type and `ILayerIncompatibilityError` interface from legacy alpha to legacy beta status. The error type was originally introduced by microsoft#25784 in release 2.72.0 and is now being promoted to a more stable API level. - Moved `layerIncompatibilityError` from `FluidErrorTypesAlpha` to `FluidErrorTypes`. - Updated the `ILayerIncompatibilityError` interface to reference the beta error type. - Updated all usages across the codebase to use the new beta references. [AB#54417](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/54417)

(compat) Add new error type for layer incompatibility error

6a7cb38

agarwal-navin requested a review from a team as a code owner October 31, 2025 17:01

agarwal-navin requested review from Abe27342 and Copilot October 31, 2025 17:01

github-actions bot added changeset-present base: main PRs targeted against main branch labels Oct 31, 2025

agarwal-navin changed the title ~~(compat) Add new error type for layer incompatibility error~~ (compat) Added a new error type for layer incompatibility error Oct 31, 2025

Copilot AI reviewed Oct 31, 2025

View reviewed changes

Abe27342 reviewed Oct 31, 2025

View reviewed changes

anthony-murphy reviewed Oct 31, 2025

View reviewed changes

Added api extractor for alpha APIs

2a0f9f7

github-actions bot added the public api change Changes to a public API label Oct 31, 2025

agarwal-navin requested a review from jason-ha October 31, 2025 18:31

agarwal-navin added 2 commits October 31, 2025 11:34

Add changeset notes for ContainerErrorTypes

6b8a946

Fix tests to use the new error type

c2ce466

github-actions bot added the area: tests Tests to add, test infrastructure improvements, etc label Oct 31, 2025

Update comments

af70c69

jason-ha reviewed Nov 3, 2025

View reviewed changes

packages/common/core-interfaces/package.json Show resolved Hide resolved

packages/common/core-interfaces/package.json Outdated Show resolved Hide resolved

Update legacyAlpha -> legacy.alpha

f1fd436

Abe27342 approved these changes Nov 3, 2025

View reviewed changes

jzaffiro approved these changes Nov 3, 2025

View reviewed changes

jason-ha approved these changes Nov 3, 2025

View reviewed changes

agarwal-navin merged commit 01d568b into microsoft:main Nov 3, 2025
46 checks passed

agarwal-navin deleted the layerIncompatibilityErrorType branch November 3, 2025 22:33

This was referenced Nov 3, 2025

Upcoming Release: FluidFramework v2.83.0 #22101

Open

Upcoming Release: FluidFramework v2.90.0 tylerbutler/FluidFramework#26

Closed

agarwal-navin mentioned this pull request Nov 5, 2025

Add new error type layerIncompatibilityError to FluidErrorTypes #25813

Closed

agarwal-navin mentioned this pull request Dec 17, 2025

Upgraded 'layerIncompatibilityError' and 'ILayerIncompatibilityError' to @legacy @beta #26068

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(compat) Added a new error type for layer incompatibility error#25784

(compat) Added a new error type for layer incompatibility error#25784
agarwal-navin merged 6 commits intomicrosoft:mainfrom
agarwal-navin:layerIncompatibilityErrorType

agarwal-navin commented Oct 31, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Abe27342 Oct 31, 2025

Uh oh!

agarwal-navin Oct 31, 2025

Uh oh!

anthony-murphy Oct 31, 2025

Uh oh!

agarwal-navin Oct 31, 2025

Uh oh!

jason-ha left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 3, 2025

Uh oh!

Abe27342 left a comment

Uh oh!

jzaffiro left a comment

Uh oh!

jzaffiro Nov 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

	Added a new Fluid error type layerIncompatibilityError
	Add a new Fluid error type layerIncompatibilityError

Conversation

agarwal-navin commented Oct 31, 2025 • 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

Pull Request Overview

Reviewed Changes

Uh oh!

Abe27342 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

agarwal-navin Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

anthony-murphy Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

agarwal-navin Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

jason-ha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 3, 2025

linkcheck output

Uh oh!

Abe27342 left a comment

Choose a reason for hiding this comment

Uh oh!

jzaffiro left a comment

Choose a reason for hiding this comment

Uh oh!

jzaffiro Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

agarwal-navin commented Oct 31, 2025 •

edited

Loading