refactor(settings): standardize Constance env overrides to CONSTANCE_ prefix DEV-1976

[platreth]

🔗 Related PRs — must merge together

This is the app-side of a 3-repo Constance env-var standardization:

• chore(env): rename KOBO_SUPPORT_EMAIL to CONSTANCE_SUPPORT_EMAIL DEV-1976 kobo-install#279 — rename in the kobo-install env template
• chore(env): rename KOBO_SUPPORT_EMAIL to CONSTANCE_SUPPORT_EMAIL DEV-1976 kobo-docker#373 — rename in the kobo-docker default env file

The kpi app now reads CONSTANCE_SUPPORT_EMAIL, so shipping one without the others silently drops the support email to its default. Merge/release together.

📣 Summary

Standardize all Constance override env vars on a single CONSTANCE_ prefix.

📖 Description

The env vars that override Constance defaults used three conventions (bare, KOBO_, CONSTANCE_). This unifies them on CONSTANCE_, matching the existing CONSTANCE_ASR_MT_GOOGLE_* precedent.

Renamed:

• KOBO_SUPPORT_EMAIL → CONSTANCE_SUPPORT_EMAIL
• KOBO_SUPPORT_URL → CONSTANCE_SUPPORT_URL
• KOBO_ACADEMY_URL → CONSTANCE_ACADEMY_URL
• KOBO_COMMUNITY_URL → CONSTANCE_COMMUNITY_URL
• USAGE_LIMIT_ENFORCEMENT → CONSTANCE_USAGE_LIMIT_ENFORCEMENT (env fallback in base.py + pytest env in pyproject.toml)

⚠️ Breaking: no backward-compat fallback. Deployments setting the old names must rename them. The two deploy repos are covered by the paired PRs above.

✅ Test plan

• test_api_environment.py — both settings axes
• usage-limit-enforcement tests (KPI submissions, OpenRosa, subsequences)

[greptile-apps]

Greptile Summary

This PR standardizes all Constance env-var overrides to a CONSTANCE_ prefix, replacing the previous mix of bare names, KOBO_, and CONSTANCE_ conventions. It introduces a shared _constance_env helper that resolves the new-prefixed key, falls back transparently to the deprecated name with a DeprecationWarning, and otherwise returns the hard-coded default.

• kobo/settings/base.py: Adds _constance_env(getter, new_key, deprecated_key, default) and applies it to SUPPORT_EMAIL, SUPPORT_URL, ACADEMY_URL, COMMUNITY_URL, and USAGE_LIMIT_ENFORCEMENT; removes the now-superseded migration comment for the ASR_MT_GOOGLE_* vars.
• pyproject.toml: Renames the pytest env override from USAGE_LIMIT_ENFORCEMENT=True to CONSTANCE_USAGE_LIMIT_ENFORCEMENT=True to match the new name, ensuring usage-limit tests still behave correctly.

Confidence Score: 5/5

Safe to merge — the refactor correctly resolves env vars with a deprecation-warning fallback, and the pytest env rename keeps tests consistent.

The two-line logic in _constance_env is straightforward, warnings is already imported, and the existing ASR_MT_GOOGLE_* vars confirm the pattern works. The only note is that the PR description overstates the breaking nature of the change — the code actually provides a graceful fallback — but this does not affect runtime correctness.

No files require special attention.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Settings module loads] --> B{Is deprecated_key in os.environ?}
    B -- Yes --> C[Emit DeprecationWarning]
    B -- No --> D[No warning]
    C --> E[Resolve deprecated_key value]
    D --> F[Resolve deprecated_key value or default]
    E --> G{Is new CONSTANCE_ key in os.environ?}
    F --> G
    G -- Yes --> H[Use CONSTANCE_ key value]
    G -- No --> I[Use deprecated key value or default]
    H --> J[CONSTANCE_CONFIG default set]
    I --> J

Loading

%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Settings module loads] --> B{Is deprecated_key in os.environ?}
    B -- Yes --> C[Emit DeprecationWarning]
    B -- No --> D[No warning]
    C --> E[Resolve deprecated_key value]
    D --> F[Resolve deprecated_key value or default]
    E --> G{Is new CONSTANCE_ key in os.environ?}
    F --> G
    G -- Yes --> H[Use CONSTANCE_ key value]
    G -- No --> I[Use deprecated key value or default]
    H --> J[CONSTANCE_CONFIG default set]
    I --> J

Loading

_{Reviews (2): Last reviewed commit: "refactor(settings): keep backward-compat..." | Re-trigger Greptile}

[noliveleger]

Let's not break the compatibility here.
Just read from the new variable but keep reading from the deprecated one too.

For any deprecated variable. Please log a Deprecation warning instance.
See

kpi/kobo/settings/base.py

Lines 2007 to 2014 in 39416ad

	if not (MONGO_DB_URL := env.str('MONGO_DB_URL', False)):
	# ToDo Remove all this block by the end of 2022.
	# Update kobo-install accordingly
	logging.warning(
	'`MONGO_DB_URL` is not found. '
	'`KPI_MONGO_HOST`, `KPI_MONGO_PORT`, `KPI_MONGO_NAME`, '
	'`KPI_MONGO_USER`, `KPI_MONGO_PASS` '
	'are deprecated and will not be supported anymore soon.'

[platreth]

Yes, that's way better! Done

[noliveleger]

You should also update the PR description.
It does not match what's happening anymore 🙏

[noliveleger]

Would you mind to create an utility file where this could be moved out the settings files.
You can also move other helpers present in that file (e.g.: dj_stripe_request_callback_method)