WIP: [image-builder, et. al] Switch image build logs to work server-to-imagebuild workspace instead of server-to-imagebuilder

The goal here is to make image build logs accessible from all meta clusters. This helps to move forward with removing the cross-cluster messagebus dependency while image-builder(s) still runs in the meta cluster(s).

Author: geropl

components/gitpod-db/src/typeorm/entity/db-workspace.ts

@@ -6,7 +6,7 @@
 
 import { PrimaryColumn, Column, Entity, Index } from "typeorm";
 
-import { Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceImageSource, WorkspaceType, WorkspaceSoftDeletion } from "@gitpod/gitpod-protocol";
+import { Workspace, WorkspaceConfig, WorkspaceContext, WorkspaceImageSource, WorkspaceType, WorkspaceSoftDeletion, ImageBuildLogInfo } from "@gitpod/gitpod-protocol";
 import { TypeORM } from "../typeorm";
 import { Transformer } from "../transformer";
 
@@ -105,4 +105,7 @@ export class DBWorkspace implements Workspace {
     })
     @Index('ind_basedOnSnapshotId')
     basedOnSnapshotId?: string;
+
+    @Column("simple-json", { nullable: true })
+    imageBuildLogInfo?: ImageBuildLogInfo;
 }

components/gitpod-db/src/typeorm/migration/1642088620203-WorkspaceImageBuildLogInfo.ts

