Redirect to custom url when workspace stops

Author: jeanp413

components/supervisor/frontend/package.json

@@ -12,7 +12,8 @@
     "stream-browserify": "^2.0.1",
     "url": "^0.11.1",
     "util": "^0.11.1",
-    "uuid": "8.3.2"
+    "uuid": "8.3.2",
+    "configcat-js": "^6.0.0"
   },
   "devDependencies": {
     "@types/sharedworker": "^0.0.29",

components/supervisor/frontend/src/experiments/client.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License.AGPL.txt in the project root for license information.
+ */
+
+import * as configcat from "configcat-js";
+import { ConfigCatClient } from "@gitpod/gitpod-protocol/lib/experiments/configcat";
+import { Client } from "@gitpod/gitpod-protocol/lib/experiments/types";
+import { LogLevel } from "configcat-common";
+import { serverUrl } from "../shared/urls";
+
+let client: Client | undefined;
+
+export function getExperimentsClient(): Client {
+    // We have already instantiated a client, we can just re-use it.
+    if (client !== undefined) {
+        return client;
+    }
+
+    client = newProxyConfigCatClient();
+    return client;
+}
+
+function newProxyConfigCatClient(): Client {
+    const clientKey = "gitpod"; // the client key is populated by the proxy
+    const client = configcat.createClientWithLazyLoad(clientKey, {
+        logger: configcat.createConsoleLogger(LogLevel.Error),
+        cacheTimeToLiveSeconds: 60 * 3, // 3 minutes
+        requestTimeoutMs: 1500,
+        baseUrl: serverUrl.with(() => ({ pathname: "/configcat" })).toString(),
+    });
+
+    return new ConfigCatClient(client);
+}

components/supervisor/frontend/src/index.ts

@@ -56,13 +56,15 @@ import * as IDEWebSocket from "./ide/ide-web-socket";
 import { SupervisorServiceClient } from "./ide/supervisor-service-client";
 import * as LoadingFrame from "./shared/loading-frame";
 import { workspaceUrl } from "./shared/urls";
+import { getExperimentsClient } from "./experiments/client";
 
 window.gitpod = {} as any;
 IDEWorker.install();
 IDEWebSocket.install();
 const ideService = IDEFrontendService.create();
 const loadingIDE = new Promise((resolve) => window.addEventListener("DOMContentLoaded", resolve, { once: true }));
 const toStop = new DisposableCollection();
+const experimentsClient = getExperimentsClient();
 
 document.body.style.visibility = "hidden";
 LoadingFrame.load().then(async (loading) => {
@@ -284,6 +286,7 @@ LoadingFrame.load().then(async (loading) => {
             IDEWebSocket.connectWorkspace(),
             frontendDashboardServiceClient.onInfoUpdate((status) => {
                 if (status.statusPhase === "stopping" || status.statusPhase === "stopped") {
+                    maybeRedirectToCustomUrl();
                     toStop.dispose();
                 }
             }),
@@ -295,3 +298,17 @@ LoadingFrame.load().then(async (loading) => {
         //#endregion
     })();
 });
+
+async function maybeRedirectToCustomUrl() {
+    const redirectURL = await experimentsClient.getValueAsync("dataops", "", {});
+    if (!redirectURL) {
+        return;
+    }
+
+    try {
+        const url = new URL(redirectURL);
+        window.location.href = url.toString();
+    } catch {
+        console.error("Invalid redirect URL");
+    }
+}