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 ApplicationCreationDTO for Application creation API body #33200

Merged
merged 9 commits into from May 22, 2024

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented May 6, 2024

This PR cleans up the application creation API with stricter validations on the input. We're also moving the workspaceId from the query parameter into the body, so it can be validated togather and all input data is in one place. Simplifies code both in client and server.

No additional changes for EE, and no conflicts either, and al unit and Cypress tests pass.

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

Tip

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

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

github-actions bot commented May 6, 2024

Failed server tests

  • com.appsmith.server.controllers.PageControllerTest#emptyCustomSlugShouldBeOkay
  • com.appsmith.server.services.ce.ActionServiceCE_Test#updateActionShouldSetUpdatedAtField

Copy link

github-actions bot commented May 7, 2024

Failed server tests

  • com.appsmith.server.controllers.PageControllerTest#emptyCustomSlugShouldBeOkay
  • com.appsmith.server.imports.internal.ImportServiceTests#extractFileAndUpdateApplication_addNewPageAfterImport_addedPageRemoved
  • com.appsmith.server.imports.internal.ImportServiceTests#extractFileAndUpdateExistingApplication_existingApplication_applicationNameAndSlugRemainsUnchanged
  • com.appsmith.server.imports.internal.ImportServiceTests#extractFileAndUpdateExistingApplication_gitConnectedApplication_throwUnsupportedOperationException
  • com.appsmith.server.imports.internal.ImportServiceTests#importApplicationInWorkspaceFromGit_WithAppLayoutInEditMode_ImportedAppHasAppLayoutInEditAndViewMode
  • com.appsmith.server.imports.internal.ImportServiceTests#importApplicationInWorkspaceFromGit_WithNavSettingsInEditMode_ImportedAppHasNavSettingsInEditAndViewMode

@sharat87 sharat87 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 7, 2024
@sharat87 sharat87 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 8, 2024
@sharat87 sharat87 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 8, 2024
@sharat87 sharat87 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 16, 2024
@sharat87 sharat87 marked this pull request as ready for review May 17, 2024 01:45
Copy link
Contributor

coderabbitai bot commented May 17, 2024

Walkthrough

The recent changes aim to streamline the application creation process within the system. Updates include simplifying API endpoints and payload structures, introducing new DTOs for application creation, and enhancing validation mechanisms. These improvements focus on improving data handling and validation during application creation, with corresponding updates to test cases to reflect these changes.

Changes

File Path Change Summary
app/client/cypress/support/commands.js
app/client/src/ce/api/ApplicationApi.tsx
Removed workspaceId=* query parameter in cy.intercept call; simplified payload structure in createApplication method.
app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/ApplicationControllerCE.java Updated create method to accept ApplicationCreationDTO.
app/server/appsmith-server/src/main/java/com/appsmith/server/domains/Application.java Added constructor to AppPositioning class; updated NavigationSetting class with @AllArgsConstructor.
app/server/appsmith-server/src/main/java/com/appsmith/server/dtos/ApplicationCreationDTO.java Introduced ApplicationCreationDTO record class for application creation data.
app/server/appsmith-server/src/main/java/com/appsmith/server/dtos/PageCreationDTO.java
app/server/appsmith-server/src/main/java/com/appsmith/server/dtos/PageUpdateDTO.java
Modified annotations for name and icon fields; updated methods for handling null values.
app/server/appsmith-server/src/main/java/com/appsmith/server/meta/validations/IconName.java
app/server/appsmith-server/src/main/java/com/appsmith/server/meta/validations/IconNameValidator.java
Introduced custom annotation and validator for icon name validation.
app/server/appsmith-server/src/test/java/com/appsmith/server/domains/EqualityTest.java Updated AppPositioning instantiation in test method to use Type enum.
Dockerfile Added comment for creating plugins directory in Dockerfile.

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 removed the ok-to-test Required label for CI label May 17, 2024
@sharat87 sharat87 added the ok-to-test Required label for CI label May 17, 2024
@sharat87
Copy link
Member Author

Resolved conflicts, tests pass on EE as well, ready for review again.

@sharat87 sharat87 requested a review from nidhi-nair May 20, 2024 04:23
@sharat87 sharat87 merged commit b831a39 into release May 22, 2024
41 checks passed
@sharat87 sharat87 deleted the chore/application-create-dto branch May 22, 2024 06:06
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.

None yet

3 participants