[image-builder, et. al] Return the public workspace URL for all imagebuilds (incl. extra headers to access said URL) and store it in workspace

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, ImageBuildInfo } 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 })
+    imageBuildInfo?: ImageBuildInfo;
 }

components/gitpod-db/src/typeorm/migration/1643295551434-ImageBuildInfo.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { columnExists } from "./helper/helper";
+
+export class ImageBuildInfo1643295551434 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, "d_b_workspace", "imageBuildInfo"))) {
+            await queryRunner.query("ALTER TABLE d_b_workspace ADD COLUMN `imageBuildInfo` text NULL");
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

components/gitpod-protocol/src/protocol.ts

@@ -463,12 +463,29 @@ export interface Workspace {
     basedOnPrebuildId?: string;
 
     basedOnSnapshotId?: string;
+
+    /**
+     * Contains information about the image build, if there was any
+     */
+    imageBuildInfo?: ImageBuildInfo;
 }
 
 export type WorkspaceSoftDeletion = "user" | "gc";
 
 export type WorkspaceType = "regular" | "prebuild" | "probe";
 
+export interface ImageBuildInfo {
+    log?: ImageBuildLogInfo,
+}
+
+/**
+ * Holds information about how to access logs for this an image build
+ */
+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,10 @@ message BuildInfo {
     BuildStatus status = 2;
     int64 started_at = 3;
     string build_id = 5;
+    LogInfo log_info = 6;
+}
+
+message LogInfo {
+    string url = 1;
+    map<string, string> headers = 2;
 }

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.
  */
@@ -456,6 +456,11 @@ export class BuildInfo extends jspb.Message {
     getBuildId(): string;
     setBuildId(value: string): BuildInfo;
 
+    hasLogInfo(): boolean;
+    clearLogInfo(): void;
+    getLogInfo(): LogInfo | undefined;
+    setLogInfo(value?: LogInfo): BuildInfo;
+
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): BuildInfo.AsObject;
     static toObject(includeInstance: boolean, msg: BuildInfo): BuildInfo.AsObject;
@@ -473,6 +478,32 @@ export namespace BuildInfo {
         status: BuildStatus,
         startedAt: number,
         buildId: string,
+        logInfo?: LogInfo.AsObject,
+    }
+}
+
+export class LogInfo extends jspb.Message {
+    getUrl(): string;
+    setUrl(value: string): LogInfo;
+
+    getHeadersMap(): jspb.Map<string, string>;
+    clearHeadersMap(): void;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): LogInfo.AsObject;
+    static toObject(includeInstance: boolean, msg: LogInfo): LogInfo.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: LogInfo, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): LogInfo;
+    static deserializeBinaryFromReader(message: LogInfo, reader: jspb.BinaryReader): LogInfo;
+}
+
+export namespace LogInfo {
+    export type AsObject = {
+        url: string,
+
+        headersMap: Array<[string, string]>,
     }
 }