Incorrect message when `plugins` directory not exists using bake #909

kicaj · 2023-02-20T23:15:21Z

Description

During creating new plugin using command bin/cake bake plugin PluginName with not existed plugins directory.

Bake:

no returns information for required plugins directory;
returns strange information:

[Cake\Core\Exception\MissingPluginException] Plugin  could not be found. in /var/www/html/vendor/cakephp/cakephp/src/Core/PluginCollection.php on line 143
Exception Attributes: array (
  'plugin' => '',
)
Stack Trace:
- /var/www/html/vendor/cakephp/cakephp/src/Core/PluginCollection.php:257
...

Bake Version

2.8.2

CakePHP Version

4.4.11

The text was updated successfully, but these errors were encountered:

dereuromark · 2023-02-20T23:27:56Z

I can reproduce this, for some reason the PluginCollection is throwing the exception a bit too eagerly.

dereuromark · 2023-02-20T23:39:56Z

Looks related to cakephp/cakephp#16374
cc @ADmad

Should we try catch this?

ADmad · 2023-02-21T03:16:14Z

The error is unrelated to that PR.

PluginCommand needs to check whether the directory for $this->path actually exists

bake/src/Command/PluginCommand.php

Line 52 in e7e795c

$this->path = current(App::path('plugins'));

ADmad · 2023-02-21T03:22:15Z

It does seem like cakephp/cakephp#16374 uncovered this issue :)

ADmad · 2023-02-21T03:23:11Z

@kicaj Can you provide the full stack trace please.

ADmad · 2023-02-21T03:40:42Z

Hmm.. I am unable to reproduce this with the latest core and bake releases. Bake just creates the missing plugins directory (and the plugin folder and files) without any errors.

LordSimal · 2023-02-21T04:33:24Z

I can confirm the error with cakephp/cakephp 4.4.5 and cakephp/bake 2.7.1
This only happens, if the plugins directory is removed manually since the cakephp/app project template does indeed create a empty plugins directory with .gitkeep file in there.

Here is the stacktrace:

-> % bin/cake bake plugin PluginName
Plugin Name: PluginName
Plugin Directory: /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/plugins/PluginName
-------------------------------------------------------------------------------
Look okay? (y/n/q) 
[y] > 
2023-02-21 05:30:00 error: [Cake\Core\Exception\MissingPluginException] Plugin  could not be found. in /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php on line 143
Exception Attributes: array (
  'plugin' => '',
)
Stack Trace:
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php:257
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php:219
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/Plugin.php:87
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php:193
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php:115
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php:81
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/BaseCommand.php:189
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php:334
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php:172
- /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/bin/cake.php:12

Stack Trace:

deprecationWarning /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/functions.php, line 321
Cake\Error\ExceptionTrap::renderer() /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php, line 123
Cake\Error\ExceptionTrap::handleException() /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php, line 239
[main] [internal], line ??
[Cake\Core\Exception\MissingPluginException] Plugin  could not be found. in /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php on line 143

Exception Attributes

array (
  'plugin' => '',
)

Stack Trace:

#0 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php(257): Cake\Core\PluginCollection->findPath('')
#1 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php(219): Cake\Core\PluginCollection->create('')
#2 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/Plugin.php(87): Cake\Core\PluginCollection->get('')
#3 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php(193): Cake\Core\Plugin::templatePath('')
#4 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php(115): Bake\Command\PluginCommand->_generateFiles('PluginName', '/Users/kevinpfe...', Object(Cake\Console\Arguments), Object(Cake\Console\ConsoleIo))
#5 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/bake/src/Command/PluginCommand.php(81): Bake\Command\PluginCommand->bake('PluginName', Object(Cake\Console\Arguments), Object(Cake\Console\ConsoleIo))
#6 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/BaseCommand.php(189): Bake\Command\PluginCommand->execute(Object(Cake\Console\Arguments), Object(Cake\Console\ConsoleIo))
#7 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php(334): Cake\Console\BaseCommand->run(Array, Object(Cake\Console\ConsoleIo))
#8 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php(172): Cake\Console\CommandRunner->runCommand(Object(Bake\Command\PluginCommand), Array, Object(Cake\Console\ConsoleIo))
#9 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/bin/cake.php(12): Cake\Console\CommandRunner->run(Array)
#10 {main}

ADmad · 2023-02-21T04:36:26Z

I can confirm the error with cakephp/cakephp 4.4.5 and cakephp/bake 2.7.1

Latest versions are cakephp/cakephp 4.4.11 and cakephp/bake 2.8.2

LordSimal · 2023-02-21T04:40:05Z

This issue still persists for me when using cakephp/cakephp 4.4.11 and cakephp/bake 2.8.2

kevinpfeifer@Kevins-MBP [05:41:18] [~/Documents/CakePHP-Videos/02_requirements_and_installation/cms] [master *]
-> % composer show cakephp/cakephp | grep versions
versions : * 4.4.11
kevinpfeifer@Kevins-MBP [05:41:28] [~/Documents/CakePHP-Videos/02_requirements_and_installation/cms] [master *]
-> % composer show cakephp/bake | grep versions
versions : * 2.8.2
kevinpfeifer@Kevins-MBP [05:41:32] [~/Documents/CakePHP-Videos/02_requirements_and_installation/cms] [master *]
-> % bin/cake bake plugin PluginName              
[Cake\Core\Exception\MissingPluginException] Plugin PluginName could not be found. in /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php on line 143

Exception Attributes

array (
  'plugin' => 'PluginName',
)

Stack Trace:

#0 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Core/PluginCollection.php(257): Cake\Core\PluginCollection->findPath('PluginName')
#1 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Http/BaseApplication.php(129): Cake\Core\PluginCollection->create('PluginName', Array)
#2 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/src/Application.php(67): Cake\Http\BaseApplication->addPlugin('PluginName')
#3 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php(195): App\Application->bootstrap()
#4 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/vendor/cakephp/cakephp/src/Console/CommandRunner.php(133): Cake\Console\CommandRunner->bootstrap()
#5 /Users/kevinpfeifer/Documents/CakePHP-Videos/02_requirements_and_installation/cms/bin/cake.php(12): Cake\Console\CommandRunner->run(Array)
#6 {main}

ADmad · 2023-02-21T04:44:00Z

There problem is here. The default value for theme is set to empty string and has() does a isset() check. So templatePath() gets called with an empty string. (I have a default theme set hence I couldn't reproduced it)

bake/src/Command/PluginCommand.php

Lines 193 to 194 in e7e795c

    
           if ($args->hasOption('theme')) { 
        
               $paths[] = Plugin::templatePath($args->getOption('theme'));

LordSimal · 2023-02-21T04:48:34Z

Well then it should be cakephp/bake's command responsibility to make sure the configured plugin directory is present at all, right? If it is not present, create it.

ADmad · 2023-02-21T05:42:41Z

Bake does create the plugins directory if missing but this theme check is done before the file generation starts.

Plugin::templatePath() shouldn't be called with an empty string, so the if check should be updated accordingly or perhaps change the default value for theme option from empty string to null so that if ($args->hasOption('theme')) check suffices.

LordSimal · 2023-02-21T05:58:37Z

Then go ahead and fix it yourself. I am unable to fix it with your approach because setting

'default' => Configure::read('Bake.theme') ?? ''

to

'default' => Configure::read('Bake.theme'),

doesn't fix it and I don't understand the difference between making sure the directory is present beforehand and your weird theme approach which should automatically create the directory (which it doesn't for me as well).

Why should the theme flag/option be responsible for creating the plugins directory?

This was caused due to `Bake.theme` option defaulting to empty string instead of null and hence a plugin with empty name was being searched causing an exception. Closes #909

kicaj added the defect label Feb 20, 2023

dereuromark added this to the 2.x (CakePHP 4) milestone Feb 20, 2023

LordSimal mentioned this issue Feb 21, 2023

2.x: make sure the configured plugin directory exists before baking a plugin #910

Closed

ADmad mentioned this issue Feb 21, 2023

Fix error when trying to bake with non-existent plugins directory. #911

Merged

dereuromark closed this as completed in #911 Feb 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorrect message when `plugins` directory not exists using bake #909

Incorrect message when `plugins` directory not exists using bake #909

kicaj commented Feb 20, 2023 •

edited by dereuromark

dereuromark commented Feb 20, 2023 •

edited

dereuromark commented Feb 20, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023

ADmad commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

LordSimal commented Feb 21, 2023

ADmad commented Feb 21, 2023

LordSimal commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023

LordSimal commented Feb 21, 2023

ADmad commented Feb 21, 2023 •

edited

LordSimal commented Feb 21, 2023 •

edited

Incorrect message when plugins directory not exists using bake #909

Incorrect message when plugins directory not exists using bake #909

Comments

kicaj commented Feb 20, 2023 • edited by dereuromark

Description

Bake Version

CakePHP Version

dereuromark commented Feb 20, 2023 • edited

dereuromark commented Feb 20, 2023 • edited

ADmad commented Feb 21, 2023 • edited

ADmad commented Feb 21, 2023

ADmad commented Feb 21, 2023 • edited

ADmad commented Feb 21, 2023 • edited

LordSimal commented Feb 21, 2023

ADmad commented Feb 21, 2023

LordSimal commented Feb 21, 2023 • edited

ADmad commented Feb 21, 2023

LordSimal commented Feb 21, 2023

ADmad commented Feb 21, 2023 • edited

LordSimal commented Feb 21, 2023 • edited

Incorrect message when `plugins` directory not exists using bake #909

Incorrect message when `plugins` directory not exists using bake #909

kicaj commented Feb 20, 2023 •

edited by dereuromark

dereuromark commented Feb 20, 2023 •

edited

dereuromark commented Feb 20, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

LordSimal commented Feb 21, 2023 •

edited

ADmad commented Feb 21, 2023 •

edited

LordSimal commented Feb 21, 2023 •

edited