feat: add config header

[Keeper-of-the-Keys]

• Resolves: [Bug]: Upgrade process re-renders config.php in a less readable/useable fashion #55171 (implements part of the suggested fix)

Summary

config.php is re-rendered by nextcloud regularly removing comments and rendering constants into their values, nextcloud supports using multiple config files and renders their content into the main config.php without modifying the external files.
This PR adds a header to config.php warning the admin/user of this and suggesting the use of the multiple config files mechanism.

TODO

• In the future adding a footer that lists the files that were rendered into config.php in the order that they were included will probably help admins troubleshoot if a config variable is doubled up by mistake.
• Expand documentation more at https://docs.nextcloud.com/server/33/admin_manual/configuration_server/config_sample_php_parameters.html#multiple-merged-configuration-files with examples
• Add example/suggestion to use separate file for DB configuration https://docs.nextcloud.com/server/33/admin_manual/configuration_database/linux_database_configuration.html#ssl-for-mysql-database

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)
• Labels added where applicable (ex: bug/enhancement, 3. to review, feature component)
• Milestone added for target branch/version (ex: 32.x for stable32)

AI (if applicable)

• The content of this PR was partly or fully generated using AI

[Keeper-of-the-Keys]

Please note that I asked on NC Talk how I could test this code before creating the PR and did not get an answer, I would love to test it before we move forward, I solidify my claim that this works as expected.

[provokateurin]

Nice addition! I think there are some small things to improve, but overall it looks very good already. I will let the CI run once these things have been adjusted.

[Keeper-of-the-Keys]

Do I need to do anything more or regularly update the branch until it is merged or is my side of things done?

[provokateurin]

You need to update the tests to account for your changes. You can see the failures here: https://github.com/nextcloud/server/actions/runs/23019402943/job/66860023752?pr=58886. You can run them locally using ./autotest.sh sqlite tests/lib/ConfigTest.php. After they pass, just amend the commit.

Please squash all your commits and make sure they follow https://www.conventionalcommits.org/en/v1.0.0/.

[provokateurin]

Tests need to be updated.

[Keeper-of-the-Keys]

I just tried to run a rebase, because I originally started working on this a half year ago there are ~5600 commits in the squash commits including conflicts that I need to resolve, it may be better to close this PR and reopen a new branch based on the current HEAD and the comments that were here, unless there is some better tool to do this.

[provokateurin]

That's not necessary. If you want I can rebase your PR for you. I could also adjusts the tests, but maybe you'd like to do that yourself? Just let me know what you need from us :)

[Keeper-of-the-Keys]

I'm happy to try on the one hand, on the other it seems to be more work than just creating a new branch and a new PR...

What I tried to do was git rebase -i HEAD~11

If there is a better/faster way to do this I'm happy to learn but it seems like a waste of time to me to start resolving merge conflicts in the past half year of commits that were for sure already resolved/were never an issue to begin with.

[provokateurin]

A git fetch && git rebase origin/master should be enough.

[Keeper-of-the-Keys]

That doesn't look like it squashed everything unless I'm very much mistaken.

/Edit - I ran:
git fetch upstream && git rebase upstream/master

[provokateurin]

Yes sorry, I also realized my instructions might not match your setup.

[provokateurin]

Can you adjust the tests now so they pass?

[Keeper-of-the-Keys]

When you say adjust the tests what exactly do you mean?

[miaulalala]

When you say adjust the tests what exactly do you mean?

You need to add your new header to the text in \Test\ConfigTest::TESTCONTENT

You can run the test locally by running NOCOVERAGE=1 ./autotest.sh sqlite tests/lib/ConfigTest.php

If you need more help, join us in our community dev chat

[miaulalala]

Cypress and performance won't run on your fork, so nothing to do there.

Can you squash your commits into a single one and sign the commit?

easiest way is:

git fetch origin
git reset --soft origin/master
git commit -sm "feat: add config header"
git push --force-with-lease

[Keeper-of-the-Keys]

OOF, looks like I should have rebased first based on the amount of files changed.