Skip to content

docs(compat): state the compatibility API's support status - #3810

Merged
armando-navarro merged 3 commits into
angular:mainfrom
armando-navarro:b35-compat-status
Oct 27, 2026
Merged

armando-navarro merged 3 commits into
angular:mainfrom
armando-navarro:b35-compat-status

Conversation

@armando-navarro

@armando-navarro armando-navarro commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

Checklist

  • Issue number for this PR: Recommended API Version #3336
  • Docs included?: yes, this is a docs-only change.
  • Test units included?: no, Markdown only.
  • Breaking change?: no.
  • In a clean directory, yarn install, yarn test run successfully? Not run, the change is two Markdown files. npm run lint passed.

Description

docs/compat.md never said whether @angular/fire/compat is supported, and the v7 upgrade guide still told readers to stop at the compatibility API because the modular API "isn't feature complete", a sentence from the 7.0 release. #3336 asked for a direct answer in 2023 and never got one. This writes the answer down.

Changes

  • docs/compat.md gets a "Support status" section: the compatibility API is still supported, gets bug fixes but no new features, and has no planned removal. A second paragraph says which of its tests are turned off and links Restore the skipped compat Firestore and Storage specs #3822, which tracks turning them back on.
  • docs/version-7-upgrade.md: the bolded line becomes "You can stop here if the compatibility API covers your needs.", followed by the support summary and a link to the new section.

Fixes #3336

docs/compat.md had no statement of whether @angular/fire/compat is
supported, and the v7 upgrade guide still told readers to stop at the
compatibility API because the modular API was not feature complete,
a sentence written for the 7.0 release.

The new section records the decision for 22: the compatibility API is
supported and kept working, its specs run in the same suite, it
receives bug fixes and no new features, and no removal is planned.
The v7 guide line now points at that section.
@armando-navarro armando-navarro added bump: patch Size of the change: a fix or docs change that reaches users comp: compat Compatibility layer for the pre-modular API (src/compat). comp: docs Documentation. type: chore Maintenance with no user-facing behavior change. labels Oct 23, 2026
@armando-navarro armando-navarro added this to the 22.0.0-rc.0 milestone Oct 23, 2026
@tyler-reitz

Copy link
Copy Markdown
Collaborator

The support section says the compatibility API "is kept working on every Angular and Firebase version AngularFire supports", but CI doesn't currently check that for compat Firestore. All 48 skips in the browser run (Executed 112 of 160 (skipped 48)) are compat specs: collection, collectionGroup and document under src/compat/firestore/ are skipped wholesale by a beforeEach pending("These are pretty broken, investigate."), in place since #3586, plus one storage upload spec.

Could the section either qualify the promise for those APIs, or link an issue tracking the skipped specs? Otherwise the first reader whose collectionGroup query breaks on an upgrade will find the docs promised it worked.

The support section said the compatibility API is kept working, but
CI skips the tests for AngularFirestoreCollection,
AngularFirestoreCollectionGroup, AngularFirestoreDocument and one
Cloud Storage upload. The section now says so and links the issue
that tracks turning them back on.
@armando-navarro

Copy link
Copy Markdown
Collaborator Author

Did both: the section now says which tests are off and links #3822, which tracks turning them back on.

@tyler-reitz tyler-reitz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

When you squash, please trim the first commit's body out of the message: it still says the compat specs "run in the same test suite as the modular API" and that the API is "kept working", which the second commit corrects.

@armando-navarro
armando-navarro enabled auto-merge (squash) October 27, 2026 18:37
@armando-navarro
armando-navarro merged commit 1b1a8b6 into angular:main Oct 27, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump: patch Size of the change: a fix or docs change that reaches users comp: compat Compatibility layer for the pre-modular API (src/compat). comp: docs Documentation. type: chore Maintenance with no user-facing behavior change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Recommended API Version

3 participants