Merge pull request #852 from fractal-analytics-platform/851-adapt-to-new-oauth-related-env-variables

Adapt to new backend OAuth variables

Author: zonia3000

.github/workflows/end_to_end_tests.yaml

@@ -13,10 +13,11 @@ jobs:
     timeout-minutes: 20
 
     env:
-      OAUTH_DEXIDP_CLIENT_ID: client_test_web_id
-      OAUTH_DEXIDP_CLIENT_SECRET: client_test_web_secret
-      OAUTH_DEXIDP_REDIRECT_URL: "http://localhost:5173/auth/login/oauth2/"
-      OAUTH_DEXIDP_OIDC_CONFIGURATION_ENDPOINT: "http://127.0.0.1:5556/dex/.well-known/openid-configuration"
+      OAUTH_CLIENT_NAME: dexidp
+      OAUTH_CLIENT_ID: client_test_web_id
+      OAUTH_CLIENT_SECRET: client_test_web_secret
+      OAUTH_REDIRECT_URL: "http://localhost:5173/auth/login/oauth2/"
+      OAUTH_OIDC_CONFIG_ENDPOINT: "http://127.0.0.1:5556/dex/.well-known/openid-configuration"
       PUBLIC_OAUTH_CLIENT_NAME: dexidp
       PUBLIC_FRACTAL_DATA_URL: http://localhost:3000/data
       PUBLIC_FRACTAL_VIZARR_VIEWER_URL: http://localhost:3000/data/vizarr

docs/development/tests.md

@@ -25,10 +25,11 @@ To skip Pixi test set the environment variable `SKIP_PIXI_TEST` to `true`.
 To run the OAuth2 test locally add the following configuration to `.fractal_server.env`:
 
 ```
-OAUTH_DEXIDP_CLIENT_ID=client_test_web_id
-OAUTH_DEXIDP_CLIENT_SECRET=client_test_web_secret
-OAUTH_DEXIDP_REDIRECT_URL=http://localhost:5173/auth/login/oauth2/
-OAUTH_DEXIDP_OIDC_CONFIGURATION_ENDPOINT=http://127.0.0.1:5556/dex/.well-known/openid-configuration
+OAUTH_CLIENT_NAME=dexidp
+OAUTH_CLIENT_ID=client_test_web_id
+OAUTH_CLIENT_SECRET=client_test_web_secret
+OAUTH_REDIRECT_URL=http://localhost:5173/auth/login/oauth2/
+OAUTH_OIDC_CONFIG_ENDPOINT=http://127.0.0.1:5556/dex/.well-known/openid-configuration
 ```
 
 And then start the test IdP container:

docs/oauth2.md

@@ -22,9 +22,10 @@ This variable has to match the client name defined in fractal-server configurati
     * Authorization callback URL: http://127.0.0.1:5173/auth/login/oauth2/
 2. Set up the following env variables for fractal-server:
 ```
-OAUTH_GITHUB_CLIENT_ID=...
-OAUTH_GITHUB_CLIENT_SECRET=...
-OAUTH_GITHUB_REDIRECT_URL=http://127.0.0.1:5173/auth/login/oauth2/
+OAUTH_CLIENT_NAME=github
+OAUTH_CLIENT_ID=...
+OAUTH_CLIENT_SECRET=...
+OAUTH_REDIRECT_URL=http://127.0.0.1:5173/auth/login/oauth2/
 # [all other variables]
 ```
 3. Set up the following env variables for fractal-web:

src/routes/v2/admin/settings/+page.server.js

@@ -9,10 +9,12 @@ export async function load({ fetch }) {
 	const appSettings = await listSettings(fetch, 'app');
 	const databaseSettings = await listSettings(fetch, 'database');
 	const emailSettings = await listSettings(fetch, 'email');
+	const oauthSettings = await listSettings(fetch, 'oauth');
 
 	return {
 		appSettings,
 		databaseSettings,
-		emailSettings
+		emailSettings,
+		oauthSettings
 	};
 }

src/routes/v2/admin/settings/+page.svelte

@@ -4,13 +4,15 @@
 	const appSettings = $derived(page.data.appSettings);
 	const databaseSettings = $derived(page.data.databaseSettings);
 	const emailSettings = $derived(page.data.emailSettings);
+	const oauthSettings = $derived(page.data.oauthSettings);
 
 	let showObfuscated = $state(false);
 
 	const settings = $derived([
 		['App settings', appSettings],
 		['Database settings', databaseSettings],
-		['E-mail settings', emailSettings]
+		['E-mail settings', emailSettings],
+		['OAuth settings', oauthSettings]
 	]);
 </script>
 

tests/start-test-server.sh

@@ -34,10 +34,11 @@ if [ ! -d "$fractal_server_test_path" ]; then
   cp "$(pwd)/tests/resource.json" "$fractal_server_test_path"
 
   if [ "$SKIP_OAUTH_TEST" != "true" ]; then
-    echo "\nOAUTH_DEXIDP_CLIENT_ID=client_test_web_id" >> "${fractal_server_test_path}/.fractal_server.env"
-    echo "OAUTH_DEXIDP_CLIENT_SECRET=client_test_web_secret" >> "${fractal_server_test_path}/.fractal_server.env"
-    echo "OAUTH_DEXIDP_REDIRECT_URL=http://localhost:5173/auth/login/oauth2/" >> "${fractal_server_test_path}/.fractal_server.env"
-    echo "OAUTH_DEXIDP_OIDC_CONFIGURATION_ENDPOINT=http://127.0.0.1:5556/dex/.well-known/openid-configuration" >> "${fractal_server_test_path}/.fractal_server.env"
+    echo "\nOAUTH_CLIENT_NAME=dexidp" >> "${fractal_server_test_path}/.fractal_server.env"
+    echo "OAUTH_CLIENT_ID=client_test_web_id" >> "${fractal_server_test_path}/.fractal_server.env"
+    echo "OAUTH_CLIENT_SECRET=client_test_web_secret" >> "${fractal_server_test_path}/.fractal_server.env"
+    echo "OAUTH_REDIRECT_URL=http://localhost:5173/auth/login/oauth2/" >> "${fractal_server_test_path}/.fractal_server.env"
+    echo "OAUTH_OIDC_CONFIG_ENDPOINT=http://127.0.0.1:5556/dex/.well-known/openid-configuration" >> "${fractal_server_test_path}/.fractal_server.env"
   fi
 
   cd "$fractal_server_test_path"