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

kenjis · 2024-04-10T02:10:53Z

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

App\ThirdParty\Shield\Config\Auth
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

…eady in use See codeigniter4/shield#1091

datamweb

Nice!

kenjis · 2024-04-12T01:40:47Z

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.

michalsn · 2024-04-12T16:04:27Z

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 · 2024-04-12T21:30:57Z

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 · 2024-04-13T01:01:12Z

The current auto-discovery process flow is as follows:

create all file paths to be checked from the list of namespaces
guess a class name from a file path using namespace path list
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 · 2024-04-13T10:53:40Z

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

…me is already in use See codeigniter4#8745 (comment)

kenjis · 2024-04-13T12:40:10Z

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

…me is already in use See codeigniter4#8745 (comment)

fix: Cannot declare class Shield\Config\Auth, because the name is alr…

5e6979b

…eady in use See codeigniter4/shield#1091

kenjis added the bug Verified issues on the current code behavior or pull requests that will fix them label Apr 10, 2024

kenjis mentioned this pull request Apr 10, 2024

Bug: [CI4.5.0] Cannot declare class Shield\Config\Auth codeigniter4/shield#1091

Closed

datamweb approved these changes Apr 10, 2024

View reviewed changes

datamweb mentioned this pull request Apr 11, 2024

feat: use config file in the custom namespace datamweb/shield-oauth#108

Merged

kenjis mentioned this pull request Apr 12, 2024

chore: update PHP versions codeigniter4/translations#441

Merged

1 task

samsonasik approved these changes Apr 13, 2024

View reviewed changes

michalsn approved these changes Apr 13, 2024

View reviewed changes

kenjis merged commit 666c8fc into codeigniter4:develop Apr 13, 2024
40 checks passed

kenjis deleted the fix-findQualifiedNameFromPath-Cannot-declare-class branch April 13, 2024 10:47

kenjis added a commit to kenjis/CodeIgniter4 that referenced this pull request Apr 13, 2024

fix: Cannot declare class CodeIgniter\Config\Services, because the na…

90748d2

…me is already in use See codeigniter4#8745 (comment)

kenjis mentioned this pull request Apr 13, 2024

fix: Cannot declare class CodeIgniter\Config\Services, because the name is already in use #8775

Closed

5 tasks

kenjis added a commit to kenjis/CodeIgniter4 that referenced this pull request Apr 13, 2024

fix: Cannot declare class CodeIgniter\Config\Services, because the na…

9f850f7

…me is already in use See codeigniter4#8745 (comment)

kenjis mentioned this pull request Apr 13, 2024

fix: Cannot declare class CodeIgniter\Config\Services, because the name is already in use #8776

Merged

5 tasks

datamweb mentioned this pull request Jun 27, 2024

Bug: Cannot declare class Config\ShieldOAuthConfig, because the name is already in use datamweb/shield-oauth#120

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kenjis commented Apr 10, 2024 •

edited

Loading

datamweb left a comment

kenjis commented Apr 12, 2024

michalsn commented Apr 12, 2024

kenjis commented Apr 12, 2024 •

edited

Loading

kenjis commented Apr 13, 2024

kenjis commented Apr 13, 2024

kenjis commented Apr 13, 2024 •

edited

Loading

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

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

Conversation

kenjis commented Apr 10, 2024 • edited Loading

datamweb left a comment

Choose a reason for hiding this comment

kenjis commented Apr 12, 2024

michalsn commented Apr 12, 2024

kenjis commented Apr 12, 2024 • edited Loading

kenjis commented Apr 13, 2024

kenjis commented Apr 13, 2024

kenjis commented Apr 13, 2024 • edited Loading

kenjis commented Apr 10, 2024 •

edited

Loading

kenjis commented Apr 12, 2024 •

edited

Loading

kenjis commented Apr 13, 2024 •

edited

Loading