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: unified way of writing messages in cypress #33659

Merged
merged 9 commits into from
May 27, 2024

Conversation

ApekshaBhosale
Copy link
Contributor

@ApekshaBhosale ApekshaBhosale commented May 22, 2024

Description

We are using createMessage() and Cypress.env("MESSAGES") in Cypress code to use strings. This can create confusion around the method to use and creates inconsistency in our cypress code base. This PR unifies it by following one way ie Cypress.env("MESSAGES"). MESSAGES is defined in https://github.com/appsmithorg/appsmith/blob/release/app/client/cypress/support/e2e.js#L61

Conversation link - https://theappsmith.slack.com/archives/C06FWBV74GH/p1715753205226649
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.All"

🔍 Cypress test results

Tip

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

Communication

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

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented May 22, 2024

Walkthrough

The changes involve a systematic refactoring of message handling in Cypress tests across various files. Instead of directly importing message constants and functions like createMessage, the code now centralizes message retrieval through Cypress.env("MESSAGES"). This approach enhances maintainability and likely facilitates localization efforts.

Changes

File(s) Change Summary
.../ImportExportForkApplication_spec.js,
.../Migration_Spec.js,
.../ReconnectDatasource_spec.js
Replaced createMessage and IMPORT_APP_SUCCESSFUL usage with Cypress.env("MESSAGES").IMPORT_APP_SUCCESSFUL() for success messages.
.../AbortAction_Spec.ts,
.../ApiBugs_Spec.ts
Replaced createMessage with Cypress.env("MESSAGES").ACTION_EXECUTION_CANCELLED for error messages.
.../API_Pane_spec.js,
.../Page_Load_Spec.js,
.../Omnibar_spec.js
Updated to use Cypress.env("MESSAGES") instead of direct createMessage calls for various constants.
.../Canvas_View_mode.ts Switched from createMessage(CANVAS_VIEW_MODE_TOOLTIP, shortKey) to Cypress.env("MESSAGES").CANVAS_VIEW_MODE_TOOLTIP(shortKey) for tooltip messages.
.../AppPageLayout_spec.js,
.../HomePage.ts
Replaced direct usage of message constants with Cypress.env("MESSAGES") for improved message management.
.../PartialImportExport.ts Substituted createMessage(ERROR_IN_EXPORTING_APP) with Cypress.env("MESSAGES").ERROR_IN_EXPORTING_APP() for error handling.
.../gitSync.js,
.../support/Pages/GitSync.ts
Updated to use Cypress.env("MESSAGES").UNABLE_TO_IMPORT_APP() instead of createMessage(UNABLE_TO_IMPORT_APP) for toast messages.
.../server/appsmith-server/src/main/java/com/appsmith/server/configurations/CommonDBConfig.java Adjusted log message from mentioning "MongoDB" to a more generic "DB" for database configuration.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to full the 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 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.

@ApekshaBhosale ApekshaBhosale added the ok-to-test Required label for CI label May 22, 2024
@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 22, 2024
@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 22, 2024
@abhvsn abhvsn added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 22, 2024
Copy link

Failed server tests

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

@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 23, 2024
@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 23, 2024
@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 24, 2024
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: 0

Outside diff range and nitpick comments (4)
app/client/cypress/e2e/Regression/ClientSide/OtherUIFeatures/Omnibar_spec.js (1)

Line range hint 19-39: Consider refactoring to use arrow functions for consistency and reduced scope complexity.

- it("1.Verify omnibar is present across all pages and validate its fields", function () {
+ it("1.Verify omnibar is present across all pages and validate its fields", () => {

This change aligns with modern JavaScript practices and enhances the readability of the code.

app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/API_Pane_spec.js (1)

Line range hint 22-75: Consider refactoring to use arrow functions for consistency and reduced scope complexity.

- function () {
+ () => {

This change aligns with modern JavaScript practices and enhances the readability of the code.

app/client/cypress/support/Pages/PartialImportExport.ts (1)

Line range hint 160-165: Consider refactoring forEach to for...of for better performance and readability.

- checkboxesInSection.each((element) => {
+ for (const element of checkboxesInSection) {

This change aligns with modern JavaScript practices and enhances the readability and performance of the code.

Also applies to: 169-171, 183-185

app/client/cypress/e2e/Regression/Apps/ImportExportForkApplication_spec.js (1)

Line range hint 17-65: Consider refactoring to use arrow functions for consistency and reduced scope complexity.

- function () {
+ () => {

This change aligns with modern JavaScript practices and enhances the readability of the code.

Also applies to: 67-81, 83-164

@ApekshaBhosale ApekshaBhosale added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 27, 2024
@NandanAnantharamu
Copy link
Collaborator

Lgtm

@ApekshaBhosale ApekshaBhosale merged commit 8788fd6 into release May 27, 2024
83 checks passed
@ApekshaBhosale ApekshaBhosale deleted the unified-way-for-messages branch May 27, 2024 13:34
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