Create installation admin controller

Author: Simon Emms

components/gitpod-db/src/container-module.ts

@@ -57,6 +57,8 @@ import { ProjectDBImpl } from './typeorm/project-db-impl';
 import { EntityManager } from 'typeorm';
 import { OssAllowListDB } from './oss-allowlist-db';
 import { OssAllowListDBImpl } from './typeorm/oss-allowlist-db-impl';
+import { TypeORMInstallationAdminImpl } from './typeorm/installation-admin-db-impl';
+import { InstallationAdminDB } from './installation-admin-db';
 
 // THE DB container module that contains all DB implementations
 export const dbContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
@@ -72,6 +74,9 @@ export const dbContainerModule = new ContainerModule((bind, unbind, isBound, reb
     bind(TermsAcceptanceDB).toService(TermsAcceptanceDBImpl);
     bindDbWithTracing(TracedUserDB, bind, UserDB).inSingletonScope();
 
+    bind(TypeORMInstallationAdminImpl).toSelf().inSingletonScope();
+    bind(InstallationAdminDB).toService(TypeORMInstallationAdminImpl);
+
     bind(AuthProviderEntryDB).to(AuthProviderEntryDBImpl).inSingletonScope();
 
     bind(TypeORMWorkspaceDBImpl).toSelf().inSingletonScope();

components/gitpod-db/src/index.ts

@@ -36,4 +36,5 @@ export * from "./edu-email-domain-db";
 export * from "./email-domain-filter-db";
 export * from "./typeorm/entity/db-account-entry";
 export * from "./project-db";
-export * from "./team-db";
+export * from "./team-db";
+export * from "./installation-admin-db";

components/gitpod-db/src/installation-admin-db.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { InstallationAdmin } from "@gitpod/gitpod-protocol";
+
+export const InstallationAdminDB = Symbol('InstallationAdminDB');
+export interface InstallationAdminDB {
+    getTelemetryData(): Promise<InstallationAdmin>;
+}

components/gitpod-db/src/typeorm/entity/db-installation-admin.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2021 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 { InstallationAdmin, InstallationAdminSettings } from "@gitpod/gitpod-protocol";
+import { Entity, Column, PrimaryColumn } from "typeorm";
+import { TypeORM } from "../typeorm";
+
+@Entity()
+export class DBInstallationAdmin implements InstallationAdmin {
+  @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
+  id: string;
+
+  @Column('simple-json')
+  settings: InstallationAdminSettings;
+}

components/gitpod-db/src/typeorm/installation-admin-db-impl.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { inject, injectable, } from 'inversify';
+import { InstallationAdmin } from '@gitpod/gitpod-protocol';
+import { v4 as uuidv4 } from 'uuid';
+import { Repository } from 'typeorm';
+import { TypeORM } from './typeorm';
+import { InstallationAdminDB } from '../installation-admin-db';
+import { DBInstallationAdmin } from './entity/db-installation-admin';
+
+@injectable()
+export class TypeORMInstallationAdminImpl implements InstallationAdminDB {
+    @inject(TypeORM) typeORM: TypeORM;
+
+    protected async getEntityManager() {
+        return (await this.typeORM.getConnection()).manager;
+    }
+
+    protected async createDefaultRecord(): Promise<InstallationAdmin> {
+        const record: InstallationAdmin = {
+            id: uuidv4(),
+            settings: {
+                sendTelemetry: false,
+            },
+        };
+
+        const repo = await this.getInstallationAdminRepo();
+        return repo.save(record);
+    }
+
+    async getInstallationAdminRepo(): Promise<Repository<DBInstallationAdmin>> {
+        return (await this.getEntityManager()).getRepository<DBInstallationAdmin>(DBInstallationAdmin);
+    }
+
+    /**
+     * Get Telemetry Data
+     *
+     * Returns the first record found or creates a
+     * new record.
+     *
+     * @returns Promise<InstallationAdmin>
+     */
+    async getTelemetryData(): Promise<InstallationAdmin> {
+        const repo = await this.getInstallationAdminRepo();
+        const [record] = await repo.find();
+
+        if (record) {
+            return record;
+        }
+
+        /* Record not found - create one */
+        return this.createDefaultRecord();
+    }
+}

components/gitpod-db/src/typeorm/migration/1642422506330-InstallationAdminTable.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { MigrationInterface, QueryRunner } from "typeorm";
+import { tableExists } from "./helper/helper";
+
+export class InstallationAdminTable1642422506330 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await tableExists(queryRunner, "d_b_installation_admin"))) {
+            await queryRunner.query("CREATE TABLE IF NOT EXISTS `d_b_installation_admin` (`id` char(128) NOT NULL, `settings` text NULL, `_lastModified` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), PRIMARY KEY(`id`)) ENGINE=InnoDB");
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        if (await tableExists(queryRunner, "d_b_installation_admin")) {
+            await queryRunner.query("DROP TABLE `d_b_installation_admin`");
+        }
+    }
+
+}

components/gitpod-protocol/src/index.ts

@@ -19,3 +19,4 @@ export * from './context-url';
 export * from './teams-projects-protocol';
 export * from './snapshot-url';
 export * from './oss-allowlist';
+export * from './installation-admin-protocol';

components/gitpod-protocol/src/installation-admin-protocol.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+
+export interface InstallationAdminSettings {
+    sendTelemetry: boolean;
+}
+
+export interface InstallationAdmin {
+    id: string;
+    settings: InstallationAdminSettings;
+}

components/server/src/container-module.ts

@@ -12,6 +12,7 @@ import { SessionHandlerProvider } from './session-handler';
 import { GitpodFileParser } from '@gitpod/gitpod-protocol/lib/gitpod-file-parser';
 import { WorkspaceFactory } from './workspace/workspace-factory';
 import { UserController } from './user/user-controller';
+import { InstallationAdminController } from './installation-admin/installation-admin-controller';
 import { GitpodServerImpl } from './workspace/gitpod-server-impl';
 import { ConfigProvider } from './workspace/config-provider';
 import { MessageBusIntegration } from './workspace/messagebus-integration';
@@ -115,6 +116,8 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
     bind(EnforcementControllerServerFactory).toAutoFactory(GitpodServerImpl);
     bind(EnforcementController).toSelf().inSingletonScope();
 
+    bind(InstallationAdminController).toSelf().inSingletonScope();
+
     bind(MessagebusConfiguration).toSelf().inSingletonScope();
     bind(MessageBusHelper).to(MessageBusHelperImpl).inSingletonScope();
     bind(MessageBusIntegration).toSelf().inSingletonScope();
@@ -124,11 +127,11 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
 
     bind(GitpodServerImpl).toSelf();
     bind(WebsocketConnectionManager).toDynamicValue(ctx => {
-            const serverFactory = () => ctx.container.get<GitpodServerImpl>(GitpodServerImpl);
-            const hostContextProvider = ctx.container.get<HostContextProvider>(HostContextProvider);
-            const config = ctx.container.get<Config>(Config);
-            return new WebsocketConnectionManager(serverFactory, hostContextProvider, config.rateLimiter);
-        }
+        const serverFactory = () => ctx.container.get<GitpodServerImpl>(GitpodServerImpl);
+        const hostContextProvider = ctx.container.get<HostContextProvider>(HostContextProvider);
+        const config = ctx.container.get<Config>(Config);
+        return new WebsocketConnectionManager(serverFactory, hostContextProvider, config.rateLimiter);
+    }
     ).inSingletonScope();
 
     bind(PrometheusClientCallMetrics).toSelf().inSingletonScope();

components/server/src/installation-admin/installation-admin-controller.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { injectable, inject } from 'inversify';
+import * as express from 'express';
+import { InstallationAdminDB } from '@gitpod/gitpod-db/lib';
+
+@injectable()
+export class InstallationAdminController {
+    @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
+
+    public create(): express.Application {
+        const app = express();
+
+        app.get('/data', async (req: express.Request, res: express.Response) => {
+            const data = await this.installationAdminDb.getTelemetryData();
+
+            res.send(data);
+        });
+
+        return app;
+    }
+}

components/server/src/server.ts

@@ -44,6 +44,7 @@ import { Config } from './config';
 import { DebugApp } from './debug-app';
 import { LocalMessageBroker } from './messaging/local-message-broker';
 import { WsConnectionHandler } from './express/ws-connection-handler';
+import { InstallationAdminController } from './installation-admin/installation-admin-controller';
 
 @injectable()
 export class Server<C extends GitpodClient, S extends GitpodServer> {
@@ -54,6 +55,7 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
     @inject(SessionHandlerProvider) protected sessionHandlerProvider: SessionHandlerProvider;
     @inject(Authenticator) protected authenticator: Authenticator;
     @inject(UserController) protected readonly userController: UserController;
+    @inject(InstallationAdminController) protected readonly installationAdminController: InstallationAdminController;
     @inject(EnforcementController) protected readonly enforcementController: EnforcementController;
     @inject(WebsocketConnectionManager) protected websocketConnectionHandler: WebsocketConnectionManager;
     @inject(MessageBusIntegration) protected readonly messagebus: MessageBusIntegration;
@@ -82,7 +84,9 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
     protected app?: express.Application;
     protected httpServer?: http.Server;
     protected monitoringApp?: express.Application;
+    protected installationAdminApp?: express.Application;
     protected monitoringHttpServer?: http.Server;
+    protected installationAdminHttpServer?: http.Server;
     protected disposables = new DisposableCollection();
 
     public async init(app: express.Application) {
@@ -102,7 +106,7 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
         // metrics
         app.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
             const startTime = Date.now();
-            req.on("end", () =>{
+            req.on("end", () => {
                 const method = req.method;
                 const route = req.route?.path || req.baseUrl || "unknown";
                 observeHttpRequestDuration(method, route, res.statusCode, (Date.now() - startTime) / 1000)
@@ -229,6 +233,9 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
         // Health check + metrics endpoints
         this.monitoringApp = this.monitoringEndpointsApp.create();
 
+        // Installation Admin - host separately to avoid exposing publicly
+        this.installationAdminApp = this.installationAdminController.create();
+
         // Report current websocket connections
         this.installWebsocketConnectionGauge();
         this.installWebsocketClientContextGauge();
@@ -302,12 +309,19 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
             });
         }
 
+        if (this.installationAdminApp) {
+            this.installationAdminHttpServer = this.installationAdminApp.listen(9000, () => {
+                log.info(`installation admin app listening on port: ${(<AddressInfo>this.installationAdminHttpServer!.address()).port}`)
+            })
+        }
+
         this.debugApp.start(6060);
     }
 
     public async stop() {
         await this.debugApp.stop();
         await this.stopServer(this.monitoringHttpServer);
+        await this.stopServer(this.installationAdminHttpServer);
         await this.stopServer(this.httpServer);
         this.disposables.dispose();
         log.info('server stopped.');