IBX-10764: Extracted Upsun environmental variables #2

barw4 · 2025-10-29T08:38:12Z

🎫 Issue	IBX-10764

Related PRs:

ibexa/core#672
ibexa/recipes-dev#222

Description:

Overview

UpsunEnvVarLoader parses Upsun environment variables (PLATFORM_RELATIONSHIPS, PLATFORM_ROUTES) and exposes them as env vars for Ibexa application.

Env Vars Generation

1. Database (MySQL/PostgreSQL)

Logic: Iterates over mysql* and pgsql* schemes (uses str_starts_with for HA support like mysql-replica)

Generated variables:

{RELATIONSHIP_NAME}_URL - full URL with charset and serverVersion
{RELATIONSHIP_NAME}_USER
{RELATIONSHIP_NAME}_USERNAME
{RELATIONSHIP_NAME}_PASSWORD
{RELATIONSHIP_NAME}_HOST
{RELATIONSHIP_NAME}_PORT
{RELATIONSHIP_NAME}_NAME
{RELATIONSHIP_NAME}_DATABASE
{RELATIONSHIP_NAME}_DRIVER
{RELATIONSHIP_NAME}_SERVER

Example: Relationship database → DATABASE_URL, DATABASE_HOST, etc.

2. DFS Database

Logic:

dfs_database relationship gets the SAME treatment as any other database via buildDatabaseEnvVars (full URL with charset, serverVersion, etc.)
ADDITIONALLY, if PLATFORMSH_DFS_NFS_PATH is set, buildDfsEnvVars adds DFS-specific variables

Condition for DFS-specific vars: Only when $_SERVER['PLATFORMSH_DFS_NFS_PATH'] is set

Standard database variables (from buildDatabaseEnvVars):

DFS_DATABASE_URL - full URL with charset and serverVersion
DFS_DATABASE_HOST
DFS_DATABASE_PORT
DFS_DATABASE_USER
DFS_DATABASE_USERNAME
DFS_DATABASE_PASSWORD
DFS_DATABASE_NAME
DFS_DATABASE_DATABASE
DFS_DATABASE_DRIVER
DFS_DATABASE_SERVER

DFS-specific variables (from buildDfsEnvVars, only when NFS path is set):

DFS_NFS_PATH
DFS_DATABASE_CHARSET
DFS_DATABASE_COLLATION
DFS_DATABASE_DRIVER (PDO driver format, e.g., pdo_mysql)

3. Cache (Redis/Memcached)

Priority: Redis ALWAYS before Memcached (regardless of array order)

Logic:

First process all Redis endpoints
Then process Memcached (only as fallback for CACHE_POOL)

Generated variables per endpoint:

{RELATIONSHIP_NAME}_URL (Redis only)
{RELATIONSHIP_NAME}_HOST
{RELATIONSHIP_NAME}_PORT
{RELATIONSHIP_NAME}_SCHEME (Redis only)

Global variables (first found):

CACHE_POOL - cache.redis or cache.memcached
CACHE_DSN

4. Session (Redis)

Priority:

First looks for relationship named redissession (dedicated Redis for sessions)
Fallback - first Redis found by scheme (any name: rediscache, myredis, etc.)

Generated variables:

SESSION_HANDLER_ID - NativeSessionHandler class
SESSION_SAVE_PATH - host:port

5. Search (Solr/Elasticsearch)

Solr logic: Checks $endpoint['scheme'] === 'solr'

Elasticsearch logic: Checks $endpoint['rel'] === 'elasticsearch' (NOT scheme, because ES uses http/https)

Solr generated variables:

SEARCH_ENGINE = solr
SOLR_DSN
SOLR_CORE
{RELATIONSHIP_NAME}_HOST
{RELATIONSHIP_NAME}_PORT
{RELATIONSHIP_NAME}_NAME
{RELATIONSHIP_NAME}_DATABASE

Elasticsearch generated variables:

SEARCH_ENGINE = elasticsearch
ELASTICSEARCH_DSN
{RELATIONSHIP_NAME}_URL
{RELATIONSHIP_NAME}_HOST
{RELATIONSHIP_NAME}_PORT
{RELATIONSHIP_NAME}_SCHEME

6. Varnish (HTTP Cache)

Logic: Looks for route with type: upstream and upstream: varnish, prefers primary: true

Generated variables:

HTTPCACHE_PURGE_TYPE = varnish
HTTPCACHE_PURGE_SERVER
HTTPCACHE_VARNISH_INVALIDATE_TOKEN

Summary: When we use relationship name vs scheme

Service	Identification method	Notes
Database	Scheme (`mysql`, `pgsql`)	`str_starts_with` for HA
DFS	Relationship name (`dfs_database`)	Within mysql/pgsql schemes
Redis/Memcached	Scheme (`redis`, `memcached`)	Redis always first
Session	Name (`redissession`) + scheme fallback	Dedicated redis preferred
Solr	Scheme (`solr`)	-
Elasticsearch	`rel` field (`elasticsearch`)	NOT scheme (uses http/https)
Varnish	Route config	`type: upstream`, `upstream: varnish`

Relationship naming conventions

Recommended names (but not required, except for special cases):

database - main database
dfs_database - DFS database (this name is required)
rediscache - Redis for cache
redissession - Redis for sessions (this name is preferred for dedicated instance)
elasticsearch - Elasticsearch
solr - Solr

Developers can use any relationship names - env vars will be generated with a prefix matching the relationship name (uppercase, - → _).

For QA:

Documentation:

konradoboza

Can we have at least logging when configuration contains errors? I assume exceptions on build/deploy will be rather annoying.

I'm also missing some unhappy path testing a bit, but this is related to the remark above.

src/bundle/DependencyInjection/UpsunEnvVarLoader.php

konradoboza · 2025-12-08T13:55:20Z

src/bundle/DependencyInjection/UpsunEnvVarLoader.php

