Skip to content

Promote onAssertionFailure to beta#27282

Merged
brrichards merged 6 commits into
microsoft:mainfrom
brrichards:promote-on-assert
May 26, 2026
Merged

Promote onAssertionFailure to beta#27282
brrichards merged 6 commits into
microsoft:mainfrom
brrichards:promote-on-assert

Conversation

@brrichards
Copy link
Copy Markdown
Contributor

Summary

Promotes onAssertionFailure from @alpha to @beta

onAssertionFailure lets apps register a first chance callback that fires immediately before an assertion failure throws.

The API shape is unchanged only the release tag is updated. The comment in fluid-framework/src/index.ts is updated to match, and the affected API report files are regenerated.

Reviewer Guidance

The review process is outlined on this wiki page.

Copilot AI review requested due to automatic review settings May 11, 2026 23:06
@brrichards brrichards requested a review from a team as a code owner May 11, 2026 23:06
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 11, 2026

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

Based on the diff (40 lines, 9 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 11, 2026

Fleet Review — Clean

No issues found across the reviewer fleet for this run.

View run

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR promotes onAssertionFailure from @alpha to @beta across @fluidframework/core-utils and the fluid-framework bundle, updating the source JSDoc release tag and regenerating the affected API report artifacts.

Changes:

  • Updated onAssertionFailure release tag in @fluidframework/core-utils from @alpha to @beta.
  • Updated fluid-framework re-export comment for onAssertionFailure to reflect the beta promotion and the import source.
  • Regenerated core-utils and fluid-framework API report files to reflect the new release tag.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/framework/fluid-framework/src/index.ts Updates the comment describing the re-export/import rationale for the now-@beta API.
packages/framework/fluid-framework/api-report/fluid-framework.legacy.beta.api.md Regenerated API report to include onAssertionFailure as @beta.
packages/framework/fluid-framework/api-report/fluid-framework.beta.api.md Regenerated API report to include onAssertionFailure as @beta.
packages/framework/fluid-framework/api-report/fluid-framework.alpha.api.md Regenerated API report showing the promoted @beta tag within the alpha surface.
packages/common/core-utils/src/assert.ts Promotes the JSDoc release tag for onAssertionFailure to @beta.
packages/common/core-utils/api-report/core-utils.legacy.beta.api.md Regenerated API report to include onAssertionFailure as @beta.
packages/common/core-utils/api-report/core-utils.beta.api.md Regenerated API report to include onAssertionFailure as @beta.
packages/common/core-utils/api-report/core-utils.alpha.api.md Regenerated API report showing the promoted @beta tag within the alpha surface.

Comment thread packages/framework/fluid-framework/src/index.ts Outdated
Comment thread packages/common/core-utils/src/assert.ts
Comment thread packages/common/core-utils/src/assert.ts Outdated
brrichards and others added 3 commits May 12, 2026 08:32
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: brrichards <brrichards@microsoft.com>
@brrichards brrichards requested a review from a team as a code owner May 21, 2026 18:54
Copy link
Copy Markdown
Contributor

@CraigMacomber CraigMacomber left a comment

Choose a reason for hiding this comment

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

Docs look good to me, and code changes look correct, but still needs API review as this adds a beta API.

@github-actions
Copy link
Copy Markdown
Contributor

🔗 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:
  288859 links
    1925 destination URLs
    2175 URLs ignored
       0 warnings
       0 errors


@brrichards brrichards merged commit 4191b82 into microsoft:main May 26, 2026
36 checks passed
CraigMacomber added a commit that referenced this pull request May 28, 2026
## Description

Add beta entry point to core-utils: it has a beta API now (as ofd
#27282), and the
changeset for that API documents using it via this previously non
existent entry point.
dannimad added a commit that referenced this pull request May 28, 2026
## Description

Two follow-ups after #27399, #27400, #27401 merged:

### 1. Six new untagged asserts in `@fluidframework/tree`

Landed via #27200 (field batch format work):
-
`packages/dds/tree/src/feature-libraries/chunked-forest/codec/chunkDecoding.ts`
(5)
- `packages/dds/tree/src/simple-tree/core/treeNodeKernel.ts` (1)

Tagged with codes `0xcfb`–`0xd00` via `pnpm run policy-check:asserts`.

### 2. Two changesets missed by #27401's release-notes generation

`.changeset/soft-beds-beam.md` and `.changeset/zesty-otters-collab.md`
from
#27212 landed *after* I ran the release-notes generation locally but
*before*
#27401 merged, so they were not picked up by the 2.102.0 release notes
or
changelogs.

Followed the documented revert-and-regenerate flow from
`.claude/skills/fluid-release/references/minor-release-prep.md`:

1. Reverted #27401 (squash commit `cf7e1891a4`) to restore the two
original
   changesets.
2. Ran `pnpm flub generate releaseNotes -g client -t minor` (now sees
all 4).
3. Ran `pnpm flub generate changelog -g client` (consumes all 4
changesets).
4. Manually fixed PR/commit refs for the two restored changesets —
`flub` had
pointed them at the revert commit (`5b7ce7075f` / `#27401`) instead of
their
   original PRs. Corrected in:
- `packages/framework/fluid-framework/CHANGELOG.md` → #27282 /
`4191b82e41`
   - `packages/common/core-utils/CHANGELOG.md` → #27282 / `4191b82e41`
- `packages/common/container-definitions/CHANGELOG.md` → #27269 /
`1f12b8e36e`

The two new changesets (soft-beds-beam, zesty-otters-collab) keep
correct
refs from their original PR #27212.

## Merge order

This PR **must merge before** #27402 (the 2.103.0 version bump).
After this merges, #27402 will need a rebase onto updated `main` (new
`packageVersion.ts` files added by #27200 also need to bump to 2.103.0).

## Reviewer Guidance

The review process is outlined on [this wiki
page](https://github.com/microsoft/FluidFramework/wiki/PR-Guidelines#guidelines).

Please skim `RELEASE_NOTES/2.102.0.md` — it should now have 4 entries
across
✨ Features (1), Legacy API Changes (1), Deprecations (1), and Legacy
(1).

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants