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

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9320598934
Commit: 86d38bd
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

cypress/e2e/Regression/ClientSide/Templates/CreateNewAppFromTemplates_spec.ts
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_Existing_app_spec.js
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts

To know the list of identified flaky tests - Refer here

Communication

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

Yes
No

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

Walkthrough

The recent changes introduce caching functionality for application templates and JSON data within the Appsmith server. A new helper class, CacheableTemplateHelper, is added to manage caching operations, and DTO classes CacheableApplicationJson and CacheableApplicationTemplate are created to encapsulate cached data. Additionally, the ApplicationTemplateServiceCEImpl class is refactored to utilize the new caching helper, enhancing performance and reliability.

Changes

File Path	Change Summary
`.../dtos/CacheableApplicationJson.java`	Introduced `CacheableApplicationJson` DTO class for application JSON data and update timestamp.
`.../dtos/CacheableApplicationTemplate.java`	Introduced `CacheableApplicationTemplate` DTO class with a list of `ApplicationTemplate` objects, timestamp, and cache expiry time.
`.../helpers/CacheableTemplateHelper.java`	Added `CacheableTemplateHelper` class with methods for retrieving and clearing cached templates and application data.
`.../services/ce/ApplicationTemplateServiceCEImpl.java`	Refactored to use `CacheableTemplateHelper` for caching; added logging with `@Slf4j`.
`.../helpers/CacheableTemplateHelperTemplateJsonDataTest.java`	Added test cases for caching application templates and validating cache utilization.
`.../helpers/CacheableTemplateHelperTemplateMetadataTest.java`	Added test cases for caching application templates, fetching data, and verifying cache functionality.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant ApplicationTemplateService
    participant CacheableTemplateHelper
    participant Cache

    Client->>ApplicationTemplateService: getActiveTemplates()
    ApplicationTemplateService->>CacheableTemplateHelper: getTemplates(releaseVersion, baseUrl)
    CacheableTemplateHelper->>Cache: Check Cache for Templates
    alt Cache Hit
        Cache->>CacheableTemplateHelper: Return Cached Templates
    else Cache Miss
        CacheableTemplateHelper->>ApplicationTemplateService: Fetch Templates from Source
        ApplicationTemplateService->>CacheableTemplateHelper: Return Templates
        CacheableTemplateHelper->>Cache: Store Templates in Cache
    end
    CacheableTemplateHelper->>ApplicationTemplateService: Return Templates
    ApplicationTemplateService->>Client: Return Templates

sequenceDiagram
    participant Client
    participant ApplicationTemplateService
    participant CacheableTemplateHelper
    participant Cache

    Client->>ApplicationTemplateService: getApplicationJsonFromTemplate(templateId, baseUrl)
    ApplicationTemplateService->>CacheableTemplateHelper: getApplicationByTemplateId(templateId, baseUrl)
    CacheableTemplateHelper->>Cache: Check Cache for Application JSON
    alt Cache Hit
        Cache->>CacheableTemplateHelper: Return Cached Application JSON
    else Cache Miss
        CacheableTemplateHelper->>ApplicationTemplateService: Fetch Application JSON from Source
        ApplicationTemplateService->>CacheableTemplateHelper: Return Application JSON
        CacheableTemplateHelper->>Cache: Store Application JSON in Cache
    end
    CacheableTemplateHelper->>ApplicationTemplateService: Return Application JSON
    ApplicationTemplateService->>Client: Return Application JSON

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 86d38bd and 01a3c42.

Files selected for processing (2)

app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateJsonDataTest.java (1 hunks)
app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateMetadataTest.java (1 hunks)

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

app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateJsonDataTest.java
app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/CacheableTemplateHelperTemplateMetadataTest.java

Warning

Review ran into problems

Problems (1)

Git: Failed to clone repository. Please contact CodeRabbit support.

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

github-actions · 2024-05-29T16:34:56Z

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

github-actions · 2024-05-29T16:43:05Z

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

coderabbitai

Actionable comments posted: 4

Outside diff range and nitpick comments (2)

app/server/appsmith-server/src/test/java/com/appsmith/server/services/ApplicationTemplateServiceUnitTest.java (2)

21-21: The @SpringBootTest annotation is used to enable full auto-configuration and start the Spring application context. This is appropriate for integration tests but might be too heavy for unit tests. Consider using @WebFluxTest or @DataMongoTest if more lightweight contexts are sufficient.

Line range hint 216-265: The test getApplicationJson_cacheIsEmpty_VerifyDataSavedInCache is comprehensive and checks the caching behavior for application JSON data. The use of JSON objects to mock responses is appropriate. However, consider abstracting repetitive setup tasks (like JSON object creation) into helper methods to improve test readability and reduce code duplication.

...th-server/src/test/java/com/appsmith/server/services/ApplicationTemplateServiceUnitTest.java

...r/src/main/java/com/appsmith/server/imports/internal/partial/PartialImportServiceCEImpl.java

…o perf/block-drag-and-drop

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

app/server/appsmith-server/src/main/java/com/appsmith/server/dtos/CacheableApplicationJson.java

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

github-actions · 2024-05-31T15:54:33Z

Failed server tests

com.appsmith.server.helpers.CacheableTemplateHelperTemplateMetadataTest#getTemplateData_cacheIsEmpty_VerifyDataSavedInCache
com.appsmith.server.solutions.AuthenticationServiceTest#testGetAuthorizationCodeURL_validDatasource

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

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

add tests

d930c9d

coderabbitai bot reviewed May 30, 2024

View reviewed changes

AnaghHegde requested a review from mohanarpit May 30, 2024 08:58

mohanarpit reviewed May 30, 2024

View reviewed changes

...r/src/main/java/com/appsmith/server/imports/internal/partial/PartialImportServiceCEImpl.java Show resolved Hide resolved

AnaghHegde requested a review from mohanarpit May 30, 2024 10:19

AnaghHegde added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 30, 2024

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

3deb046

…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 May 31, 2024

reviw changes

2070521

AnaghHegde added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 31, 2024