chore: Only send uidString to remove a JSLib

[sharat87]

Part of #33724. The server uses only uidString for this API endpoint, which is all we should be sending. The server accepts a few other fields as well today, but doesn't use them. That'll also be fixed in the future, to only accept strictly what's needed.

/test sanity js

Tip

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

Summary by CodeRabbit

• Bug Fixes

  • Improved the updateLibrary method to send specific payload data, enhancing API reliability.

• Logging Improvements

  • Updated log messages in the removeJSLibFromApplication method to exclude version information for better clarity.

[coderabbitai]

Walkthrough

The updates consist of a more specific payload being sent in the updateLibrary method of the LibraryAPI.tsx file, and an update to the log message in the CustomJSLibControllerCE.java file to remove version information from the JS library being removed.

Changes

Files	Change Summary
app/client/src/api/LibraryAPI.tsx	Updated updateLibrary method to send a specific payload { accessor: library.accessor, url: library.url } instead of the entire library object.
app/server/appsmith-server/src/main/java/.../CustomJSLibControllerCE.java	Removed version information from log message in removeJSLibFromApplication method.

Poem

As lines of code align anew,
Payloads find a path more true,
Logs now speak a simpler rhyme,
Version free, in perfect time.
With each tweak, our system grows,
Crafting swift and clever flows.
— A rabbit’s joy, as coding shows. 🐰💻

---

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

Outside diff range and nitpick comments (1)

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

Line range hint 5-33: Consider refactoring to use simple functions instead of a class with only static methods.

Classes with only static methods often signal that a module with simple functions might be more appropriate. This would also address the lint warning and align the design with functional programming practices, which are generally favored in JavaScript for such use cases.

- export default class LibraryApi extends Api {
-   static base_url = "v1/libraries";
-   static getUpdateLibraryBaseURL = (applicationId: string) => `${LibraryApi.base_url}/${applicationId}`;
-   static async addLibrary(applicationId: string, library: Partial<JSLibrary> & { defs: string }) {
-     const url = LibraryApi.getUpdateLibraryBaseURL(applicationId) + "/add";
-     return Api.patch(url, library);
-   }
-   static async removeLibrary(applicationId: string, library: Partial<JSLibrary>) {
-     const url = LibraryApi.getUpdateLibraryBaseURL(applicationId) + "/remove";
-     return Api.patch(url, { uidString: library.uidString });
-   }
-   static async getLibraries(applicationId: string, mode: APP_MODE) {
-     const url = `${LibraryApi.getUpdateLibraryBaseURL(applicationId)}${mode === APP_MODE.PUBLISHED ? "/view" : ""}`;
-     return Api.get(url);
-   }
- }
+ export const base_url = "v1/libraries";
+ export const getUpdateLibraryBaseURL = (applicationId: string) => `${base_url}/${applicationId}`;
+ export async function addLibrary(applicationId: string, library: Partial<JSLibrary> & { defs: string }) {
+   const url = getUpdateLibraryBaseURL(applicationId) + "/add";
+   return Api.patch(url, library);
+ }
+ export async function removeLibrary(applicationId: string, library: Partial<JSLibrary>) {
+   const url = getUpdateLibraryBaseURL(applicationId) + "/remove";
+   return Api.patch(url, { uidString: library.uidString });
+ }
+ export async function getLibraries(applicationId: string, mode: APP_MODE) {
+   const url = `${getUpdateLibraryBaseURL(applicationId)}${mode === APP_MODE.PUBLISHED ? "/view" : ""}`;
+   return Api.get(url);
+ }

Consider this refactor to improve modularity and align with best practices in JavaScript.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 519b53e and 6b5b480.

Files selected for processing (1)

• app/client/src/api/LibraryAPI.tsx (1 hunks)

Additional context used

Biome

app/client/src/api/LibraryAPI.tsx

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

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

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

Line range hint 5-33: Consider refactoring to use utility functions instead of a static-only class.

The static analysis tool has flagged the use of a class that only contains static methods. This can be refactored into a series of utility functions, which may simplify the structure and enhance maintainability.

- export default class LibraryApi extends Api {
-   static base_url = "v1/libraries";
-   ...
- }
+ const base_url = "v1/libraries";
+ export const getUpdateLibraryBaseURL = (applicationId: string) => `${base_url}/${applicationId}`;
+ ...

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6b5b480 and a61fa21.

Files selected for processing (2)

• app/client/src/api/LibraryAPI.tsx (1 hunks)
• app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/CustomJSLibControllerCE.java (1 hunks)

Additional context used

Learnings (2)

Common learnings

User: nidhi-nair
PR: appsmithorg/appsmith#29372
File: app/server/appsmith-server/src/main/java/com/appsmith/server/applications/jslibs/ApplicationJsLibServiceCEImpl.java:51-56
Timestamp: 2023-12-06T08:42:30.719Z
Learning: The `updateJsLibsInContext` method in the `ApplicationJsLibServiceCEImpl` class was mistakenly referred to as a new method in a previous comment. It is important to accurately assess the context of changes in a pull request to avoid misrepresenting the nature of the code modifications.

app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/CustomJSLibControllerCE.java (1)

User: nidhi-nair
PR: appsmithorg/appsmith#29372
File: app/server/appsmith-server/src/main/java/com/appsmith/server/applications/jslibs/ApplicationJsLibServiceCEImpl.java:51-56
Timestamp: 2023-12-06T08:42:30.719Z
Learning: The `updateJsLibsInContext` method in the `ApplicationJsLibServiceCEImpl` class was mistakenly referred to as a new method in a previous comment. It is important to accurately assess the context of changes in a pull request to avoid misrepresenting the nature of the code modifications.

Biome

app/client/src/api/LibraryAPI.tsx

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

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

Additional comments not posted (2)

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

24-24: Refine payload to increase specificity and security.

The change to send only { accessor: library.accessor, url: library.url } is aligned with the PR's objective to ensure that only necessary data is sent. This minimizes potential security risks and reduces bandwidth usage.

app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/CustomJSLibControllerCE.java (1)

64-65: Simplified log statement enhances clarity and reduces potential PII exposure.

Updating the log statement to exclude version information and focus on uidString aligns with the goal of minimizing unnecessary data exposure. This change is a good practice in terms of security and data privacy.