Repository navigation
docs(bench): add repo allocation micro-benchmarks and remove non-technical docs - #5
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds README documentation for internal repository micro-benchmarks and end-to-end Redis verification, while removing the non-technical social templates document. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="205" />
<code_context>
+| :--- | :---: | :---: | :---: | :---: | :---: |
+| **Cache Hit (`GetByID_CacheHit`)** | 8 | `36.98 ns/op` | ~27.0M ops/sec | `0 B/op` | `0 allocs/op` |
+| **Parallel Contention (`GetByID_Contention`)** | 8 | `42.99 ns/op` | ~23.3M ops/sec | `0 B/op` | `0 allocs/op` |
+| **Cache Miss Fast-Path (`GetByID_CacheMiss`)** | 8 | `73.99 ns/op` | ~13.5M ops/sec | `0 B/op` | `0 allocs/op` |
+| **Cold Miss + Cache Backfill (`GetByID_BackfillPath`)** | 8 | `418.90 ns/op` | ~2.39M ops/sec | `352 B/op` | `2 allocs/op` |
+
</code_context>
<issue_to_address>
**Cache miss work mislabeled**
When readers compare the reported row as a fast-path result, `BenchmarkCacheItemRepo_GetByID_CacheMiss` gets a cache miss on every iteration, then runs the fallback and attempts a cache backfill. Its result therefore includes that work, not a cache-miss fast path.
Rename the row to describe the fallback and backfill work, or change the benchmark to measure an actual fast path.
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: README.md:205
| | :--- | :---: | :---: | :---: | :---: | :---: | | ||
| | **Cache Hit (`GetByID_CacheHit`)** | 8 | `36.98 ns/op` | ~27.0M ops/sec | `0 B/op` | `0 allocs/op` | | ||
| | **Parallel Contention (`GetByID_Contention`)** | 8 | `42.99 ns/op` | ~23.3M ops/sec | `0 B/op` | `0 allocs/op` | | ||
| | **Cache Miss Fast-Path (`GetByID_CacheMiss`)** | 8 | `73.99 ns/op` | ~13.5M ops/sec | `0 B/op` | `0 allocs/op` | |
There was a problem hiding this comment.
🟡 Medium · Cache miss work mislabeled
When readers compare the reported row as a fast-path result, BenchmarkCacheItemRepo_GetByID_CacheMiss gets a cache miss on every iteration, then runs the fallback and attempts a cache backfill. Its result therefore includes that work, not a cache-miss fast path.
Rename the row to describe the fallback and backfill work, or change the benchmark to measure an actual fast path.
Prompt for AI agents
In `README.md` at line 205:
**Cache miss work mislabeled**
When readers compare the reported row as a fast-path result, `BenchmarkCacheItemRepo_GetByID_CacheMiss` gets a cache miss on every iteration, then runs the fallback and attempts a cache backfill. Its result therefore includes that work, not a cache-miss fast path.
Rename the row to describe the fallback and backfill work, or change the benchmark to measure an actual fast path.
Updates README with internal/repo micro-benchmark results and removes social_templates.md.
Summary by Sourcery
Document repository performance and verification results while removing obsolete social media templates.
Enhancements:
Documentation: