SECRET_KEY: fall back to beaker.session.secret

[wardi]

Proposed fixes:

• default secret_key to beaker.session.secret for easier config migration/sharing configurations between ckan versions
• a small config documentation fix

Features:

• includes tests covering changes
• includes updated documentation
• includes user-visible changes
• includes API changes
• includes bugfix for possible backport

[wardi]

@amercader interested in your thoughts on this one. If the uppercase SECRET_KEY is a flask convention should we change envvars so it can generate this option instead?

[amercader]

I think we should align with Flask and keep the upper case SECRET_KEY and make ckanext-envvar catch up and support uppercase config options as we now have plenty of those declared in the config declaration (coming from Flask-login, WTForms, etc) which would be great to support.

I made a first try in ckanext-envvars, using the config declaration if present (ie CKAN>=2.10) to keep those keys declared as they are when parsing the env vars. This works well in CKAN 2.11 (master) but not in CKAN 2.10. The problem is that SECRET_KEY is declared as internal: true in CKAN 2.10 which I think prevents it from being returned when doing config_declaration.iter_options().

ckan/ckanext-envvars#9

I'll keep investigating but does this seem like a good approach to explore?

[wardi]

@amercader ckan/ckanext-envvars#9 looks good to me.

I'll remove the lowercase secret_key part of this PR

[amercader]

ckanext-envvars 0.0.4 supports upper case config options

[wardi]

@amercader I merged #7884 so we can see the tests passing, once we merge that to master this will be easier to review

[ckanbot]

Backport failed for dev-v2.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dev-v2.11
git worktree add -d .worktree/backport-7853-to-dev-v2.11 origin/dev-v2.11
cd .worktree/backport-7853-to-dev-v2.11
git switch --create backport-7853-to-dev-v2.11
git cherry-pick -x 4160facd55bedf321b0f32d9b73f57f2aea8730a 1ab96909f6b04f0d90a8bd7ed2758f315dc97b12 1cd72262274895e08a0d835e79f391b3712dddc2