Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Fix JSON binding error caused by incorrectly quoted empty variables in Bruno #186

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

ShuaiweiYu
Copy link
Contributor

@ShuaiweiYu ShuaiweiYu commented Mar 24, 2025

This PR fixes an issue where variable values like user: "" and password: "" in Bruno were resulting in double-quoted strings (e.g. """") after template replacement, which broke JSON validity during request execution.

By removing the surrounding quotes in the variable definitions (e.g. changing user: "" to user:), Bruno correctly replaces them with empty strings (""), producing valid JSON.

This change ensures successful binding of JSON and avoids runtime errors when submitting build jobs.

Summary by CodeRabbit

  • Chores
    • Streamlined build job configurations by updating how default credential values are set.
    • Standardized repository URL definitions to ensure consistent parameter handling.

These behind-the-scenes updates enhance the processing of authentication details and repository information in the build jobs.

Copy link

coderabbitai bot commented Mar 24, 2025

Walkthrough

The changes update the pre-request variable definitions across several build job configuration files. Specifically, the default empty string values for user and password are removed, and quotation marks around repository URLs for test_repo and assignment_repo are eliminated. The URL values remain the same, though one file now references a template repository while the others reference a solution repository. These modifications affect how these variables are interpreted during build job execution.

Changes

File(s) Change Summary
docs/api/Create Build Job (Test Fail).bru In vars:pre-request: removed "" for user and password; removed quotes around URLs so that test_repo becomes https://github.com/Mtze/Artemis-Java-Test.git and assignment_repo becomes https://github.com/Mtze/Artemis-Java-Template.git.
docs/api/Create Build Job (Test Succeed - Result Container).bru,
docs/api/Create Build Job (Test Succeed).bru,
docs/api/Create Build Job (long-running-debug).bru
In vars:pre-request: removed "" for user and password; removed quotes around URLs so that test_repo becomes https://github.com/Mtze/Artemis-Java-Test.git and assignment_repo becomes https://github.com/Mtze/Artemis-Java-Solution.git.

Poem

I'm a rabbit in the codeyard, hopping by,
Removing quotes that once lay high.
User and password set free to roam,
URL fields unquoted, finding their home.
With each gentle tweak and debug delight,
I dance through changes with pure insight.
Happy hops for a cleaner build day and night!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f52bdfd and a52949f.

📒 Files selected for processing (4)
  • docs/api/Create Build Job (Test Fail).bru (1 hunks)
  • docs/api/Create Build Job (Test Succeed - Result Container).bru (1 hunks)
  • docs/api/Create Build Job (Test Succeed).bru (1 hunks)
  • docs/api/Create Build Job (long-running-debug).bru (1 hunks)
🔇 Additional comments (4)
docs/api/Create Build Job (Test Succeed - Result Container).bru (1)

51-54: Changes correctly address the JSON binding error issue

This modification fixes the issue with incorrectly quoted empty variables by removing quotes from variable definitions. The changes include:

  1. Removing empty string quotes from user and password variables
  2. Removing quotes from repository URLs for test_repo and assignment_repo

These changes will prevent the generation of invalid JSON strings (like """") during template replacement, ensuring proper JSON binding when these variables are used in the request body (lines 28-37).

docs/api/Create Build Job (Test Succeed).bru (1)

51-54: Changes correctly fix variable interpolation for JSON binding

The modification follows the same pattern as in other files, removing quotes from variable definitions to prevent invalid JSON generation. The changes ensure that when these variables are interpolated in the metadata section (lines 28-37), they'll produce valid JSON strings.

docs/api/Create Build Job (long-running-debug).bru (1)

51-54: Properly implemented fix for JSON binding issue

The changes in this long-running debug configuration file match the pattern applied to other files, removing quotes from empty variables and repository URLs. This ensures consistent behavior across all build job configurations, preventing JSON binding errors during request execution.

docs/api/Create Build Job (Test Fail).bru (1)

51-54: Changes fix JSON binding while maintaining the test configuration

The changes correctly remove quotes from variables, matching the pattern in other files. Note that this file appropriately uses a Template repository for the assignment_repo URL (line 54) rather than a Solution repository, which is consistent with its purpose as a "Test Fail" configuration.


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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

@Mtze
Copy link
Member

Mtze commented Mar 24, 2025

Thank you for fixing this issue :)

@Mtze Mtze changed the title Fix JSON binding error caused by incorrectly quoted empty variables in Bruno Development: Fix JSON binding error caused by incorrectly quoted empty variables in Bruno Mar 24, 2025
@Mtze Mtze merged commit b511c92 into ls1intum:main Mar 24, 2025
1 of 7 checks passed
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