[supervisor-frontend] implement frontend dashboard client

Co-authored-by: mustard <[email protected]>
Co-authored-by: Jean Pierre <[email protected]>

Author: 2 people

components/gitpod-protocol/src/typings/globals.ts

@@ -7,7 +7,6 @@
 interface Window {
     // gitpod is used by supervisor/frontend and vscode browser https://github.com/gitpod-io/openvscode-server/blob/dadd40deda5959c0efdaa0c7d02ab64b6f8b5ad0/src/vs/gitpod/browser/workbench/workbench.ts#L7
     gitpod: {
-        service: import("../gitpod-service").GitpodService;
         ideService?: import("../ide-frontend-service").IDEFrontendService;
         loggedUserID?: string;
     };

components/supervisor/frontend/src/debug.ts

@@ -19,7 +19,7 @@ const loadingIDE = new Promise((resolve) => window.addEventListener("DOMContentL
 const toStop = new DisposableCollection();
 
 (async () => {
-    const supervisorServiceClient = SupervisorServiceClient.get(Promise.resolve());
+    const supervisorServiceClient = SupervisorServiceClient.get();
     const [ideStatus] = await Promise.all([
         supervisorServiceClient.ideReady,
         supervisorServiceClient.contentReady,

components/supervisor/frontend/src/ide/gitpod-service-client.ts

@@ -5,9 +5,7 @@
  */
 
 import { DisposableCollection, Disposable } from "@gitpod/gitpod-protocol/lib/util/disposable";
-import { WorkspaceInfo } from "@gitpod/gitpod-protocol";
-import { isSaaSServerGreaterThan, isSaaS } from "./gitpod-server-compatibility";
-import { serverUrl } from "../shared/urls";
+import { FrontendDashboardServiceClient } from "../shared/frontend-dashboard-service";
 
 let lastActivity = 0;
 const updateLastActivitiy = () => {
@@ -18,28 +16,19 @@ export const track = (w: Window) => {
     w.document.addEventListener("keydown", updateLastActivitiy, { capture: true });
 };
 
-let pageCloseCompatibile: boolean = false;
-// TODO(ak) remove
-isSaaSServerGreaterThan("main.4124").then((r) => {
-    pageCloseCompatibile = r;
-});
-
 let toCancel: DisposableCollection | undefined;
-export function schedule(wsInfo: WorkspaceInfo, sessionId: string): void {
+export function schedule(frontendDashboardServiceClient: FrontendDashboardServiceClient): void {
     if (toCancel) {
         return;
     }
     toCancel = new DisposableCollection();
     const sendHeartBeat = async (wasClosed?: true) => {
         try {
-            await window.gitpod.service.server.sendHeartBeat({ instanceId: wsInfo.latestInstance!.id, wasClosed });
+            frontendDashboardServiceClient.activeHeartbeat(); // wasClosed
             if (wasClosed) {
-                window.gitpod.service.server.trackEvent({
+                frontendDashboardServiceClient.trackEvent({
                     event: "ide_close_signal",
                     properties: {
-                        workspaceId: wsInfo.workspace.id,
-                        instanceId: wsInfo.latestInstance!.id,
-                        sessionId,
                         clientKind: "supervisor-frontend",
                     },
                 });
@@ -50,28 +39,6 @@ export function schedule(wsInfo: WorkspaceInfo, sessionId: string): void {
     };
     sendHeartBeat();
 
-    const beaconWorkspacePageClose = () => {
-        const instanceId = wsInfo.latestInstance!.id;
-        const data = { sessionId };
-        const blob = new Blob([JSON.stringify(data)], { type: "application/json" });
-        const url = serverUrl.withApi({ pathname: `/auth/workspacePageClose/${instanceId}` }).toString();
-        navigator.sendBeacon(url, blob);
-    };
-
-    const workspacePageCloseCompatible = () => {
-        if (isSaaS && !pageCloseCompatibile) {
-            sendHeartBeat(true);
-            return;
-        }
-        beaconWorkspacePageClose();
-    };
-
-    const unloadListener = () => {
-        workspacePageCloseCompatible();
-    };
-    window.addEventListener("unload", unloadListener);
-    toCancel.push(Disposable.create(() => window.removeEventListener("unload", unloadListener)));
-
     let activityInterval = 30000;
     const intervalHandle = setInterval(() => {
         // add an additional random value between 5 and 15 seconds

components/supervisor/frontend/src/ide/heart-beat.ts

@@ -4,8 +4,8 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { FrontendDashboardServiceClient } from "../shared/frontend-dashboard-service";
 import { serverUrl, workspaceUrl } from "../shared/urls";
-import { GitpodServiceClient } from "./gitpod-service-client";
 const commit = require("../../config.json").commit;
 
 export enum MetricsName {
@@ -31,15 +31,15 @@ interface ReportErrorParam {
     properties?: Record<string, string>;
 }
 export class IDEMetricsServiceClient {
-    static workspaceId = workspaceUrl.workspaceId;
+    static workspaceId? = workspaceUrl.workspaceId;
     static debugWorkspace = workspaceUrl.debugWorkspace;
-    static gitpodServiceClient?: GitpodServiceClient;
+    static serviceClient: FrontendDashboardServiceClient;
 
     static get instanceId(): string {
-        return this.gitpodServiceClient?.info.latestInstance?.id ?? "";
+        return this.serviceClient.latestStatus?.instanceId ?? "";
     }
     static get userId(): string {
-        return this.gitpodServiceClient?.user.id ?? "";
+        return this.serviceClient.latestStatus?.loggedUserId ?? "";
     }
 
     static async addCounter(
@@ -101,7 +101,7 @@ export class IDEMetricsServiceClient {
         }
     }
 
-    static loadWorkspaceInfo(gitpodServiceClient: GitpodServiceClient) {
-        this.gitpodServiceClient = gitpodServiceClient;
+    static loadWorkspaceInfo(serviceClient: FrontendDashboardServiceClient) {
+        this.serviceClient = serviceClient;
     }
 }

components/supervisor/frontend/src/ide/ide-metrics-service-client.ts

@@ -9,23 +9,22 @@ import {
     IDEStatusResponse,
     ContentStatusResponse,
 } from "@gitpod/supervisor-api-grpc/lib/status_pb";
-import { GitpodServiceClient } from "./gitpod-service-client";
 import { GitpodHostUrl } from "@gitpod/gitpod-protocol/lib/util/gitpod-host-url";
 
 export class SupervisorServiceClient {
     private static _instance: SupervisorServiceClient | undefined;
-    static get(gitpodAuth: Promise<void>): SupervisorServiceClient {
+    static get(): SupervisorServiceClient {
         if (!SupervisorServiceClient._instance) {
-            SupervisorServiceClient._instance = new SupervisorServiceClient(gitpodAuth);
+            SupervisorServiceClient._instance = new SupervisorServiceClient();
         }
         return SupervisorServiceClient._instance;
     }
 
     readonly supervisorReady = this.checkReady("supervisor");
     readonly ideReady = this.supervisorReady.then(() => this.checkReady("ide"));
-    readonly contentReady = Promise.all([this.supervisorReady, this.gitpodAuth]).then(() => this.checkReady("content"));
+    readonly contentReady = Promise.all([this.supervisorReady]).then(() => this.checkReady("content"));
 
-    private constructor(private readonly gitpodAuth: Promise<void>) {}
+    private constructor() {}
 
     private async checkReady(kind: "content" | "ide" | "supervisor", delay?: boolean): Promise<any> {
         if (delay) {