Merge pull request #514 from fractal-analytics-platform/conditional-v1

zonia3000 · web-flow · commit 8546d71e5b19 · 2024-06-13T12:37:29.000+02:00
Conditionally included V1 pages
diff --git a/.env b/.env
@@ -17,3 +17,5 @@ PUBLIC_OAUTH_CLIENT_NAME=
 LOG_FILE=/tmp/fractal-web.log
 LOG_LEVEL_FILE=info
 LOG_LEVEL_CONSOLE=warn
+
+FRACTAL_API_V1_MODE=include
diff --git a/.env.development b/.env.development
@@ -16,3 +16,5 @@ PUBLIC_OAUTH_CLIENT_NAME=
 LOG_FILE=./fractal-web.log
 LOG_LEVEL_FILE=debug
 LOG_LEVEL_CONSOLE=info
+
+FRACTAL_API_V1_MODE=include
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 # Unreleased
 
+* Conditionally included V1 pages (\#514);
 * Added task version update sandbox page (\#509);
 * JSON Schema form improvements (\#509):
     * supported enums of any type;
diff --git a/docs/development/tests.md b/docs/development/tests.md
@@ -43,7 +43,7 @@ LOCAL_PORT=8000
 REMOTE_USER=...
 REMOTE_HOST_IP=...
 
-ssh $REMOTE_USER@$REMOTE_HOST_IP -L $LOCAL_PORT:$REMOTE_HOST_IP:$REMOTE_PORT -N
+ssh $REMOTE_USER@$REMOTE_HOST_IP -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT -N
 ```
 should work and forward the remote port `REMOTE_PORT` to the `LOCAL_PORT` on
 localhost, so that `fractal-web` can use it from the local machine. Note that
diff --git a/docs/environment-variables.md b/docs/environment-variables.md
@@ -15,7 +15,8 @@ The following environment variables can be used to configure fractal-web.
 * `PUBLIC_OAUTH_CLIENT_NAME`: if set, the application enables the external account login via OAuth2; the name is used to create the authorization call sent to fractal-server (see [configuration page](../oauth2/));
 * `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`.
+* `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`.
 
 When running directly using `node` command these extra variables can also be configured:
 
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -55,6 +55,8 @@ export LOG_FILE=fractal-web.log
 # export LOG_LEVEL_FILE=info
 # export LOG_LEVEL_CONSOLE=warn
 
+export FRACTAL_API_V1_MODE=include
+
 # default values are usually fine for the following variables; remove comments if needed
 #export AUTH_COOKIE_NAME=fastapiusersauth
 #export AUTH_COOKIE_PATH=/
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/routes/+layout.server.js b/src/routes/+layout.server.js
@@ -1,3 +1,4 @@
+import { env } from '$env/dynamic/private';
 import { getLogger } from '$lib/server/logger.js';
 
 const logger = getLogger('page layout');
@@ -15,5 +16,8 @@ export async function load({ locals, request, url }) {
 		logger.error('pageInfo is missing, it should have been loaded by hooks.server.js');
 	}
 
-	return pageInfo;
+	return {
+		...pageInfo,
+		v1Enabled: env.FRACTAL_API_V1_MODE !== 'exclude'
+	};
 }
diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
@@ -16,6 +16,7 @@
 	let clientVersion = __APP_VERSION__;
 
 	$: displayVersionSelector =
+		$page.data.v1Enabled &&
 		(!isSubPage($page.url.pathname, apiVersion) ||
 			$page.url.pathname === '/v2/admin/jobs' ||
 			$page.url.pathname === '/v1/admin/jobs') &&
diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte
@@ -32,16 +32,18 @@
 		{/if}
 	</div>
 
-	<p>
-		This is the new version 2 of Fractal. Your older projects and workflows are still available in
-		the legacy version that you can access in <a href="/v1/projects">the legacy project page</a>. We
-		encourage you to switch to Fractal V2 for all new projects and report any issues you find.
-	</p>
-	<p>
-		We strictly separate projects, datasets and workflows into Fractal V2 and legacy. You can use
-		many of your existing tasks in the Fractal V2 version without any changes required. If you don't
-		find the task you require in Fractal V2, please reach out to the support.
-	</p>
+	{#if $page.data.v1Enabled}
+		<p>
+			This is the new version 2 of Fractal. Your older projects and workflows are still available in
+			the legacy version that you can access in <a href="/v1/projects">the legacy project page</a>.
+			We encourage you to switch to Fractal V2 for all new projects and report any issues you find.
+		</p>
+		<p>
+			We strictly separate projects, datasets and workflows into Fractal V2 and legacy. You can use
+			many of your existing tasks in the Fractal V2 version without any changes required. If you
+			don't find the task you require in Fractal V2, please reach out to the support.
+		</p>
+	{/if}
 
 	{#if env.PUBLIC_FRACTAL_ADMIN_SUPPORT_EMAIL}
 		<h3 class="fw-light">Where to get support</h3>
diff --git a/src/routes/v1/+layout.server.js b/src/routes/v1/+layout.server.js
@@ -0,0 +1,12 @@
+import { getLogger } from '$lib/server/logger';
+import { redirect } from '@sveltejs/kit';
+import { env } from '$env/dynamic/private';
+
+const logger = getLogger('v1 pages');
+
+export async function load() {
+	if (env.FRACTAL_API_V1_MODE === 'exclude') {
+		logger.warn('v1 pages has been disabled, redirecting to home');
+		throw redirect(307, '/');
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { env } from '$env/dynamic/private';`
`1`	`2`	`import { getLogger } from '$lib/server/logger.js';`
`2`	`3`
`3`	`4`	`const logger = getLogger('page layout');`
`@@ -15,5 +16,8 @@ export async function load({ locals, request, url }) {`
`15`	`16`	`logger.error('pageInfo is missing, it should have been loaded by hooks.server.js');`
`16`	`17`	`}`
`17`	`18`
`18`		`- return pageInfo;`
	`19`	`+ return {`
	`20`	`+ ...pageInfo,`
	`21`	`+ v1Enabled: env.FRACTAL_API_V1_MODE !== 'exclude'`
	`22`	`+ };`
`19`	`23`	`}`