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: Remove BaseController on WorkspaceControllerCE #32254

Merged
merged 2 commits into from
Apr 17, 2024

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented Mar 29, 2024

Continuation on #32216, for WorkspaceController.

Cypress Sanity and Workspace tags passed on EE.

Summary by CodeRabbit

  • Refactor
    • Enhanced the workspace management by improving methods for creating, updating, and deleting workspaces, and fetching default permission groups.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Mar 29, 2024
Copy link

Failed server tests

  • com.appsmith.server.refactors.ce.RefactoringServiceCETest#refactorActionName

Copy link

github-actions bot commented Apr 5, 2024

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 Apr 5, 2024
Copy link

Failed server tests

  • com.appsmith.server.services.ce.ActionServiceCE_Test#testUpdateActionWithValidRangeTimeout

@sharat87 sharat87 marked this pull request as ready for review April 17, 2024 06:07
Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

Walkthrough

The recent update involves refactoring the WorkspaceControllerCE class to enhance code maintainability and readability. Key modifications include the adoption of @RequiredArgsConstructor and @Valid annotations, updates to method signatures, and improved annotation usage across several methods. These changes aim to streamline processes and reinforce validation mechanisms within the workspace management functionalities.

Changes

File Path Change Summary
.../appsmith-server/.../WorkspaceControllerCE.java Refactored to include @RequiredArgsConstructor and @Valid annotations. Updated method signatures and annotations for getByIdAndBranchName, create, update, and delete methods. Modified method for fetching default permission groups.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7e18b9e and 184491e.
Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/WorkspaceControllerCE.java (2 hunks)
Additional comments not posted (6)
app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/WorkspaceControllerCE.java (6)

13-14: Introduction of @Valid and @RequiredArgsConstructor annotations.

These annotations are used to enforce validation on method parameters and to automatically generate constructors with required arguments, enhancing code maintainability and safety.


32-33: Refactor to use @RequiredArgsConstructor.

This change simplifies the constructor management by automatically generating a constructor with required dependencies, improving code cleanliness and reducing boilerplate.


39-41: Update to method getByIdAndBranchName.

The method now directly returns a Mono<ResponseDTO<Workspace>>, simplifying the flow and improving readability.


46-47: Introduction of @Valid annotation in create method.

This ensures that the Workspace object passed to the method meets the validation constraints defined in its class, enhancing data integrity.


52-54: Refactor of update method.

The method signature remains largely the same but is now more consistent with other methods in terms of response handling.


59-61: Simplification in delete method.

The method now handles the deletion process more succinctly, improving the readability and maintainability of the code.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@sharat87 sharat87 merged commit 048e3b0 into release Apr 17, 2024
16 of 18 checks passed
@sharat87 sharat87 deleted the chore/workspace-controller-no-base branch April 17, 2024 06:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants