SL-356: add Order reference on payment page toggle to control Descripton

[GytisZum]

…on field value

Self-Checks

• I have performed a self-review of my code.
• I have updated/added necessary technical documentation in the README file.

JIRA task link

Summary

QA Checklist Labels

• Bug fix?
• New feature?
• Improvement?
• Technical debt?
• Reusable?
• Covered by tests?

QA Checklist

Additional Context

Frontend Changes

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the SaferPay payment module by providing merchants with greater flexibility over the payment description displayed to customers. It introduces a new configuration option in the admin settings, allowing users to choose between using the standard PrestaShop order reference or a custom description for payments. This change aims to improve clarity and customization for payment processing, ensuring that the most relevant information is presented to the customer during checkout.

Highlights

• New Configuration Option: Introduced a new setting to control whether the payment description on the payment page uses the PrestaShop order reference or a custom description field.
• Dynamic Payment Description: Implemented logic to dynamically set the payment description based on the newly added configuration, with a fallback to the custom description if the order reference is not yet available.
• Admin UI Integration: Added a user interface in the admin panel's general settings to allow merchants to easily select their preferred option for the payment page description.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• controllers/admin/AdminSaferPayOfficialSettingsController.php
  • Added orderIdOption to the ajaxProcessSaveGeneralSettings method for saving the new configuration.
  • Included orderIdOption in the collectSettingsData method to retrieve the new setting.
• src/Config/SaferPayConfig.php
  • Defined a new constant SAFERPAY_ORDER_ID_OPTION to store the configuration key.
  • Added SAFERPAY_ORDER_ID_OPTION with a default value to the getDefaultConfiguration method.
  • Included SAFERPAY_ORDER_ID_OPTION in the getUninstallConfiguration method to ensure proper cleanup.
• src/Service/Request/RequestObjectCreator.php
  • Modified the createPayment method to conditionally set the payment description based on the SAFERPAY_ORDER_ID_OPTION setting, using the order reference or a custom description.
• src/Service/SettingsTranslationService.php
  • Added new translation keys for 'Order reference on payment page', 'Use PrestaShop Order reference (default)', 'Use Description field value', and a fallback information message.
• views/js/admin/settings-app/src/components/settings/general-settings.tsx
  • Imported RadioGroup, RadioGroupItem, and Info components for the new UI.
  • Implemented a radio button group for 'Order reference on payment page' to select between using the PrestaShop order reference or a custom description.
  • Conditionally rendered the 'description' input field only when 'Use Description field value' is selected.
  • Added an informational banner explaining the fallback behavior for the order reference.
• views/js/admin/settings-app/src/context/settings-context.tsx
  • Included orderIdOption in the handleSave function to persist the new setting.
• views/js/admin/settings-app/src/types/index.ts
  • Added orderIdOption as a number type to the SaferpaySettingsData interface.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request introduces a new configuration option to control the order reference displayed on the payment page. This includes adding the configuration to the backend, updating the settings collection, and implementing the corresponding UI changes in the frontend. Translations for the new options have also been added. The changes are generally well-implemented, but there is a potential bug in the RequestObjectCreator where an $order object might be null when its reference property is accessed.

[gemini-code-assist]

The $order variable can be null at this point if SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION is enabled and the order has not yet been created (as checked on line 131). Accessing $order->reference when $order is null will result in a fatal error. This line should only execute if $order is not null.

        if (!empty($order)) {
            $payment->setOrderReference($order->reference);
        }