fix: Disallow trailing commas when uploading options lists

[ErlingHauan]

Description

We should not allow trailing commas in option lists, because Apps do not support option lists that contain them.

Related Issue(s)

• #{issue number}

Verification

• Your code builds clean without any errors or warnings
• Manual testing done (required)
• Relevant automated test added (if you find this hard, leave it and we'll help out)

Summary by CodeRabbit

• Bug Fixes
  • Adjusted JSON deserialization options to improve input validation and error handling for option uploads.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the UploadNewOption method in the OptionsService class within the backend's designer services. The change specifically alters the JsonSerializerOptions configuration, removing the previous allowance for trailing commas during JSON deserialization. This adjustment impacts how JSON input is processed, potentially affecting error handling for inputs with trailing commas, while maintaining the method's core logic for option validation and repository management.

Changes

File	Change Summary
backend/src/Designer/Services/Implementation/OptionsService.cs	Modified JsonSerializerOptions in UploadNewOption method to disallow trailing commas during JSON deserialization

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

backend/src/Designer/Services/Implementation/OptionsService.cs (1)

119-119: Consider enhancing error messaging for trailing comma scenarios.

The change correctly disallows trailing commas, but when users upload JSON with trailing commas, they'll receive a generic JsonException. Consider wrapping the deserialization in a try-catch block to provide a more specific error message about trailing commas not being supported.

-            new JsonSerializerOptions { WriteIndented = true });
+            try
+            {
+                new JsonSerializerOptions { WriteIndented = true });
+            }
+            catch (JsonException ex) when (ex.Message.Contains("trailing comma"))
+            {
+                throw new InvalidOptionsFormatException("Trailing commas are not supported in options lists. Please remove any trailing commas from your JSON.");
+            }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0e9be78 and 0df6271.

📒 Files selected for processing (1)

• backend/src/Designer/Services/Implementation/OptionsService.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: Run dotnet build and test (macos-latest)
• GitHub Check: Build environment and run e2e test
• GitHub Check: Run dotnet build and test (windows-latest)
• GitHub Check: Run dotnet build and test (ubuntu-latest)
• GitHub Check: Analyze
• GitHub Check: Run integration tests against actual gitea and db

🔇 Additional comments (1)

backend/src/Designer/Services/Implementation/OptionsService.cs (1)

119-119: Verify the change through unit tests.

The change to disallow trailing commas is a behavioral change that should be verified through unit tests.

Let's check if there are any existing tests for this scenario:

Would you like me to help create a unit test that verifies the rejection of trailing commas?