Keep config

[rodinux]

Problem

• to resolve the issue #49, the upgrade will remove personalization in the config.local.php

Solution

• I propose to keep the file config.local.php on the upgrade script without reinstall it from config

PR Status

• [ ] Code finished and ready to be reviewed/tested
• [ ] The fix/enhancement were manually tested (if applicable)

Automatic tests

Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ after creating the PR, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)

[rodinux]

@alexAubin @ericgaspar , do you think we can do this ? Or is better add a file config.local.user.php dedicated to personalization on the folder __DATA__DIR__/data ??

I am just afraid about if someone try upgrade from older versions where we did not add all the new constants... in that case I would like to add something as

if ynh_compare_current_package_version --comparison lt --version 1.3.1~ynh1
then
   ynh_script_progression --message="Updating a configuration file..." --weight=5

  ynh_add_config --template="config.local.php" --destination="$install_dir/config.local.php"
  chmod 650 "$install_dir/config.local.php"
  chown $app:$app "$install_dir/config.local.php"
fi

Then, it can be a better way keep always the config.local.php without need bring it back from the config if admin users add personalization on the constants...

[alexAubin]

There is no straightforward way to address the issue, this is a shortcoming of the current strategy in packaging regarding app config 1) One the one hand, you want the new version of the app config to be applied in case there are new keys to be added etc ... 2) On the other hand, you don't want to overwrite manually modified files because the amin may have tweaked stuff

The "real" way to address this would be to keep the original config file somewhere and use like a git merge thing somehow, but for now we don't have the logistic for this

[rodinux]

There is no straightforward way to address the issue, this is a shortcoming of the current strategy in packaging regarding app config

1. One the one hand, you want the new version of the app config to be applied in case there are new keys to be added etc ...

2. On the other hand, you don't want to overwrite manually modified files because the amin may have tweaked stuff

The "real" way to address this would be to keep the original config file somewhere and use like a git merge thing somehow, but for now we don't have the logistic for this

Ok, what about doing like this ? I added a file config here $data_dir/data/config.local.user.php Then a line at the bottom of the file $intall_dir/config.local.php

/**
 * Chemin vers le fichier pour des configurations personnelles
 * qui ne sera pas écraser lors des mises à jour.
 */
require '__DATA__DIR__/data/config.local.user.php';

Like this we should keep the config.local.php safe and users can customize on the file in their $data_dir/data/config.local.user.php... For example, they could configure API key and user, isn't it ? or Nextcloud sync or wopi_url to use collabora or only_office...

[rodinux]

Ok, I found how makes it working... !testme

[yunohost-bot]

:stuck_out_tongue_winking_eye:

[rodinux]

!testme

[yunohost-bot]

Fingers crossed!

[rodinux]

Ok, So I have added some stuff when try

• installing app garradin_ynh,
• made a pre-install, then a migration to paheko with the command sudo yunohost app upgrade garradin -u https://github.com/YunoHost-Apps/paheko_ynh/tree/garradin-migration --debug.
• At this moment the migration is well, but not very clean and have old configurations with some files $install_dir/config.local.yunohost.php and $install_dir/config.local.user.php and also a duplicated directory $install_dir/data/data, so I do a first cleaning here:

https://github.com/YunoHost-Apps/paheko_ynh/blob/9c0aa9a58481d9a23316fd1d1aee68a6fa0e474a/scripts/upgrade#L35-L44

• Also, at the end of the upgrade to I need mv the db files .sqlite on the new path:

https://github.com/YunoHost-Apps/paheko_ynh/blob/9c0aa9a58481d9a23316fd1d1aee68a6fa0e474a/scripts/upgrade#L109-L112

This works nice...

[rodinux]

!testme

[yunohost-bot]

:sunflower:

[rodinux]

!testme

[yunohost-bot]

:rocket:

[rodinux]

!testme

[yunohost-bot]

May the CI gods be with you!

[rodinux]

For me it's OK this time, after doing few tests...

[rodinux]

!testme

[yunohost-bot]

Alrighty!

[rodinux]

There is no straightforward way to address the issue, this is a shortcoming of the current strategy in packaging regarding app config

1. One the one hand, you want the new version of the app config to be applied in case there are new keys to be added etc ...

2. On the other hand, you don't want to overwrite manually modified files because the amin may have tweaked stuff

The "real" way to address this would be to keep the original config file somewhere and use like a git merge thing somehow, but for now we don't have the logistic for this

Hello, after lot of tests, I think I can push this PR, it will keep a config.local.user.php for the users in the $data_dir/data/ folder, needed for add some personal configurations and keep them on an upgrade. It keep the original config file also.

Do you approve ? also @ericgaspar is it OK for you ?

[ericgaspar]

but to be honest I am not really following the package :)

[rodinux]

but to be honest I am not really following the package :)

Ok thanks.