test: fix flaky inline editing 2 spec #35426

jacquesikot · 2024-08-05T16:19:27Z

Description

Fix flaky test - Inline_editing_2_spec.js

Related EE PR for fix - https://github.com/appsmithorg/appsmith-ee/pull/4819

Problems
Previous change made to remove the editable checkbox from the columns list on the table property pane made the table.EnableEditableOfColumn obsolete as a method for enabling edit mode on specific columns. There is a newly introduced method toggleColumnEditableViaColSettingsPane was swapped only in some cases, not implemented correctly, and in some other cases, the table.EnableEditableOfColumn still existed, causing the test to fail.

Solution

Fix the implementation of the table.toggleColumnEditableViaColSettingsPane in all instances in the test suit
Replace table.EnableEditableOfColumn with table.toggleColumnEditableViaColSettingsPane in tests
Move standalone values into consts for readability
Remove unused const

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10352974239
Commit: 83116d9
Cypress dashboard.
Tags: @tag.Sanity
Spec:

Mon, 12 Aug 2024 14:08:51 UTC

Communication

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

Yes
No

Summary by CodeRabbit

Bug Fixes
- Improved reliability of inline editing tests for the table widget, ensuring consistent behavior when editing columns.
Improvements
- Enhanced clarity of test case descriptions regarding cell column height behavior with text wrapping.
- Updated height assertions to use constants for better readability and maintainability.
Chores
- Changed focus of limited tests from template-related tests to inline editing functionality tests.

coderabbitai · 2024-08-05T16:19:36Z

Walkthrough

The recent updates to the Cypress test suite for inline editing in the table widget enhance both clarity and consistency. Unused variables have been eliminated, resulting in cleaner code. The editability of columns is now uniformly set to true, bolstering test reliability. Test descriptions have been made clearer, and constants have replaced hard-coded height values, improving maintainability. Overall, these changes streamline the test logic while preserving the core functionality under evaluation.

Changes

Files	Change Summary
`app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js`	Removed unused variable `propPaneBack`, standardized the editable parameter to always use `true`, clarified test descriptions, and updated height assertions to use constants.
`app/client/cypress/limited-tests.txt`	Updated the test specification from `Fork_Template_spec.js` to `Inline_editing_2_spec.js`, refocusing the limited tests on inline editing functionality.

Poem

In the realm of code, where tests reside,
Clarity shines bright, with changes applied.
Unused lines vanished, logic refined,
A table that dances, in tests well-defined.
Constants now guide, like stars in the night,
Simplifying the path, making everything right! 🌟

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.
- @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 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 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration 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.

jacquesikot · 2024-08-05T16:24:04Z

/ci-test-limit

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (6)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (6)
Line range hint 1-1: Use locator variables for selectors.

Avoid using plain strings for selectors. Instead, use locator variables to improve maintainability.
- cy.get(".t--property-pane-section-collapse-savebutton").click();
+ cy.get(commonlocators.saveButton).click();
Line range hint 1-1: Use constants for assertions.

Avoid using plain strings for assertions. Instead, use constants to improve readability and maintainability.
- expect(text).to.equal("discarded!!");
+ const DISCARD_MESSAGE = "discarded!!";
+ expect(text).to.equal(DISCARD_MESSAGE);
52-52: Use locator variables for selectors.

Avoid using plain strings for selectors. Instead, use locator variables to improve maintainability.
- cy.get("[data-colindex=0][data-rowindex=0] .t--inlined-cell-editor input.bp3-input").should("not.be.disabled");
+ cy.get(commonlocators.inlineCellEditor).should("not.be.disabled");
Line range hint 1-1: Use locator variables for selectors.

Avoid using plain strings for selectors. Instead, use locator variables to improve maintainability.
- cy.get("[data-colindex=0][data-rowindex=0] .t--inlined-cell-editor input.bp3-input").should("not.be.disabled");
+ cy.get(commonlocators.inlineCellEditor).should("not.be.disabled");
137-137: Avoid using cy.wait.

Using cy.wait can lead to flaky tests. Instead, use assertions or other commands to wait for the desired state.
- cy.wait(1000);
+ cy.get(commonlocators.textWidgetContainer).should("contain.text", -1);
182-182: Avoid using cy.wait.

Using cy.wait can lead to flaky tests. Instead, use assertions or other commands to wait for the desired state.
- cy.wait(1000);
+ cy.get(commonlocators.textWidgetContainer).should("contain.text", -1);

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 828c6ae and 52b1868.

Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (7 hunks)

Additional context used

