chore: Strict schema for datasource and action APIs

[sharat87]

Part of #33724. This is an effort to harden the server in terms of what request payloads are acceptable.

/test all

Summary by CodeRabbit

• New Features

  • Enhanced API request payload handling for creating actions to include additional properties, improving data integrity and server-side validation.

• Improvements

  • Refined data manipulation and payload structures in datasource-related API requests for better compatibility with server requirements.

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9626214547
Commit: fe5db45
Cypress dashboard.
Tags: ``
The following are new failures, please fix them before merging the PR:

1. cypress/e2e/Regression/ClientSide/Widgets/RTE/RichTextEditor3_spec.ts
2. cypress/e2e/Regression/ClientSide/Widgets/RTE/RichTextEditor_1_spec.js
3. cypress/e2e/Regression/ClientSide/Widgets/RTE/RichTextEditor_2_spec.js

List of identified flaky tests.

[coderabbitai]

Warning

Review failed

The head commit changed during the review from bd6d527 to fe5db45.

Walkthrough

The recent updates mainly involve refining the payloads for API requests in two key files: ActionAPI.tsx and DatasourcesApi.ts. The ActionAPI class's createAction method now includes additional properties set to undefined to ensure cleaner data handling. Similar adjustments are made in various methods of the DatasourcesApi class, improving the consistency and accuracy of API interactions.

Changes

File	Change Summary
app/client/src/api/ActionAPI.tsx	Modified the createAction method to include additional properties such as isValid, entityReferenceType, and new set to undefined.
app/client/src/api/DatasourcesApi.ts	Restructured data manipulation by removing specific fields, adjusting payload structures, and refining field assignments in several methods.

Poem

In fields of code, APIs play,
Refined with care, in a clever way.
Properties set to undefined,
Cleaner payloads now you'll find.
With each commit, our system grows,
Efficient, clear, like a well-read prose. 🌱

---

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f7b535 and e8265dd.

Files selected for processing (2)

• app/client/src/api/ActionAPI.tsx (2 hunks)
• app/client/src/api/DatasourcesApi.ts (4 hunks)

Additional comments not posted (4)

app/client/src/api/DatasourcesApi.ts (2)

37-66: Consider simplifying the payload manipulation in createDatasource.
[REFACTOR_SUGGESTion]
The payload manipulation in the createDatasource method seems overly complex and repetitive, especially with the nested object and undefined assignments. Consider using a helper function to clean this up, which can be reused across different methods where similar manipulations are needed.

+ function cleanPayload(payload) {
+   const cleanedPayload = {...payload};
+   Object.entries(payload).forEach(([key, value]) => {
+     if (typeof value === 'object' && value !== null) {
+       cleanedPayload[key] = cleanPayload(value);
+     } else {
+       cleanedPayload[key] = undefined;
+     }
+   });
+   return cleanedPayload;
+ }
- // existing code block
+ const cleanedConfig = cleanPayload(datasourceConfig);
+ return API.post(DatasourcesApi.url, cleanedConfig);

---

76-95: Ensure that the testDatasource method handles potential null values safely.

The method manipulates the datasourceConfiguration and its nested connection and ssl objects without null checks. This could lead to runtime errors if these are not defined. Verify that the upstream code ensures these objects are always defined or add necessary null checks.

#!/bin/bash
# Description: Verify upstream null checks for datasourceConfiguration.

# Test: Search for the method usage. Expect: Proper null checks or guarantees that the object is defined.
rg --type typescript $'DatasourcesApi.testDatasource'

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

135-146: Validate the addition of undefined properties in createAction.

The method now includes additional properties (isValid, entityReferenceType, new) set to undefined. It's crucial to confirm that these additions align with the intended schema changes and are handled appropriately by the server.

#!/bin/bash
# Description: Verify server schema handling for new undefined properties.

# Test: Search for server-side handling of new properties. Expect: Proper handling or ignoring of undefined properties.
rg --type typescript $'createAction'

---

183-184: Check the consistency of changes in updateAction.

The updateAction method also manipulates the datasource object like the createAction method, but it appears to handle fewer properties. Verify that all necessary properties are being handled consistently between these methods.

#!/bin/bash
# Description: Verify consistency between createAction and updateAction in handling datasource properties.

# Test: Compare the handling of properties in both methods. Expect: Consistent handling of properties.
rg --type typescript $'ActionAPI.createAction|ActionAPI.updateAction'