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

feat: add cypress tests for drag and drop building blocks #33036

Merged
merged 46 commits into from
May 21, 2024

Conversation

jacquesikot
Copy link
Contributor

@jacquesikot jacquesikot commented Apr 29, 2024

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 feat/cypress-tests-for-drag-drop-building-blocks
…o feat/cypress-tests-for-drag-drop-building-blocks
…o feat/cypress-tests-for-drag-drop-building-blocks
@jacquesikot jacquesikot self-assigned this Apr 29, 2024
Copy link
Contributor

coderabbitai bot commented Apr 29, 2024

Walkthrough

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

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0a9bd72 and 07eaa5e.
Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Drag_Drop_Building_Blocks_spec.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Drag_Drop_Building_Blocks_spec.ts

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

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

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: 2

Comment on lines 36 to 53
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");
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines 56 to 78
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");
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@rahulbarwal rahulbarwal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jacquesikot We are again mixing scopes of 2 prs into single one.
Split this one into 2:

  1. just the cypress test.
  2. performance enhancement by not saving skeleton loader.

Also checkout Code rabbits suggestions.. they are good.

@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 16, 2024
@@ -84,7 +84,8 @@ function WidgetCardComponent({
onDragStart?: (e: any) => void;
}) {
const type = `${details.type.split("_").join("").toLowerCase()}`;
const className = `t--widget-card-draggable t--widget-card-draggable-${type}`;
const displayName = details.displayName.split(" ").join("").toLowerCase();
const className = `t--widget-card-draggable t--widget-card-draggable-${type} ${details.type === BUILDING_BLOCK_EXPLORER_TYPE ? `t--widget-card-draggable-${type}-${displayName}` : ""}`;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know the current implementation uses class names, however can we pls pass the selector only needed for testing as a data attribute instead of a class name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change has been made

@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 17, 2024
@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 17, 2024
@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 17, 2024
rahulbarwal
rahulbarwal previously approved these changes May 17, 2024
@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 17, 2024
@jacquesikot jacquesikot added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 17, 2024
@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 20, 2024
Copy link
Contributor

@rahulbarwal rahulbarwal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jacquesikot jacquesikot merged commit 1d5277c into release May 21, 2024
71 checks passed
@jacquesikot jacquesikot deleted the feat/cypress-tests-for-drag-drop-building-blocks branch May 21, 2024 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Building blocks Building blocks on cavas, on templates listing or drag and drop of building blocks. Enhancement New feature or request ok-to-test Required label for CI Task A simple Todo Templates Pod Issues related to Templates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Task: Automation testing for drag and drop building blocks.
4 participants