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

fix: Anvil toggleable widgets not working when native callbacks are used for AnvilFlexComponent #31125

Merged
merged 4 commits into from
Feb 15, 2024

Conversation

marks0351
Copy link
Contributor

@marks0351 marks0351 commented Feb 14, 2024

Pull Request Template

Use this template to quickly create a well written pull request. Delete all quotes before creating the pull request.

Description

In last weeks effort of cleaning up Editor and Viewer parts of AnvilFlexComponent I had changed synthetic React callbacks to native ones #30780 .
This has resulted in regression of widget toggling of widgets like Checkbox, Switch, etc.
so changing them back to synthetic events by passing callbacks and props to the viewer part of AnvilFlexComponent.

PR fixes following issue(s)

Fixes # (issue number)

if no issue exists, please create an issue and ask the maintainers about this first

Media

A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Chore (housekeeping or task changes that don't impact user perception)
  • This change requires a documentation update

Testing

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration.
Delete anything that is not relevant

  • Manual
  • JUnit
  • Jest
  • Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • PR is being merged under a feature flag

QA activity:

  • Speedbreak features have been covered
  • Test plan covers all impacted features and areas of interest
  • Test plan has been peer reviewed by project stakeholders and other QA members
  • Manually tested functionality on DP
  • We had an implementation alignment call with stakeholders post QA Round 2
  • Cypress test cases have been added and approved by SDET/manual QA
  • Added Test Plan Approved label after Cypress tests were reviewed
  • Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

  • New Features

    • Introduced a new testing suite for validating widget interactions in Anvil Layout Mode, focusing on switch and checkbox widgets.
    • Added new functionalities for switch and checkbox widgets, including selection toggling and state verification.
    • Enhanced Anvil editor components to support custom click behaviors, improving widget interaction in edit mode.
  • Bug Fixes

    • Addressed issues with native click callbacks interfering with widget events.
  • Tests

    • Added comprehensive test cases for new widget functionalities and interactions.
  • Refactor

    • Updated internal logic for widget selection and style adjustments based on interaction states.

@github-actions github-actions bot added the Bug Something isn't working label Feb 14, 2024
@marks0351 marks0351 added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 14, 2024
@marks0351 marks0351 marked this pull request as ready for review February 14, 2024 12:18
Copy link
Contributor

coderabbitai bot commented Feb 14, 2024

Walkthrough

The update introduces enhancements to the Anvil Layout Mode in a web application, focusing on improving the interaction with widget elements like switches and checkboxes. It adds test cases for validating widget clicks, updates widget locators, and introduces a new class for widget interaction. Additionally, it modifies Anvil components to handle click events more effectively, ensuring proper functionality in edit mode, and updates hook logic for better widget style management based on selection and visibility.

Changes

File Path Change Summary
.../cypress/e2e/Regression/ClientSide/Anvil/AnvilWidgetClicking_spec.ts Added test cases for widget clicks in Anvil Layout Mode.
.../cypress/locators/WidgetLocators.ts Added constants for Switch and Checkbox widgets.
.../cypress/support/Objects/ObjectsCore.ts Added wdsWidgets export.
.../cypress/support/Objects/Registry.ts Added WDSWidgets import and static method.
.../cypress/support/Pages/WDSWidgets.ts Introduced WDSWidgets class for widget interaction.
app/client/src/layoutSystems/anvil/common/AnvilFlexComponent.tsx
app/client/src/layoutSystems/anvil/editor/AnvilEditorFlexComponent.tsx
Adjusted for custom click event handling in Anvil components.
.../anvil/editor/hooks/useAnvilWidgetClick.ts
.../anvil/editor/hooks/useAnvilWidgetStyles.ts
Updated hooks for widget selection and style management.
app/client/src/layoutSystems/anvil/utils/types.ts Added onClick and onClickCapture to AnvilFlexComponentProps.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot removed the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 14, 2024
@marks0351
Copy link
Contributor Author

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

Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7901226816.
Workflow: Appsmith External Integration Test Workflow.
Tags: @tag.Anvil.

Copy link

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

@marks0351
Copy link
Contributor Author

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

Copy link

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7911320409.
Workflow: Appsmith External Integration Test Workflow.
Tags: @tag.Anvil.

Copy link

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

@marks0351 marks0351 merged commit f7d4189 into release Feb 15, 2024
15 checks passed
@marks0351 marks0351 deleted the anvil-click-fix branch February 15, 2024 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants