feat: add cypress tests for drag and drop building blocks by jacquesikot · Pull Request #33036 · appsmithorg/appsmith

jacquesikot · 2024-04-29T10:31:03Z

Description

Tip

Adds the following cypress tests suite and cases for building blocks drag and drop
Building_Blocks.ts

Building blocks tag is visible and open by default
If widgets are more than 9, see more button should be visible
Should not show the 'See More' button if widgets are less than 9
Clicking on 'See More' button should show all widgets, and 'See Less' should show max 9 widgets

Fixes #32961

Automation

/ok-to-test tags="@tag.Widget"

🔍 Cypress test results

Tip

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

Communication

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

Yes
No

Summary by CodeRabbit

Tests
- Introduced new tests for the Building Blocks explorer to ensure the visibility of tags, the functionality of "See More" and "See Less" buttons, and proper display behavior for widgets.

…o release

…o feat/cypress-tests-for-drag-drop-building-blocks

coderabbitai · 2024-04-29T10:31:11Z

Walkthrough

The changes focus on enhancing the drag-and-drop functionality for building blocks in the client-side application. This includes adding Cypress tests for automation, updating Redux actions and reducers to handle skeleton loaders, and modifying saga functions to manage widget additions and deletions. The updates ensure smoother interactions and better state management for building blocks.

Changes

Files/Modules	Change Summary
`Drag_Drop_Building_Blocks_spec.ts`	Added imports and constants for testing building blocks explorer functionality.
`WidgetCard.tsx`	Modified `className` assignment logic in `WidgetCardComponent` to include `details.type` and `details.displayName`.

Assessment against linked issues

Objective	Addressed	Explanation
Automation testing for drag and drop building blocks (Issue #32961)	✅
Ensure building blocks explorer functionality is covered (visibility, interaction, drag-drop)	✅
Update Redux actions and reducers to manage skeleton loaders effectively	✅
Modify saga functions to handle widget additions and deletions with skeleton loaders	✅

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.

coderabbitai

Actionable comments posted: 2

coderabbitai · 2024-04-29T10:35:31Z

app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Building_Blocks.ts

+    it("2. If widgets are more than 9, see more button should be visible", () => {
+      featureFlagIntercept({ release_drag_drop_building_blocks_enabled: true });
+      let widgetsInThisTag: string[] = [];
+
+      agHelper
+        .GetElement(`${entityExplorer._widgetTagBuildingBlocks}`)
+        .each(($widgetTag) => {
+          cy.wrap($widgetTag)
+            .find(entityExplorer._widgetCardTitle)
+            .each(($widgetName) => {
+              const value = $widgetName.text();
+              widgetsInThisTag.push(value);
+            });
+        });
+
+      if (widgetsInThisTag.length > MAX_BUILDING_BLOCKS_TO_DISPLAY) {
+        cy.get(entityExplorer._widgetSeeMoreButton).should("be.visible");
+      }


Address the variable scope issue to prevent potential test failures.

The variable widgetsInThisTag is defined outside the .each() block but is used inside it, which might lead to incorrect behavior due to asynchronous execution. Consider defining it inside the .each() block or using a different approach to ensure correct behavior.

coderabbitai · 2024-04-29T10:35:31Z

app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Building_Blocks.ts

+    it("3. Should not show the 'See More' button if widgets are less than 9", () => {
+      featureFlagIntercept({ release_drag_drop_building_blocks_enabled: true });
+
+      // Array to store the names of widgets found
+      const widgetsInThisTag: string[] = [];
+
+      // Find and iterate over each widget card title within the specified tag
+      cy.get(entityExplorer._widgetTagBuildingBlocks)
+        .find(entityExplorer._widgetCardTitle)
+        .each(($widgetName) => {
+          // Extract the text of each widget title
+          const value = $widgetName.text().trim();
+          widgetsInThisTag.push(value);
+        })
+        .then(() => {
+          // After collecting widget names, assert based on the count
+          if (widgetsInThisTag.length < MAX_BUILDING_BLOCKS_TO_DISPLAY) {
+            // If less than 9 widgets, ensure the 'See More' button does not exist
+            cy.get(entityExplorer._widgetSeeMoreButton).should("not.exist");
+          } else {
+            // If 9 or more widgets, ensure the 'See More' button exists
+            cy.get(entityExplorer._widgetSeeMoreButton).should("exist");
+          }


Refactor to remove redundant conditions.

The conditions in lines 73 and 77 are redundant since they are mutually exclusive and handled in the same .then() block. Consider simplifying the logic to enhance readability and maintainability.

app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Building_Blocks.ts

…o feat/cypress-tests-for-drag-drop-building-blocks

rahulbarwal

since we've added a new spec, ran ok-to-test once again to make sure this passes.

jacquesikot added 19 commits January 10, 2024 10:47

remove testid from ForkTemplate modal

3d10db4

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

be509fd

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

5f53f7d

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

4e84de9

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

d34ab5d

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

6c76fc0

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

fbf2da8

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

1435ce3

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

4b77394

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

b348574

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

bc4cafb

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

6e9baea

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

1dd0e9a

…o release

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

8cfa49c

…o release

add 4 cypress test cases for building blocks

e8d2ef0

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

813c3b4

…o feat/cypress-tests-for-drag-drop-building-blocks

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

6c10107

…o feat/cypress-tests-for-drag-drop-building-blocks

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

38eb5ac

…o feat/cypress-tests-for-drag-drop-building-blocks

create base PR

922e49e

jacquesikot requested a review from rahulbarwal April 29, 2024 10:31

jacquesikot self-assigned this Apr 29, 2024

github-actions bot added the Enhancement New feature or request label Apr 29, 2024

jacquesikot marked this pull request as draft April 29, 2024 10:31

jacquesikot mentioned this pull request Apr 29, 2024

fix: refactor widget addition sagas and widget operation sagas to allow gridPosition in pasteSaga #32992

Merged

2 tasks

coderabbitai bot reviewed Apr 29, 2024

View reviewed changes

mohanarpit reviewed Apr 29, 2024

View reviewed changes

app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Building_Blocks.ts Outdated Show resolved Hide resolved

jacquesikot added 3 commits April 30, 2024 11:08

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

df26919

…o feat/cypress-tests-for-drag-drop-building-blocks

push changes to rahul

cc3da8a

added test case for drag and drop BB on canvas

0ce8f9b

jacquesikot added 2 commits May 17, 2024 10:59

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

f1f27d3

…o feat/cypress-tests-for-drag-drop-building-blocks

fix .each redundancy

2b8f502

jacquesikot requested a review from rahulbarwal May 17, 2024 10:14