fix: Don't run shadow ListObjects query for request weight=∞ #2572

justincoh · 2025-07-21T19:33:53Z

Description

What problem is being solved?

Right now the shadow list objects query is configured to run on a user-defined % of listObjects requests. However, the new ReverseExpand code, which the shadow resolver is designed to test, falls back to the current implementation (non-weighted) when it receives queries of infinite weight. That means that for some models, the shadow query is just re-running the exact same query as the main list objects query; doing duplicate work and providing no value.

How is it being solved?

Added some additional metadata to prevent running an additional shadow query when it isn't meaningful.

What changes are made to solve it?

If the query is going to skip the weighted graph, we will no longer run the shadow query on it.

Summary by CodeRabbit

Bug Fixes
- Improved handling of shadow queries by preventing reporting on requests that use the old reverse expansion path.
- Enhanced tracking of weighted graph usage in object listing operations for more accurate metadata reporting.

coderabbitai · 2025-07-21T19:34:00Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update the handling of the WasWeightedGraphUsed flag in the ListObjects query evaluation and shadow comparison logic. The flag is now set after reverse expansion, and shadow result comparisons are skipped when the flag indicates the weighted graph was not used.

Changes

File(s)	Change Summary
pkg/server/commands/list_objects.go	Updates `WasWeightedGraphUsed` in `resolutionMetadata` after reverse expansion in `ListObjectsQuery.evaluate`.
pkg/server/commands/list_objects_shadow.go	Adds a conditional to skip shadow result comparison if `WasWeightedGraphUsed` is false.

Estimated code review effort

2 (~15 minutes)

Possibly related PRs

feat: ReverseExpand with weighted graph, non-infinite weights #2529: Modifies weighted graph usage and metadata handling in ListObjects and ReverseExpand queries, directly related to the updated flag management in this PR.

Suggested labels

Skip-Changelog

Suggested reviewers

cikasfm
adriantam

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-07-22T01:42:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.47%. Comparing base (11ac7e4) to head (cf70769).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2572      +/-   ##
==========================================
+ Coverage   90.36%   90.47%   +0.12%     
==========================================
  Files         140      140              
  Lines       19661    19685      +24     
==========================================
+ Hits        17765    17809      +44     
+ Misses       1444     1429      -15     
+ Partials      452      447       -5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

pkg/server/commands/list_objects_shadow.go

cikasfm

LGTM

But is there a way to avoid running the WG query if we know that its in shadow mode and we know we can't use WG and we fallback instead?

pkg/server/commands/reverseexpand/reverse_expand.go

pkg/server/commands/list_objects_shadow.go

don't report shadow listObjects metrics if WG was not used

db7a9ee

justincoh requested a review from a team as a code owner July 21, 2025 19:33

justincoh requested review from poovamraj and Vic-Dev July 21, 2025 19:34

justincoh added the Skip-Changelog Indicates that a PR does not need a changelog entry label Jul 21, 2025

fix shadow query test mock return

5941481

justincoh force-pushed the fix/add-metadata-for-reverse-expand-weighted branch from 0f6c48c to 5941481 Compare July 22, 2025 01:23

add test ensuring no logs if WG didn't run

c961236

poovamraj requested changes Jul 22, 2025

View reviewed changes

pkg/server/commands/list_objects_shadow.go Outdated Show resolved Hide resolved

add comment about code removal once ∞ weight lands

397e756

justincoh requested a review from poovamraj July 22, 2025 14:26

Merge branch 'main' into fix/add-metadata-for-reverse-expand-weighted

e333466

cikasfm reviewed Jul 22, 2025

View reviewed changes

pkg/server/commands/list_objects_shadow.go Outdated Show resolved Hide resolved

cikasfm previously approved these changes Jul 22, 2025

View reviewed changes

skip shadow query if it's not meaningful

490629c

justincoh dismissed cikasfm’s stale review via 490629c July 22, 2025 18:39

poovamraj previously approved these changes Jul 22, 2025

View reviewed changes

update ShouldRunShadowQuery metadata everywhere

22ace9c

justincoh dismissed poovamraj’s stale review via 22ace9c July 22, 2025 19:03

justincoh changed the title ~~fix: Don't report shadow listObjects metrics if WG was not used~~ fix: Don't run shadow ListObjects query for request weight=∞ Jul 22, 2025

Merge branch 'main' into fix/add-metadata-for-reverse-expand-weighted

3c7d8e5

poovamraj previously approved these changes Jul 22, 2025

View reviewed changes

justincoh requested a review from cikasfm July 22, 2025 19:10

ensure node exists before using it

f6bfc35

justincoh dismissed poovamraj’s stale review via f6bfc35 July 22, 2025 20:06

cikasfm reviewed Jul 22, 2025

View reviewed changes

pkg/server/commands/reverseexpand/reverse_expand.go Outdated Show resolved Hide resolved

pkg/server/commands/list_objects_shadow.go Outdated Show resolved Hide resolved

justincoh added 2 commits July 23, 2025 09:13

add much more detailed explainer comment

81060c1

add common shadow log fields

2e77331

justincoh and others added 2 commits July 23, 2025 09:45

lint fix

0387692

Merge branch 'main' into fix/add-metadata-for-reverse-expand-weighted

cf70769

cikasfm approved these changes Jul 23, 2025

View reviewed changes

justincoh merged commit 741ebe9 into main Jul 23, 2025
30 of 34 checks passed

justincoh deleted the fix/add-metadata-for-reverse-expand-weighted branch July 23, 2025 14:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Don't run shadow ListObjects query for request weight=∞ #2572

fix: Don't run shadow ListObjects query for request weight=∞ #2572

Uh oh!

justincoh commented Jul 21, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 21, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

cikasfm left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix: Don't run shadow ListObjects query for request weight=∞ #2572

fix: Don't run shadow ListObjects query for request weight=∞ #2572

Uh oh!

Conversation

justincoh commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

cikasfm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

justincoh commented Jul 21, 2025 •

edited

Loading

coderabbitai bot commented Jul 21, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 22, 2025 •

edited

Loading