[Enhancement]: allow using pr_id as a Preview Deployments Environment Variables

[larbijirari]

Request Type

Improvement

Description

this will help linking the backend and frontend apps.
example:
where $pr_id is representing the current pr_id

[MatanMaimon]

Any update on this one!? 🙏

[nil0ft]

Would like to see that!

[Arnaud-IFEA]

Hello,
i don't even understand how people can make the preview deployment to work actually !
if you have an url in your envvar it can't adapt to a preview deployment.
If with docker compose you use a service name to connect to the database (you don't want a public URL!), how can you make it work knowing that preview deployment changes service names.

[astabeno]

I worked for a while trying to get preview branches to work. It seems like this feature is not really ready unless you have a pretty simple setup. A docker-compose with multiple containers and a tightly coupled DB that needs isolation in PR environment doesn't seem feasible yet.

[atlijohanns]

This would be a great! Makes syncing two preview apps in a monorepo so much simpler.

[faahim]

Upvoting this! ⬆️

[bysontin]

Upvoting this too. It would be a great enhancement !

[djsisson]

if someone wants to test, try add the following (it has to start with COOLIFY):

            if ($this->application->environment_variables_preview->where('key', 'COOLIFY_PR_ID')->isEmpty()) {
                  $coolify_envs->put('COOLIFY_PR_ID', $this->pull_request_id);
            }

to here

coolify/app/Jobs/ApplicationDeploymentJob.php

Lines 1621 to 1647 in 723f14e

	if ($this->application->environment_variables_preview->where('key', 'COOLIFY_FQDN')->isEmpty()) {
	if ((int) $this->application->compose_parsing_version >= 3) {
	$coolify_envs->put('COOLIFY_URL', $this->preview->fqdn);
	} else {
	$coolify_envs->put('COOLIFY_FQDN', $this->preview->fqdn);
	}
	}
	if ($this->application->environment_variables_preview->where('key', 'COOLIFY_URL')->isEmpty()) {
	$url = str($this->preview->fqdn)->replace('http://', '')->replace('https://', '');
	if ((int) $this->application->compose_parsing_version >= 3) {
	$coolify_envs->put('COOLIFY_FQDN', $url);
	} else {
	$coolify_envs->put('COOLIFY_URL', $url);
	}
	}
	if ($this->application->build_pack !== 'dockercompose' || $this->application->compose_parsing_version === '1' || $this->application->compose_parsing_version === '2') {
	if ($this->application->environment_variables_preview->where('key', 'COOLIFY_BRANCH')->isEmpty()) {
	$coolify_envs->put('COOLIFY_BRANCH', $local_branch);
	}
	if ($this->application->environment_variables_preview->where('key', 'COOLIFY_RESOURCE_UUID')->isEmpty()) {
	$coolify_envs->put('COOLIFY_RESOURCE_UUID', $this->application->uuid);
	}
	if ($this->application->environment_variables_preview->where('key', 'COOLIFY_CONTAINER_NAME')->isEmpty()) {
	$coolify_envs->put('COOLIFY_CONTAINER_NAME', $this->container_name);
	}
	}

[atlijohanns]

Hey @djsisson.

Could you help me understand where this code is located? Is it somewhere in the Coolify install on my underlying self hosted environment?

[djsisson]

although you can exec into your docker container and manually edit the php files and then update using some artisan commands, i don't recommend it

i meant the above for testing locally, the file is linked above the bottom code section

[nemvince]

+1

[chrisgen19]

any status on this?

[ondrejznojil]

+1

Would really love to see this feature. Otherwise, it is very hard to use preview deployments.

[Cinzya]

What's the usecase / reason that the PR ID is needed as a env variable?

If it's to pass the URL of a preview deployment, you can use Coolifys Predefined environment variables. For Applications that will be COOLIFY_URL and for service stacks SERVICE_URL_IDENTIFIER.
There is also a SERVICE_NAME_IDENTIFIER which resolves to the name of a service in a service stack.

[Cinzya]

yes. Lets say your compose looks like this

frontend:
	image: nginx:latest
...
api:
	image: node:latest
...

then you can get the url for the frontend service via the predefined environment variables SERVICE_URL_FRONTEND and for the api SERVICE_URL_API.

[SuperRonanCraft]

I see a problem about this as some libraries especially @t3-oss/env-nextjs a typesafe environment variable library expect environment variables, that are meant for client's, require to be prefixed with "NEXT_PUBLIC" else it literally doesn't let you create a client environment variable.
I actually need the {{pr_id}} to be available to I can create a preview env variable called NEXT_PUBLIC_FRONTEND_URL=https://{{pr_id}}.preview.myapp.com so I can give clients the current frontend url that I described, also another example would be the auth call back url like NEXTAUTH_URL from NextAuth, it would allow me to have dynamic auth routes so authentication isn't broken between pr's
Since the pr creates a new url each time, I cant use just "preview.myapp.com" because my team works on multiple pr's at one time so I need the flexibility, if this pr variable can available for environment variables it would make github pre-deployments a dream!

[Cinzya]

What stops you from doing

NEXT_PUBLIC_SERVICE_URL_FRONTEND=$SERVICE_URL_FRONTEND

?

[kareemmahlees]

@Cinzya Here is a use case I am currently encountering and don't know how to get about it.

I am currently trying to setup preview deployments with each deployment connecting to a separate database branch, I would have liked to be able to add the following env var to my preview deployments:

DATABASE_URL=postgresql://postgres:postgres@localhost:5432/$pr_id

and in my CI/CD I would create a database branch with that PR id or number before triggering a deployment in coolify.

Can this be done now with the available env vars or this is a valid use-case where some PR specific env vars would have solved it?

[LeanderM99]

@kareemmahlees Im currently having the same issue. Could you please inform me if you find a solution for that problem?

[hubertoschusch]

Bump