WorkOS not working with cached config

[rolandorojas]

Laravel Version

12

PHP Version

8.4

Database Driver & Version

No response

Description

The WorkOS integration breaks when running php artisan config:cache

The reason seems to be that the workos-php package tries to get the API key using an environment variable, which stops working after the configuration is cached. If you try to log in with the configuration cached, you will get a WorkOS\Exception\ConfigurationException

Here is the relevant stacktrace:

$apiKey is required {"exception":"[object] (WorkOS\\Exception\\ConfigurationException(code: 0): $apiKey is required at C:\\Projects\\Experiments\\test\\vendor\\workos\\workos-php\\lib\\WorkOS.php:52)
[stacktrace]                                                                                                         
#0 C:\\Projects\\Experiments\\test\\vendor\\workos\\workos-php\\lib\\UserManagement.php(750): WorkOS\\WorkOS::getApiKey()
#1 C:\\Projects\\Experiments\\test\\vendor\\laravel\\workos\\src\\Http\\Requests\\AuthKitAuthenticationRequest.php(28): WorkOS\\UserManagement->authenticateWithCode('****', '****')
#2 C:\\Projects\\Experiments\\test\\routes\\auth.php(13): Laravel\\WorkOS\\Http\\Requests\\AuthKitAuthenticationRequest->authenticate()
#3 C:\\Projects\\Experiments\\test\\vendor\\laravel\\framework\\src\\Illuminate\\Support\\helpers.php(399): Illuminate\\Routing\\RouteFileRegistrar->{closure}(Object(Illuminate\\Http\\RedirectResponse))                                
#4 C:\\Projects\\Experiments\\test\\routes\\auth.php(13): tap(Object(Illuminate\\Http\\RedirectResponse), Object(Closure))                            

Steps To Reproduce

1. Create a new laravel app
2. Select the livewire starter kit
3. Select workos as the auth provider
4. Create a WorkOS account and set your credentials in your .env file.
5. Try to log in. It should work normally.
6. Clear your cookies and run php artisan config:cache
7. Try to log in again. You should now see a WorkOS\Exception\ConfigurationException with message "$apiKey is required"

[alexisyanguas]

php artisan config:cache does not clear the cache but recreates it, do php artisan config:clear, it works for me

[rodrigopedra]

php artisan config:cache does not clear the cache but recreates it, do php artisan config:clear, it works for me

The very first thing php artisan config:cache does, is to call php artisan config:clear

framework/src/Illuminate/Foundation/Console/ConfigCacheCommand.php

Lines 56 to 58 in 8f3f0fd

	public function handle()
	{
	$this->callSilent('config:clear');

Running just php artisan config:clear, clears any cached configuration, thus all files under your ./config directory will be read for each request. Which degrades performance per request.

I believe this the scenario the author wants to avoid.

[alexisyanguas]

I didn't think about performance, so if another solution is provided then I'm also interested.😊

[iBotPeaches]

The setting of the configs - probably need to be manually initiated like their unofficial wrapper did.

See official: https://github.com/laravel/workos/blob/main/src/WorkOS.php#L29
See unofficial: https://github.com/workos/workos-php-laravel/blob/main/lib/WorkOSServiceProvider.php#L32

Which would expand the services.workos so you can pull from a cached config / config powered env.

[jpmorby]

There is an official laravel SDK which is basically the workos-php that the starter kit installs, plus additional laravel specific bits ...

composer require workos/workos-php-laravel

Just doing this seems to overcome the issue ... literally no other work required.

I would suggest adding the workos/workos-php-laravel dependency to the composer files