chore: Skip case due to open bug #38930
Conversation
WalkthroughThe pull request involves modifications to the 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
![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/ServerSide/ApiTests/API_RunValidations_spec.ts (2)
Line range hint
22-26: Consider removing the timeout parameter from GetNClick.According to our guidelines, we should avoid using waits/timeouts. Consider using Cypress's built-in retry-ability instead.
- agHelper.GetNClick(apiPage._apiRunBtn, 0, true, 10000); + agHelper.GetNClick(apiPage._apiRunBtn);
Line range hint
26-26: Enhance assertion coverage.The test uses a single assertion. Consider adding additional assertions to validate the complete error state.
apiPage.ResponseStatusCheck("PE-RST-5000"); + // Add additional assertions + cy.get(ApiEditor.errorMessage).should('be.visible') + .and('contain', 'Invalid URL');
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_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 (7)
- GitHub Check: perform-test / rts-build / build
- GitHub Check: perform-test / client-build / client-build
- GitHub Check: perform-test / server-build / server-unit-tests
- GitHub Check: client-unit-tests / client-unit-tests
- GitHub Check: client-prettier / prettier-check
- GitHub Check: client-lint / client-lint
- GitHub Check: client-build / client-build
🔇 Additional comments (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts (1)
18-19: LGTM! Consider adding a tracking ticket.The skip is well documented with a reference to the bug. However, to ensure this doesn't get forgotten, consider creating a tracking ticket to re-enable these tests once the bug is fixed.
Let's verify if there's already a tracking ticket:
✅ Verification successful
Skip is properly tracked in issue #38156
The test skip is already well-documented and tracked in issue #38156, which also affects other test files. The second skipped test is tracked in Cypress issue #8267. No additional tracking ticket is needed.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any existing tracking tickets gh issue list --search "in:title re-enable API validation tests"Length of output: 66
Script:
#!/bin/bash # Search for references to the bug ID and TODOs rg -i "38156|todo.*api.*validation|fixme.*api.*validation" --type ts # Also check the specific test file content cat "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts"Length of output: 2079
## Description > [!TIP] > _Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team)._ > > _Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR._ 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.Datasource" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/13052804085> > Commit: 8a2b310 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13052804085&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Datasource` > Spec: > <hr>Thu, 30 Jan 2025 13:41:45 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Tests** - Skipped two test cases in the API validation test suite - Added comments referencing bug reports for skipped tests <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Description
Tip
Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).
Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.
Fixes #
Issue Numberor
Fixes
Issue URLWarning
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.Datasource"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13052804085
Commit: 8a2b310
Cypress dashboard.
Tags:
@tag.DatasourceSpec:
Thu, 30 Jan 2025 13:41:45 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit