GeezerVison is showing github.com — docs(compat): state the compatibility API's support status by armando-navarro · Pull Request #3810 · angular/angularfire
Conversation
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
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
|
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.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
|
Did both: the section now says which tests are off and links #3822, which tracks turning them back on.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Reviewers
+1 more reviewer
Reviewers whose approvals may not affect merge requirements
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
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.
Development
Successfully merging this pull request may close these issues.
Recommended API Version
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|
tyler-reitz
left a comment