Docs: migration 4.6.x to 4.7.0 - project space that received changes ( clarification)

[ampmonteiro]

PHP Version

8.5

CodeIgniter4 Version

4.6.5

CodeIgniter4 Installation Method

Composer (using codeigniter4/appstarter)

Which operating systems have you tested for this bug?

Linux

Which server did you use?

fpm-fcgi

Environment

development

Database

No response

What happened?

Hi,

after doing / update from version 4.6.4 to 4.6.5,

i was reading the migration / indication guide of doing from Upgrading from 4.6.x to 4.7.0

in section project-files, missing the indication which source you can / should copy that files that were changed ?

from :

• repo: codeigniter4/CodeIgniter4
• repo: codeigniter4/appstarter
• repo: codeigniter4/framework

Maybe i should ask in the forum, however, i think this should be well explicit in Docs.

Thank you,

Steps to Reproduce

you read the changelog of 4.7.0

this mention nothing and then in

Upgrading from 4.6.x to 4.7.0 indicate the files however does not mention which repo to do do the copy of that files

Expected Output

To be clear of which repo / source of framework to do the manual copy of that files that are in Config folder

should be explicit and clear this info in docs in this two section of website:

• changelog of respective version
• Upgrading From a Previous Version

Anything else?

No response

[neznaika0]

The files should be copied from your /vendor/codeigniter4/framework folder. Appstarter has the same framework package.
There will be differences if you have set as a zip archive - the files will be located in the /system.

[ampmonteiro]

The files should be copied from your /vendor/codeigniter4/framework folder. Appstarter has the same framework package. .

That is the problem, the Appstarter which is in repo codeigniter4/appstarter some files are missmatch with codeigniter4/CodeIgniter4 and
codeigniter4/framework, this last two, has have so far same updated files, even with diff dates.

I notice in this, for example in one of files mentioned files in upgrade guide:
in app/Config/Paths, it is missing $envDirectory prop.

Either way, the info that you, after update framework package via composer, copy that files from vendor/codeigniter4/framework into respective app/Config/ files remains a problem to be fixed in the docs.

[neznaika0]

this is a bug during the update. The versions must be the same.

@michalsn @samsonasik @paulbalandan bug found.
appstarter automatic updates are lagging behind the framework.

[paulbalandan]

In appstarter the only file that should be different is the app/Config/Paths.php. Other than that, everything should be the same. How is appstarter lagging specifically?

[neznaika0]

No changes have been made to it to search for .env

[ampmonteiro]

@paulbalandan

i dont understand why, when you do composer create, composer, by my understand, copy the files in codeigniter4/appstarter, right ?

if so, in my opinion make no sense to be diff appstarter repo to be diff from codeigniter/framework which is what will be in the vendor folder.

i will try to verify the other files, comparing between this branches:

repo: codeigniter4/appstarter
repo: codeigniter4/framework

@neznaika0
is that for me ?

like i said, in app/Config/Paths, it is missing $envDirectory prop.

[paulbalandan]

I see now. Paths.php in appstarter lacked the new $envDirectory property as @ampmonteiro says. This is because it was not updated when the configurable env directory PR was made.

[ampmonteiro]

@neznaika0 @paulbalandan

Hi beside app > Configs > Paths, also in

Configs > Toolbar ( when i had 4.6.4 and now 4.6.5 )

changes form Index::class -> Routes::class (for some reason this change is not in 4.6.4 and 4.6.5)

all of this you can verify in this my repo and branch:

mirgation to v4_7_0

[paulbalandan]

@ampmonteiro that index::class was not a documented change. It may be your own changes but at least 6 years ago it was already Routes::class. see b8ad778

[ampmonteiro]

@paulbalandan @neznaika0

i did not change the toolbar file, tomorrow will compare with project company which still is in v4.6.4

now here summary that i asked to github copilot to do after i asked it to compare between my app > config files with what is in vendor > framework > app > Config ( from that branch changes mirgation to v4_7_0:

Config Files Comparison

Comparison between play/app/Config/ and play/vendor/codeigniter4/framework/app/Config/

Summary

Out of 17 config files compared, 3 files have differences and 14 files are identical to the framework defaults.

---

Files with Differences

1. Paths.php - 2 Differences

1a. System Directory Path

Version	Value
App	__DIR__ . '/../../vendor/codeigniter4/framework/system'
Framework	__DIR__ . '/../../system'

1b. Missing Property

The framework version has an additional property that your app is missing:

/**
 * ---------------------------------------------------------------
 * ENVIRONMENT DIRECTORY NAME
 * ---------------------------------------------------------------
 *
 * This variable must contain the name of the directory where
 * the .env file is located.
 * Please consider security implications when changing this
 * value - the directory should not be publicly accessible.
 */
public string $envDirectory = __DIR__ . '/../../';

Impact: Your app doesn't define where the .env file is located, which might cause issues if the framework expects this property.

2. Images.php - 1 Comment Difference

Deprecation Comment

Version	Comment
App	@deprecated 4.7.0 No longer used. Will be removed in a future release.
Framework	@deprecated 4.7.0 No longer used.

Impact: Minor - only affects documentation/comments. The actual functionality is identical.

---

3. Toolbar.php - 1 Formatting Difference

watchedExtensions Array Format

App Version:

public array $watchedExtensions = [
    'php',
    'css',
    'js',
    'html',
    'svg',
    'json',
    'env',
];

Framework Version:

public array $watchedExtensions = [
    'php', 'css', 'js', 'html', 'svg', 'json', 'env',
];

Impact: None - both are functionally identical, just formatted differently (multi-line vs single-line).

---

Files with NO Differences

The following 14 config files are identical to the framework defaults:

1. ✅ CURLRequest.php
2. ✅ Cache.php
3. ✅ ContentSecurityPolicy.php
4. ✅ Email.php
5. ✅ Encryption.php
6. ✅ Format.php
7. ✅ Hostnames.php
8. ✅ Migrations.php
9. ✅ Optimize.php
10. ✅ Session.php
11. ✅ UserAgents.php
12. ✅ View.php
13. ✅ WorkerMode.php
14. ✅ Routing.php

---

Recommendations

Critical

• Consider adding envDirectory to Paths.php if the framework or your application depends on this property.

Non-Critical

• Images.php comment difference is purely cosmetic.
• Toolbar.php formatting difference has no functional impact.

[paulbalandan]

Difference 1a is intentional as that is needed for the appstarter to work.

1b is a bug that needs fixing.

Overall, we should need a test that will catch this in the future. Or the pipeline should be updated.

[ampmonteiro]

@paulbalandan @neznaika0

1a - ok ( understood)
1b - bug (Paths file)

now, please about the Docs, when possible like i asked here, add info about how / which source to be used to update that files in local project app > Configs > [ * ] .

Something like:

• if installed via composer, go and compare the mention files between local files in app > Configs and in vendor/codeigniter4/framework/app/Config/

• if without composer. ......

Thank you.

[neznaika0]

This note is not important here, as it should be clear to everyone that you need to copy from the original /system (the one you have installed)

[ampmonteiro]

@neznaika0
about this:

This note is not important here, as it should be clear to everyone that you need to copy from the original /system (the one you have installed)

Sorry but ahhh, LOL,

i will try to give you a short answer, because a long would take much time, effort and etc ....

So,

1. if it was clear in the DOCS, i would not have to waste my time writing this issue

2. this is a breaking changes, in semantic version you only should do breaking changes in major version not in minor version and even less in patch versions.
   you did in minor version.

3. Unfortunately, with all due respect to all people, who contribute to this framework i have to write:
   only CI framework, even with package manager, make a developer waste time coping files, from a folder generated with a tool like composer ( vendor folder in this case), that should only related to the framework, not to the project itself.

If you want to stop read, i only ask, please update / fix the DOCS.

if you have time keep reading about my frustrations about few decisions and mistakes in this framework.

Thanks. ;)

One thing is a change of syntax, another thing is configuration, that in this context, could be in env, for example to config thing like cache serve.
Things like a toolbar, a developer should not even be touching it, or Paths, it is up to framework to make available class methods to config things like where is path for views, controller, models, routes declarations, etc.
Some configs can be defined in env file, others config via Class Methods / settings by defining an API for that. Make no sense coping files, even worst in minor version by doing several braking changes.

Another breaking changes, that marked me when i was still learning CI 4, when was changed already in version 4, you change defined routes from routing file into separated file called Routes, bringing a confusion in the Config folder between Routing and Routes.

Another Breaking Changes was between version 2/3 to 4, this one already created and was closed the issue, the decision, which still do not understand, all frameworks use and so did this framework in version 2/3, the choice of not to use PDO drivers base, WTF,,,

Last, i did not choose this framework, even i liked some improvements and its evolution, however it was up to the company i current work, even i tried to changed their mind, no luck.