Skip to content

⚡ Bolt: [performance improvement] Cache raw bytes instead of parsed dicts in _read_annotations_async - #603

Open
sheepdestroyer wants to merge 4 commits into
masterfrom
jules-9129391600238647080-daf88e6c
Open

⚡ Bolt: [performance improvement] Cache raw bytes instead of parsed dicts in _read_annotations_async#603
sheepdestroyer wants to merge 4 commits into
masterfrom
jules-9129391600238647080-daf88e6c

Conversation

@sheepdestroyer

@sheepdestroyersheepdestroyer commented Aug 27, 2026

Copy link
Copy Markdown
Owner

💡 What: Replaced caching parsed dictionaries and returning copy.deepcopy() with caching raw bytes and returning orjson.loads(cached_bytes) in _read_annotations_async.
🎯 Why: Returning copy.deepcopy() from an in-memory cache is slow and blocks the event loop. Storing raw JSON bytes and deserializing on read is significantly faster for returning safe, non-mutating copies.
📊 Impact: Eliminates blocking event loop operations caused by copy.deepcopy(), improving response times for the dashboard annotations API.
🔬 Measurement: Benchmark copy.deepcopy(dict) versus orjson.loads(bytes) for typical annotation payloads to observe the latency reduction.


PR created automatically by Jules for task 9129391600238647080 started by @sheepdestroyer

Summary by Sourcery

Optimize asynchronous annotation caching to improve response performance while preserving isolated results for callers.

Enhancements:

  • Improve annotation reads by caching raw JSON bytes and deserializing fresh results on demand, avoiding slow deep copies and reducing event-loop blocking.

Tests:

  • Update annotation cache tests to validate byte-based caching, binary file reads, cache invalidation, and mutation-safe results.

Chores:

  • Record the performance guidance for safely copying cached data.

…icts in _read_annotations_async
Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@coderabbitai

coderabbitaiBot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0918283d-3376-419a-92d4-b0e0cbeb09fd


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai

sourcery-aiBot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

The PR optimizes annotation reads by caching raw JSON bytes and parsing them with orjson.loads() per request, preserving non-mutating results while removing event-loop-blocking deep copies; tests and documentation are updated accordingly, with minor unrelated cleanup in the router.

Sequence diagram for optimized annotation cache reads

sequenceDiagram
participant Caller
participant Reader as _read_annotations_async
participant File as AnnotationFile
participant Cache as _annotations_cache
Caller->>Reader: _read_annotations_async(path)
Reader->>Reader: asyncio.to_thread(os.path.getmtime, path)
Reader->>Cache: get(path)
alt cache miss or mtime changed
Reader->>File: aiofiles.open(path, rb)
Reader->>File: read()
File-->>Reader: raw JSON bytes
Reader->>Cache: store mtime and raw_bytes
end
Reader->>Cache: raw_bytes
Reader->>Reader: orjson.loads(raw_bytes)
Reader-->>Caller: parsed annotation dict
Loading

File-Level Changes

ChangeDetailsFiles
Reworked annotation caching to store serialized JSON bytes and deserialize fresh objects on each read, avoiding synchronous deep-copying of cached dictionaries.
  • Switched file reads from text mode to binary mode.
  • Stored file content under raw_bytes with mtime-based invalidation.
  • Returned orjson.loads() results to preserve caller isolation without copy.deepcopy().
  • Updated async cache tests for byte-based storage, cache hits, invalidation, and mutation safety.
router/main.py
tests/test_read_annotations_async.py
Applied minor cleanup and naming improvements in the router module.
  • Removed unused imports and an unnecessary local import.
  • Renamed a token-counting variable for clarity.
router/main.py
Documented the performance lesson behind serialized cache entries.
  • Added guidance favoring raw JSON bytes over deep-copying cached dictionaries in async paths.
.jules/bolt.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation router tests labels Aug 27, 2026

@sourcery-aisourcery-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments### Comment 1
<locationpath="router/main.py"line_range="4431" />
<code_context>
+ _annotations_cache[path] = {"mtime": current_mtime, "raw_bytes": content}- return copy.deepcopy(_annotations_cache[path]["data"])
+ return orjson.loads(_annotations_cache[path]["raw_bytes"])
</code_context>
<issue_to_address>
**issue (performance):**`orjson.loads(_annotations_cache[path]["raw_bytes"])` now runs synchronously on the event-loop thread, whereas the previous cache-miss path parsed with `asyncio.to_thread`; parsing a large annotation payload therefore blocks other async requests during every cache hit and read.
**Triggers:** When the cached annotation JSON is large or many annotation requests are handled concurrently.
**Suggested fix:** Keep JSON deserialization in `asyncio.to_thread`, or otherwise move the CPU-bound parse off the event loop.
```suggestion return await asyncio.to_thread(orjson.loads, _annotations_cache[path]["raw_bytes"])```
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: router/main.py:4431


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment threadrouter/main.py
_annotations_cache[path] = {"mtime": current_mtime, "raw_bytes": content}

return copy.deepcopy(_annotations_cache[path]["data"])
return orjson.loads(_annotations_cache[path]["raw_bytes"])

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (performance):orjson.loads(_annotations_cache[path]["raw_bytes"]) now runs synchronously on the event-loop thread, whereas the previous cache-miss path parsed with asyncio.to_thread; parsing a large annotation payload therefore blocks other async requests during every cache hit and read.

Triggers: When the cached annotation JSON is large or many annotation requests are handled concurrently.

Suggested fix: Keep JSON deserialization in asyncio.to_thread, or otherwise move the CPU-bound parse off the event loop.

Suggested change
returnorjson.loads(_annotations_cache[path]["raw_bytes"])
returnawaitasyncio.to_thread(orjson.loads, _annotations_cache[path]["raw_bytes"])

google-labs-julesBotand others added 3 commits August 27, 2026 05:37
…icts in _read_annotations_async
Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>
…icts in _read_annotations_async
Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>
…icts in _read_annotations_async
Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationroutertests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@sheepdestroyer