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

Added sponsor label toggle to CTA Card #1420

Merged
merged 3 commits into from
Jan 27, 2025
Merged

Added sponsor label toggle to CTA Card #1420

merged 3 commits into from
Jan 27, 2025

Conversation

ronaldlangeveld
Copy link
Member

@ronaldlangeveld ronaldlangeveld commented Jan 27, 2025

ref https://linear.app/ghost/issue/PLG-314/add-sponsor-label-toggle-on-cta-card

  • Wired up the Sponsor Label toggle to the CTA card.

Summary by CodeRabbit

  • New Features

    • Added ability to toggle a sponsor label for Call To Action (CTA) cards.
    • Improved testability of CTA card components with specific test identifiers.
  • Tests

    • Added new end-to-end test to verify sponsor label toggle functionality.

Copy link

coderabbitai bot commented Jan 27, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces enhancements to the Call To Action (CTA) card, focusing on the implementation of a toggle for a sponsor label. Changes include the addition of dataTestId attributes to improve test identification and the introduction of a new function to manage the state of the sponsor label. A corresponding test case has also been added to verify the toggle functionality, ensuring the component's interactivity is effectively tested.

Changes

File Change Summary
packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx Added dataTestId attributes to ToggleSetting and sponsor label p element for improved test identification.
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx Introduced handleHasSponsorLabelChange method to toggle hasSponsorLabel property and updated prop handling.
packages/koenig-lexical/test/e2e/cards/cta-card.test.js Added new test case to verify sponsor label toggle functionality.

Sequence Diagram

sequenceDiagram
    participant User
    participant CtaCard
    participant CallToActionNode
    User->>CtaCard: Click sponsor label toggle
    CtaCard->>CallToActionNode: updateHasSponsorLabel()
    CallToActionNode-->>CtaCard: Toggle hasSponsorLabel
    CtaCard-->>User: Update sponsor label visibility
Loading

Possibly related PRs

Poem

🐰 A toggle for sponsors, oh what delight!
With test IDs so clear, our code shines bright.
Click here, click there, the label appears,
A rabbit's small change brings testing cheers!
Hop, hop, hooray for testable flair! 🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab822d and 3da0d54.

📒 Files selected for processing (2)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@ronaldlangeveld ronaldlangeveld marked this pull request as ready for review January 27, 2025 00:39
Copy link

@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: 0

🧹 Nitpick comments (2)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

66-72: Remove redundant comment.

The comment on line 69 is unnecessary as the code is self-explanatory. Consider removing it for cleaner code.

 const handleHasSponsorLabelChange = (val) => {
     editor.update(() => {
         const node = $getNodeByKey(nodeKey);
-        // get the current value and toggle it
         node.hasSponsorLabel = !node.hasSponsorLabel;
     });
 };
packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1)

178-186: Consider a more descriptive test name.

While the test implementation is good, consider making the test name more descriptive to better indicate what's being tested.

-    test('can toggle has sponsor label', async function () {
+    test('toggles sponsor label visibility when clicking the toggle button', async function () {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e3d763e and 3b127a3.

📒 Files selected for processing (3)
  • packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx (2 hunks)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node 20.11.1
🔇 Additional comments (2)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

97-97: LGTM!

The handler is properly connected to the CtaCard component.

packages/koenig-lexical/src/components/ui/cards/CtaCard.jsx (1)

128-128: LGTM!

Test IDs are consistently named and properly placed on both the toggle control and the label display.

Also applies to: 228-228

Copy link

@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: 0

🧹 Nitpick comments (2)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2)

65-69: Clean up the implementation of handleHasSponsorLabelChange.

The function has a few minor issues:

  1. The val parameter is unused
  2. The comment is redundant
  3. There appears to be a missing closing brace

Apply this diff to clean up the implementation:

-    const handleHasSponsorLabelChange = (val) => {
+    const handleHasSponsorLabelChange = () => {
         editor.update(() => {
             const node = $getNodeByKey(nodeKey);
-            // get the current value and toggle it
             node.hasSponsorLabel = !node.hasSponsorLabel;
+        });
+    };

Line range hint 11-29: Consider migrating to TypeScript for better type safety.

Adding TypeScript or at least PropTypes would help catch issues like unused parameters and provide better documentation of the component's interface. This would be especially helpful for props like hasSponsorLabel that have specific boolean behaviors.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b127a3 and 6ab822d.

📒 Files selected for processing (2)
  • packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (2 hunks)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/koenig-lexical/test/e2e/cards/cta-card.test.js
🔇 Additional comments (1)
packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

100-100: LGTM!

The updateHasSponsorLabel prop is correctly connected to the new handler function, enabling the sponsor label toggle functionality as intended.

@ronaldlangeveld ronaldlangeveld merged commit 5329fa2 into main Jan 27, 2025
2 checks passed
@ronaldlangeveld ronaldlangeveld deleted the plg-314 branch January 27, 2025 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant