Skip to content
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.

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

chore: Add plugin name to server execution metrics #39413

Open
wants to merge 4 commits into
base: release
Choose a base branch
from

Conversation

ApekshaBhosale
Copy link
Contributor

@ApekshaBhosale ApekshaBhosale commented Feb 24, 2025

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

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.All"

🔍 Cypress test results

Tip

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


Mon, 24 Feb 2025 13:53:45 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Enhanced asynchronous processing for action executions to improve performance and reliability.
    • Implemented caching for multipart data and refined plugin data tagging, providing streamlined operations and clearer tracking during action execution.
    • Added a new property to hold a reference to a Plugin object in the action execution metadata.

Copy link
Contributor

coderabbitai bot commented Feb 24, 2025

Walkthrough

This pull request introduces a new field in the ExecuteActionMetaDTO class and updates the plugin retrieval process in the ActionExecutionSolutionCEImpl class. A Plugin type property named plugin is added to the DTO, and the executeAction method now incorporates a caching mechanism for the ExecuteActionDTO. The plugin is retrieved from the cached data and tagged in the execution result for improved observability.

Changes

File Summary
app/.../dtos/ExecuteActionMetaDTO.java Added a new field Plugin plugin and updated imports to include com.appsmith.server.domains.Plugin.
app/.../solutions/ce/ActionExecutionSolutionCEImpl.java Modified the executeAction method to cache multipart data, retrieve the plugin from the cached ExecuteActionDTO, and tag the execution result with the plugin name.

Possibly related PRs

Suggested labels

Task, Anvil Pod

Suggested reviewers

  • subhrashisdas
  • nidhi-nair
  • rajatagrawal

Poem

In the code’s vast digital expanse,
A new field awakens in a swift advance.
Cached parts and plugins now align,
Making action flows sleek and fine.
Cheers to changes that effortlessly shine!
🚀✨


📜 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 4d57634 and b059249.

📒 Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/ActionExecutionSolutionCEImpl.java (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/ActionExecutionSolutionCEImpl.java
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: server-unit-tests / server-unit-tests
  • GitHub Check: server-spotless / spotless-check

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
🪧 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.

@ApekshaBhosale ApekshaBhosale added the ok-to-test Required label for CI label Feb 24, 2025
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 24, 2025
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/solutions/ce/ActionExecutionSolutionCEImpl.java (1)

302-303: Consider using switchIfEmpty for error handling.

When deriving ExecuteActionDTO from cached parts, consider adding error handling for empty cases.

 Mono<ExecuteActionDTO> executeActionDTOMono =
-        cachedPartsMono.flatMap(parts -> createExecuteActionDTO(Flux.fromIterable(parts)));
+        cachedPartsMono.flatMap(parts -> createExecuteActionDTO(Flux.fromIterable(parts)))
+        .switchIfEmpty(Mono.error(new AppsmithException(AppsmithError.INVALID_PARAMETER, "No parts found")));
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f3eca9b and e882245.

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

3-4: LGTM! The new plugin field improves code efficiency.

The addition of the plugin field to store a reactive reference to the plugin is a good optimization that helps avoid redundant plugin fetching during action execution.

Also applies to: 8-9, 19-19

app/server/appsmith-server/src/main/java/com/appsmith/server/solutions/ce/ActionExecutionSolutionCEImpl.java (4)

291-293: LGTM! Efficient caching of multipart data.

The caching of multipart data using collectList().cache() is a good optimization that prevents multiple reads of the same data.


306-310: LGTM! Efficient plugin caching strategy.

The plugin retrieval and caching strategy is well implemented:

  • Uses proper reactive patterns with flatMap and cache()
  • Stores the plugin in the metadata DTO for reuse

312-319: LGTM! Good observability with plugin name tagging.

The addition of plugin name tagging improves observability in metrics, which is valuable for monitoring and debugging.


345-346: LGTM! Removed redundant plugin fetching.

Good cleanup by removing the redundant plugin fetching in favor of using the cached plugin from the metadata DTO.

Copy link

Failed server tests

  • com.appsmith.server.solutions.ce.ActionExecutionSolutionCEImplTest#testExecuteAPIWithUsualOrderingOfTheParts

createExecuteActionDTO(partFlux).cache();
Mono<Plugin> pluginMono = executeActionDTOMono.flatMap(executeActionDTO -> newActionService
.findById(executeActionDTO.getActionId())
.flatMap(newAction -> pluginService.findById(newAction.getPluginId()))
Copy link
Contributor

@NilanshBansal NilanshBansal Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ApekshaBhosale can you please add a check if newAction.getPluginId() is not null?
You can also add error handling for switchIfEmpty() from both the findById() db calls

Copy link
Contributor

@NilanshBansal NilanshBansal Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ApekshaBhosale can you check the case when executeAction() is called and pluginId is null. This usually happens in the case of JSObject Action.

Also, please handle the case if entire pluginMono is an empty mono here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it. will check. if action id is not present i will throw an appsmith error with http code 400 but what about plugin id not present, i should not be throwing error right? but handle it @NilanshBansal

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes thats correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

js action doesn't get executed on backend at all @NilanshBansal

Copy link

Failed server tests

  • com.appsmith.server.solutions.ce.ActionExecutionSolutionCEImplTest#testExecuteAPIWithUsualOrderingOfTheParts

@appsmithorg appsmithorg deleted a comment from github-actions bot Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants