vaimo/composer-patches

Maintenance

• follow-up to incorrectly released version (4.8.1); no extra changes done

Links: src diff

Fix

• forward-port (3.39.1): patches not applied when dealing with requires that use dev branches (even when version available in package config or when dev branch aliased as proper version)

Links: src diff

all features and fixes in this release are forward-ported from 3.39.0

Feature

• added --brief to list command (skips over description, etc)
• when using --filter or targeting a specific package with 'redo', 'undo' or 'apply', show only those patches that match with the filter; other patches still applied, just not reported (all actions can still be made visible when using --explicit flag)
• show information about patches that are removed (when patches are re-applied, show which items were applied, but no longer listed/queued)

Fix

• rework on fix done in 3.37.1 for patches that applied half-way while 'patch' command still returned SUCCESS exit code; perform patch command dry-apply output analysis to detect edge-cases that should be considered as failures
• the command 'list' listing removals even when --filter used
• the command 'list' --excluded option not properly dealing with filter when --filter used
• the command 'list' not listing removals when every patch against some package gets removed
• the command 'list' always listing removed items, even when they do not match with used filter
• allow both 'undo' and 'redo' command to finish even when there are errors encountered while re-applying some patches (bundled patches might get re-applied; encountered when doing partial/targeted command call); suppress environment flags that tell otherwise (apply still stops on first failure when required)
• queue resolver re-introducing undo'd patches when patches targeting a package that had bundled patches defined against it
• show all applied patches when running 'redo' command without a filter (otherwise only matched patches are shown)
• hide NEW patches (that might be failing) when doing filtered redo/undo calls to avoid too much noise in output where it's pretty clear that developer is working with a sub-selection of patches (all shown when doing explicit call)
• composer lock still modified when applying patches (leaves empty EXTRA key behind where there previously wasn't one present)

Links: src diff

Feature

• forward-port (3.38.0): hide all information on previously applied patches by default (when patches for certain package are re-applied) and only show the ones that changed, are new or got matches with a filter (--explicit flag added for commands to use old output that shows every patch that gets re-applied)

Fix

• forward-port (3.38.0): rollback to fix in 3.37.1 (caused errors for patches that created new files, new solution needed)

Links: src diff

Fix

• forward-port (3.37.1): some patches that patched multiple files applied only half-way through on certain OS's without returning with proper exit code on failure (or failed hunks considered as ignoreable junk)

Links: src diff

Feature

• forward-port (3.37.0): new flag introduced for patch:list to allow including patches that have been ruled out due to mismatch with certain constraint: --excluded

Fix

• forward-port (3.37.0): embedded targeting info for bundled patches that declares constrains not processed correctly (@depends,@version)

Links: src diff

Feature

• forward-port (3.36.0): allow '@type bundle' to be used for bundle package instead of using somewhat cryptic '@package *'
• forward-port (3.36.0): allow multiple types to be combined in embedded info (@type dev+bundle)

Fix

• forward-port (3.36.0): multi-line description not presented properly when using composer patch:list command
• forward-port (3.36.0): bundled patches not included as expected when using embedded patch target info

Links: src diff

Fix

• forward-port (3.35.3): backwards compatibility problems with composer.lock contents for projects that upgraded to latest releases of the plugin and had patches previously applied (boolean values for patches_applied no longer tolerated)

Links: src diff

Fix

• forward-port (3.35.2): lock management reworked (again) to make sure that under no circumstances does the plugin crash while sanitizing the lock

Links: src diff

Fix

• forward-port (3.35.1): lock management reworked to use built-in methods for locating a package to avoid issues with potential aliases, etc

Links: src diff

Feature

• forward-port (3.35.0): list command added (allows listing all registered patches and their state)

Fix

• forward-port (3.35.0): bundled patch targets not properly reset when using patch:redo in case patches applied on packages, but installed.json reset to provide no information about applied patches
• forward-port (3.35.0): patches for packages that are covered with certain bundle patch do not get re-applied when running patch:redo with filter (redo should not leave any patch uninstalled even when executed with a filter)

Links: src diff

Feature

• forward-port (3.34.0): allow patch path strip level to be defined in patch's embedded target-info declaration (@level <int>)

Fix

• forward-port (3.34.0): patches queue generator sometimes generated lists that did not queue proper re-applying of patches when dealing with bundles and indirect targets so that 'patch:redo' == 'patch:undo' + 'patch:apply'
• forward-port (3.34.0): make sure that the removal of 'dev' bundle (or any other type with indirect targets) patches cause proper re-patching of related targets when running with --no-dev
• forward-port (3.34.1): conflicting project applied patches state when doing a --no-dev call and a filtered undo/redo after that

Links: src diff

Fix

• forward-port (3.33.1): improved error reporting when encountering issues on composer lock cleanup

Links: src diff

Feature

• forward-port (3.33.0): allow patch applied root to be configured per patch to allow patching of files that are mapped by other composer plugins to project root (see more at 'Patches: patch applier cwd options')

Fix

• forward-port (3.33.0): switched away from using a class constant name that on older php versions is reserved (new)
• forward-port (3.33.0): avoid reporting non-vcs package differences as reason for halting the patch applying (which requires package reset)
• forward-port (3.33.0): full list of applied patches ended up in composer.lock (new: none added, not even 'true' flag)
• forward-port (3.33.0): multiple dependencies on patches with embedded target info not respected

Links: src diff

Fix

• forward-port (3.32.1): definition list validation command returning with false failures when using #skip on patch paths

Maintenance

• forward-port (3.32.1): removing #skip flag from path when encountered (previously it remained in the path)

Links: src diff

Feature

• forward-port (3.32.0): allow comments on any level and with any keyword as long as it starts with underscore (_)

Links: src diff

Breaking

• logic: installation/update/applying patches fails on first patch failure (used to be activated by COMPOSER_PATCHES_FATAL_FAIL); old default behavior usable via COMPOSER_PATCHES_GRACEFUL or using --graceful flag
• config: removed COMPOSER_PATCHES_REAPPLY_ALL, COMPOSER_FORCE_PATCH_REAPPLY; replaced by 'composer patch:redo'
• config: removed COMPOSER_PATCHES_FATAL_FAIL, COMPOSER_EXIT_ON_PATCH_FAILURE; replaced by COMPOSER_PATCHES_GRACEFUL
• config: removed COMPOSER_PATCHES_FROM_SOURCE, COMPOSER_PATCHES_PREFER_OWNER; replaced with --from-source flag on commands (was meant for testing out a patch)
• config: removed COMPOSER_SKIP_PATCH_PACKAGES, COMPOSER_PATCHES_SKIP_PACKAGES; never really used for anything, could be achieved via using patcher configuration

Feature

• allow patch failures to be passed over gracefully with --graceful flag on 'composer patch:*' commands
• allow patch failures to be passed over gracefully with COMPOSER_PATCHES_GRACEFUL flag
• allow patch failures to be passed over gracefully with extra/patcher/graceful configuration in root package

Links: src diff

Merge pull request #168 from vaimo/feature/applicable-variable-in-pat…

Fix

• bundled patches fail to apply when using patch-mapping configuration due to refactored code in 3.53.2 having messed up argument order used for a sub-function call in BasePathComponent

Links: src diff

Fix

• patch applier crash when branch alias defined for root package (scenario: root-branch-alias) [pull/73]

Maintenance

• make patch commands available when the plugin itself is a root package (just for the sake of allowing people to conduct quick experiments when developing)

Links: src diff

Fix

• patches applied before packages properly re-installed with Composer V2 (missed the fact that installations, like downloads are now done in asynchronous manner) [issues/70]

Links: src diff

Fix

• minor issue addressed with V2-style call being in code without version-check (said call is currently backwards-compatible with V1, but you never know ...)

Links: src diff

Feature

• add support for Composer 2 [issues/59]
• allow patcher operations to be optionally disabled by re-declarng them with label replaced with: false

Maintenance

• introduce ready-to-use development environment setup for quicker developer onboarding [issues/65]
• improved linter rules to be a it less forgiving on excessive use of whitespace
• fix an issue where GIT applier was polled within the tests (due to there being repo-within-repo situation which made the applier to be excluded)

Links: src diff

Fix

• remote patch availability validation crash under certain package setups

Maintenance

• improve test coverage to include scenarios where the patches are owned by a sub-package rather than the root

Links: src diff

Feature

• allow global usage of the plugin when explicitly enabled via environment variable: COMPOSER_PATCHER_ALLOW_GLOBAL_USAGE (pull/45)

Fix

• added /F switch to where to add double quotes to windows commands [pull/44]
• added no-scripts option to avoid executing post-install-cmd [pull/48]
• strpos() empty needle errors can occur with certain configurations [pull/53]
• patches-searches path containing .patch fails [pull/58] (with extra modifications)

Maintenance

• CI config fixed to use Composer 1.X
• make it possible to run tests while developing the module on MacOS
• make sure output assertions on tests don't fail on small terminal windows when composer output gets wrapped
• update compatibility checker not to fail on false-negatives
• fix normaliser script not executing as expected after code:deps run

Links: src diff

Fix

• some errors not properly reported in the 'most likely' errors brief report (for patches with corrupt content)
• errors not listed when file reference not available within patch (affects brief reporting, everything worked as expected with -vvv)

Links: src diff

Fix

• allow the plugin to be installed as dependency to globally installed package (as part of dependency of some global package); previously caused every composer call to crash with class declaration conflict
• patch error reporting includes patch creation date where just path should have been shown
• patch errors caused by output analysis did not include the raw output line that caused the failure detector to trigger
• outdated documentation reference in code when specifying unsecure URL endpoint for a patch to be downloaded from

Maintenance

• new documentation page added to shed some light to different situations one might find themselves in when a patch applying fails

Links: src diff

Feature

• allow defining OS-specific applier operation without overwriting the default operation value

Fix

• proper support for FreeBSD 'patch' command that does not have the call arguments of --no-backup-if-mismatch and --verbose [issues/38]

Maintenance

• documentation split to make it easier to read and work with updating it [issues/38]

Links: src diff

Fix

• running 'composer update --lock' not cleaning up composer.lock afterwards when patches already applied. No such issue when no patches applied at all (running 'update' with --lock does not apply the patches); This situation resulted in patches being perceived as already applied when a package with such a lock was installed

Maintenance

• the state of the test installation not properly reset when composer.lock got corrupted (a'la: 'patches_applied' key ended up there)
• test run output improvements; less output from composer calls that are not directly relevant to scenarios

Links: src diff

Fix

• loosened dependency on drupol/phposinfo to make sure that the module is installable on all PHP version (latest release of the module is only covering PHP <7.0 (the constraint used to explicitly state 1.6.1.2, changed to 1.6 which covers all needed PHP versions) [issues/37]
• validation error for remote patches displayed TMP path in output instead of the URL
• the 'probable causes' report did not include file path reference

Maintenance

• removed lock files from tests to make sure that initial setup always ends up installing the latest package dependencies
• make sure that under no conditions, the Packagist package will not end up being used in tests (using aliased package)
• run tests (including the test that the module can be installed) on multiple PHP versions: 5.3 5.4 5.5 5.6 7.0 7.1 7.2 7.3
• run Compatibility ruleset on all installations

Links: src diff

Fix

• the command patch:list not usable when some patch configuration included remote patches that would have resulted in 404 errors on apply (now listing said patches with proper errors)

Maintenance

• test coverage increased around dealing with remote patches

Links: src diff

Feature

• allow defining sha1 checksum for remote patches through 'sha1' key within JSON definition

Fix

• the configuration value of 'secure-http' not having any effect (value usage ignored); Now properly handled by remote filesystem implementation
• allow retries on failed downloads (switch from using remote filesystem to file downloader which allows the usage of caching and retry logic in place for Composer package downloads)

Links: src diff

Fix

• needless whitespace in output when using patches-search (extra line for patch label added for no reason)

Maintenance

• introduces output expectation for each test scenario

Links: src diff

Maintenance

• package configuration and build flow updates

Links: src diff

Maintenance

• code quality improvements

Links: src diff

Feature

• allow very precise configuration for specific OS based on OS names in drupol\phposinfo\Enum\OsName

Fix

• switched over to using drupol/phposinfo instead of tivie/php-os-detector which was only detecting the OS that php binary was built for and not the actual OS the php binary was being used [issues/36]

Maintenance

• improved dependency compatibility scanner to allow whitelisted issue reports (in case the dependency had mechanics to deal with the reported issue)

Links: src diff

Fix

• more clear error reporting when encountering patch reversals (failures from log output analysis)

Maintenance

• increased test coverage

Links: src diff

Fix

• certain behaviour flags incorrectly forced to false (explicit flag) when using redo/undo with no option to override said falsey value

Maintenance

• improved test coverage where 'redo' and 'undo' also get covered
• allow multiple commands to be called per test

Links: src diff

Fix

• patches validation not failing when there are patch files present without patch target definition in JSON files and using sym-linked patch folder (not an issue when using patches-search)

Links: src diff

Fix

• using printf variable syntax in patch descriptions crashed the patch applier

Links: src diff

Fix

• the meta-data @skip tag not perceived properly (this actually affected all tags that had no value)

Maintenance

• test coverage improved; introduced the possibility to write test scenarios for multiple installations (one using patches-search, other using patches-file, etc)

Links: src diff

Fix

• basePatch templates not being applied after code changes from last release

Links: src diff

Fix

• patch file meta-tags conflict in situations where there are values for all of: depends, package, version; the following setup now results in package+version also being listed as dependency

Links: src diff

Fix

• patch file meta-tags overwriting each-other rather than stacking (when, say @depends is used multiple times)

Links: src diff

Maintenance

• added notice to the 'most likely error' output (on patch failure) to indicate that the list presented is not the full list of details

Links: src diff

Fix

• broken compatibility with PHP 5.3 (wrong array syntax used)

Links: src diff

Feature

• highlight most probable error that caused patch to fail in the non-verbose error message (full logs available when running with -vvv); this change was introduced to make it easier for people to identify issues within patches as the verbose output is extremely noisy [issues/34]

Fix

• operation step always gets reported as 'UNKNOWN' when running the apply commands with heightened verbosity [issues/34]
• hard-coded path separators made patches to fail on certain operation systems (Windows) when applying remote patch [github/33]

Maintenance

• exception and call stack directly exposed when executing code with 'halt of first failure'; changed to fail with proper error message (full stack still available with -vvv)

Links: src diff

Fix

• support for older (<1.1) Composer releases faultily implemented where the availability with CommandsProvider was incorrectly checked for

Links: src diff

Fix

• wrong path used for pre-loading classes while running composer commands when the plugin package used as ROOT
• removed all syntax/code that was not compatible with 5.3
• removed/replaced all dependencies that were not compatible with 5.3
• having a patch for a back-ported fix for a package where when the package gets updated, the update could cause reverse-apply of the patch, thus reintroducing issue that was fixed in newer release (only happens with patches that should be declared with upper-capped version constraints but are not for some reason). This will cause patch failure from now on
• don't provide patch commands when plugin on older (<1.1) Composer versions [github/31]
• always load patches in alphabetical order from file-system when using patches-search (unless @after, @before directives used within the patch file; introduced in FileSystemUtils, using natural sorting) [github/29]
• fail the whole patching process with fatal exception when none of the patch applier commands (defined in the plugin config) are available [github/30]
• log output typos corrected

Maintenance

• improved early autoloader setup within proxy plugin
• code normalised according to coding standards
• simple integration tests added that test the patch applying in sandbox Composer project

Links: src diff

Feature

• allow platform requirement dependencies on patches a'la php:>=7.2 (previously only package dependencies could be declared); usable with "depends" config or @depends tag

Fix

• malformed package reset queue in some edge cases when using bundled patches which targets packages that have no direct patches applying on them
• load all the plugin classes on startup (to avoid crashes on patch apply); the old plugin logic will be used til the end of the particular Composer call that upgraded the plugin [github/28]

Links: src diff

This release comes basically with re-written logic to the core of the patch apply queue generation due to issues with the old logic. The listing command now also uses same code which removes some of the confusion when using apply and seeing something different than what list reports

Feature

• added --with-affected argument option for path:list command to list patches that indirectly are affected by the new/changed patches (would be re-applied on actually patch:apply due to package resets caused by new/changed statuses)
• patch owner embedded in applied patch registry to provide proper REMOVED information when patch gets removed

Fix

• bundled patches partially reset when removing some dev-only (with --no-dev option) patches that targeted same packages as bundles did; Issue caused by only partially recursive lookup on an impact of re-installing certain composer package
• the alias argument for --explicit, --show-reapplies did not trigger explicit output
• make sure that repeated patch:undo calls don't reinstall previously undo'd patches
• make sure that patch:list uses same functionality that the main patch applier uses, thus guaranteeing that path:list will list the things as they'd be processed in actual patch apply run

Links: src diff

Feature

• allow patch:validate to use only patches that the root package owns: --local

Fix

• patch contents not properly analysed when working with Bundled patches or using patches-search or patcher/search when trying to apply patches on Windows; Reason: using OS-specific EOL constant to split file content to lines [github/26]

Links: src diff

Feature

• Allow declaration of pathces that only apply when owner package is used as ROOT package (README/Patches: local patch)

Links: src diff

Feature

• allow patch file paths, etc to be defined under extra/patcher key to make sure that they don't hog up too much main level keys of 'extra' config for given package (old keys are also still supported)
• allow some patches to be ignored when running patch:validate by providing list of path ignores in package's configuration: extra/patcher/ignore (takes array of ignored paths)
• allow patcher operations to be split to have separate sub-operation per OS type [github/26]

Fix

• some path processing functions did not use proper directory separator constant
• patches not applied properly on Windows due to using 'which' instead of 'where' when resolving the patch applier absolute path [gitdhub/26]

Links: src diff

Fix

• additional rollbacks on newer array declaration usage (broke compatibility with 5.3)

Links: src diff

Fix

• rollback on newer array declaration usage (broke compatibility with 5.3)

Links: src diff

Feature

• added more informative patches configuration JSON validation (that gives exact details on what's wrong with the JSON file)
• added alias for --excluded argument: --with-excludes for more intuitive usage and to move towards more self-documenting arguments
• added alias for --explicit argument: --show-reapplies for more intuitive usage and to move towards more self-documenting arguments
• added reason to patch:validation errors (either 'NO FILE' or 'NO CONFIG')

Fix

• incorrect TMP path on Windows [github/22]
• crash when running patch:list in situation where none of bundled patches dependencies is directly available (expectation: should be able to list all patches even when none of the targets are installed)
• the patch:validate not catching situations where there's a patch JSON declaration that has no corresponding file at the place where the declaration targets
• better error message when wanting to download patches from unsecure URLs by referring to documentation of the plugin rather than to documentation of Composer (the module has it's own 'secure-http' config option that only affects patches)
• patch validation not properly issues that one can have with remote patches (report UNSECURE and ERROR 404 patches)

Maintenance

• made patch commands available within the plugin itself (not currently used for anything, potentially used in integration tests in the near future)

Links: src diff

Feature

• allow patcher config overrides per package instead of allowing it only per patch definition (reserved key: '_config'). More on this under the topic of 'Patches: shared config' in the README

Links: src diff