Fix/precache cleanupresult compat#3483
Open
Ujjwaljain16 wants to merge 2 commits intoGoogleChrome:v7from
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Author
|
waiting for the review |
Author
|
@swissspidy can i get the review? |
Author
|
CI test failing due to version mismatch unrelated to my changes |
Collaborator
|
Thanks for the PR. I don't have much capacity right now, but that unrelated test failure would definitely need fixing first in another PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #3400
Summary
This PR resolves a mismatch between the declared
CleanupResulttype and the actual runtime behavior ofPrecacheController.activate().Currently:
deletedCacheRequestsdeletedURLsdeletedURLsThis leads to an inconsistent public API where TypeScript users are guided to use a property that does not exist at runtime.
Changes
Align runtime and types
deletedURLsis now treated as the canonical fieldAdd backward compatibility
deletedCacheRequestsis returned as an alias pointing to the same arrayUpdate type definition
CleanupResultdeletedCacheRequestsas deprecatedUpdate JSDoc
deletedURLsas the primary fielddeletedCacheRequestsAdd test coverage
deletedURLsanddeletedCacheRequestsreturn consistent valuesRationale
deletedURLsas the de facto APIdeletedCacheRequestsfrom types would break existing TypeScript usersThis approach:
Notes
deletedCacheRequestsis now deprecated and can be removed in a future major releasedeletedURLsis more semantically accurate (array of URL strings rather than Request objects)Testing
Risk
Low , this is an additive, backward-compatible change with no impact on runtime logic or precaching behavior