You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(readme): a plain read that fails counts nothing, even when degraded (LAB-11422) - #322
The README's telemetry paragraph now says a plain read that fails counts nothing, even when degradation returns null (false from exists()) in its place. This covers a backend failure, or an L2 entry that fails to decrypt or decode. The behaviour has been in place since the one-outcome-per-call change (#265): getEntry returns null from the degraded fetch or after recordFailure('l2_decode', …) without recording a hit or a miss, and exists() records only inside its executor callback. The README did not say so.
No actionable comments were generated in the recent review.
Summary by CodeRabbit
Documentation
Clarified how telemetry counts hits and misses for get(), exists(), and wrap() calls, including failed reads and degraded responses.
Walkthrough
The telemetry documentation now describes how plain get() and exists() calls count hits, misses and failed reads. It also states that wrap() calls count one outcome separately.
The README describes hit and miss counting for plain reads. Failed reads count nothing, including when degradation substitutes a return value. It also distinguishes wrap() outcome counting.
cachekit-io/cachekit-ts#265: Its implementation defines the failed-read and wrap() accounting described in this README update.
Suggested reviewers: kodus-27b
Merge Risk: Minimal · up to b20df
The documentation change is ready to merge.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title clearly summarises the README change: failed plain reads count nothing, even when degraded.
Description check
The description explains the telemetry behaviour and the README-only change.
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between 5e08930 and b20df93.
Files selected for processing: 1
packages/cachekit/README.md
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
Head b20df93 against base 5e089301c03b331e4270581b0683b94eec14c363, Node v24.22.2, valgrind-3.26.0. Instructions per op on the main thread (bench:ir --compare); median of the repeats, A/A = (max − min) / median. A workload fails above +2.00% and warns above +1.00% (its own threshold: plaintext-set-1mb at +10.00%, napi-encrypted at +4.00%, warning at half); an A/A over 0.40% reads INCONCLUSIVE.
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
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.
![kodus-27b[bot]](https://avatars.githubusercontent.com/u/223823690?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
The README's telemetry paragraph now says a plain read that fails counts nothing, even when degradation returns
null(falsefromexists()) in its place. This covers a backend failure, or an L2 entry that fails to decrypt or decode. The behaviour has been in place since the one-outcome-per-call change (#265):getEntryreturnsnullfrom the degraded fetch or afterrecordFailure('l2_decode', …)without recording a hit or a miss, andexists()records only inside its executor callback. The README did not say so.README only, with no code change.