Skip to content

SL-355: add Capture option to 3D Secure failure behavior setting#317

Open
GytisZum wants to merge 2 commits intoSL-353/fields-settings-licencefrom
SL-355/payment-capture-3ds
Open

SL-355: add Capture option to 3D Secure failure behavior setting#317
GytisZum wants to merge 2 commits intoSL-353/fields-settings-licencefrom
SL-355/payment-capture-3ds

Conversation

@GytisZum
Copy link
Copy Markdown
Collaborator

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
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 payment module by providing merchants with more granular control over how transactions are handled when 3D Secure authentication fails. Previously, the only explicit option was to cancel the order. With this change, a new "Capture" option is introduced, allowing the system to attempt to capture the payment even without a liability shift, providing greater flexibility in payment processing workflows.

Highlights

  • New 3D Secure Failure Behavior: Introduced a new 'Capture' option for handling payments where 3D Secure authentication fails and liability shift is not granted, providing more flexibility in payment processing.
  • Conditional Payment Processing Logic: Updated payment processing logic in both the notification and return controllers to conditionally capture or cancel orders based on the newly configured 3D Secure failure behavior.
  • Configuration and UI Updates: Added a new constant in SaferPayConfig.php for the 'Capture' behavior, updated relevant translations, and integrated the new option into the admin settings user interface.

🧠 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/front/notify.php
    • Refactored the 3D Secure failure handling logic to support multiple behaviors (cancel, capture).
    • Added logic to capture an order if PAYMENT_BEHAVIOR_WITHOUT_3D_CAPTURE is configured and the transaction is not already captured.
    • Updated debug logs to reflect the new behaviors.
  • controllers/front/return.php
    • Modified the createAndValidateOrder method to incorporate the new PAYMENT_BEHAVIOR_WITHOUT_3D_CAPTURE option for 3D Secure failure scenarios.
    • Introduced conditional logic to either cancel or capture the order based on the configured behavior.
  • src/Config/SaferPayConfig.php
    • Added a new constant PAYMENT_BEHAVIOR_WITHOUT_3D_CAPTURE with a value of 2.
    • Changed the default value for PAYMENT_BEHAVIOR_WITHOUT_3D from 1 (Authorize) to 0 (Cancel).
  • src/Service/SettingsTranslationService.php
    • Updated the translation for behaviourWhen3dsFails to be more descriptive.
    • Added a new translation key captureWithout3ds for the new capture option.
  • views/js/admin/settings-app/src/components/settings/payment-processing.tsx
    • Added a new radio button option for "Capture" under the "Behavior when 3D Secure fails" setting, allowing administrators to select this new behavior.
Activity
  • No human activity (comments, reviews, etc.) has been recorded for this pull request yet.
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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a 'Capture' option for the 3D Secure failure behavior setting. The changes are implemented across the backend and frontend, including new configuration options, translation strings, and UI elements. The core logic in the notify and return controllers has been updated to handle this new behavior. My main feedback is regarding code duplication between these two controllers, which could be refactored to improve maintainability.

Comment on lines 145 to 173
if (!$assertResponseBody->getLiability()->getLiabilityShift() &&
in_array($order->payment, SaferPayConfig::SUPPORTED_3DS_PAYMENT_METHODS) &&
(int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D) === SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D_CANCEL
in_array($order->payment, SaferPayConfig::SUPPORTED_3DS_PAYMENT_METHODS)
) {
/** @var SaferPayOrderStatusService $orderStatusService */
$orderStatusService = $this->module->getService(SaferPayOrderStatusService::class);
$orderStatusService->cancel($order);

$logger->debug(sprintf('%s - Liability shift is false', self::FILE_NAME), [
'context' => [
'id_order' => $order->id,
],
]);

$logger->debug(sprintf('%s - liability shift is false', self::FILE_NAME), [
'context' => [
'id_order' => $order->id,
],
]);

die($this->module->l('Liability shift is false', self::FILE_NAME));
if ($paymentBehaviorWithout3D === SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D_CANCEL) {
$orderStatusService->cancel($order);

$logger->debug(sprintf('%s - Liability shift is false, canceling order', self::FILE_NAME), [
'context' => [
'id_order' => $order->id,
],
]);

die($this->module->l('Liability shift is false', self::FILE_NAME));
} elseif ($paymentBehaviorWithout3D === SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D_CAPTURE
&& SaferPayConfig::supportsOrderCapture($order->payment)
&& $transactionStatus !== TransactionStatus::CAPTURED
) {
$orderStatusService->capture($order);

$logger->debug(sprintf('%s - Liability shift is false, capturing order', self::FILE_NAME), [
'context' => [
'id_order' => $order->id,
],
]);
}
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This block of logic for handling failed liability shift is nearly identical to the code in controllers/front/return.php on lines 334-350. This code duplication can lead to maintenance issues, where a change in one place might be forgotten in the other.

To improve maintainability, I recommend extracting this logic into a shared method. Since both SaferPayOfficialNotifyModuleFrontController and SaferPayOfficialReturnModuleFrontController extend AbstractSaferPayController, you could add a protected method to the base class to encapsulate this shared logic.

This refactoring would also be a good opportunity to improve the readability of the long elseif condition by breaking it down into smaller, well-named boolean variables.

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