+            foreach ($groupedRelationships['redis'] as $endpoints) {
+                foreach ($endpoints as $endpoint) {


Why nested foreach if we return an array in the first iteration?

I'm not sure I follow you here, nested foreach is here to return first endpoint under a given relationship's scheme, in this case redis. Am I missing something?

It looks weird at first glance that you iterate in two loops just to return the first element. If we cannot do it differently ($array[0]) then fine.

konradoboza · 2025-12-08T13:56:15Z

src/bundle/DependencyInjection/UpsunEnvVarLoader.php

+    /**
+     * @param array<string, mixed> $route
+     */
+    private function isVarnishRoute(array $route): bool


Is Fastly handled at all here?

Http cache is handled by exactly the same way as in the current core solution: https://github.com/ibexa/core/pull/672/files#diff-0bc93691994620e932aa9941baa089094640bca3da1275b5073f74d5e9b71d16L952

barw4 · 2025-12-08T14:04:45Z

Can we have at least logging when configuration contains errors? I assume exceptions on build/deploy will be rather annoying.

I'm also missing some unhappy path testing a bit, but this is related to the remark above.

@konradoboza I'm not quite sure I understand. What kind of logging or maybe at which point in time do you wish to see such logging to be done?

If configuration contains errors then build hook will crash which is completely expected. The loader presented in this PR doesn't inject itself into build hook, it's active during runtime.

konradoboza · 2025-12-08T14:14:46Z

Ok, just wanted to suggest some way to report misconfigurations. If the build hook fails with proper info, I am fine with that.

barw4 · 2025-12-08T14:15:51Z

Ok, just wanted to suggest some way to report misconfigurations. If the build hook fails with proper info, I am fine with that.

I'm not aware of any way to report broken configuration, if the configuration is broken the build will simply fail on Upsun side and they provide us with build logs :)

konradoboza · 2025-12-09T09:03:36Z

@barw4 please add permissions for ibexa/cloud repository to PHP Team.

barw4 self-assigned this Oct 29, 2025

IBX-10764: Upsun env var loader

fa2b4cb

barw4 force-pushed the ibx-10764-upsun-env-loader branch from effd671 to fa2b4cb Compare October 29, 2025 20:47

IBX-10764: Add unit tests

79e343c

barw4 mentioned this pull request Oct 31, 2025

IBX-10764: Removed dependencies to Platform.sh ibexa/core#672

Open

barw4 added Feature New feature request Work in progress labels Oct 31, 2025

barw4 added 2 commits October 31, 2025 10:12

IBX-10764: Add unit tests for dfs

f760a78

IBX-10764: Baseline

42a104c

barw4 mentioned this pull request Oct 31, 2025

IBX-10764: Replace parameters with env variables to account for Cloud configuration ibexa/recipes-dev#222

Open

barw4 added 9 commits November 3, 2025 22:23

IBX-10764: Bundle boot

0a0c340

IBX-10764: Add test env

b6b5d77

IBX-10764: Fixup

915ae43

IBX-10764: Added container configuration

fa04b31

IBX-10764: Refactor service files loading

4e965aa

IBX-10764: Added database URLs handling

103faad

IBX-10764: Update

5186114

IBX-10764: Update loader

facb7c0

IBX-10764: Updated tests

1043331

barw4 marked this pull request as ready for review December 8, 2025 09:24

barw4 added Ready for review and removed Work in progress labels Dec 8, 2025

barw4 added 5 commits December 8, 2025 10:26

IBX-10764: Cleared PHPStan baseline

5ccc0ed

IBX-10764: CS

84a82ab

IBX-10764: Update

8d4da0b

IBX-10764: Update

84b8c49

IBX-10764: Updated test

cef7cd9

barw4 requested review from Steveb-p, alongosz and mikadamczyk December 8, 2025 11:48

barw4 requested review from ViniTou, ciastektk, konradoboza, tbialcz and wiewiurdp December 8, 2025 11:48

barw4 changed the title ~~IBX-10764: Upsun env var loader~~ IBX-10764: Extracted Upsun environmental variables Dec 8, 2025

konradoboza reviewed Dec 8, 2025

View reviewed changes

barw4 requested a review from konradoboza December 8, 2025 14:06

barw4 added 2 commits December 8, 2025 15:34

IBX-10764: Updated loader

fb9bb3f

IBX-10764: Rollback

388c69d

konradoboza approved these changes Dec 9, 2025

View reviewed changes

Steveb-p approved these changes Dec 11, 2025

View reviewed changes

konradoboza added Ready for QA and removed Ready for review labels Dec 11, 2025

alongosz approved these changes Dec 12, 2025

View reviewed changes

tbialcz approved these changes Dec 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

IBX-10764: Extracted Upsun environmental variables #2

IBX-10764: Extracted Upsun environmental variables #2

Uh oh!

barw4 commented Oct 29, 2025 •

edited by atlassian bot

Loading

Uh oh!

konradoboza left a comment

Uh oh!

Uh oh!

konradoboza Dec 8, 2025

Uh oh!

barw4 Dec 8, 2025 •

edited

Loading

Uh oh!

konradoboza Dec 9, 2025

Uh oh!

konradoboza Dec 8, 2025

Uh oh!

barw4 Dec 8, 2025 •

edited

Loading

Uh oh!

barw4 commented Dec 8, 2025 •

edited

Loading

Uh oh!

konradoboza commented Dec 8, 2025 •

edited

Loading

Uh oh!

barw4 commented Dec 8, 2025

Uh oh!

konradoboza commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		foreach ($groupedRelationships['redis'] as $endpoints) {
		foreach ($endpoints as $endpoint) {

IBX-10764: Extracted Upsun environmental variables #2

Are you sure you want to change the base?

IBX-10764: Extracted Upsun environmental variables #2

Uh oh!

Conversation

barw4 commented Oct 29, 2025 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related PRs:

Description:

Overview

Env Vars Generation

1. Database (MySQL/PostgreSQL)

2. DFS Database

3. Cache (Redis/Memcached)

4. Session (Redis)

5. Search (Solr/Elasticsearch)

6. Varnish (HTTP Cache)

Summary: When we use relationship name vs scheme

Relationship naming conventions

For QA:

Documentation:

Uh oh!

konradoboza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

konradoboza Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

barw4 Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

konradoboza Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

konradoboza Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

barw4 Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

barw4 commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

konradoboza commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

barw4 commented Dec 8, 2025

Uh oh!

konradoboza commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

barw4 commented Oct 29, 2025 •

edited by atlassian bot

Loading

barw4 Dec 8, 2025 •

edited

Loading

barw4 Dec 8, 2025 •

edited

Loading

barw4 commented Dec 8, 2025 •

edited

Loading

konradoboza commented Dec 8, 2025 •

edited

Loading