Change package type to "composer-plugin". by ADmad · Pull Request #45 · cakephp/plugin-installer

ADmad · 2020-04-23T07:05:58Z

Issues with current version

The current PluginInstaller updates the vendor/cakephp-plugins.php file to add/remove entry for the cakephp plugin that is installed/removed via composer.
Later on the PluginInstaller::postAutoloadDump() which is set as post-autoload-dump hook through app's composer.json recreates the cakephp-plugins.php file making the changes done earlier for individual plugin addition/removal redundant.

Changes in this PR

The package type is changed to composer-plugin and the composer-plugin-api interface is used. This allows the package to rely on event subscription and run our postAutoloadDump() script itself and avoid calling it from app's composer.json.
The redundancy mentioned above is also removed. The cakephp-plugins.php is manipulated/created only once for the post-autoload-dump event.
The installer will remain compatible with both composer v1 and v2.

Compatibility

Existing 4.x apps will be able to upgrade to new major version of the installer without problems. They will just get a warning to remove the unneeded post-autoload-dump hook from app's composer.json.
From what I can tell existing v1 of our plugin installer should continue working with composer v2, so no changes would be required for CakePHP 3 plugins.
We can hold off releasing v2 until composer v2 stable is released.

Add new Plugin class which implements Composer's PluginInterface.

markstory · 2020-09-28T01:23:11Z

If these changes are compatible with both composer 1 and 2 it would be preferable to me if we could release this as 1.3.0 and not require any significant changes in userland code.

Doing that seems like it would require at least a dummy method for Cake\\Composer\\Installer\\PluginInstaller::postAutoloadDump so that existing composer scripts don't fail. This method could emit a deprecation notice letting people know that this line is now redundant with the new installer.

I don't think the implementation of this installer hook requires a major version bump if we include the above shim because functionally it still does everything the old code did and wouldn't raise any runtime errors.

ADmad · 2020-09-28T08:40:58Z

If these changes are compatible with both composer 1 and 2 it would be preferable to me if we could release this as 1.3.0 and not require any significant changes in userland code.

Sounds good to me.

Doing that seems like it would require at least a dummy method for Cake\Composer\Installer\PluginInstaller::postAutoloadDump so that existing composer scripts don't fail. This method could emit a deprecation notice letting people know that this line is now redundant with the new installer.

Yes, I have already done that.

ADmad · 2020-09-28T08:46:23Z

Would appreciate it if people could try out the next branch and confirm everything works smoothly.

Things to ensure:

vendor/cakephp-plugins.php file generation works properly when adding/removing plugins.
No errors with either composer v1 or v2
Warning is shown if "post-autoload-dump": "Cake\\Composer\\Installer\\PluginInstaller::postAutoloadDump" has not been removed from scripts block of composer.json.

othercorey · 2020-09-28T09:37:32Z

Want to release a beta or rc out of next branch for easier testing?

ADmad · 2020-09-28T12:07:35Z

1.3.0-beta released

markstory · 2020-09-29T02:33:31Z

I tried the beta out tonight and this was my composer log (with composer 1)

ᐉ composer up
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 0 installs, 11 updates, 0 removals
  - Removing cakephp/plugin-installer (1.2.0)
  - Installing cakephp/plugin-installer (1.3.0-beta): Downloading (100%)
  - Updating composer/semver (1.7.0 => 1.7.1): Downloading (100%)
  - Updating symfony/string (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating symfony/console (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating symfony/finder (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating symfony/process (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating symfony/filesystem (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating symfony/config (v5.1.5 => v5.1.6): Downloading (100%)
  - Updating phpspec/prophecy (1.11.1 => 1.12.0): Downloading (100%)
  - Updating nikic/php-parser (v4.10.1 => v4.10.2): Downloading (100%)
  - Updating symfony/var-dumper (v5.1.5 => v5.1.6): Downloading (100%)
Package phpunit/php-token-stream is abandoned, you should avoid using it. No replacement was suggested.
Writing lock file
Generating autoload files
> Cake\Composer\Installer\PluginInstaller::postAutoloadDump
31 packages you are using are looking for funding.
Use the `composer fund` command to find out more!

The cakephp-plugins.php file was correctly generated.

ADmad · 2020-09-29T14:02:07Z

Things works as expected for me too with both composer v1 and v2. The warning for removing post-autoload-dump hook doesn't show up the first time when upgrading from plugin-installer v1.2 to v1.3 but it does show up on subsequent autoload dumps. That's not a biggie as the warning is for cleanup only.

othercorey · 2020-09-29T15:10:58Z

I can confirm cakephp-plugins.php is generated on windows as well with composer v1.

LordSimal · 2020-09-30T07:24:05Z

I can also confirm, that the cakephp-plugins.php is generated correctly under

Composer v2 under MacOS and
Composer v1 under Debian

The only thing that can be quite confusing for users who are upgrading (to at least 1.3.0-beta for now) is the fact, that the following message is being shown after performing a composer install with the new composer.lock file under Composer v1

composer install


                                                                                
     Action required!                                                           
                                                                                
     The CakePHP plugin installer has been changed, please update your          
     application composer.json file to add the post-autoload-dump hook.         
     See the changes in https://github.com/cakephp/app/pull/216 for more        
     info.                                                                      
                                                                                


Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
Package operations: 0 installs, 3 updates, 0 removals
  - Removing cakephp/plugin-installer (dev-issue-47 6b968c1)
  - Installing cakephp/plugin-installer (1.3.0-beta): Downloading (100%)         
  - Updating dereuromark/cakephp-shim (2.0.1 => 2.1.0): Downloading (100%)         
  - Updating phpspec/prophecy (1.11.1 => 1.12.1): Downloading (100%)         
Package phpunit/php-token-stream is abandoned, you should avoid using it. No replacement was suggested.
Generating autoload files
46 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
> App\Console\Installer::postInstall
Created `<my-path>/tmp/cache/views` directory
Created `<my-path>/tmp/sessions` directory
Created `<my-path>/tmp/tests` directory
Set Folder Permissions ? (Default to Y) [Y,n]? Y
Permissions set on <my-path>/tmp/cache
Permissions set on <my-path>/tmp/cache/models
Permissions set on <my-path>/tmp/cache/persistent
Permissions set on <my-path>/tmp/cache/views
Permissions set on <my-path>/tmp/sessions
Permissions set on <my-path>/tmp/tests

Here what I did:

Updated my composer.json to have the following records adjusted/added

  "require": {
    ...
    "cakephp/plugin-installer": "^1.3",
    ...
  },
  "minimum-stability" : "beta",

Performed a composer update --with-dependencies on my machine with Composer v2 RC1

After that i removed all my vendor modules and performed a new composer install. This brought up the following message:

     Action required!                                                           
                                                                                
     The CakePHP plugin installer v1.3+ no longer requires the                  
     "post-autoload-dump" hook. Please update your app's composer.json          
     file and remove usage of                                                   
     Cake\Composer\Installer\PluginInstaller::postAutoloadDump

Therefore i removed the postAutoloadDump hook from the composer.json.

Commited that in my repo and pulled it on my production machine

Performed a composer install on my production machine with Composer 1.10.10

And then the message from the start was shown.

ADmad · 2020-09-30T07:32:58Z

The only thing that can be quite confusing for users who are upgrading (to at least 1.3.0-beta for now) is the fact, that the following message is being shown after performing a composer install with the new composer.lock file under Composer v1

Initially you got the message to add the post install hook because you were using a very old bugfix branch as evident from
- Removing cakephp/plugin-installer (dev-issue-47 6b968c1).

You should have updated to use stable release of the plugin installer years ago 🙂.

And then the message from the start was shown.

Which message exactly? What does your composer.json and composer.lock look like on production machine after running composer install?

LordSimal · 2020-09-30T07:41:58Z

The only reason i used the DEV version is because I used your bugfix from #48

The message i was referring to was

     Action required!                                                           
                                                                                
     The CakePHP plugin installer has been changed, please update your          
     application composer.json file to add the post-autoload-dump hook.         
     See the changes in https://github.com/cakephp/app/pull/216 for more        
     info.

composer.json

  {
  "name": "cakephp/app",
  "description": "CakePHP skeleton app",
  "homepage": "https://cakephp.org",
  "type": "project",
  "license": "MIT",
  "require": {
    "php": ">=7.2",
    "ext-mysqli": "*",
    "ext-curl": "*",
    "ext-ftp": "*",
    "ext-intl": "*",
    "ext-json": "*",
    "bitbucket/client": "^3.1",
    "cakephp/cakephp": "^4.1",
    "cakephp/migrations": "^3.0.0",
    "cakephp/plugin-installer": "^1.3",
    "dereuromark/cakephp-queue": "^5.0",
    "dereuromark/cakephp-tools": "^2.1",
    "dereuromark/cakephp-setup": "^2.0",
    "easybill/php-sdk": "^2.0",
    "gamez/mite": "^1.0",
    "guzzlehttp/guzzle": "^6.5",
    "http-interop/http-factory-guzzle": "^1.0",
    "jeroendesloovere/vcard": "^1.7",
    "lesstif/php-jira-rest-client": "^2.4",
    "mlocati/ip-lib": "^1.12",
    "mobiledetect/mobiledetectlib": "^2.8",
    "php-http/guzzle6-adapter": "^2.0.1",
    "phpoffice/phpspreadsheet": "^1.9",
    "phpseclib/phpseclib": "^2.0",
    "solarium/solarium": "^6.0",
    "stevenmaguire/oauth2-bitbucket": "^3.0",
    "symfony/event-dispatcher": "^5.1"
  },
  "require-dev": {
    "cakephp/bake": "^2.0",
    "cakephp/cakephp-codesniffer": "^4.1",
    "cakephp/debug_kit": "^4.0",
    "dereuromark/cakephp-ide-helper": "^1.5",
    "dereuromark/cakephp-test-helper": "^1.0",
    "josegonzalez/dotenv": "^3.2",
    "pakacuda/cakephp-fixture-factories": "^0.2.4",
    "phpunit/phpunit": "^8.5",
    "psy/psysh": "@stable",
    "phan/phan": "^2.4"
  },
  "suggest": {
    "markstory/asset_compress": "An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.",
    "dereuromark/cakephp-ide-helper": "After baking your code, this keeps your annotations in sync with the code evolving from there on for maximum IDE and PHPStan compatibility."
  },
  "autoload": {
    "psr-4": {
      "App\\": "src/"
    }
  },
  "autoload-dev": {
    "psr-4": {
      "App\\Test\\": "tests/",
      "Cake\\Test\\": "vendor/cakephp/cakephp/tests/"
    }
  },
  "scripts": {
    "post-install-cmd": "App\\Console\\Installer::postInstall",
    "post-create-project-cmd": "App\\Console\\Installer::postInstall",
    "check": [
      "@test",
      "@cs-check"
    ],
    "cs-check": "phpcs --colors -p --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
    "cs-fix": "phpcbf --colors --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
    "stan": "phpstan analyse src/",
    "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan-shim:^0.11 && mv composer.backup composer.json",
    "local-test": "./local-phpunit --colors=always",
    "local-coverage": "./local-phpunit --coverage-html webroot/coverage",
    "local-setup": "./local-cake code_completion generate && ./local-cake phpstorm generate",
    "local-annotate": "./local-cake annotate all"
  },
  "minimum-stability" : "beta",
  "config": {
    "sort-packages": true,
    "process-timeout": 0
  }
}

composer.lock.zip

LordSimal · 2020-09-30T07:47:05Z

But of course this can only be a special case just for users like me which were previously on that bugfix for Composer v2

ADmad · 2020-09-30T07:48:07Z

The only reason i used the DEV version is because I used your bugfix from #48

Oh sorry, yes that's a special case and normally no one will get that message.

You can run composer dumpautoload either locally or on production and you now won't get any message after removing post-autoload-dump hook.

othercorey · 2020-10-14T23:18:04Z

Let's merge and release. We won't get any more testing out of this.

ADmad · 2020-10-15T05:45:17Z

We would have to keep composer v2 constraint with @RC if we want to merge and release now (I don't mind it). Composer v2's stable release is slated for end of October.

BTW our plugin installer v1.2 doesn't work at all now with the composer 2 RC releases. The composer update/install seems to go nicely and doesn't give any errors but the folders for the plugins under vendors are simply missing 🙂.

othercorey · 2020-10-15T07:15:25Z

Ah right. I guess we could just wait.

ADmad added 6 commits April 10, 2020 00:38

Upgrade to cakephp codesniffer v4

993331b

Upgrade to PHPUnit v8.5

69e0b36

Upgrade to composer v2.

340af1f

Change package type to "composer-plugin".

daea918

Add new Plugin class which implements Composer's PluginInterface.

Update unused PluginInstaller::postAutoloadDump() to just show warning.

ec5230c

Fix CS error

0b2b0fb

ADmad force-pushed the next branch from 8196a8e to cfbfa4a Compare April 23, 2020 07:09

Update travis config

460634a

ADmad force-pushed the next branch from cfbfa4a to 460634a Compare April 23, 2020 07:12

ADmad force-pushed the next branch from 07a8fe4 to b393b41 Compare September 26, 2020 20:34

Fix CS error

fe210ee

ADmad force-pushed the next branch from b393b41 to fe210ee Compare September 26, 2020 20:38

Update composer config

1e3ad2d

ADmad mentioned this pull request Sep 27, 2020

Removed deprecated methods. #48

Closed

ADmad added 2 commits September 28, 2020 13:52

Merge branch 'master' into next

bfd8028

Remove unneeded tests/bootstrap.php

c385c0e

ADmad marked this pull request as ready for review September 28, 2020 08:33

ADmad added 2 commits September 28, 2020 14:06

Update docblock

c87002d

update error message

5381afa

ADmad force-pushed the next branch 2 times, most recently from 2820e6d to 9ae955a Compare October 14, 2020 20:17

Add support for PHP 8

74b1508

ADmad force-pushed the next branch from 9ae955a to 74b1508 Compare October 14, 2020 21:10

ADmad merged commit 549548a into master Oct 24, 2020

ADmad deleted the next branch October 24, 2020 07:29

Conversation

ADmad commented Apr 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issues with current version

Changes in this PR

Compatibility

Uh oh!

markstory commented Sep 28, 2020

Uh oh!

ADmad commented Sep 28, 2020

Uh oh!

ADmad commented Sep 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

othercorey commented Sep 28, 2020

Uh oh!

ADmad commented Sep 28, 2020

Uh oh!

markstory commented Sep 29, 2020

Uh oh!

ADmad commented Sep 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

othercorey commented Sep 29, 2020

Uh oh!

LordSimal commented Sep 30, 2020

Uh oh!

ADmad commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LordSimal commented Sep 30, 2020

Uh oh!

LordSimal commented Sep 30, 2020

Uh oh!

ADmad commented Sep 30, 2020

Uh oh!

othercorey commented Oct 14, 2020

Uh oh!

ADmad commented Oct 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

othercorey commented Oct 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ADmad commented Apr 23, 2020 •

edited

Loading

ADmad commented Sep 28, 2020 •

edited

Loading

ADmad commented Sep 29, 2020 •

edited

Loading

ADmad commented Sep 30, 2020 •

edited

Loading

ADmad commented Oct 15, 2020 •

edited

Loading