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 code-split for Git integration for packages #39166

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

Conversation

subrata71
Copy link
Contributor

@subrata71 subrata71 commented Feb 11, 2025

Description

EE counterpart: https://github.com/appsmithorg/appsmith-ee/pull/6032

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.ImportExport, @tag.Git"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13263436476
Commit: b2f06cc
Cypress dashboard.
Tags: @tag.ImportExport, @tag.Git
Spec:


Tue, 11 Feb 2025 13:46:22 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Improved Git integration when discarding changes by adding extra validation and enhanced error reporting. These enhancements ensure that modifications are handled more reliably, resulting in a smoother and more consistent experience for users.

@subrata71 subrata71 requested a review from a team as a code owner February 11, 2025 06:29
Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

Walkthrough

This pull request updates several components in the Git integration. In the central Git service, the internal logic of the discardChanges method now calls validateAndPublishArtifact instead of publishArtifact, enhancing validation and error logging. Test utilities have been restructured: a new GitApplicationTestUtils class has been introduced, the existing GitArtifactTestUtils has been converted from a concrete class to an interface, and GitTestUtils is refactored to extend the newly added GitTestUtilsCE. These changes streamline artifact diff creation and improve modularity within the Git-related code.

Changes

File(s) Change Summary
app/.../CentralGitServiceCEImpl.java Updated discardChanges method: replaced publishArtifact with validateAndPublishArtifact and enhanced error logging without changing the method signature.
app/.../git/GitApplicationTestUtils.java Introduced a new Spring-managed component that implements GitArtifactTestUtils and adds the createADiff method for Application artifacts.
app/.../git/GitArtifactTestUtils.java Converted from a @Component class to an interface; removed implementation details, retaining the method declaration for createADiff.
app/.../git/GitTestUtils.java
app/.../git/ce/GitTestUtilsCE.java
Refactored GitTestUtils to extend GitTestUtilsCE, removed redundant fields and methods; added GitTestUtilsCE with getArtifactSpecificUtils and createADiffInArtifact methods.

Sequence Diagram(s)

sequenceDiagram
    participant Server as CentralGitServiceCEImpl
    participant GitHelper as GitArtifactHelper
    participant Logger as ErrorLogger
    Server->>GitHelper: Rehydrate artifact from last commit
    Server->>GitHelper: validateAndPublishArtifact(artifact, true)
    alt Exception occurs
        Server->>Logger: Log error details
    end
Loading
sequenceDiagram
    participant TestUtils as GitTestUtilsCE
    participant Util as GitArtifactTestUtils
    participant Artifact as Artifact
    TestUtils->>Util: getArtifactSpecificUtils(artifactType)
    Util-->>TestUtils: Return instance (GitApplicationTestUtils)
    TestUtils->>Util: createADiff(artifact)
    Util-->>TestUtils: Mono<Void> complete signal
Loading

Possibly related PRs

Suggested labels

Enhancement, ok-to-test, Task, Git Product, skip-changelog

Suggested reviewers

  • nidhi-nair

Poem

In the code’s quiet night, changes take flight,
Artifacts reborn with validation so bright,
Test utils reformed in the Git sky so wide,
New patterns and flows now perfectly side by side,
A commit of harmony—our code’s joyful guide! 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@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 11, 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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f44a5f7 and 9e23ae6.

📒 Files selected for processing (5)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/git/central/CentralGitServiceCEImpl.java (1 hunks)
  • app/server/appsmith-server/src/test/utils/com/appsmith/server/git/GitApplicationTestUtils.java (1 hunks)
  • app/server/appsmith-server/src/test/utils/com/appsmith/server/git/GitArtifactTestUtils.java (1 hunks)
  • app/server/appsmith-server/src/test/utils/com/appsmith/server/git/GitTestUtils.java (1 hunks)
  • app/server/appsmith-server/src/test/utils/com/appsmith/server/git/ce/GitTestUtilsCE.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: server-unit-tests / server-unit-tests
  • GitHub Check: server-spotless / spotless-check
🔇 Additional comments (4)
app/server/appsmith-server/src/test/utils/com/appsmith/server/git/GitArtifactTestUtils.java (1)

6-7: LGTM! Clean interface design.

The conversion to a generic interface with a single responsibility is a good design choice, allowing for different implementations per artifact type.

app/server/appsmith-server/src/test/utils/com/appsmith/server/git/GitTestUtils.java (1)

9-12: LGTM! Clean inheritance and DI pattern.

Good use of constructor injection and inheritance to extend the CE functionality.

app/server/appsmith-server/src/test/utils/com/appsmith/server/git/ce/GitTestUtilsCE.java (1)

16-18: Consider handling different artifact types.

The method ignores the artifactType parameter and always returns gitApplicationTestUtils. This might need to be updated when supporting different artifact types in the future.

app/server/appsmith-server/src/main/java/com/appsmith/server/git/central/CentralGitServiceCEImpl.java (1)

2058-2058: Improved validation in discardChanges method.

The change from publishArtifact to validateAndPublishArtifact adds an additional validation layer before publishing the artifact, which enhances error handling and data integrity.


Application application = (Application) artifact;
String pageId = application.getPages().get(0).getId();
Plugin plugin = pluginService.findByPackageName("restapi-plugin").block();
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid blocking calls in reactive code.

The .block() call breaks the reactive chain and could cause performance issues. Consider using reactive operators instead.

-        Plugin plugin = pluginService.findByPackageName("restapi-plugin").block();
+        return pluginService.findByPackageName("restapi-plugin")
+            .flatMap(plugin -> {
+                Datasource datasource = new Datasource();
+                // ... rest of the code
+                return layoutActionService.createSingleAction(action, Boolean.FALSE);
+            })
+            .then();

Committable suggestion skipped: line range outside the PR's diff.

Comment on lines +23 to +26
@Autowired
LayoutActionService layoutActionService;
@Autowired
PluginService pluginService;
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Replace field injection with constructor injection.

Field injection is not recommended. Use constructor injection instead for better testability and explicit dependency declaration.

-    @Autowired
-    LayoutActionService layoutActionService;
-    @Autowired
-    PluginService pluginService;
+    private final LayoutActionService layoutActionService;
+    private final PluginService pluginService;
+
+    public GitApplicationTestUtils(
+            LayoutActionService layoutActionService,
+            PluginService pluginService) {
+        this.layoutActionService = layoutActionService;
+        this.pluginService = pluginService;
+    }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@Autowired
LayoutActionService layoutActionService;
@Autowired
PluginService pluginService;
private final LayoutActionService layoutActionService;
private final PluginService pluginService;
public GitApplicationTestUtils(
LayoutActionService layoutActionService,
PluginService pluginService) {
this.layoutActionService = layoutActionService;
this.pluginService = pluginService;
}

@subrata71 subrata71 added the ok-to-test Required label for CI label Feb 11, 2025
Copy link

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label Feb 18, 2025
@subrata71
Copy link
Contributor Author

Adding comment to keep the PR active

@github-actions github-actions bot removed the Stale label Feb 19, 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.

1 participant