helloagain / connector-magento2
Helloagain Connector module for Magento2
Package info
gitlab.com/helloagainpublic/connectors/magento-2
Type:magento2-module
pkg:composer/helloagain/connector-magento2
Requires
- php: ~8.1.0||~8.2.0||~8.3.0
- firebase/php-jwt: ^7.0
- magento/framework: >=103.0.0 <104.0.0
README
Installation
# composer require helloagain/connector-magento2
# bin/magento setup:upgrade
Version Compatibility
Pick the connector version that matches your Magento and PHP version:
| Connector version | Magento | PHP |
|---|---|---|
| 1.3.0 (current) | 2.4.4 – 2.4.x | 8.1 / 8.2 / 8.3 |
| 1.2.15 | 2.3.5 – 2.4.7 | 7.4 / 8.0 / 8.1 / 8.2 / 8.3 |
Installing on an unsupported combination is blocked by the constraints in composer.json. To pin an older release explicitly:
# composer require helloagain/connector-magento2:1.2.15
Upgrade Notes
firebase/php-jwt v7 (CVE PKSA-y2cr-5h3j-g3ys): all v6.x releases are blocked by a security advisory, so this module now requires firebase/php-jwt ^7.0. v7 enforces a minimum HMAC key length: HS256 secrets must be at least 32 bytes. Before upgrading, verify that the configured helloagain/jwt/jwt_key (Stores → Configuration → HelloAgain) is ≥ 32 bytes — otherwise token issuance will throw DomainException: Provided key is too short at runtime.
Debugging
Log file location <MAGENTO_HOME>/var/log/system.log
Release Process
Versioning follows SemVer. The annotated git tag is the single source of truth — composer.json no longer carries a version field.
Publishing chain (each step is currently manual):
git.mstage.at (private, dev)
│ (manual: git push public main + tag)
▼
gitlab.com/helloagainpublic/connectors/magento-2 (public)
│ (manual: trigger Packagist update)
▼
packagist.org/packages/helloagain/connector-magento2
Steps to cut a release (e.g. X.Y.Z):
- Land all changes for the release on
main(via MR, CI green). - Create an annotated tag on the merge commit and push it to
origin(git.mstage.at):git checkout main && git pull --ff-only git tag -a X.Y.Z -m "Release X.Y.Z — <short notes>" git push origin X.Y.Z Push
mainand the new tag to the public gitlab.com mirror:# one-time: add the mirror as a remote git remote add public git@gitlab.com:helloagainpublic/connectors/magento-2.git git push public main git push public X.Y.Z- Trigger Packagist to crawl the new tag — either click Update on https://packagist.org/packages/helloagain/connector-magento2, or:
curl -XPOST -H 'content-type:application/json' \ "https://packagist.org/api/update-package?username=<your-user>&apiToken=<token>" \ -d '{"repository":{"url":"https://gitlab.com/helloagainpublic/connectors/magento-2"}}' - Verify on https://packagist.org/packages/helloagain/connector-magento2 that
X.Y.Zis listed.
TODO: automate steps 3 and 4. Set up a push mirror on
git.mstage.atto replicatemainand tags to the gitlab.com repo, and enable the Packagist integration on the gitlab.com mirror so new tags publish via webhook.