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(popover): refactor toggle and close handlers for controlled components #31792

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dmytrohoi
Copy link

@dmytrohoi dmytrohoi commented Jan 10, 2025

SUMMARY

Fixes #25592

Added clearing of popoverLabel and hasCustomLabel states. Merged handlers that works with toggle/close from props and locally implemented in component to work with new column selectors and edit existing ones.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

After:
Screenshot 2025-01-10 о 18 27 31

TESTING INSTRUCTIONS

  1. On the chart table agregattion edit page
  2. Add new column with custom title
  3. Open new popover to add column
  4. Check that column name in popover is default ('My Column')

ADDITIONAL INFORMATION

  • Has associated issue: Table chart : New ad-hoc columns retain the name of previous columns #25592
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Description by Korbit AI

What change is being made?

Refactor the handleTogglePopover and handleClosePopover functions to better accommodate controlled components within ColumnSelectPopoverTrigger.

Why are these changes being made?

The changes ensure that ColumnSelectPopoverTrigger handles both controlled and uncontrolled component cases by delegating toggle and close functionality to external handlers when needed, enhancing flexibility and ensuring consistent behavior across different component states. This approach also consolidates logic, making maintenance easier, though it introduces dependency on the existence of externally provided handlers for controlled components.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

@dosubot dosubot bot added the explore:control Related to the controls panel of Explore label Jan 10, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Functionality Unsafe visibility state access ▹ view
Files scanned
File Path Reviewed
superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopoverTrigger.tsx

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Naming
Database Operations
Documentation
Logging
Error Handling
Systems and Environment
Objects and Data Structures
Readability and Maintainability
Asynchronous Processing
Design Patterns
Third-Party Libraries
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

handleTogglePopover: togglePopover,
handleClosePopover: closePopover,
};
const visible = isControlledComponent ? props.visible! : popoverVisible;
Copy link

Choose a reason for hiding this comment

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

Unsafe visibility state access category Functionality

Tell me more
What is the issue?

Non-null assertion is used on props.visible without ensuring it exists for controlled components.

Why this matters

This could lead to runtime errors if the visible prop is not provided when the component is used in controlled mode.

Suggested change ∙ Feature Preview

Add a validation check or provide a default value:

const visible = isControlledComponent ? props.visible ?? false : popoverVisible;
Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@michael-s-molina michael-s-molina added the review:checkpoint Last PR reviewed during the daily review standup label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
explore:control Related to the controls panel of Explore review:checkpoint Last PR reviewed during the daily review standup size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Table chart : New ad-hoc columns retain the name of previous columns
2 participants