Skip to content

SL-358: add ConfigSet field validation, move hosted field style to general settings - #319

Merged
justelis22 merged 32 commits into
SL-356/configurable-payment-descriptionfrom
SL-358/payment-field
Jul 9, 2026
Merged

SL-358: add ConfigSet field validation, move hosted field style to general settings#319
justelis22 merged 32 commits into
SL-356/configurable-payment-descriptionfrom
SL-358/payment-field

Conversation

@GytisZum

Copy link
Copy Markdown
Collaborator

…ral settings

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 refines the SaferPay module's administrative interface and data handling. It integrates the hosted field style selection directly into the general settings, eliminating a separate configuration tab. Additionally, it introduces robust validation for the configuration name, ensuring data integrity and consistency. These changes streamline the user experience and improve the module's maintainability by centralizing related settings and removing obsolete components.

Highlights

  • Configuration Name Validation: Implemented server-side and client-side validation for the ConfigSet field's configurationName, restricting it to letters, numbers, dots, colons, hyphens, and underscores, with a maximum length of 20 characters.
  • Hosted Field Style Relocation: Moved the 'Hosted fields style' settings from a dedicated administration controller (AdminSaferPayOfficialFieldsController) to the main general settings page (AdminSaferPayOfficialSettingsController), consolidating configuration options.
  • Module Cleanup and Version Update: Removed the now-redundant AdminSaferPayOfficialFieldsController, its associated files (CSS, templates, and empty index.php files), and references in module constants and installation/upgrade scripts. The module version was updated to 2.1.1.
  • Cypress Test Updates: Adjusted Cypress integration tests to remove steps related to the 'Fields' tab, reflecting its removal from the administrative 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/admin/AdminSaferPayOfficialFieldsController.php
    • Removed the dedicated controller for hosted field settings.
  • controllers/admin/AdminSaferPayOfficialSettingsController.php
    • Added validation for the configurationName field, restricting characters and length.
    • Integrated logic to save and validate the hostedFieldsTemplate setting.
    • Added hostedFieldsTemplate and modulePath to the collected settings data.
  • cypress/integration/01_ps1764.Module.Configure.cy.js
    • Removed tests for the deprecated 'Fields' tab.
  • cypress/integration/01_ps1770.Module.Configure.cy.js
    • Removed tests for the deprecated 'Fields' tab.
  • cypress/integration/01_ps1784.Module.Configure.cy.js
    • Removed tests for the deprecated 'Fields' tab.
  • cypress/integration/01_ps1786.Module.Configure.cy.js
    • Removed tests for the deprecated 'Fields' tab.
  • saferpayofficial.php
    • Removed the ADMIN_FIELDS_CONTROLLER constant.
    • Updated the module version from 2.0.2 to 2.1.1.
  • src/Entity/index.php
    • Removed an empty placeholder file.
  • src/Install/AbstractInstaller.php
    • Removed the installation of the 'Fields' administration tab.
  • src/Service/Request/RequestObjectCreator.php
    • Simplified order reference assignment logic by removing a conditional check.
  • src/Service/SettingsTranslationService.php
    • Updated the translation for 'Card Display & Saving' to include HTML entity decoding.
    • Modified the configNameDescription translation and added new translations for hosted field information and styles.
  • upgrade/install-1.0.3.php
    • Removed the installation of the 'Fields' tab from an old upgrade script.
  • views/css/admin/saferpay_fields.css
    • Removed the CSS file for the deprecated hosted fields page.
  • views/js/admin/saferpay_settings.js
    • Implemented client-side validation for the SAFERPAY_CONFIGURATION_NAME input, including character restrictions, length limit, and paste handling.
  • views/js/admin/settings-app/src/components/settings/general-settings.tsx
    • Enhanced the general settings UI with configuration name validation and a hosted field style selector, including a visual preview.
  • views/js/admin/settings-app/src/context/settings-context.tsx
    • Included hostedFieldsTemplate in the general settings context.
  • views/js/admin/settings-app/src/types/index.ts
    • Extended the settings data interface to include hostedFieldsTemplate and modulePath properties.
  • views/templates/admin/field-option-settings/helpers/index.php
    • Removed an empty placeholder file.
  • views/templates/admin/field-option-settings/helpers/options/index.php
    • Removed an empty placeholder file.
  • views/templates/admin/field-option-settings/helpers/options/options.tpl
    • Removed the Smarty template file for hosted field options.
  • views/templates/admin/field-option-settings/index.php
    • Removed an empty placeholder file.
  • views/templates/admin/partials/field-hosted-field-template-desc.tpl
    • Renamed to upgrade/install-2.1.1.php and converted into an upgrade script to delete the AdminSaferPayOfficialFields tab.
Activity
  • The pull request was created by GytisZum.
  • No specific review comments or progress updates are available in the provided context.
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 successfully refactors the module settings by moving the hosted field style configuration to the general settings page. The changes include removing the old controller and associated files, and integrating the functionality into the new React-based UI. Additionally, robust validation has been added for the 'Payment Page configurations name' field on both the client and server sides. The overall implementation is solid, with proper cleanup and an upgrade script for existing installations. I have a couple of minor suggestions to improve security and code consistency.

I am having trouble creating individual review comments. Click here to see my feedback.

src/Entity/index.php (1-31)

medium

This file appears to be a standard security measure in PrestaShop modules to prevent directory listing. Its removal could pose a minor security risk if directory listing is enabled on the web server. It is recommended to retain such index.php files in all module directories to follow best practices for security. Please consider restoring this file.

src/Service/SettingsTranslationService.php (191)

medium

I've noticed an inconsistent use of html_entity_decode. It's applied to this line and line 230, but not to other similar translation strings. For instance, groupCardsLabel on line 193 is not decoded. This inconsistency can make the code harder to maintain. To improve clarity and consistency, I recommend either applying html_entity_decode to all translatable strings that could potentially contain HTML entities, or adding a comment to clarify the reasoning behind this selective application.

Gytautas Zumaras and others added 27 commits March 20, 2026 14: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
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
Tadas Labutis and others added 4 commits May 26, 2026 15:08
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
@justelis22
justelis22 merged commit 2001b75 into SL-356/configurable-payment-description Jul 9, 2026
1 of 3 checks passed
@justelis22
justelis22 deleted the SL-358/payment-field branch July 9, 2026 06:10
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