Skip to content

SL-353/SL-354: fields settings block logic - #316

Merged
justelis22 merged 40 commits into
SL-350/overall-design-changesfrom
SL-353/fields-settings-licence
Jul 9, 2026
Merged

SL-353/SL-354: fields settings block logic#316
justelis22 merged 40 commits into
SL-350/overall-design-changesfrom
SL-353/fields-settings-licence

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 significantly enhances the Saferpay module's license management by implementing real-time license fetching and dynamically adjusting the user interface based on the retrieved license status. This ensures that the displayed features and configuration options accurately reflect the user's current Saferpay plan, improving user experience and reducing potential confusion regarding feature availability.

Highlights

  • Dynamic License Fetching: Implemented automatic re-fetching of Saferpay license information from the API on every settings page load to ensure the displayed license status is always up-to-date.
  • New License API Services: Introduced new PHP services and Data Transfer Objects (DTOs) specifically for handling Saferpay license API requests, including a fallback mechanism for different API endpoints.
  • Conditional UI Rendering: Modified the API credentials settings page to dynamically display the 'Saferpay Fields Configuration' section only when a business license is successfully detected, streamlining the user interface.
  • Simplified UI Interaction: Removed conditional disabling of input fields and buttons within the 'Saferpay Fields Configuration' section, making them always editable once the section is visible.
  • Translation Cleanup: Cleaned up unused translation strings related to messages indicating that Saferpay Fields are not available, aligning with the new conditional UI approach.

🧠 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
    • Updated the success message displayed after saving API credentials.
    • Added logic to re-fetch the Saferpay license from the API on page load using the currently configured credentials.
  • src/Api/Request/GetLicenseService.php
    • Added a new service responsible for making API requests to retrieve license information, including support for a fallback URL.
  • src/DTO/Request/GetLicense/GetLicenseRequest.php
    • Added a new Data Transfer Object (DTO) for constructing license request URLs, incorporating validation for the customer ID format.
  • src/Service/SaferPayGetLicense.php
    • Added a new service to orchestrate the fetching of Saferpay license details, process the API response, and determine the presence of a business license and associated features.
  • src/Service/SettingsTranslationService.php
    • Removed translation keys that were previously used for messages indicating the unavailability of Saferpay Fields, as this information is now handled by conditional UI rendering.
  • views/js/admin/settings-app/src/components/settings/api-credentials.tsx
    • Modified the rendering logic for the 'Saferpay Fields Configuration' card to only display if a business license is detected.
    • Removed the 'disabled' attribute from the 'Field Access Token' input, its associated 'Generate' button, and the 'JavaScript Library URL' input, making them always editable when the configuration section is visible.
Activity
  • No specific activity (comments, reviews, or progress updates) was provided in the context for this pull request.
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 gemini-code-assist Bot left a comment

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.

Code Review

This pull request introduces logic to fetch and handle Saferpay license information, which controls the visibility of "Saferpay Fields" settings. The frontend changes correctly hide this section if the user does not have the required business license, improving the UI. The backend adds new services and DTOs to communicate with the Saferpay API for license fetching, including a fallback mechanism which is a nice touch.

However, I have identified a couple of areas for improvement. Firstly, a new block of code in AdminSaferPayOfficialSettingsController fetches the license status on every page load. This is a performance concern and it fails silently, which can lead to a confusing user experience with stale data. I've recommended removing it or implementing caching and proper error handling. Secondly, the new service classes use mixed as a return type in PHPDocs, which weakens type safety. I've suggested using more specific types like object|null to improve code clarity and maintainability.

Comment on lines +455 to +472
if (!empty($activeUsername) && !empty($activePassword) && !empty($activeCustomerId)) {
try {
/** @var SaferPayGetLicense $getLicense */
$getLicense = $this->module->getService(SaferPayGetLicense::class);
$licenseInfo = $getLicense->fetchLicenseWithCredentials(
$activeUsername,
$activePassword,
$activeCustomerId,
$isTestMode
);
$configuration->set(
SaferPayConfig::BUSINESS_LICENSE . $suffix,
$licenseInfo['hasBusinessLicense'] ? 1 : 0
);
} catch (\Exception $e) {
// Silently fall back to stored value
}
}

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.

high

Making an API call on every page load of the settings page can negatively impact performance and user experience, especially if the external API is slow to respond. Additionally, silently catching all exceptions (catch (\Exception $e)) hides potential issues from the user, such as invalid credentials or network problems. This can lead to confusion when the license status displayed is stale and doesn't reflect the actual state.

Consider removing this automatic refresh. The license status is already updated when credentials are saved, which provides better user feedback on failure. If a manual refresh is desired, a dedicated button would be more efficient.

If you must keep the automatic refresh, please consider these improvements:

  • Implement caching with a reasonable TTL (e.g., 1 hour) to avoid making an API call on every single page load.
  • Handle exceptions gracefully by logging the error and displaying a non-intrusive message to the user indicating that the license status could not be refreshed.

Comment thread src/Service/SaferPayGetLicense.php
@GytisZum GytisZum changed the title SL-353/ fields settings licence block logic and licence fetching SL-353: fields settings licence block logic and licence fetching Mar 16, 2026
@GytisZum GytisZum changed the title SL-353: fields settings licence block logic and licence fetching SL-353/SL-354: fields settings block logic Mar 16, 2026
Gytautas Zumaras and others added 24 commits March 16, 2026 17:10
Adds discernible accessible names to interactive controls that
were unlabelled at narrow viewports, resolving 33 of the 36 axe-core
violations found during SL-346 QA.

- Payment Methods mobile cards: add aria-label to "Logos" and
  "Custom form" switches (28 violations). Desktop layout was already
  labelled; only the md:sp-hidden mobile block was missing labels.
- Settings tab triggers: add aria-label to all five TabsTrigger
  buttons (5 violations). Visible text labels are wrapped in
  sp-hidden sm:sp-inline so on mobile only the icon shows; without
  aria-label the buttons had no accessible name.
- Darken --sp-muted-foreground from 46% to 38% lightness (4.31:1 -> ~6.4:1)
- Replace sp-text-emerald-600 with sp-text-emerald-700 in API Credentials
  (3.76:1 -> 5.27:1 on white, 3.57:1 -> ~5:1 on emerald-50)

Resolves 3 axe-core color-contrast violations across all 5 settings tabs.
Verified: 0 contrast issues remain inside #saferpay-settings-root.
Radix Label component does not auto-wire to SelectTrigger; without
an explicit aria-label, screen readers announced only the selected
value. Resolves last open finding in TC-346.1.
Previously Tab could escape the modal into background page content
violating WCAG 2.1.2 (Focus Order) for modal dialogs. Tab/Shift+Tab
now cycle within the modal's focusable elements.

