Skip to content

fix: [FileLocator] Cannot declare class XXX, because the name is already in use#8745

Merged
kenjis merged 1 commit intocodeigniter4:developfrom
kenjis:fix-findQualifiedNameFromPath-Cannot-declare-class
Apr 13, 2024
Merged

fix: [FileLocator] Cannot declare class XXX, because the name is already in use#8745
kenjis merged 1 commit intocodeigniter4:developfrom
kenjis:fix-findQualifiedNameFromPath-Cannot-declare-class

Conversation

@kenjis
Copy link
Copy Markdown
Member

@kenjis kenjis commented Apr 10, 2024 •
edited
Loading

Description
See codeigniter4/shield#1091

If you define a namespace in another namespace,

    public $psr4 = [
        APP_NAMESPACE => APPPATH,
        'Shield'      => APPPATH . 'ThirdParty/Shield',
    ];

The file path app/ThirdParty/Shield/Config/Auth.php could be

  1. App\ThirdParty\Shield\Config\Auth
  2. Shield\Config\Auth

findQualifiedNameFromPath() tries to find App\ThirdParty\Shield\Config\Auth more than once,
then the following error occurs:

Cannot declare class Shield\Config\Auth, because the name is already in use

The error does not occur if app/Config/Auth.php exists.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@kenjis kenjis added the bug Verified issues on the current code behavior or pull requests that will fix them label Apr 10, 2024
@kenjis kenjis mentioned this pull request Apr 10, 2024
Closed
datamweb
datamweb approved these changes Apr 10, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@datamweb datamweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@datamweb datamweb mentioned this pull request Apr 11, 2024
Merged
@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 12, 2024

See also https://github.com/codeigniter4/translations/actions/runs/8652234845/job/23735006874?pr=440

Run if [ "pull_request" = "pull_request" ]; then
PHP Fatal error:  Cannot declare class CodeIgniter\Config\Services, because the name is already in use in /home/runner/work/translations/translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php on line 111

Fatal error: Cannot declare class CodeIgniter\Config\Services, because the name is already in use in /home/runner/work/translations/translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php on line 111
Error: Process completed with exit code 255.

@kenjis kenjis mentioned this pull request Apr 12, 2024
Merged
1 task
@michalsn
Copy link
Copy Markdown
Member

michalsn commented Apr 12, 2024

findQualifiedNameFromPath() tries to find App\ThirdParty\Shield\Config\Auth more than once,
then the following error occurs:

Cannot declare class Shield\Config\Auth, because the name is already in use

To be honest, I don't entirely understand this.

If the problem is that the file is trying to be loaded more than once, why are we collecting class names that don't exist in the $invalidClassnames variable?

Where is the source of the problem? In which place the error is generated?

@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 12, 2024 •
edited
Loading

If the problem is that the file is trying to be loaded more than once, why are we collecting class names that don't exist in the $invalidClassnames variable?

To prevent from loading twice.

Where is the source of the problem? In which place the error is generated?

Composer.

You can easily reproduce in translations repository.
Because it has Translations namespace.
See https://github.com/codeigniter4/translations/blob/2903b570df3c3526055e4d23c19291a90675607b/composer.json#L29-L33

codeigniter4-translations (develop $=)$ bin/test ja
PHP Fatal error:  Cannot declare class CodeIgniter\Config\Services, because the name is already in use in /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php on line 111
PHP Stack trace:
PHP   1. {main}() /Users/kenji/work/codeigniter/official/codeigniter4-translations/bin/test:0
PHP   2. require() /Users/kenji/work/codeigniter/official/codeigniter4-translations/bin/test:15
PHP   3. CodeIgniter\Boot::bootTest($paths = class Config\Paths { public string $systemDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../system'; public string $appDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/..'; public string $writableDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../writable'; public string $testsDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../tests'; public string $viewDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../Views' }) /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Test/bootstrap.php:83
PHP   4. CodeIgniter\Boot::setExceptionHandler() /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Boot.php:120
PHP   5. CodeIgniter\Config\BaseService::__callStatic($name = 'exceptions', $arguments = []) /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Boot.php:241
PHP   6. CodeIgniter\Config\BaseService::serviceExists($name = 'exceptions') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:314
PHP   7. CodeIgniter\Config\BaseService::buildServicesCache() /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:329
PHP   8. CodeIgniter\Autoloader\FileLocator->findQualifiedNameFromPath($path = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:394
PHP   9. class_exists($class = 'Translations\\vendor\\codeigniter4\\codeigniter4\\system\\Config\\Services') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Autoloader/FileLocator.php:296
PHP  10. Composer\Autoload\ClassLoader->loadClass($class = 'Translations\\vendor\\codeigniter4\\codeigniter4\\system\\Config\\Services') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Autoloader/FileLocator.php:296
PHP  11. Composer\Autoload\{closure:/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:575-577}($file = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/../..//vendor/codeigniter4/codeigniter4/system/Config/Services.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:427
PHP  12. include() /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:576

Fatal error: Cannot declare class CodeIgniter\Config\Services, because the name is already in use in /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php on line 111

Call Stack:
    0.0011     630608   1. {main}() /Users/kenji/work/codeigniter/official/codeigniter4-translations/bin/test:0
    0.0027     645992   2. require('/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Test/bootstrap.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/bin/test:15
    0.0059     699520   3. CodeIgniter\Boot::bootTest($paths = class Config\Paths { public string $systemDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../system'; public string $appDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/..'; public string $writableDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../writable'; public string $testsDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../../tests'; public string $viewDirectory = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/app/Config/../Views' }) /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Test/bootstrap.php:83
    0.0391    2471640   4. CodeIgniter\Boot::setExceptionHandler() /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Boot.php:120
    0.0391    2471640   5. CodeIgniter\Config\BaseService::__callStatic($name = 'exceptions', $arguments = []) /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Boot.php:241
    0.0391    2471640   6. CodeIgniter\Config\BaseService::serviceExists($name = 'exceptions') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:314
    0.0391    2471640   7. CodeIgniter\Config\BaseService::buildServicesCache() /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:329
    0.0430    2524336   8. CodeIgniter\Autoloader\FileLocator->findQualifiedNameFromPath($path = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/BaseService.php:394
    0.0431    2543400   9. class_exists($class = 'Translations\\vendor\\codeigniter4\\codeigniter4\\system\\Config\\Services') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Autoloader/FileLocator.php:296
    0.0431    2543528  10. Composer\Autoload\ClassLoader->loadClass($class = 'Translations\\vendor\\codeigniter4\\codeigniter4\\system\\Config\\Services') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Autoloader/FileLocator.php:296
    0.0432    2543720  11. Composer\Autoload\{closure:/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:575-577}($file = '/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/../..//vendor/codeigniter4/codeigniter4/system/Config/Services.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:427
    0.0438    2620984  12. include('/Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/codeigniter4/codeigniter4/system/Config/Services.php') /Users/kenji/work/codeigniter/official/codeigniter4-translations/vendor/composer/ClassLoader.php:576

@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 13, 2024

The current auto-discovery process flow is as follows:

  1. create all file paths to be checked from the list of namespaces
  2. guess a class name from a file path using namespace path list
  3. check if the class exists

In the sample case above, app/ThirdParty/Shield/Config/Auth.php should not be App\ThirdParty\Shield\Config\Auth.
So there is room for improvement in this flow, but the code needs to be rewritten to do so.

@kenjis kenjis merged commit 666c8fc into codeigniter4:develop Apr 13, 2024
@kenjis kenjis deleted the fix-findQualifiedNameFromPath-Cannot-declare-class branch April 13, 2024 10:47
@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 13, 2024

Hmmm....this solved the error in Shield, but not the error in Translations.

kenjis added a commit to kenjis/CodeIgniter4 that referenced this pull request Apr 13, 2024
@kenjis
fix: Cannot declare class CodeIgniter\Config\Services, because the na…
90748d2 
…me is already in use

See codeigniter4#8745 (comment)
@kenjis kenjis mentioned this pull request Apr 13, 2024
Closed
5 tasks
@kenjis
Copy link
Copy Markdown
Member Author

kenjis commented Apr 13, 2024 •
edited
Loading

I sent #8775.
It seems rewriting is better, but I don't want a big change in the patch release.

kenjis added a commit to kenjis/CodeIgniter4 that referenced this pull request Apr 13, 2024
@kenjis
fix: Cannot declare class CodeIgniter\Config\Services, because the na…
9f850f7 
…me is already in use

See codeigniter4#8745 (comment)
@kenjis kenjis mentioned this pull request Apr 13, 2024
Merged
5 tasks
@datamweb datamweb mentioned this pull request Jun 27, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michalsn michalsn michalsn approved these changes

@samsonasik samsonasik samsonasik approved these changes

+1 more reviewer

@datamweb datamweb datamweb approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

bug Verified issues on the current code behavior or pull requests that will fix them

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kenjis @michalsn @samsonasik @datamweb