On Saturday, the 16. September 2023, the checksum of several of the composer packages on mirror.mage-os.org will change. This will likely lead to warnings during subsequent composer operations on projects utilizing the mirror.
There is no reason for alarm – there is a technical reason for the update.
We recently discovered a flaw in the integrity check used to confirm that Mage-OS mirror packages are identical to Magento Open Source packages. We have fixed the flaw, and have ensured all Mage-OS mirror packages are identical to their Magento Open Source counterparts.
We do not expect to have to change the checksums of released packages again.
If you are interested in details, please read on.
Why are the checksums changing?
Ever since we started publishing self-built packages on mirror.mage-os.org we have been using GitHub actions to ensure our packages are a drop-in replacement for the packages from repo.magento.com.
The old package integrity check process
After the packages for a given Magento Open Source Mirror release were generated, that release was installed twice:
once using the Mage-OS composer repository, and once using the Magento composer repository.
Composer create-project --repository-url="https://mirror.mage-os.org" magento/project-community-edition:$VERSION ./mageos
composer create-project --repository-url="https://repo.magento.com" magento/project-community-edition:$VERSION ./magentoThen the check compared the versions of all installed packages using composer show.
diff <(composer show -d ./magento | sort) <(composer show -d ./mageos | sort)If there were no differences, the same package versions were used in both installations, meaning the requirements of all composer.json files were resolved to the same package versions.
Finally, the check compared all files, excluding composer and caching files.
diff -rq -x "*composer*" -x "*autoload*" -x "*mage---*" ./magento ./mageosIf any differences were found, the mirror release failed. If all versions and files were the same, the check succeeded.
The problem
The old integrity check only checked the installed versions were identical at the point in time the two installations were made.
It turned out that in some composer.json files of Magento Open Source, wildcard constraints were used, while Mage-OS used exact version constraints.
For example, version 1.3.0 of the package magento/module-adobe-stock-image requires (among others) the package magento/module-adobe-stock-client-api.
Magento Open Source uses the version constraint 2.1.*, while Mage-OS used to use 2.1.0.
Now, when Adobe releases a new package that matches such a wildcard constraint, the new version would be installed on Magento Open Source installations, but not on Mage-OS installations.
Consequently, the integrity check for a release that previously passed would no longer succeed, because the Mage-OS installation would not change.
Regardless of which approach to package version constraints is “better”, since the goal of the Mage-OS mirror is to provide drop-in replacement packages, the Mage-OS packages had to be updated to also use the same wildcard constraints as Magento Open Source.
For more information, please refer to the GitHub issue, where Damien Retzinger describes the problem in depth.
The new package integrity check process
To fix the problem, the integrity check now no longer compares only the version of installed packages, but instead compares the require, require-dev, and suggests sections of all Mage-OS packages with their corresponding Magento Open Source counterpart directly.
This allowed us to identify all packages that might have caused installations to diverge over time.
The new integrity check was written by Vladyslav Podorozhnyi during the Mage-OS Hackathon in Würzburg a few days ago. Thank you very much!
Get Involved
Want to get involved with learning more and contributing to our package and distribution process? Join our weekly tech calls to find out more.