Resolves TC-346.7.
PrestaShop core .btn-primary teal (#25b9d7) on white was 2.6:1 — fails
WCAG 2.1 AA (requires 4.5:1). Scoped override on #saferpay-admin-form
only, so other admin pages keep their PS theme. Refund/Capture buttons
now use the module brand teal #1c7c80 (5.27:1).
Without scope, screen readers cannot reliably associate header cells
with their data column. Resolves TC-346.10 (FO saved credit cards).
The PS Classic theme rendered the Remove link in teal #24b9d7 on white
(2.6:1) which fails WCAG 2.1 AA. Use brand teal #1c7c80 (5.27:1) via
inline color so the override does not bleed to other theme buttons.
The .btn-primary (BO admin order) and .btn-default (FO saved cards)
contrast issues originate in PrestaShop core/theme CSS, not in our
module. Overriding them at module level was the wrong layer:
- fragile against theme updates
- could clash with merchant theme customizations
- inconsistent with our decision to scope SL-346 to module-owned UI

These now match the same out-of-scope category as the BO breadcrumb,
help button, and submenu tabs. Module-owned a11y fixes (React Settings
app contrast, aria-labels, scope=col, focus trap, etc.) remain in PR.
- Disable Save Changes button when username/password empty, credential
  check is in flight, or inline credential error is shown
- Mark JSON API Username and Password as required (visual asterisk +
  aria-required) to surface the requirement before user clicks Save
The Saferpay Fields section was driven by a single hasBusinessLicense
flag derived from the active environment's stored license at page load.
Switching environments client-side did not re-evaluate it, so the
section stayed visible after switching to an environment with no
validated business license.

Expose testHasBusinessLicense and liveHasBusinessLicense separately
from the controller (initial payload and save response), and pick the
active one in api-credentials.tsx based on testMode.
When the Saferpay Management API license lookup fails during credentials
save, the previous flow showed a misleading green success toast that
asked merchants to verify credentials they had just successfully validated.

- Log the underlying error to the SaferPay module Logs tab via LoggerInterface
- Return a 'warning' flag in the save credentials response
- Render an amber warning toast with a clearer message that points to the Logs
…ntials

Disable Save Changes when API credentials empty or invalid
…nse-visibility

Fix Saferpay Fields visibility per active environment license
…toast

Log license fetch failures and surface honest warning toast on save
The polling script in saferpay_wait.tpl navigated the iframe itself via
window.location.href, leaving the parent window stuck on the SaferPay
iframe controller URL while the cart or order-confirmation page rendered
nested inside the iframe.

Use window.top so the redirect targets the parent window and the user
lands at /cart or /order-confirmation with the proper top-level chrome.
Address review feedback on PR #325:
- Use location.replace() so the polling page is not stored in history
  (Back from order-confirmation should not return to the spinner).
- Wrap window.top access in try/catch with an in-iframe fallback in
  case sandboxing or browser policy blocks the breakout.
…rictions-default

BUGFIX: payment methods default to all countries/currencies and dropdowns show All instead of 0
fix: break out of SaferPay iframe on payment status redirect
Tadas Labutis and others added 14 commits May 15, 2026 13:57
BUGFIX: redirect customer to cart instead of order history after Saferpay transaction abort
…le-info

BUGFIX: clarify Hosted field style info banner to mention Custom form requirement
Frontend (api-credentials.tsx): show inline error and disable Save when
any comma-separated entry fails an email regex.

Backend (AdminSaferPayOfficialSettingsController): reject save when
testMerchantEmails or liveMerchantEmails contains a value that fails
Validate::isEmail() — guards against curl/devtools bypass.
BUGFIX: validate Merchant Emails field on save
When 'Behavior when 3D Secure Payer Authentication was not successful'
was set to Authorize, the order was still being captured because the
AUTHORIZE branch was missing and the CANCEL branch did not return early,
so control fell through to the default-payment-behavior Capture block.

Each 3DS-fail branch now returns/dies explicitly, so the configured
3DS-fail behavior is always honored.
isValidResponse() already logs API errors before throwing
SaferPayApiException, so the surrounding catch in get(),
getWithCredentials(), and postWithCredentials() produced a redundant
error row for every failed call. Guard the catch-block logger->error
with if ($response === null) so it only fires on transport-level
failures, where isValidResponse() never ran.
…6/accessibility-eaa-compliance

# Conflicts:
#	controllers/admin/AdminSaferPayOfficialSettingsController.php
…ance

SL-346: add accessibility improvements for EAA compliance
SL-358: add ConfigSet field validation, move hosted field style to general settings
…cription

SL-356: add Order reference on payment page toggle to control Descripton
SL-355: add Capture option to 3D Secure failure behavior setting
@justelis22
justelis22 merged commit 2641c24 into SL-350/overall-design-changes Jul 9, 2026
1 of 3 checks passed
@justelis22
justelis22 deleted the SL-353/fields-settings-licence branch July 9, 2026 06:12
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.

3 participants