Add a flag to prioritize custom color over variant image

[hta218]

Summary by CodeRabbit

• New Features

  • Enhanced image rendering logic in the VariantOption component, introducing a fallback mechanism for custom images based on a new constant.

• Bug Fixes

  • Improved handling of background colors for fallback images, ensuring correct color swatches are displayed.

[coderabbitai]

Walkthrough

The pull request introduces a new configuration constant in the VariantOption component that modifies the image rendering logic for product variant options. The change provides more flexible control over how images are displayed when a custom swatch image is not defined, with a configurable fallback mechanism that can be controlled through a boolean constant.

Changes

File	Change Summary
app/components/product/.../variant-option.tsx	Added FALLBACK_TO_COLOR_IF_NO_CUSTOM_IMAGE_DEFINED constant to control image fallback behavior

Poem

🐰 A rabbit's tale of pixels bright,
Where images dance with color's might
A switch to toggle, a constant's glee
Fallback or not, now set to be free!
In variant's realm, flexibility reigns 🎨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

app/components/product/variant-option.tsx (3)

16-16: Consider making the constant more approachable or configurable.
The name FALLBACK_TO_COLOR_IF_NO_CUSTOM_IMAGE_DEFINED is quite verbose and might confuse future contributors. If it’s truly a feature toggle, consider making it a configurable setting (e.g., via environment variables or feature flags).

---

159-166: Clarify fallback logic and address the TS error.

1. The naming of FALLBACK_TO_COLOR_IF_NO_CUSTOM_IMAGE_DEFINED can be confusing because when it is true, we actually do not use the variant’s default image as a fallback. A clearer name might be USE_COLOR_INSTEAD_OF_VARIANT_IMAGE.
2. The // @ts-expect-error comment suggests a type mismatch for image. Verify that image aligns with your ProductVariantFragmentFragment["image"] type or refine the condition to avoid forcibly bypassing TypeScript checks if possible.

---

208-208: Validate or sanitize the fallback color value.
The style uses swatchColor?.value || value as a background color. If value is not a valid CSS color string, this can result in unexpected UI or rendering issues. Consider validating or sanitizing the fallback color.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aa4f9f0 and 52cdec7.

📒 Files selected for processing (1)

• app/components/product/variant-option.tsx (3 hunks)

🔇 Additional comments (2)

app/components/product/variant-option.tsx (2)

156-158: Check for consistent case sensitivity and potential missed matches.
This logic searches for a matching color in colorsSwatches using toLowerCase(). Make sure the rest of your codebase is consistent in how it handles color names. If partial or advanced matching is expected, consider including it or clarifying this approach in inline comments or documentation.

---

168-168: Guard image usage when shape is not "circle".
You access image.width and image.height to compute the aspect ratio. Ensure image is defined if the shape is not "circle" or provide a fallback dimension in edge cases where the image is missing to avoid runtime errors.