chore: client side changes for git api contracts

[sondermanish]

Description

• Client side changes for new git api contracts, non breaking

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

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/13129481728
Commit: 6d93671
Cypress dashboard.
Tags: @tag.Git
Spec:

---

Tue, 04 Feb 2025 08:18:46 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

• New Features
  • Improved Git branch management with updated endpoints for protected branch operations.
  • Introduced new functionality for updating protected branches with enhanced parameters.
• Refactor
  • Standardized naming for commit operations to enhance clarity.
  • Streamlined workspace identification in Git import requests for a more consistent experience.

[coderabbitai]

Walkthrough

The changes update several Git-related client functions and request types in the application. The primary modifications involve renaming the commitMessage parameter to message across functions and interfaces, ensuring consistency in naming. Additionally, the API endpoints for fetching and updating protected branches have been revised to include /protected-branches, and there is a change in how the workspaceId is passed in the Git import request. Control flows remain largely the same, with new functions introduced for handling the revised endpoints based on an isNew flag.

Changes

File(s)	Change Summary
app/.../hooks/useCommit.ts, app/.../requests/commitRequest.types.ts, app/.../sagas/commitSaga.ts	Renamed parameter commitMessage to message in function signatures, interfaces, and saga payloads without altering core logic.
app/.../requests/fetchProtectedBranchesRequest.ts	Updated endpoint URL from /protected to /protected-branches and modified method signature to use a new function (fetchProtectedBranchesRequestNew) when the isNew flag is true.
app/.../requests/gitImportRequest.ts	Changed the API call in gitImportRequestNew by passing workspaceId directly in the options object instead of wrapping it under a params key.
app/.../requests/updateProtectedBranchesRequest.ts	Introduced updateProtectedBranchesRequestNew and updated the old function to use baseArtifactId instead of baseApplicationId, along with modifying the URL endpoint to include /protected-branches.

Possibly related PRs

• chore: git mod - minor fixes #38634: The changes in the main PR, specifically the renaming of the commitMessage parameter to message, are directly related to the modifications in the commitSaga function where the same parameter is renamed.
• chore: git mod - minor fixes #38563: The changes in the main PR involve renaming the commitMessage parameter to message, which aligns with the modifications in the retrieved PR that also involve renaming properties and improving handling of related data structures.
• chore: Git mod - quick action bar control #37912: The changes in the main PR, which involve renaming the commitMessage parameter to message, relate to the modifications in the commitSaga function that also rename commitMessage to message.

Suggested labels

Git Product, Task

Suggested reviewers

• sharat87
• mohanarpit
• yatinappsmith

Poem

A subtle shift in names so bright,
commitMessage takes a sleeker flight.
Endpoints now travel a brand‐new lane,
With branches sung in a cleaner refrain.
Code flows smooth like a whispered breeze,
Cheers to changes — may our commits appease!
🚀💻 Happy coding under the Git trees!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 591f1f5 and 6d93671.

📒 Files selected for processing (2)

• app/client/src/git/requests/fetchProtectedBranchesRequest.ts (1 hunks)
• app/client/src/git/requests/gitImportRequest.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• app/client/src/git/requests/gitImportRequest.ts
• app/client/src/git/requests/fetchProtectedBranchesRequest.ts

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

• GitHub Check: perform-test / rts-build / build
• GitHub Check: perform-test / server-build / server-unit-tests
• GitHub Check: client-prettier / prettier-check
• GitHub Check: client-unit-tests / client-unit-tests
• GitHub Check: client-lint / client-lint
• GitHub Check: client-build / client-build
• GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies

---

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.

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.