Create installation admin controller

Author: Simon Emms

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';
@@ -114,6 +115,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();
@@ -123,11 +126,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,23 @@
+/**
+ * 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 } from 'inversify';
+import * as express from 'express';
+
+@injectable()
+export class InstallationAdminController {
+    get apiRouter(): express.Router {
+        const router = express.Router();
+
+        router.get('/data', async (req: express.Request, res: express.Response) => {
+            res.send({
+                sendTelemetry: false
+            });
+        });
+
+        return router;
+    }
+}

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 { WsPingPongHandler } from './express/ws-ping-pong-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;
@@ -102,7 +104,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)
@@ -283,6 +285,7 @@ export class Server<C extends GitpodClient, S extends GitpodServer> {
             res.send(this.config.version);
         });
         app.use(this.oauthController.oauthRouter);
+        app.use('/installation-admin', this.installationAdminController.apiRouter);
     }
 
     public async start(port: number) {