Skip to content

chore: update debug launch config to open Swagger UI#178

Merged
nanotaboada merged 1 commit intomasterfrom
feature/serverreadyaction
Apr 10, 2025
Merged

chore: update debug launch config to open Swagger UI#178
nanotaboada merged 1 commit intomasterfrom
feature/serverreadyaction

Conversation

@nanotaboada
Copy link
Copy Markdown
Owner

@nanotaboada nanotaboada commented Apr 10, 2025

This change is Reviewable

Summary by CodeRabbit

  • New Features
    • Improved the launch process to automatically open a resource page when the application server is ready for use, streamlining access to key documentation and tools.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 10, 2025

Walkthrough

The pull request updates the launch configuration for a Java Spring Boot application in the .vscode/launch.json file. It adds a new configuration version "0.2.0" and introduces a serverReadyAction object. This new object instructs the debugger to monitor the application output for the pattern "Tomcat started on port 9000", and when detected, to open the specified URL externally. The existing Spring profiles argument remains unchanged.

Changes

File Change Summary
.vscode/launch.json Added a new key "version": "0.2.0", introduced serverReadyAction with properties: action: "openExternally", pattern: "Tomcat started on port 9000", and uriFormat: "http://localhost:9000/swagger/index.html". Also adjusted the comma placement for the existing Spring profiles argument.

Sequence Diagram(s)

sequenceDiagram
    actor Developer
    participant VSCode as "VSCode Debugger"
    participant App as "Spring Boot Application"
    participant Browser as "Web Browser"

    Developer->>VSCode: Start Debug Session
    VSCode->>App: Launch Application
    App->>VSCode: Output logs ("Tomcat started on port 9000")
    VSCode->>VSCode: Detect output pattern
    VSCode->>Browser: Open URL "http://localhost:9000/swagger/index.html"
Loading

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 plan to trigger planning for file edits and PR creation.
  • @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.

@qlty-cloud-legacy
Copy link
Copy Markdown

Code Climate has analyzed commit 9cf7d96 and detected 0 issues on this pull request.

View more on Code Climate.

@sonarqubecloud
Copy link
Copy Markdown

@codacy-production
Copy link
Copy Markdown

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (85ad620) 57 57 100.00%
Head commit (9cf7d96) 57 (+0) 57 (+0) 100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#178) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.49%. Comparing base (85ad620) to head (9cf7d96).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #178   +/-   ##
=========================================
  Coverage     96.49%   96.49%           
  Complexity       24       24           
=========================================
  Files             2        2           
  Lines            57       57           
  Branches          6        6           
=========================================
  Hits             55       55           
  Partials          2        2           

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

Copy link
Copy Markdown

@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: 0

🧹 Nitpick comments (1)
.vscode/launch.json (1)

13-17: Server Ready Action Addition:

The serverReadyAction block is well-integrated. It specifies an "action": "openExternally", a matching "pattern": "Tomcat started on port 9000", and the corresponding "uriFormat" pointing to the Swagger UI. This should help streamline the debugging process by automatically opening the Swagger UI once Tomcat is started. As an optional enhancement, consider parameterizing the port and/or Swagger path in case the environment changes in the future.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 85ad620 and 9cf7d96.

📒 Files selected for processing (1)
  • .vscode/launch.json (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
.vscode/launch.json (2)

2-2: Configuration Version Update:

The new "version": "0.2.0" key correctly establishes the configuration format version. This is useful for future-proofing your launch configuration.


12-12: Maintain Argument Consistency:

The "args": "--spring.profiles.active=local", line remains consistent with the existing configuration. The trailing comma now seamlessly supports the addition of the new serverReadyAction object.

@nanotaboada nanotaboada merged commit 77af28d into master Apr 10, 2025
23 checks passed
@nanotaboada nanotaboada deleted the feature/serverreadyaction branch April 10, 2025 21:15
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.

Open Swagger UI in browser on local startup using VS Code launch.json integration

1 participant