Skip to content

Conversation

ysmolski
Copy link
Contributor

@ysmolski ysmolski commented Aug 15, 2025

This change fixes the introspection benchmark.

Use the goldie fixture: full_introspection.json
It corresponds to the test "execute full introspection query".

Summary by CodeRabbit

  • Tests
    • Benchmark introspection tests now load expected output from a fixture and normalize it to a canonical JSON form.
    • Assertions updated to use strict string/byte equality (rather than tolerant JSON-aware comparison) to reduce contamination and improve determinism.
    • Expected responses normalized to reduce flakiness and simplify verification.
    • No changes to user-facing functionality or public APIs.

This change fixes the introspection benchmark.

Use the goldie fixture: full_introspection.json
It corresponds to the test "execute full introspection query".
@ysmolski ysmolski requested a review from a team as a code owner August 15, 2025 13:26
Copy link

coderabbitai bot commented Aug 15, 2025

Walkthrough

Replace inline expected JSON in BenchmarkIntrospection with a fixture read from testdata/full_introspection.json, minify it with json.Compact, and switch test assertions to strict string/byte equality (avoid JSONEq). Adds os import. No production API changes.

Changes

Cohort / File(s) Summary of changes
Tests
execution/engine/execution_engine_test.go
Read expected introspection from testdata/full_introspection.json via os.ReadFile; minify fixture with json.Compact to produce a canonical expectedResponse; replace JSON-aware comparisons with strict equality checks (compare writer.String() / bc.writer.Bytes() to expectedResponse using string(...) or bytes.Equal(...)); add comment about avoiding require.JSONEq to prevent timing/contamination; add os import.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 4ab5a4f and f1ff8e1.

📒 Files selected for processing (1)
  • execution/engine/execution_engine_test.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • execution/engine/execution_engine_test.go
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and test (go 1.23 / windows-latest)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch yury/eng-7626-engine-fix-executionbenchmarkintrospection

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

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

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
execution/engine/execution_engine_test.go (1)

4642-4644: Avoid skewing the benchmark when validating mismatches

If bytes.Equal fails, JSONEq unmarshals and compares JSON, which is relatively heavy. Wrap that check with b.StopTimer()/b.StartTimer() so validation doesn’t contaminate timing. With the json.Compact change above, bytes.Equal should pass and this path won’t be hit, but the guard keeps the benchmark robust.

Apply this diff:

-			if !bytes.Equal(expectedResponse, bc.writer.Bytes()) {
-				require.JSONEq(b, string(expectedResponse), bc.writer.String())
-			}
+			if !bytes.Equal(expectedResponse, bc.writer.Bytes()) {
+				b.StopTimer()
+				require.JSONEq(b, string(expectedResponse), bc.writer.String())
+				b.StartTimer()
+			}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1020056 and 52bdcba.

📒 Files selected for processing (1)
  • execution/engine/execution_engine_test.go (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Build and test (go 1.23 / ubuntu-latest)
  • GitHub Check: Build and test (go 1.23 / windows-latest)
🔇 Additional comments (2)
execution/engine/execution_engine_test.go (2)

12-12: Import looks correct for reading the goldie fixture

Adding os is appropriate for using os.ReadFile in the benchmark setup.


4625-4625: Good switch to JSON-aware comparison

Using require.JSONEq here prevents failures due to insignificant formatting differences between the engine output and the fixture.

@ysmolski ysmolski merged commit ef53827 into master Aug 21, 2025
6 checks passed
@ysmolski ysmolski deleted the yury/eng-7626-engine-fix-executionbenchmarkintrospection branch August 21, 2025 11:37
@ysmolski ysmolski changed the title fix: use goldie fixture as expected response chore: use goldie fixture as expected response Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants