chore: Improve code #38622
chore: Improve code #38622
Conversation
WalkthroughThe pull request focuses on enhancing the Cypress end-to-end tests for the Admin settings page. The changes introduce more robust test assertions by adding checks for loading states, document readiness, and element visibility. These modifications aim to improve the reliability of the test suite by ensuring the application is in a stable state before executing test interactions. Changes
Possibly related PRs
Suggested Labels
Suggested Reviewers
Poem
Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
the
skip-changelog
|
/ci-test-limit-count run_count=30 update_snapshot=false specs_to_run=cypress/e2e/Regression/ClientSide/AdminSettings/Admin_settings_spec.ts |
|
Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/12745117253. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Admin_settings_spec.ts (2)
30-32: LGTM! Consider consolidating assertions into a custom command.The added assertions improve test reliability. Consider creating a custom command to encapsulate these common assertions for reuse across tests.
// commands.ts Cypress.Commands.add('assertPageReady', () => { agHelper.AssertElementAbsence(locators._loading); assertHelper.AssertDocumentReady(); });
Line range hint
1-258: Consider improving test organization.The test file follows good practices by:
- Using proper locator variables
- Avoiding cy.wait for loading states
- Adding reliable state checks
However, there are opportunities for improvement:
- The repeated assertions could be moved to a custom command or helper function
- Consider grouping related tests using
describeblocks for better organization
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Admin_settings_spec.ts(6 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Admin_settings_spec.ts (1)
Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:
- Follow best practices for Cypress code and e2e automation.
- Avoid using cy.wait in code.
- Avoid using cy.pause in code.
- Avoid using agHelper.sleep().
- Use locator variables for locators and do not use plain strings.
- Use data-* attributes for selectors.
- Avoid Xpaths, Attributes and CSS path.
- Avoid selectors like .btn.submit or button[type=submit].
- Perform logins via API with LoginFromAPI.
- Perform logout via API with LogOutviaAPI.
- Perform signup via API with SignupFromAPI.
- Avoid using it.only.
- Avoid using after and aftereach in test cases.
- Use multiple assertions for expect statements.
- Avoid using strings for assertions.
- Do not use duplicate filenames even with different paths.
- Avoid using agHelper.Sleep, this.Sleep in any file in code.
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: perform-test / client-build / client-build
- GitHub Check: client-unit-tests / client-unit-tests
- GitHub Check: client-lint / client-lint
- GitHub Check: client-build / client-build
🔇 Additional comments (4)
app/client/cypress/e2e/Regression/ClientSide/AdminSettings/Admin_settings_spec.ts (4)
41-42: Same assertions as in the super user test.
64-66: Same assertions as in previous tests.
211-213: Same assertions as in previous tests.
228-230: Same assertions as in previous tests.
|
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12745117253. |
Description
Minor improvement.
Fixes # https://app.zenhub.com/workspaces/qa-63316faf86bb2e170ed2e46b/issues/gh/appsmithorg/appsmith/38320
Automation
/ok-to-test tags="@tag.Settings"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12745102566
Commit: 6fd0683
Cypress dashboard.
Tags:
@tag.SettingsSpec:
Mon, 13 Jan 2025 10:43:28 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit