Merge pull request #557 from fractal-analytics-platform/warning-banners

Supported warning banner, FRACTAL_API_V1_MODE=include_read_only, and displayed OAuth2 accounts in user profile page

Author: zonia3000

.env

@@ -19,3 +19,4 @@ LOG_LEVEL_FILE=info
 LOG_LEVEL_CONSOLE=warn
 
 FRACTAL_API_V1_MODE=include
+#WARNING_BANNER_PATH=/path/to/banner.txt

.env.development

@@ -18,3 +18,4 @@ LOG_LEVEL_FILE=debug
 LOG_LEVEL_CONSOLE=info
 
 FRACTAL_API_V1_MODE=include
+#WARNING_BANNER_PATH=/path/to/banner.txt

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 # Unreleased
 
+* Displayed OAuth2 accounts in user profile page (\#557);
+* Supported `FRACTAL_API_V1_MODE=include_read_only` (\#557);
+* Added support for displaying temporary warning banner using the `WARNING_BANNER_PATH` environment variable (\#557);
 * Deprecated support for legacy tasks in V2 workflows (\#554);
 
 # 1.5.0

docs/development/tests.md

@@ -20,7 +20,24 @@ By default v2 tests are run. These tests require running a fractal-server instan
 
 To run v1 tests start playwright setting the environment variable `TEST_VERSION` to `v1`. These tests require running a fractal-server instance using `FRACTAL_RUNNER_BACKEND=local`.
 
-OAuth2 test requires a running instance of dexidp test image and a fractal-server instance configured to use it. To skip OAuth2 test set the environment variable `SKIP_OAUTH_TEST` to `true`.
+OAuth2 test requires a running instance of dexidp test image and a fractal-server instance configured to use it.
+
+To skip OAuth2 test set the environment variable `SKIP_OAUTH_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
+```
+
+And then start the test IdP container:
+
+```sh
+docker run -d --rm -p 5556:5556 ghcr.io/fractal-analytics-platform/oauth:0.1
+```
 
 ## Coverage
 

docs/environment-variables.md

@@ -16,8 +16,9 @@ The following environment variables can be used to configure fractal-web.
 * `LOG_FILE`: the path of the file where logs will be written; by default is unset and no file will be created;
 * `LOG_LEVEL_FILE`: the log level of logs that will be written to the file; the default value is `info`;
 * `LOG_LEVEL_CONSOLE`: the log level of logs that will be written to the console; the default value is `warn`;
-* `FRACTAL_API_V1_MODE`: include/exclude V1 pages and version switcher; the default value is `include`;
-* `PUBLIC_FRACTAL_VIZARR_VIEWER_URL`: URL to [fractal-vizarr-viewer](https://github.com/fractal-analytics-platform/fractal-vizarr-viewer) service (e.g. http://localhost:3000/vizarr for testing).
+* `FRACTAL_API_V1_MODE`: include/exclude V1 pages and version switcher; supported values are: `include`, `include_read_only`, `exclude`; the default value is `include`;
+* `PUBLIC_FRACTAL_VIZARR_VIEWER_URL`: URL to [fractal-vizarr-viewer](https://github.com/fractal-analytics-platform/fractal-vizarr-viewer) service (e.g. http://localhost:3000/vizarr for testing);
+* `WARNING_BANNER_PATH`: specifies the path to a text file containing the warning banner message displayed on the site; the banner is used to inform users about important issues, such as external resources downtime or maintenance alerts; if the variable is empty or unset no banner is displayed.
 
 When running directly using `node` command these extra variables can also be configured:
 

docs/quickstart.md

@@ -57,6 +57,9 @@ export LOG_FILE=fractal-web.log
 
 export FRACTAL_API_V1_MODE=include
 
+#export PUBLIC_FRACTAL_VIZARR_VIEWER_URL=
+#export WARNING_BANNER_PATH=
+
 # default values are usually fine for the following variables; remove comments if needed
 #export AUTH_COOKIE_NAME=fastapiusersauth
 #export AUTH_COOKIE_PATH=/

playwright.config.js

@@ -107,7 +107,7 @@ export default defineConfig({
 
 	webServer: [
 		{
-			command: './tests/start-test-server.sh 2.5.0a0',
+			command: './tests/start-test-server.sh 2.5.0a1',
 			port: 8000,
 			waitForPort: true,
 			stdout: 'pipe',

src/lib/types.d.ts

@@ -117,6 +117,11 @@ export type User = {
   slurm_accounts: string[]
   group_names?: string[]
   group_ids?: number[]
+  oauth_accounts: Array<{
+    id: number
+    account_email: string
+    oauth_name: string
+  }>
 }
 
 export type Group = {

src/routes/+layout.server.js

@@ -1,5 +1,6 @@
 import { env } from '$env/dynamic/private';
 import { getLogger } from '$lib/server/logger.js';
+import fs from 'fs/promises';
 
 const logger = getLogger('page layout');
 
@@ -16,8 +17,24 @@ export async function load({ locals, request, url }) {
 		logger.error('pageInfo is missing, it should have been loaded by hooks.server.js');
 	}
 
+	const warningBanner = await getWarningBanner();
+
 	return {
 		...pageInfo,
-		v1Enabled: env.FRACTAL_API_V1_MODE !== 'exclude'
+		warningBanner,
+		apiV1Mode: env.FRACTAL_API_V1_MODE
 	};
 }
+
+async function getWarningBanner() {
+	if (!env.WARNING_BANNER_PATH) {
+		return null;
+	}
+	try {
+		const bannerData = await fs.readFile(env.WARNING_BANNER_PATH, { encoding: 'utf-8' });
+		return bannerData.trim();
+	} catch (err) {
+		logger.error('An error happened reading warning banner file %s', env.WARNING_BANNER_PATH, err);
+		return null;
+	}
+}

src/routes/+layout.svelte

@@ -11,12 +11,13 @@
 	$: server = $page.data.serverInfo || {};
 	/** @type {'v1'|'v2'} */
 	$: apiVersion = $page.url.pathname.startsWith('/v1') ? 'v1' : 'v2';
+	$: warningBanner = $page.data.warningBanner;
 	// @ts-ignore
 	// eslint-disable-next-line no-undef
 	let clientVersion = __APP_VERSION__;
 
 	$: displayVersionSelector =
-		$page.data.v1Enabled &&
+		$page.data.apiV1Mode !== 'exclude' &&
 		(!isSubPage($page.url.pathname, apiVersion) ||
 			$page.url.pathname === '/v2/admin/jobs' ||
 			$page.url.pathname === '/v1/admin/jobs') &&
@@ -220,6 +221,19 @@
 				Sorry, we are performing some maintenance on fractal-server. It will be back online soon.
 			</div>
 		{/if}
+		{#if apiVersion === 'v1' && $page.data.apiV1Mode === 'include_read_only'}
+			<div class="alert alert-warning">Warning: legacy API is in read-only mode.</div>
+		{/if}
+		{#if warningBanner}
+			<div class="alert alert-warning">
+				{#each warningBanner.split('\n') as line, index}
+					{#if index > 0}
+						<br />
+					{/if}
+					{line}
+				{/each}
+			</div>
+		{/if}
 		{#if userLoggedIn && !$page.data.userInfo.is_verified}
 			<div class="row">
 				<div class="col">