chore: Strict payloads for update action and gen template API

[sharat87]

Part of #33724.

This PR fixes a few more APIs to pass just the fields that the server expects, and nothing more.

/test sanity datasource

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9648180689
Commit: 874f9f1
Cypress dashboard.
Tags: @tag.Sanity, @tag.Datasource

Summary by CodeRabbit

• Refactor
  • Improved payload structure for updateAction and moveAction methods to enhance API request consistency.
  • Updated updateApplicationTheme method to refine the payload before making API calls.
  • Modified generateTemplatePage method to update the request payload, improving API interaction.

[coderabbitai]

Walkthrough

The recent code changes primarily involve updating the payload structure in various APIs, ensuring more consistent and flexible handling of API requests. The updates target methods in the ActionAPI, AppThemingApi, and PageApi classes, all of which now modify their request payloads to set certain properties to undefined or adjust the structure of nested objects before making PUT requests.

Changes

Files	Change Summary
app/client/src/api/ActionAPI.tsx	Refactored updateAction and moveAction methods to rename action to payload, set certain properties to undefined, and adjust structure for actionConfiguration and datasource.
app/client/src/api/AppThemingApi.tsx	updateApplicationTheme method now uses a payload object instead of directly using theme object, with a new property new set to undefined.
app/client/src/api/PageApi.tsx	generateTemplatePage method now modifies the request object into a payload object and sets pageId to undefined.

Poem

In lines of code where actions move,
Payloads change, new patterns groove.
Themes and pages flow anew,
Structured paths for all they do.
With undefined fields, clear and bright,
APIs now set for flight.
Coders cheer, the job's well done,
Ahead we leap, our software spun.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Outside diff range and nitpick comments (3)

app/client/src/api/AppThemingApi.tsx (1)

Line range hint 1-87: Consider refactoring class to use utility functions.

The class AppThemingApi only contains static members, which could be simplified into a set of utility functions. This would reduce the complexity and improve modularity.

- class AppThemingApi extends API {
+ const AppThemingApi = {
- static async fetchThemes(applicationId: string) {
+ async function fetchThemes(applicationId: string) {
- ...
- }
+ export { fetchThemes, fetchSelected, updateTheme, changeTheme, deleteTheme };

app/client/src/api/ActionAPI.tsx (1)

Line range hint 125-264: Consider refactoring class to use utility functions.

Similar to AppThemingApi, ActionAPI could benefit from being refactored into a set of utility functions instead of a class with only static methods.

- class ActionAPI extends API {
+ const ActionAPI = {
- static async createAction(apiConfig: Partial<Action>) {
+ async function createAction(apiConfig: Partial<Action>) {
- ...
- }
+ export { createAction, fetchActions, updateAction, deleteAction, moveAction };

app/client/src/api/PageApi.tsx (1)

Line range hint 170-323: Consider refactoring class to use utility functions.

PageApi also only contains static members and could be simplified into a set of utility functions, enhancing modularity and reducing complexity.

- class PageApi extends Api {
+ const PageApi = {
- static async fetchPage(pageRequest: FetchPageRequest) {
+ async function fetchPage(pageRequest: FetchPageRequest) {
- ...
- }
+ export { fetchPage, savePage, createPage, updatePage, deletePage };

Tools

Biome

[error] 271-273: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dc79ebb and 874f9f1.

Files selected for processing (3)

• app/client/src/api/ActionAPI.tsx (2 hunks)
• app/client/src/api/AppThemingApi.tsx (1 hunks)
• app/client/src/api/PageApi.tsx (1 hunks)

Additional context used

Biome

app/client/src/api/AppThemingApi.tsx

[error] 5-87: Avoid classes that contain only static members. (lint/complexity/noStaticOnlyClass)

Prefer using simple functions instead of classes with only static members.

app/client/src/api/ActionAPI.tsx

[error] 125-264: Avoid classes that contain only static members. (lint/complexity/noStaticOnlyClass)

Prefer using simple functions instead of classes with only static members.

---

[error] 231-231: Using this in a static context can be confusing. (lint/complexity/noThisInStatic)

this refers to the class.
Unsafe fix: Use the class name instead.

---

[error] 234-234: Using this in a static context can be confusing. (lint/complexity/noThisInStatic)

this refers to the class.
Unsafe fix: Use the class name instead.

app/client/src/api/PageApi.tsx

[error] 170-323: Avoid classes that contain only static members. (lint/complexity/noStaticOnlyClass)

Prefer using simple functions instead of classes with only static members.

---

[error] 189-189: Avoid redundant double-negation. (lint/complexity/noExtraBooleanCast)

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

---

[error] 271-273: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

Additional comments not posted (4)

app/client/src/api/AppThemingApi.tsx (1)

48-54: Refactor to improve payload construction in updateTheme.

The payload construction in updateTheme method explicitly sets new to undefined. This is a good practice to ensure the payload only contains the necessary data. However, consider documenting why new is set to undefined.

app/client/src/api/ActionAPI.tsx (2)

239-251: Refactor moveAction to improve payload construction.

The moveAction method follows a similar pattern to updateAction for payload construction. This consistency is good, but ensure the fields set to undefined are documented for clarity.

---

174-195: Ensure consistency in payload structure for updateAction.

The method updateAction now constructs a payload that omits certain fields and sets others to undefined. This aligns with the PR's goal to make payloads stricter. Ensure that all fields set to undefined are intentionally excluded and document the reason.

app/client/src/api/PageApi.tsx (1)

265-272: Improve clarity in generateTemplatePage method.

The payload construction in generateTemplatePage sets pageId to undefined before making the API call. This is likely to ensure that pageId is not mistakenly sent as part of the payload. Document this explicitly to avoid confusion.