shopsys icon indicating copy to clipboard operation
shopsys copied to clipboard

[shopsys] product inquiries

Open grossmannmartin opened this issue 1 year ago • 3 comments

Description, the reason for the PR

This PR adds an inquiry feature, so it's now possible to mark some products as upon inquiry. Such a product has its price hidden and cannot be bought. The new mutation is introduced to send an inquiry for a product. Info about inquiring is sent by email to the customer and admin with editable email templates. Also, an admin panel was introduced to see sent inquiries.

Fixes issues

closes #2069

Check the appropriate checkboxes below, please

Summary by CodeRabbit

Release Notes

  • New Features

    • Added functionality for managing inquiries in the admin interface, including listing and detail views.
    • Implemented a new monetary value representation called HiddenMoney, which masks actual amounts.
  • Database Changes

    • New database tables for inquiries and updated product types to enhance data structure.
  • Enhancements

    • Improved the product form to conditionally include a product type field.
    • Enhanced email notification system with customizable templates for inquiries.

:globe_with_meridians: Live Preview:

  • https://mg-product-inquiry.odin.shopsys.cloud
  • https://cz.mg-product-inquiry.odin.shopsys.cloud

grossmannmartin avatar Sep 30 '24 15:09 grossmannmartin

[!IMPORTANT]

Review skipped

Auto reviews are limited to specific labels.

:label: Labels to auto review (1)
  • coderabbit

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request introduces several enhancements, including a new email template for notifying users about password changes, a new class for handling hidden monetary values, and an InquiryController for managing inquiries in the admin panel. Additionally, it includes multiple database migrations for updating the schema to support these features, such as adding new columns and creating new tables. Overall, the changes focus on improving email notifications, inquiry management, and monetary handling within the application.

Changes

File Path Change Summary
docs/cookbook/adding-a-new-email-template.md Introduced PasswordChangedMail class for password change notifications and updated migration process for email templates.
packages/framework/src/Component/Money/HiddenMoney.php Added HiddenMoney class to represent hidden monetary values with overridden methods for arithmetic and comparison.
packages/framework/src/Controller/Admin/InquiryController.php Created InquiryController for managing inquiries with listing and detail actions.
packages/framework/src/Form/Admin/Product/ProductFormType.php Updated ProductFormType to include ProductTypeEnum dependency for conditional product type field.
packages/framework/src/Migrations/Version20240924082209.php Created migration to add product_type column to products table and set default values.
packages/framework/src/Migrations/Version20240926162253.php Added migration to create inquiries table with various fields and foreign key constraints.
packages/framework/src/Migrations/Version20241001113136.php Implemented migration to update mail templates for product inquiries in a multi-domain setup.

Possibly related PRs

  • #3364: Introduces new email templates for complaint status notifications, related to the enhancements in email template functionality.
  • #3445: Adds a complaint detail URL to mail templates, directly connecting to the improvements in email notifications.

Suggested labels

Enhancement

Suggested reviewers

  • Vitek Rostislav

Poem

In the land of code, changes bloom,
New templates rise, dispelling gloom.
Hidden values, inquiries too,
Admins rejoice, with tasks anew!
A sprinkle of magic, in each line,
Together we code, and all will be fine! ✨


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.

coderabbitai[bot] avatar Sep 30 '24 15:09 coderabbitai[bot]

@coderabbitai review

grossmannmartin avatar Oct 02 '24 08:10 grossmannmartin

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar Oct 02 '24 08:10 coderabbitai[bot]