chore: cache templates data #33439

AnaghHegde · 2024-05-14T13:49:11Z

Description

Cache the templates data to improve the turn around time

Automation

/ok-to-test tags="@tag.Templates"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9368135903
Commit: 5cbcbd3
Cypress dashboard url: Click here!

Communication

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

Yes
No

Summary by CodeRabbit

New Features
- Introduced caching functionality for application templates and data to improve performance.
Bug Fixes
- Updated error handling for cloud services errors, changing the HTTP status code from 500 to 400.
Tests
- Added test cases to ensure data retrieval accuracy and validate cache utilization for application templates.

coderabbitai · 2024-05-14T13:50:14Z

Walkthrough

The recent updates introduce caching mechanisms for application templates and data within the Appsmith server. Key additions include new data transfer objects (DTOs) for caching, a helper class for cache management, and modifications to the application template service to utilize the new caching functionalities. Additionally, test cases were added to ensure the accuracy and reliability of the caching system.

Changes

File Path	Change Summary
`.../CacheableApplicationJson.java`	Introduced `CacheableApplicationJson` DTO for application JSON data and last update timestamp.
`.../CacheableApplicationTemplate.java`	Introduced `CacheableApplicationTemplate` DTO with a list of `ApplicationTemplate` objects, timestamp, and cache expiry time.
`.../CacheableTemplateHelper.java`	Added `CacheableTemplateHelper` class for caching templates and application data, including methods for retrieval and cache validation.
`.../ApplicationTemplateServiceCEImpl.java`	Refactored to use `CacheableTemplateHelper` for caching and error handling, added logging capabilities.
`.../CacheableTemplateHelperTemplateJsonDataTest.java`	Added test cases for caching application templates and validating cache functionality.
`.../CacheableTemplateHelperTemplateMetadataTest.java`	Added test cases for caching application templates, fetching data from a mock server, and verifying cache functionality.
`.../AppsmithError.java`	Updated `CLOUD_SERVICES_ERROR` HTTP status code from `500` to `400`.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant ApplicationTemplateServiceCEImpl
    participant CacheableTemplateHelper
    participant Cache
    participant Server

    Client->>ApplicationTemplateServiceCEImpl: Request template details
    ApplicationTemplateServiceCEImpl->>CacheableTemplateHelper: getTemplateDetails(templateId, baseUrl)
    CacheableTemplateHelper->>Cache: Check cache for templateId
    alt Cache hit
        Cache-->>CacheableTemplateHelper: Return cached template
    else Cache miss
        CacheableTemplateHelper->>Server: Fetch template details from server
        Server-->>CacheableTemplateHelper: Return template details
        CacheableTemplateHelper->>Cache: Store template details in cache
    end
    CacheableTemplateHelper-->>ApplicationTemplateServiceCEImpl: Return template details
    ApplicationTemplateServiceCEImpl-->>Client: Return template details

Poem

In code we trust, a cache we weave,
For templates swift, no time to grieve.
With helpers strong and tests so bright,
Our data flows both day and night.
Errors tamed, and logs in sight,
Appsmith soars to greater height. 🚀

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

AnaghHegde · 2024-05-14T13:54:09Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-14T13:54:34Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9080612987.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33439.
recreate: .

github-actions · 2024-05-14T14:03:19Z

Deploy-Preview-URL: https://ce-33439.dp.appsmith.com

AnaghHegde · 2024-05-14T17:20:07Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-14T17:20:31Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9083537520.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33439.
recreate: .

github-actions · 2024-05-14T17:29:09Z

Deploy-Preview-URL: https://ce-33439.dp.appsmith.com

...erver/appsmith-server/src/main/java/com/appsmith/server/helpers/CacheableTemplateHelper.java

…o perf/block-drag-and-drop

...erver/appsmith-server/src/main/java/com/appsmith/server/helpers/CacheableTemplateHelper.java

...h-server/src/main/java/com/appsmith/server/services/ce/ApplicationTemplateServiceCEImpl.java

…o perf/block-drag-and-drop

AnaghHegde · 2024-05-23T17:12:55Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-23T17:13:16Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9212140934.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33439.
recreate: .

...r/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateJsonDataTest.java

...r/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateMetadataTest.java

github-actions · 2024-05-31T17:59:51Z

Failed server tests

com.appsmith.server.services.ce.ActionServiceCE_Test#createValidActionWithJustName

mohanarpit · 2024-06-03T07:50:34Z

@AnaghHegde Please resolve the failing tests here. Apart from that, the code LGTM.

…o perf/block-drag-and-drop

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01a3c42 and 7b43c43.