Path-based instructions (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (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.

Additional comments not posted (2)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (2)

72-81: LGTM!

The test case is well-written and follows best practices by using constants for expected height values.

Line range hint 95-111: LGTM!

The test case is well-written and follows best practices by using constants for expected height values.

github-actions · 2024-08-05T16:24:38Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10252478508.
Cypress dashboard
PR: #35426.

coderabbitai

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 52b1868 and 71adba8.

Files selected for processing (1)

app/client/cypress/limited-tests.txt (1 hunks)

Additional context used

Path-based instructions (1)

app/client/cypress/limited-tests.txt (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.

Additional comments not posted (1)

app/client/cypress/limited-tests.txt (1)

2-2: Good update! Ensure best practices in the referenced test file.

The test specification has been updated to Inline_editing_2_spec.js. Make sure that this test file adheres to Cypress best practices, such as avoiding cy.wait, using locator variables, and performing logins via API.

jacquesikot · 2024-08-05T17:32:28Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-05T17:32:58Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10253377818.
Cypress dashboard
PR: #35426.

coderabbitai

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 71adba8 and 41cd2e7.

Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (7 hunks)

Files skipped from review as they are similar to previous changes (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js

github-actions · 2024-08-05T17:41:36Z

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

jacquesikot · 2024-08-05T17:42:04Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-05T17:43:01Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10253497535.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-05T17:52:05Z

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

jacquesikot · 2024-08-05T17:55:21Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-05T17:55:50Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10253651022.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-05T18:04:36Z

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

jacquesikot · 2024-08-05T18:08:21Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-05T18:08:53Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10253817873.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-05T18:18:10Z

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

jacquesikot · 2024-08-05T18:23:35Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-05T18:27:12Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10254069050.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-05T18:37:08Z

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

jacquesikot · 2024-08-05T19:03:23Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-06T08:46:23Z

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

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js

coderabbitai

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 41cd2e7 and 83caf57.

Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (9 hunks)

Files skipped from review as they are similar to previous changes (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js

jacquesikot · 2024-08-06T17:37:12Z

/ci-test-limit runId=10252478508

github-actions · 2024-08-06T17:37:45Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10271315975.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-06T17:42:23Z

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

coderabbitai

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 83caf57 and 83116d9.

Files selected for processing (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js (10 hunks)

Files skipped from review as they are similar to previous changes (1)

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js

jacquesikot · 2024-08-09T11:21:17Z

/ci-test-limit

github-actions · 2024-08-09T11:21:51Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10318382771.
Cypress dashboard
PR: #35426.

github-actions · 2024-08-09T11:41:30Z

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

fix test cases

52b1868

jacquesikot self-assigned this Aug 5, 2024

jacquesikot requested review from ApekshaBhosale and sagar-qa007 as code owners August 5, 2024 16:19

github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Aug 5, 2024

add Inline_editing_2_spec.js to limited-tests

71adba8

coderabbitai bot reviewed Aug 5, 2024

View reviewed changes

update DEFAULT_NON_WRAP_CELL_COLUMN_HEIGHT value

41cd2e7

coderabbitai bot reviewed Aug 5, 2024

View reviewed changes

revert limited-tests.txt change

ccf6b95

ApekshaBhosale requested changes Aug 6, 2024

View reviewed changes

app/client/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js Outdated Show resolved Hide resolved

remove redundant cy.wait

83caf57

coderabbitai bot reviewed Aug 6, 2024

View reviewed changes

jacquesikot requested a review from ApekshaBhosale August 7, 2024 08:20

jacquesikot added the Widgets & Accelerators Pod Issues related to widgets & Accelerators label Aug 7, 2024

swap DragDropNVerify for dragAndDropToCanvas in 7 test case

83116d9

coderabbitai bot reviewed Aug 9, 2024

View reviewed changes

ApekshaBhosale approved these changes Aug 12, 2024

View reviewed changes

jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Aug 12, 2024

jacquesikot merged commit 35839c6 into release Aug 12, 2024
74 of 76 checks passed

jacquesikot deleted the test/flaky-inline-editing-2 branch August 12, 2024 16:48

This was referenced Oct 21, 2024

test: Enable skipped test related to Autocomplete #36991

Merged

test: udpated locator for GenetateCrud test #37000

Merged

fix(#16584): filterTableData source of truth #36849

Merged

test: fix tabs skipped test CE #37023

Merged

This was referenced Oct 29, 2024

test: fixed datepicker skipped tests set 2 #37126

Merged

Do not merge running test for fix #37237

Open

This was referenced Nov 6, 2024

test: fix Embedd Spec #37263

Closed

test: Analyse TBP failure WidgetPropertyNavigation #37336

Open

test: Analyse TBP failure RestAPIDatasource #37337

Open

test: fix flaky inline editing 2 spec #35426

test: fix flaky inline editing 2 spec #35426

Conversation

jacquesikot commented Aug 5, 2024 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai bot commented Aug 5, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

jacquesikot commented Aug 5, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 5, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 5, 2024

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

github-actions bot commented Aug 5, 2024

jacquesikot commented Aug 5, 2024

github-actions bot commented Aug 6, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

jacquesikot commented Aug 6, 2024

github-actions bot commented Aug 6, 2024

github-actions bot commented Aug 6, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

jacquesikot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

jacquesikot commented Aug 5, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented Aug 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)