@@ -0,0 +1,15 @@
+import {MigrationInterface, QueryRunner} from "typeorm";
+import { columnExists } from "./helper/helper";
+
+export class WorkspaceImageBuildLogInfo1642088620203 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, "d_b_workspace", "imageBuildLogInfo"))) {
+            await queryRunner.query("ALTER TABLE d_b_workspace ADD COLUMN `imageBuildLogInfo` text NULL");
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

components/gitpod-db/src/typeorm/workspace-db-impl.ts

@@ -20,7 +20,6 @@ import { DBPrebuiltWorkspace } from "./entity/db-prebuilt-workspace";
 import { DBPrebuiltWorkspaceUpdatable } from "./entity/db-prebuilt-workspace-updatable";
 import { BUILTIN_WORKSPACE_PROBE_USER_ID } from "../user-db";
 import { DBPrebuildInfo } from "./entity/db-prebuild-info-entry";
-import { FindInstanceOptions } from "..";
 
 type RawTo<T> = (instance: WorkspaceInstance, ws: Workspace) => T;
 interface OrderBy {

components/gitpod-db/src/workspace-db.ts

@@ -46,11 +46,6 @@ export interface PrebuildWithWorkspace {
     workspace: Workspace;
 }
 
-export type FindInstanceOptions = Partial<Pick<
-    WorkspaceInstance, "region"> & {
-        phasePersisted: WorkspaceInstancePhase;
-    }>;
-
 export type WorkspaceAndOwner = Pick<Workspace, "id" | "ownerId">;
 export type WorkspaceOwnerAndSoftDeleted = Pick<Workspace, "id" | "ownerId" | "softDeleted">;
 

components/gitpod-protocol/src/protocol.ts

@@ -448,12 +448,19 @@ export interface Workspace {
     basedOnPrebuildId?: string;
 
     basedOnSnapshotId?: string;
+
+    imageBuildLogInfo?: ImageBuildLogInfo;
 }
 
 export type WorkspaceSoftDeletion = "user" | "gc";
 
 export type WorkspaceType = "regular" | "prebuild" | "probe";
 
+export interface ImageBuildLogInfo {
+    url: string,
+    headers: { [key: string]: string },
+}
+
 export namespace Workspace {
 
     export function getFullRepositoryName(ws: Workspace): string | undefined {

components/image-builder-api/go/imgbuilder.pb.go

@@ -128,4 +128,6 @@ message BuildInfo {
     BuildStatus status = 2;
     int64 started_at = 3;
     string build_id = 5;
+    string log_url = 6;
+    map<string, string> log_url_extra_headers = 7;
 }

components/image-builder-api/go/imgbuilder_grpc.pb.go

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * 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.
  */

components/image-builder-api/go/mock/mock.go

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * 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.
  */

components/image-builder-api/imgbuilder.proto

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * 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.
  */
@@ -455,6 +455,11 @@ export class BuildInfo extends jspb.Message {
     setStartedAt(value: number): BuildInfo;
     getBuildId(): string;
     setBuildId(value: string): BuildInfo;
+    getLogUrl(): string;
+    setLogUrl(value: string): BuildInfo;
+
+    getLogUrlExtraHeadersMap(): jspb.Map<string, string>;
+    clearLogUrlExtraHeadersMap(): void;
 
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): BuildInfo.AsObject;
@@ -473,6 +478,9 @@ export namespace BuildInfo {
         status: BuildStatus,
         startedAt: number,
         buildId: string,
+        logUrl: string,
+
+        logUrlExtraHeadersMap: Array<[string, string]>,
     }
 }
 

components/image-builder-api/typescript/src/imgbuilder_grpc_pb.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * 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.
  */
@@ -3426,7 +3426,9 @@ proto.builder.BuildInfo.toObject = function(includeInstance, msg) {
     baseRef: jspb.Message.getFieldWithDefault(msg, 4, ""),
     status: jspb.Message.getFieldWithDefault(msg, 2, 0),
     startedAt: jspb.Message.getFieldWithDefault(msg, 3, 0),
-    buildId: jspb.Message.getFieldWithDefault(msg, 5, "")
+    buildId: jspb.Message.getFieldWithDefault(msg, 5, ""),
+    logUrl: jspb.Message.getFieldWithDefault(msg, 6, ""),
+    logUrlExtraHeadersMap: (f = msg.getLogUrlExtraHeadersMap()) ? f.toObject(includeInstance, undefined) : []
   };
 
   if (includeInstance) {
@@ -3483,6 +3485,16 @@ proto.builder.BuildInfo.deserializeBinaryFromReader = function(msg, reader) {
       var value = /** @type {string} */ (reader.readString());
       msg.setBuildId(value);
       break;
+    case 6:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setLogUrl(value);
+      break;
+    case 7:
+      var value = msg.getLogUrlExtraHeadersMap();
+      reader.readMessage(value, function(message, reader) {
+        jspb.Map.deserializeBinary(message, reader, jspb.BinaryReader.prototype.readString, jspb.BinaryReader.prototype.readString, null, "", "");
+         });
+      break;
     default:
       reader.skipField();
       break;
@@ -3547,6 +3559,17 @@ proto.builder.BuildInfo.serializeBinaryToWriter = function(message, writer) {
       f
     );
   }
+  f = message.getLogUrl();
+  if (f.length > 0) {
+    writer.writeString(
+      6,
+      f
+    );
+  }
+  f = message.getLogUrlExtraHeadersMap(true);
+  if (f && f.getLength() > 0) {
+    f.serializeBinary(7, writer, jspb.BinaryWriter.prototype.writeString, jspb.BinaryWriter.prototype.writeString);
+  }
 };
 
 
@@ -3640,6 +3663,46 @@ proto.builder.BuildInfo.prototype.setBuildId = function(value) {
 };
 
 
+/**
+ * optional string log_url = 6;
+ * @return {string}
+ */
+proto.builder.BuildInfo.prototype.getLogUrl = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 6, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.builder.BuildInfo} returns this
+ */
+proto.builder.BuildInfo.prototype.setLogUrl = function(value) {
+  return jspb.Message.setProto3StringField(this, 6, value);
+};
+
+
+/**
+ * map<string, string> log_url_extra_headers = 7;
+ * @param {boolean=} opt_noLazyCreate Do not create the map if
+ * empty, instead returning `undefined`
+ * @return {!jspb.Map<string,string>}
+ */
+proto.builder.BuildInfo.prototype.getLogUrlExtraHeadersMap = function(opt_noLazyCreate) {
+  return /** @type {!jspb.Map<string,string>} */ (
+      jspb.Message.getMapField(this, 7, opt_noLazyCreate,
+      null));
+};
+
+
+/**
+ * Clears values from the map. The map will be non-null.
+ * @return {!proto.builder.BuildInfo} returns this
+ */
+proto.builder.BuildInfo.prototype.clearLogUrlExtraHeadersMap = function() {
+  this.getLogUrlExtraHeadersMap().clear();
+  return this;};
+
+
 /**
  * @enum {number}
  */

components/image-builder-api/typescript/src/imgbuilder_grpc_pb.js

@@ -15,6 +15,7 @@ import { BuildRequest, BuildResponse, BuildStatus, LogsRequest, LogsResponse, Re
 import { injectable, inject, optional } from 'inversify';
 import * as grpc from "@grpc/grpc-js";
 import { TextDecoder } from "util";
+import { ImageBuildLogInfo } from "@gitpod/gitpod-protocol";
 
 export const ImageBuilderClientProvider = Symbol("ImageBuilderClientProvider");
 
@@ -82,6 +83,7 @@ export class CachingImageBuilderClientProvider implements ImageBuilderClientProv
 // StagedBuildResponse captures the multi-stage nature (starting, running, done) of image builds.
 export interface StagedBuildResponse {
     buildPromise: Promise<BuildResponse>;
+    logPromise: Promise<ImageBuildLogInfo>;
 
     actuallyNeedsBuild: boolean;
     ref: string;
@@ -133,9 +135,11 @@ export class PromisifiedImageBuilderClient {
         const span = TraceContext.startSpan(`/image-builder/build`, ctx);
 
         const buildResult = new Deferred<BuildResponse>();
+        const logInfo = new Deferred<ImageBuildLogInfo>();
 
         const result = new Deferred<StagedBuildResponse>();
         const resultResp: StagedBuildResponse = {
+            logPromise: logInfo.promise,
             buildPromise: buildResult.promise,
             actuallyNeedsBuild: true,
             ref: "unknown",
@@ -151,6 +155,7 @@ export class PromisifiedImageBuilderClient {
                     result.reject(err);
                 } else {
                     buildResult.reject(err);
+                    logInfo.reject(err);
                 }
 
                 TraceContext.setError({ span }, err);
@@ -166,6 +171,21 @@ export class PromisifiedImageBuilderClient {
                     resultResp.baseRef = resp.getBaseRef();
                 }
 
+                if (resp.hasInfo() && !logInfo.isResolved) {
+                    // assumes that log info stays stable for instance lifetime
+                    const info = resp.getInfo()
+                    if (info) {
+                        const headers: { [key: string]: string } = {};
+                        for (const [k, v] of info.getLogUrlExtraHeadersMap().entries()) {
+                            headers[k] = v;
+                        }
+                        logInfo.resolve({
+                            url: info.getLogUrl(),
+                            headers,
+                        });
+                    }
+                }
+
                 if (resp.getStatus() == BuildStatus.RUNNING) {
                     resultResp.actuallyNeedsBuild = true;
                     result.resolve(resultResp);
@@ -177,6 +197,9 @@ export class PromisifiedImageBuilderClient {
                     } else {
                         buildResult.resolve(resp);
                     }
+                    if (!logInfo.isResolved) {
+                        logInfo.reject(new Error("no log stream for this image build"));
+                    }
 
                     span.finish();
                 }

components/image-builder-api/typescript/src/imgbuilder_pb.d.ts

@@ -20,6 +20,7 @@ import (
 	"github.com/hashicorp/go-retryablehttp"
 	"golang.org/x/xerrors"
 
+	"github.com/gitpod-io/gitpod/common-go/kubernetes"
 	"github.com/gitpod-io/gitpod/common-go/log"
 	"github.com/gitpod-io/gitpod/common-go/tracing"
 	"github.com/gitpod-io/gitpod/image-builder/api"
@@ -202,6 +203,10 @@ func extractBuildStatus(status *wsmanapi.WorkspaceStatus) *api.BuildInfo {
 		BaseRef:   status.Metadata.Annotations[annotationBaseRef],
 		Status:    s,
 		StartedAt: status.Metadata.StartedAt.Seconds,
+		LogUrl:    fmt.Sprintf("%s/_supervisor/v1", status.Metadata.Annotations[kubernetes.WorkspaceURLAnnotation]),
+		LogUrlExtraHeaders: map[string]string{
+			"x-gitpod-owner-token": status.Auth.OwnerToken,
+		},
 	}
 }
 

components/image-builder-api/typescript/src/imgbuilder_pb.js

@@ -516,6 +516,13 @@ export class WorkspaceStarter {
             span.log({"ref": workspace.imageNameResolved});
             await this.workspaceDb.trace({ span }).store(workspace);
 
+            // Make sure we persist logInfo once we retrieve it
+            result.logPromise.then(async logInfo => {
+                await this.workspaceDb.trace({span}).updatePartial(workspace.id, {
+                    imageBuildLogInfo: logInfo,
+                }).catch(err => log.error("error writing image build log info to the DB", err));
+            }).catch(err => log.warn("image build: never received log info"));
+
             // Update workspace instance to tell the world we're building an image
             const workspaceImage = result.ref;
             const status: WorkspaceInstanceStatus = result.actuallyNeedsBuild ? { ...instance.status, phase: 'preparing' } : instance.status;