8000 fix: refactored incoming request parameter name by sondermanish · Pull Request #40231 · appsmithorg/appsmith · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: refactored incoming request parameter name #40231

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 11, 2025
Merged

fix: refactored incoming request parameter name #40231

merged 1 commit into from
Apr 11, 2025

Conversation

sondermanish
Copy link
Contributor
@sondermanish sondermanish commented Apr 11, 2025 •
edited by github-actions bot
Loading

Description

  • Fixes sync of remote branch in ce

Fixes #40157

Automation

/ok-to-test tags="@tag.Git"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/14409483938
Commit: 71bcdea
Cypress dashboard.
Tags: @tag.Git
Spec:

Fri, 11 Apr 2025 19:13:54 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Refactor
    • Updated the internal naming convention used in Git operations for improved clarity and consistency. This change is entirely under-the-hood, ensuring that end-user functionality and default behaviors remain the same.

@sondermanish sondermanish requested a review from a team as a code owner April 11, 2025 18:16
@sondermanish sondermanish self-assigned this Apr 11, 2025
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Apr 11, 2025 •
edited
Loading

Walkthrough

The pull request renames a method parameter in the getReferences method of the GitApplicationControllerCE class. The parameter is changed from pruneBranches to pruneRefs, and the corresponding service call is updated accordingly. The default value and internal logic remain unchanged, ensuring that the functionality and control flow are preserved.

Changes

File Path Change Summary
app/.../GitApplicationControllerCE.java Renamed parameter from pruneBranches to pruneRefs in the getReferences method; updated service call accordingly.

Assessment against linked issues

Objective Addressed Explanation
Default branch update reflected in the app (#40157) ❌ Parameter renaming does not modify branch sync logic.

Poem

In silent code, a name reborn,
pruneRefs now guides where branches are drawn.
A tiny tweak in Java’s art,
Though logic stays, it plays its part;
Code whispers change at break of dawn.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

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.

@sondermanish sondermanish added the ok-to-test Required label for CI label Apr 11, 2025
@github-actions github-actions bot added Bug Something isn't working Critical This issue needs immediate attention. Drop everything else Git Product Issues related to version control product Needs Triaging Needs attention from maintainers to triage Packages & Git Pod All issues belonging to Packages and Git Production labels Apr 11, 2025
coderabbitai[bot]
coderabbitai bot reviewed Apr 11, 2025
View reviewed changes
Copy link
Contributor
@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)
app/server/appsmith-server/src/main/java/com/appsmith/server/git/controllers/GitApplicationControllerCE.java (1)

249-257: Consider adding documentation for the pruneRefs parameter.

While the parameter rename is appropriate, adding a brief Javadoc comment explaining what "pruning refs" means would improve developer understanding of this API endpoint.

 @JsonView(Views.Public.class)
 @GetMapping("/{branchedApplicationId}/refs")
+ /**
+  * Get references (branches/tags) for an application
+  * @param branchedApplicationId The ID of the application to get references for
+  * @param refType The type of reference to get (branch/tag)
+  * @param pruneRefs When true, removes stale tracking refs that no longer exist on remote
+  * @return A list of references
+  */
 public Mono<ResponseDTO<List<GitRefDTO>>> getReferences(
         @PathVariable String branchedApplicationId,
         @RequestParam(required = false, defaultValue = "branch") RefType refType,
         @RequestParam(required = false, defaultValue = "false") Boolean pruneRefs) {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0260c09 and 71bcdea.

📒 Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/git/controllers/GitApplicationControllerCE.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: server-spotless / spotless-check
  • GitHub Check: server-unit-tests / server-unit-tests
🔇 Additional comments (2)
app/server/appsmith-server/src/main/java/com/appsmith/server/git/controllers/GitApplicationControllerCE.java (2)

252-252: Parameter name update is more semantically accurate.

The renaming from pruneBranches to pruneRefs better aligns with Git terminology, as it can include references beyond just branches (tags, etc.). This change improves API clarity.

255-255: Service call updated consistently with parameter renaming.

The parameter reference in the service call has been correctly updated to use the new parameter name, ensuring consistent implementation throughout the method.

@sondermanish sondermanish enabled auto-merge (squash) April 11, 2025 18:33
@appsmithorg appsmithorg deleted a comment from github-actions bot Apr 11, 2025
@sondermanish sondermanish merged commit 28a629f into release Apr 11, 2025
48 checks passed
@sondermanish sondermanish deleted the fix/sync-branches branch April 11, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@brayn003 brayn003 brayn003 approved these changes

Assignees

@sondermanish sondermanish

Labels
Bug Something isn't working Critical This issue needs immediate attention. Drop everything else Git Product Issues related to version control product Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Packages & Git Pod All issues belonging to Packages and Git Production
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: Change in default branch isn't getting reflected on the app
2 participants
@sondermanish @brayn003
0