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

Do not merge: Flaky test : Peekoverlay #36183

Closed
wants to merge 1 commit into from
Closed

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Sep 9, 2024

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.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10775624863
Commit: 5d98fe2
Cypress dashboard.
Tags: @tag.All
Spec:


Mon, 09 Sep 2024 16:05:04 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores
    • Updated the test specification paths to focus on the PeekOverlay component and the Fork_Template_To_App component.
  • New Features
    • Enhanced end-to-end tests for forking templates, improving reliability and clarity by updating element selectors and streamlining navigation steps.

Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

The pull request modifies the test specifications listed in the limited-tests.txt file, changing references from Fork_Template_spec.js to PeekOverlay_Spec.ts and Fork_Template_To_App_spec.ts. This indicates a shift in testing focus towards the PeekOverlay and Fork_Template_To_App components. The changes are limited to the file paths and do not affect the underlying functionality of the testing framework.

Changes

File Change Summary
Renamed: cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.jscypress/e2e/Regression/ClientSide/PeekOverlay/PeekOverlay_Spec.ts in app/client/cypress/limited-tests.txt
Renamed: cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.jscypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts in app/client/cypress/limited-tests.txt
Modifications to cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts include updated element selectors, new page creation steps, and streamlined navigation actions.

Possibly related PRs

  • fix: Video2 spec flaky fix #36166: The changes in limited-tests.txt reflect a modification in test specification paths, which is related to the changes made in the Video2_Spec.ts file, indicating a shift in focus within the testing framework.

Suggested labels

Bug, skip-changelog, Stale, ok-to-test

Poem

In the realm of tests, a shift we see,
From Forks to Peeks, as clear as can be.
A path now leads to a new overlay,
Where functionality shines in a brighter way.
So let’s embrace this change with cheer,
For testing evolves, year after year! 🎉


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @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 do a full 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 configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20

Copy link

github-actions bot commented Sep 9, 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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0e601a6 and 5d98fe2.

Files selected for processing (1)
  • app/client/cypress/limited-tests.txt (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/client/cypress/limited-tests.txt

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Sep 9, 2024
Copy link

github-actions bot commented Sep 9, 2024

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

***** Repeat Run Summary ***** Total Tests with repeat: 20 Total Passed: 20 Total Failed: 0 Total Skipped: 0 *****************************

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5d98fe2 and 81e0415.

Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts (2 hunks)
  • app/client/cypress/limited-tests.txt (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/client/cypress/limited-tests.txt
Additional context used
Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_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.
Learnings (2)
Common learnings
Learnt from: dipyamanbiswas07
PR: appsmithorg/appsmith#29282
File: app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js:11-17
Timestamp: 2024-01-09T08:39:59.723Z
Learning: The user has clarified that intercepts are called in end-to-end tests, and therefore resetting the feature flag in an `afterEach` hook is not required in their test setup.
app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts (1)
Learnt from: dipyamanbiswas07
PR: appsmithorg/appsmith#29282
File: app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js:11-17
Timestamp: 2024-01-09T08:39:59.723Z
Learning: The user has clarified that intercepts are called in end-to-end tests, and therefore resetting the feature flag in an `afterEach` hook is not required in their test setup.
Additional comments not posted (2)
app/client/cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.ts (2)

18-23: Well done on enhancing the test reliability!

The modifications in this test case, including the use of direct clicks on template cards and the addition of a new page creation step, are well thought out. These changes should help in reducing the flakiness by making the test actions more deterministic and less prone to errors related to UI changes.

Also applies to: 25-25


35-35: Excellent work on structuring the test case!

This test case is well-organized and includes comprehensive checks and assertions that enhance its reliability and robustness. The use of specific locators and helper functions contributes to making the test more maintainable and less prone to errors.

@sagar-qa007 sagar-qa007 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Sep 9, 2024
@sagar-qa007 sagar-qa007 closed this Sep 9, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant