Register the integration webhook in Sequra by tamaralogeecom · Pull Request #104 · sequra/magento2-core

tamaralogeecom · 2025-12-29T08:54:45Z

What is the goal?

Register the integration webhook in Sequra and enable webhook re-registration on the Connection page

References

Issue: LIS-90

How is it being implemented?

Implemented RegexProvider
Added encodeURIComponent to replace values in the URL path
Updated CORE version for integration registration logic
Updated CORE UI version to render the button and handle webhook re-registration
Added a migration to register webhooks for existing users

How is it tested?

Run the command to check the PHP syntax
Manual tests
- New installation
  - Install and enable the SeQura module in the Magento 2 system.
  - Test the onboarding flow.
  - Test webhook re-registration on the Connection Settings page.
- Existing installation
  - Update the SeQura module in the Magento 2 system.
  - Test module behavior
  - Test webhook re-registration on the Connection Settings page.

ISSUE: LIS-90

# Conflicts: # composer.json # package-lock.json

ISSUE: LIS-90

tamaralogeecom · 2025-12-29T15:16:52Z

We have noticed that an “Advanced” section has been added in the latest CORE UI version. Should these changes be included in the current onboarding implementation for the Magento 2 integration? They would require implementing a new endpoint and backend business logic. If this is something that should be included at this point, then the exact requirements for what the endpoint should return need to be clearly defined.

tamaralogeecom · 2025-12-29T15:17:35Z

We also observed that encodeURIComponent was replaced with a direct string replacement for {storeId} in the API calls. This approach does not work for the Magento 2 integration because Magento generates the backend URL and automatically encodes URI components when {storeId} or any other value is added to the path. That encoded value must then be replaced. For now, the JS controllers in the Magento integration are overridden so that encodeURIComponent is still used, ensuring the plugin behaves as expected.

tamaralogeecom · 2025-12-29T15:18:03Z

Please provide us with the translations for the button on the Connection Settings page, which allows merchants to re-register their store integration for the corresponding deployment target:

Button label:

Re-register webhooks

Success message:

Webhooks were re-registered successfully.

Error message:

Webhooks were not re-registered successfully.

mescalantea · 2025-12-30T10:43:22Z

We also observed that encodeURIComponent was replaced with a direct string replacement for {storeId} in the API calls. This approach does not work for the Magento 2 integration because Magento generates the backend URL and automatically encodes URI components when {storeId} or any other value is added to the path. That encoded value must then be replaced. For now, the JS controllers in the Magento integration are overridden so that encodeURIComponent is still used, ensuring the plugin behaves as expected.

Thanks @tamaralogeecom for pointing this out. I've submitted a solution via this PR. Please have a look at it

mescalantea · 2025-12-30T10:46:21Z

We have noticed that an “Advanced” section has been added in the latest CORE UI version. Should these changes be included in the current onboarding implementation for the Magento 2 integration? They would require implementing a new endpoint and backend business logic. If this is something that should be included at this point, then the exact requirements for what the endpoint should return need to be clearly defined.

This new section is not part of the Onboarding flow. It is accesible once the onboarding is completed. I would implement it in a new PR due you will need to do several changes to support it. There's a working implementation in the woocommerce repository you can use as a guide.

mescalantea · 2025-12-30T10:52:07Z

Please provide us with the translations for the button on the Connection Settings page, which allows merchants to re-register their store integration for the corresponding deployment target:

Button label:

Re-register webhooks
🇪🇸 Volver a registrar webhooks
🇫🇷 Re-enregistrer les webhooks
🇮🇹 Registrare nuovamente i webhook
🇵🇹 Registrar novamente os webhooks

Success message:

Webhooks were re-registered successfully.
🇪🇸 Los webhooks se registraron nuevamente con éxito.
🇫🇷 Les webhooks ont été réenregistrés avec succès.
🇮🇹 I webhook sono stati registrati nuovamente con successo.
🇵🇹 Os webhooks foram registrados novamente com sucesso.

Error message:

Webhooks were not re-registered successfully.
🇪🇸 No se pudieron volver a registrar los webhooks.
🇫🇷 Les webhooks n’ont pas pu être réenregistrés avec succès.
🇮🇹 Non è stato possibile registrare nuovamente i webhook.
🇵🇹 Não foi possível registrar novamente os webhooks.

@tamaralogeecom

Copilot

Pull request overview

This pull request implements webhook registration functionality in Sequra for a Magento 2 integration. The changes include adding a webhook re-registration button on the Connection Settings page, implementing a RegexProvider for validation, updating the CORE and CORE UI library versions, and adding an Advanced section with debug logging capabilities.

Key Changes:

Added webhook re-registration functionality with UI button and backend endpoint
Implemented regex validation system with ValidationService updates
Added Advanced/Debug section for log management
Updated CORE UI library to enable new features
Fixed URL parameter encoding (changed from encodeURIComponent wrapping to inline usage)
Added comprehensive translation updates for 5 languages (EN, ES, FR, IT, PT)

Reviewed changes

Copilot reviewed 36 out of 41 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
StateController.js (override)	Adds Advanced state/pages, fixes URL encoding, adds data store clearing
SettingsController.js (override)	Updates to use new encoding pattern and adds SequraFE.customHeader
PaymentController.js (override)	Adds support link, updates encoding, handles payment method icons
ConnectionSettingsForm.js	Implements webhook re-registration button and handler
AdvancedController.js	New controller for debug logs management page
ValidationService.js	Adds regex provider requirement check and new validation methods
UtilityService.js	Adds getMenuItems helper for navigation
ResponseService.js	Adds successHandler for success messages
ElementGenerator.js	Adds createActionsBar and createSupportLink helpers
GeneralSettingsForm.js	Adds service-related fields and validation
Translation files	Comprehensive updates for webhook, debug, and service features
sequra-core.css	Major styling updates with proper scoping and new components
index.phtml	Adds regex configuration and ValidationService loading
sequra_configuration_index.xml	Updates script loading order
package.json	Updates CORE UI version to feature branch

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ISSUE: LIS-90

Copilot

Pull request overview

Copilot reviewed 36 out of 41 changed files in this pull request and generated 17 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-03T08:36:00Z

+
+                        if (!dataStore.deploymentsSettings?.some(deployment => deployment.active === true)) {
+                            page = SequraFE.appPages.DEPLOYMENTS;
+                        }


issue (blocking): Invalid appPages reference breaks onboarding navigation
SequraFE.appPages.DEPLOYMENTS doesn’t exist (DEPLOYMENTS is nested under appPages.ONBOARDING). This will set page to undefined and can route users to the wrong onboarding step. Use SequraFE.appPages.ONBOARDING.DEPLOYMENTS here (and in the other occurrences in this switch).

Copilot · 2026-03-03T08:36:00Z

+                            currentVersion: version.current,
+                            newVersion: {
+                                versionLabel: version.new,
+                                versionUrl: version.downloadNewVersionUrl
+                            },


issue (blocking): newVersion is always rendered, even when no update is available
PageHeader shows a download link whenever newVersion is truthy and versionLabel !== currentVersion. Passing { versionLabel: null, versionUrl: null } will still be truthy and can render a broken link. Pass null unless both version.new and version.downloadNewVersionUrl are present.

Copilot · 2026-03-03T08:36:01Z

+            Promise.all([
+                sellingCountries ? [] : api.get(configuration.getSellingCountriesUrl, null, SequraFE.customHeader),
+                paymentMethods ? [] : api.get(configuration.getPaymentMethodsUrl.replace(encodeURIComponent('{merchantId}'), countryConfiguration[0].merchantId)),
+            ]).then(([sellingCountriesRes, paymentMethodsRes]) => {


issue (blocking): Missing custom header when loading payment methods
This get() call omits SequraFE.customHeader (3rd param), so it may fail in environments where the backend requires the custom header. Use api.get(url, null, SequraFE.customHeader) (and keep the encoded {merchantId} replacement).

Copilot · 2026-03-03T08:36:01Z

+            const valid = validator.validateDateOrDuration(changedGeneralSettings.defaultServicesEndDate);
+            validator.validateField(
+                document.querySelector('.sq-default-services-end-date'),
+                !valid,
+                'validation.invalidTimeDuration'
+            );
+


issue (blocking): isValidTimeDuration() can crash when the field isn’t rendered
document.querySelector('.sq-default-services-end-date') can be null when service-selling fields aren’t added, but validateField() assumes a non-null element and will throw. Guard on SequraFE.flags.isServiceSellingAllowed and/or the element existing before validating.

Suggested change

const valid = validator.validateDateOrDuration(changedGeneralSettings.defaultServicesEndDate);

validator.validateField(

document.querySelector('.sq-default-services-end-date'),

!valid,

'validation.invalidTimeDuration'

);

// If service selling is not allowed, skip validating the related field.

if (SequraFE.flags && SequraFE.flags.isServiceSellingAllowed === false) {

return true;

}

const fieldElement = document.querySelector('.sq-default-services-end-date');

const valid = validator.validateDateOrDuration(changedGeneralSettings.defaultServicesEndDate);

// Only attempt to validate the field if the element exists in the DOM.

if (fieldElement) {

validator.validateField(

fieldElement,

!valid,

'validation.invalidTimeDuration'

);

}

Copilot · 2026-03-03T08:36:01Z

+        $jsonEncoded = json_encode($regex);
+        return $jsonEncoded === false ? '' : $jsonEncoded;


issue (blocking): Returning an empty string can generate invalid JS
If json_encode() fails, this returns '', and the template outputs SequraFE.regex = ; which is a syntax error. Return '{}' (or throw) on failure; consider JSON_THROW_ON_ERROR to surface encoding problems.

Suggested change

$jsonEncoded = json_encode($regex);

return $jsonEncoded === false ? '' : $jsonEncoded;

try {

$jsonEncoded = json_encode($regex, JSON_THROW_ON_ERROR);

} catch (\JsonException $e) {

// Fallback to an empty JSON object to avoid generating invalid JavaScript

return '{}';

}

return $jsonEncoded;

Copilot · 2026-03-03T08:36:03Z

+                    promises = Promise.all([
+                        SequraFE.state.getData('paymentMethods') ?? api.get(configuration.getPaymentMethodsUrl.replace(encodeURIComponent('{merchantId}'), countrySettings[0].merchantId)),
+                        SequraFE.state.getData('allAvailablePaymentMethods') ?? api.get(configuration.getAllAvailablePaymentMethodsUrl, null, SequraFE.customHeader),
+                    ])


issue (blocking): Missing auth header + wrong get() signature when fetching payment methods
ajaxService.get(url, errorCallback, customHeader) treats the 2nd argument as the error callback. This call passes no customHeader, so requests can fail if the backend requires it. Pass null (or a callback) as the 2nd arg and SequraFE.customHeader as the 3rd.

Copilot · 2026-03-03T08:36:04Z

+        const handleCountryChange = (value) => {
+            utilities.showLoader();
+            api.get(configuration.getPaymentMethodsUrl.replace(encodeURIComponent('{merchantId}'), value))
+                .then((methods) => {
+                    paymentMethods = [...methods];
+                    document.querySelector('.sq-table-container').remove();
+                    document.querySelector('.sq-content-inner')?.append(
+                        components.DataTable.create(getTableHeaders(), getTableRows())
+                    )
+                })
+                .finally(utilities.hideLoader);


issue (blocking): Missing custom header when changing country
This request omits SequraFE.customHeader (and passes the URL as the only argument, so the 2nd arg is treated as errorCallback). Use api.get(url, null, SequraFE.customHeader) to keep the request consistent with other authenticated calls.

Copilot · 2026-03-03T08:36:04Z

+                size: 'medium',
+                className: '',
+                onClick: handleReRegister,
+                label: 'Re-register webhooks'


issue: Button label isn’t translatable
createButton() treats label as a translation key. Using a literal string here prevents localization (and bypasses the existing connection.webhookReRegistration.title key). Use a translation key for the button label.

Suggested change

label: 'Re-register webhooks'

label: 'connection.webhookReRegistration.title'

Copilot · 2026-03-03T08:36:04Z

+                    SequraFE.responseService.errorHandler(
+                        {errorMessage: error}


issue: Error handling passes a non-string into errorHandler
In the catch block, { errorMessage: error } passes an Error/object, which will typically render as [object Object] and won’t translate. Pass a translation key (or error.message) or just forward the backend error shape returned by ajaxService (often contains errorCode/errorMessage).

Suggested change

SequraFE.responseService.errorHandler(

{errorMessage: error}

const errorMessage =

error && typeof error === 'object'

? (error.errorMessage || error.message || 'connection.webhookReRegistration.errorMessage')

: (error || 'connection.webhookReRegistration.errorMessage');

SequraFE.responseService.errorHandler(

{errorMessage: errorMessage}

Copilot · 2026-03-03T08:36:04Z

+    "prefer-stable": true,
+    "require": {
+        "php": ">=7.4 <8.5",
+        "sequra/integration-core": "dev-feature/LIS-90",


issue: Composer dependency points to a dev branch
Depending on sequra/integration-core: dev-feature/LIS-90 makes builds non-reproducible and can unexpectedly change as the branch moves. Prefer a tagged release (or a fixed commit reference) before merging to reduce deployment risk.

Suggested change

"sequra/integration-core": "dev-feature/LIS-90",

"sequra/integration-core": "dev-feature/LIS-90#abcdef1234567890abcdef1234567890abcdef12",

Tamara Vukovic added 10 commits December 8, 2025 15:47

Update CORE UI version to 2.0.1

d92783c

ISSUE: LIS-90

Update CORE version

146c0bb

ISSUE: LIS-90

Update CORE UI version to 2.0.2

aa61d9d

ISSUE: LIS-90

Use encodeURIComponent to replace values in URL path

3a70944

ISSUE: LIS-90

Add button for webhook re-registration

e619fa2

ISSUE: LIS-90

Implement RegexProvider provider

4736696

ISSUE: LIS-90

Use encodeURIComponent to replace values in URL path

42663b0

ISSUE: LIS-90

Implement StoreIntegrationService

9ba898b

ISSUE: LIS-90

Implement endpoint for webhook re-registration

f659075

ISSUE: LIS-90

Merge branch 'master' into feature/LIS-90

9e0710a

# Conflicts: # composer.json # package-lock.json

tamaralogeecom requested review from m1k3lm and mescalantea December 29, 2025 08:54

Tamara Vukovic added 5 commits December 29, 2025 10:14

Fix Code Sniffer issues

52cf115

ISSUE: LIS-90

Fix PHPStan issue

87b4d54

ISSUE: LIS-90

Fix PHPStan issue

514c3e9

ISSUE: LIS-90

Fix undefined available payment methods

698d277

ISSUE: LIS-90

Add a migration to register webhooks for existing users

de0de8c

ISSUE: LIS-90

m1k3lm marked this pull request as ready for review January 8, 2026 16:49

Copilot AI review requested due to automatic review settings January 8, 2026 16:49

Copilot started reviewing on behalf of m1k3lm January 8, 2026 16:50 View session

Copilot AI reviewed Jan 8, 2026

View reviewed changes

Tamara Vukovic added 2 commits January 13, 2026 17:43

Fix Copilot issues

d8f358f

ISSUE: LIS-90

Fix Copilot issues

b64a9a6

ISSUE: LIS-90

m1k3lm requested a review from Copilot March 3, 2026 08:23

Copilot started reviewing on behalf of m1k3lm March 3, 2026 08:23 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

AleksandarBoljanovic closed this Mar 3, 2026

		$jsonEncoded = json_encode($regex);
		return $jsonEncoded === false ? '' : $jsonEncoded;

-        $jsonEncoded = json_encode($regex);
-        return $jsonEncoded === false ? '' : $jsonEncoded;
+        try {
+            $jsonEncoded = json_encode($regex, JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
+            // Fallback to an empty JSON object to avoid generating invalid JavaScript
+            return '{}';
+        }
+        return $jsonEncoded;

	label: 'Re-register webhooks'
	label: 'connection.webhookReRegistration.title'

-                    SequraFE.responseService.errorHandler(
-                        {errorMessage: error}
+                    const errorMessage =
+                        error && typeof error === 'object'
+                            ? (error.errorMessage || error.message || 'connection.webhookReRegistration.errorMessage')
+                            : (error || 'connection.webhookReRegistration.errorMessage');
+                    SequraFE.responseService.errorHandler(
+                        {errorMessage: errorMessage}

	"sequra/integration-core": "dev-feature/LIS-90",
	"sequra/integration-core": "dev-feature/LIS-90#abcdef1234567890abcdef1234567890abcdef12",

Conversation

tamaralogeecom commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the goal?

References

How is it being implemented?

How is it tested?

Uh oh!

tamaralogeecom commented Dec 29, 2025

Uh oh!

tamaralogeecom commented Dec 29, 2025

Uh oh!

tamaralogeecom commented Dec 29, 2025

Uh oh!

mescalantea commented Dec 30, 2025

Uh oh!

mescalantea commented Dec 30, 2025

Uh oh!

mescalantea commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tamaralogeecom commented Dec 29, 2025 •

edited

Loading

mescalantea commented Dec 30, 2025 •

edited

Loading