Files selected for processing (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/exceptions/AppsmithError.java (1 hunks)

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

app/server/appsmith-server/src/main/java/com/appsmith/server/exceptions/AppsmithError.java

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b43c43 and 5cbcbd3.

Files selected for processing (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/CacheableTemplateHelper.java (1 hunks)

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

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/CacheableTemplateHelper.java

Tests have been added. Review is complete.

cache templates data

0296eef

AnaghHegde self-assigned this May 14, 2024

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label May 14, 2024

github-actions bot added Enhancement New feature or request Templates Issues related to templates Templates Pod Issues related to Templates and removed Enhancement New feature or request labels May 14, 2024

AnaghHegde added the ok-to-test Required label for CI label May 14, 2024

github-actions bot added the Enhancement New feature or request label May 14, 2024

AnaghHegde marked this pull request as draft May 14, 2024 13:54

github-actions bot removed the Enhancement New feature or request label May 14, 2024

fix method parameters

c955b77

github-actions bot added the Enhancement New feature or request label May 14, 2024

mohanarpit reviewed May 15, 2024

View reviewed changes

...erver/appsmith-server/src/main/java/com/appsmith/server/helpers/CacheableTemplateHelper.java Outdated Show resolved Hide resolved

AnaghHegde added 3 commits May 21, 2024 15:32

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

c240600

…o perf/block-drag-and-drop

chore: add evict cache flow

53d1291

evit cache flow

ad56029

NilanshBansal requested changes May 23, 2024

View reviewed changes

AnaghHegde added 2 commits May 23, 2024 22:41

review comments

c0ae652

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

0b6ce52

…o perf/block-drag-and-drop

fix reference issue

c4ecc4b

mohanarpit reviewed May 31, 2024

View reviewed changes

...r/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateJsonDataTest.java Outdated Show resolved Hide resolved

mohanarpit reviewed May 31, 2024

View reviewed changes

...r/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateMetadataTest.java Show resolved Hide resolved

AnaghHegde added 2 commits May 31, 2024 22:49

update review comment

799f449

review comment

01a3c42

mohanarpit previously approved these changes Jun 3, 2024

View reviewed changes

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

7b43c43

…o perf/block-drag-and-drop

AnaghHegde added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jun 3, 2024

github-actions bot removed the Enhancement New feature or request label Jun 3, 2024

coderabbitai bot reviewed Jun 3, 2024

View reviewed changes

deep copy of POJOs to fix source not modified

5cbcbd3

AnaghHegde dismissed mohanarpit’s stale review via 5cbcbd3 June 4, 2024 13:34

github-actions bot added the Enhancement New feature or request label Jun 4, 2024

AnaghHegde added ok-to-test Required label for CI and removed Enhancement New feature or request ok-to-test Required label for CI labels Jun 4, 2024

github-actions bot added the Enhancement New feature or request label Jun 4, 2024

AnaghHegde requested a review from mohanarpit June 4, 2024 13:36

github-actions bot removed the Enhancement New feature or request label Jun 4, 2024

mohanarpit approved these changes Jun 4, 2024

View reviewed changes

coderabbitai bot reviewed Jun 4, 2024

View reviewed changes

AnaghHegde removed the request for review from NilanshBansal June 4, 2024 14:19

github-actions bot added Enhancement New feature or request and removed Enhancement New feature or request labels Jun 4, 2024

rahulbarwal merged commit a4a4f59 into release Jun 5, 2024
48 checks passed

rahulbarwal deleted the perf/block-drag-and-drop branch June 5, 2024 01:54

rahulbarwal mentioned this pull request Jun 7, 2024

Task: Performance of drag and drop of Building blocks. #33312

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: cache templates data #33439

chore: cache templates data #33439

AnaghHegde commented May 14, 2024 •

edited by mohanarpit

coderabbitai bot commented May 14, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

AnaghHegde commented May 14, 2024

github-actions bot commented May 14, 2024

github-actions bot commented May 14, 2024

AnaghHegde commented May 14, 2024

github-actions bot commented May 14, 2024

github-actions bot commented May 14, 2024

AnaghHegde commented May 23, 2024

github-actions bot commented May 23, 2024

github-actions bot commented May 31, 2024

mohanarpit commented Jun 3, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

chore: cache templates data #33439

chore: cache templates data #33439

Conversation

AnaghHegde commented May 14, 2024 • edited by mohanarpit

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

coderabbitai bot commented May 14, 2024 • edited

Walkthrough

Changes

Sequence Diagram(s) (Beta)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

AnaghHegde commented May 14, 2024

github-actions bot commented May 14, 2024

github-actions bot commented May 14, 2024

AnaghHegde commented May 14, 2024

github-actions bot commented May 14, 2024

github-actions bot commented May 14, 2024

AnaghHegde commented May 23, 2024

github-actions bot commented May 23, 2024

github-actions bot commented May 31, 2024

Failed server tests

mohanarpit commented Jun 3, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

AnaghHegde commented May 14, 2024 •

edited by mohanarpit

coderabbitai bot commented May 14, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)