[server] Move /ready to /startup, and rename code to StartupController (because it's used by the StartupProbe)

Tool: gitpod/catfood.gitpod.cloud

Author: geropl

components/server/src/container-module.ts

@@ -71,7 +71,7 @@ import { WebhookEventGarbageCollector } from "./jobs/webhook-gc";
 import { WorkspaceGarbageCollector } from "./jobs/workspace-gc";
 import { LinkedInService } from "./linkedin-service";
 import { LivenessController } from "./liveness/liveness-controller";
-import { ReadinessController } from "./liveness/readiness-controller";
+import { StartupController } from "./liveness/startup-controller";
 import { RedisSubscriber } from "./messaging/redis-subscriber";
 import { MonitoringEndpointsApp } from "./monitoring-endpoints";
 import { OAuthController } from "./oauth-server/oauth-controller";
@@ -245,7 +245,7 @@ export const productionContainerModule = new ContainerModule(
 
         bind(ProbesApp).toSelf().inSingletonScope();
         bind(LivenessController).toSelf().inSingletonScope();
-        bind(ReadinessController).toSelf().inSingletonScope();
+        bind(StartupController).toSelf().inSingletonScope();
 
         bind(OneTimeSecretServer).toSelf().inSingletonScope();
 

components/server/src/liveness/probes.ts

@@ -8,7 +8,7 @@ import * as http from "http";
 import express from "express";
 import { inject, injectable } from "inversify";
 import { LivenessController } from "./liveness-controller";
-import { ReadinessController } from "./readiness-controller";
+import { StartupController } from "./startup-controller";
 import { AddressInfo } from "net";
 
 @injectable()
@@ -18,17 +18,15 @@ export class ProbesApp {
 
     constructor(
         @inject(LivenessController) protected readonly livenessController: LivenessController,
-        @inject(ReadinessController) protected readonly readinessController: ReadinessController,
+        @inject(StartupController) protected readonly startupController: StartupController,
     ) {
         const probesApp = express();
         probesApp.use("/live", this.livenessController.apiRouter);
-        probesApp.use("/ready", this.readinessController.apiRouter);
+        probesApp.use("/startup", this.startupController.apiRouter);
         this.app = probesApp;
     }
 
     public async start(port: number): Promise<number> {
-        await this.readinessController.start();
-
         return new Promise((resolve, reject) => {
             const probeServer = this.app.listen(port, () => {
                 resolve((<AddressInfo>probeServer.address()).port);
@@ -39,6 +37,5 @@ export class ProbesApp {
 
     public async stop(): Promise<void> {
         this.httpServer?.close();
-        await this.readinessController.stop();
     }
 }

components/server/src/liveness/readiness-controller.ts renamed to components/server/src/liveness/startup-controller.ts

@@ -10,73 +10,53 @@ import { TypeORM } from "@gitpod/gitpod-db/lib";
 import { SpiceDBClientProvider } from "../authorization/spicedb";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { v1 } from "@authzed/authzed-node";
-import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
 import { Redis } from "ioredis";
-import { repeat } from "@gitpod/gitpod-protocol/lib/util/repeat";
-import { Disposable, DisposableCollection } from "@gitpod/gitpod-protocol";
 
 @injectable()
-export class ReadinessController {
+export class StartupController {
     @inject(TypeORM) protected readonly typeOrm: TypeORM;
     @inject(SpiceDBClientProvider) protected readonly spiceDBClientProvider: SpiceDBClientProvider;
     @inject(Redis) protected readonly redis: Redis;
 
-    private readinessProbeEnabled: boolean = true;
-    private disposables: DisposableCollection = new DisposableCollection();
-
     get apiRouter(): express.Router {
         const router = express.Router();
-        this.addReadinessHandler(router);
+        this.addStartupHandler(router);
         return router;
     }
 
-    public async start() {
-        this.disposables.push(this.startPollingFeatureFlag());
-    }
-
-    public async stop() {
-        this.disposables.dispose();
-    }
-
-    protected addReadinessHandler(router: express.Router) {
+    protected addStartupHandler(router: express.Router) {
         router.get("/", async (_, res) => {
             try {
-                if (!this.readinessProbeEnabled) {
-                    log.debug("Readiness check skipped due to feature flag");
-                    res.status(200);
-                    return;
-                }
-
                 // Check database connection
                 const dbConnection = await this.checkDatabaseConnection();
                 if (!dbConnection) {
-                    log.warn("Readiness check failed: Database connection failed");
+                    log.warn("Startup check failed: Database connection failed");
                     res.status(503).send("Database connection failed");
                     return;
                 }
 
                 // Check SpiceDB connection
                 const spiceDBConnection = await this.checkSpiceDBConnection();
                 if (!spiceDBConnection) {
-                    log.warn("Readiness check failed: SpiceDB connection failed");
+                    log.warn("Startup check failed: SpiceDB connection failed");
                     res.status(503).send("SpiceDB connection failed");
                     return;
                 }
 
                 // Check Redis connection
                 const redisConnection = await this.checkRedisConnection();
                 if (!redisConnection) {
-                    log.warn("Readiness check failed: Redis connection failed");
+                    log.warn("Startup check failed: Redis connection failed");
                     res.status(503).send("Redis connection failed");
                     return;
                 }
 
                 // All connections are good
                 res.status(200).send("Ready");
-                log.debug("Readiness check successful");
+                log.debug("Startup check successful");
             } catch (error) {
-                log.error("Readiness check failed", error);
-                res.status(503).send("Readiness check failed");
+                log.error("Startup check failed", error);
+                res.status(503).send("Startup check failed");
             }
         });
     }
@@ -121,21 +101,4 @@ export class ReadinessController {
             return false;
         }
     }
-
-    private startPollingFeatureFlag(): Disposable {
-        return repeat(async () => {
-            // Check feature flag first
-            const readinessProbeEnabled = await getExperimentsClientForBackend().getValueAsync(
-                "server_readiness_probe",
-                true, // Default to readiness probe, skip if false
-                {},
-            );
-
-            log.debug("Feature flag server_readiness_probe updated", {
-                readinessProbeEnabled,
-                oldValue: this.readinessProbeEnabled,
-            });
-            this.readinessProbeEnabled = readinessProbeEnabled;
-        }, 10_000);
-    }
 }

install/installer/pkg/components/server/deployment.go

@@ -376,7 +376,7 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
 							StartupProbe: &corev1.Probe{
 								ProbeHandler: corev1.ProbeHandler{
 									HTTPGet: &corev1.HTTPGetAction{
-										Path: "/ready",
+										Path: "/startup",
 										Port: intstr.IntOrString{
 											Type:   intstr.Int,
 											IntVal: ProbesPort,