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(picqer): allow not falling back to product image #536

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

martijnvdbrug
Copy link
Member

@martijnvdbrug martijnvdbrug commented Nov 13, 2024

Description

  • make falling back to parent product featured asset configurable, so that only images of variants are synced to Picqer.

Deploy

This needs to happen to deploy this feature, for example:

  • Merge PR
  • Wait until version is published
  • Install 3.4.2 in consumer project

Checklist

📌 Always:

  • I have set a clear title
  • My PR is small and contains a single feature
  • I have checked my own PR

👍 Most of the time:

  • I have added or updated test cases for important functionality
  • I have updated the README if needed

📦 For publishable packages:

Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

Walkthrough

The pull request updates the vendure-plugin-picqer to version 3.4.2, introducing a feature that allows configuration for falling back to a parent product's featured asset when a variant lacks one. It enhances the PicqerService class with improved asset retrieval logic and error handling. Additionally, the PicqerOptions interface and PicqerPlugin class are updated to include new properties for synchronization control, streamlining the initialization process.

Changes

File Path Change Summary
packages/vendure-plugin-picqer/CHANGELOG.md Updated changelog for version 3.4.2, detailing new feature for fallback to parent product's featured asset and previous version modifications.
packages/vendure-plugin-picqer/src/api/picqer.service.ts Modified getFeaturedImageAsBase64 method to include fallback logic for featured assets; enhanced error handling in handlePushVariantsJob method. Updated method signature.
packages/vendure-plugin-picqer/src/picqer.plugin.ts Updated PicqerOptions interface with new properties for sync control; modified init method to simplify initialization logic and set default values. Updated method signature.

Possibly related PRs

  • feat(picqer): added additional order line fields #514: The changes in this PR also involve modifications to the PicqerService class, specifically enhancing the handling of order lines, which is related to the changes made in the main PR regarding the asset retrieval logic and error handling.

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

@martijnvdbrug martijnvdbrug merged commit 661d9b1 into main Nov 13, 2024
40 checks passed
@martijnvdbrug martijnvdbrug deleted the feat/picqer-images branch November 13, 2024 14:47
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fddf1c4 and 9d667b0.

⛔ Files ignored due to path filters (1)
  • packages/vendure-plugin-picqer/package.json is excluded by !**/*.json
📒 Files selected for processing (3)
  • packages/vendure-plugin-picqer/CHANGELOG.md (1 hunks)
  • packages/vendure-plugin-picqer/src/api/picqer.service.ts (1 hunks)
  • packages/vendure-plugin-picqer/src/picqer.plugin.ts (2 hunks)
🧰 Additional context used
🪛 Biome
packages/vendure-plugin-picqer/src/picqer.plugin.ts

[error] 112-112: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

🔇 Additional comments (3)
packages/vendure-plugin-picqer/CHANGELOG.md (1)

1-4: LGTM! Clear and well-documented changelog entry.

The changelog entry follows semantic versioning and clearly describes the new configurable feature for controlling featured asset fallback behavior.

packages/vendure-plugin-picqer/src/picqer.plugin.ts (1)

70-78: LGTM! Well-documented interface additions

The new options are clearly documented and provide good flexibility for controlling sync behavior.

packages/vendure-plugin-picqer/src/api/picqer.service.ts (1)

1009-1009: LGTM! The fallback condition is correctly implemented.

The change adds the configurable option to control whether to fall back to the parent product's featured asset, which aligns with the PR objective.

Comment on lines +112 to +115
this.options = {
fallBackToProductFeaturedAsset: true,
...options,
};
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix use of 'this' in static context

Using 'this' in a static method can be confusing and is flagged by static analysis.

Apply this fix:

-    this.options = {
+    PicqerPlugin.options = {
      fallBackToProductFeaturedAsset: true,
      ...options,
    };
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
this.options = {
fallBackToProductFeaturedAsset: true,
...options,
};
PicqerPlugin.options = {
fallBackToProductFeaturedAsset: true,
...options,
};
🧰 Tools
🪛 Biome

[error] 112-112: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

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