Explicit logging of cache key and restore key matches #2101
+10
−1
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves cache restoration logging in the restoreCacheV2 functionality by adding explicit differentiation between exact cache key matches and restore key matches. This enhancement addresses issue #1626 by providing clearer debugging information during cache operations.
- Replaces generic cache hit logging with specific messages for exact vs restore key matches
- Adds logic to determine if the matched key differs from the requested key
- Updates test cases to verify the new logging behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/cache/src/cache.ts | Implements conditional logging logic to distinguish between exact key and restore key cache hits |
| packages/cache/tests/restoreCacheV2.test.ts | Adds test assertions to verify the new logging messages are generated correctly |
Comments suppressed due to low confidence (1)
packages/cache/src/cache.ts:267
- The variable name 'isRestoreKeyMatch' is misleading. When request.key !== response.matchedKey, it indicates a restore key was matched, but the variable name suggests it's checking if it IS a restore key match. Consider renaming to 'isExactKeyMatch' with inverted logic or 'matchedRestoreKey' for clarity.
const isRestoreKeyMatch = request.key !== response.matchedKey
BoomchainLabs
approved these changes
Jul 14, 2025
GrantBirki
approved these changes
Jul 17, 2025
danwkennedy
approved these changes
Jul 18, 2025
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: actions/cache#1626
Improve logging for cache restoration in the
restoreCacheV2functionality. It adds more specific log messages to differentiate between cache hits for exact keys and restore keys, enhancing debugging and traceability.