wip prebuild events

Author: AlexTugarev

components/dashboard/src/projects/Prebuilds.tsx

@@ -24,7 +24,6 @@ export default function () {
     const projectName = match?.params?.resource;
     const team = getCurrentTeam(location, teams);
 
-    // @ts-ignore
     const [project, setProject] = useState<Project | undefined>();
     const [defaultBranch, setDefaultBranch] = useState<string | undefined>();
 
@@ -33,6 +32,34 @@ export default function () {
 
     const [prebuilds, setPrebuilds] = useState<PrebuildInfo[]>([]);
 
+    useEffect(() => {
+        if (!project) {
+            return;
+        }
+        const registration = getGitpodService().registerClient({
+            onPrebuildUpdate: (update) => {
+
+                if (!project) {
+                    return;
+                }
+                if (update.prebuildInfo.projectId === project.id) {
+                    // TODO(at) create a proper model to update the state
+                    setPrebuilds((prev) => {
+                        const existingPrebuild = prev.find(p => p.id);
+                        if (existingPrebuild) {
+                            existingPrebuild.status = update.status;
+                            return [...prev];
+                        }
+                        return [update.prebuildInfo, ...prev];
+                    })
+                }
+            }
+        })
+        return () => {
+            registration.dispose();
+        }
+    }, [ project ]);
+
     useEffect(() => {
         if (!teams) {
             return;
@@ -42,21 +69,23 @@ export default function () {
                 ? await getGitpodService().server.getTeamProjects(team.id)
                 : await getGitpodService().server.getUserProjects());
 
-            const project = projectName && projects.find(p => p.name === projectName);
-            if (project) {
-                setProject(project);
+            const newProject = projectName && projects.find(p => p.name === projectName);
+            if (newProject) {
+                setProject(newProject);
 
-                const prebuilds = await getGitpodService().server.findPrebuilds({ projectId: project.id });
+                const prebuilds = await getGitpodService().server.findPrebuilds({ projectId: newProject.id });
                 setPrebuilds(prebuilds);
 
-                const details = await getGitpodService().server.getProjectOverview(project.id);
+                const details = await getGitpodService().server.getProjectOverview(newProject.id);
                 if (details?.branches) {
                     setDefaultBranch(details.branches.find(b => b.isDefault)?.name);
                 }
             }
         })();
     }, [ teams, team ]);
 
+
+
     const prebuildContextMenu = (p: PrebuildInfo) => {
         const running = p.status === "building";
         const entries: ContextMenuEntry[] = [];
@@ -102,8 +131,6 @@ export default function () {
         return true;
     }
 
-    const filteredPrebuilds = prebuilds.filter(filter);
-
     const openPrebuild = (pb: PrebuildInfo) => {
         history.push(`/${!!team ? team.slug : 'projects'}/${projectName}/${pb.id}`);
     }
@@ -147,7 +174,7 @@ export default function () {
                         <ItemFieldContextMenu />
                     </ItemField>
                 </Item>
-                {filteredPrebuilds.map((p: PrebuildInfo) => <Item className="grid grid-cols-3">
+                {prebuilds.filter(filter).map((p: PrebuildInfo) => <Item key={`prebuild-${p.id}`} className="grid grid-cols-3">
                     <ItemField className="flex items-center">
                         <div className="cursor-pointer" onClick={() => openPrebuild(p)}>
                             <div className="text-base text-gray-900 dark:text-gray-50 font-medium uppercase mb-1">

components/gitpod-db/src/typeorm/entity/db-prebuild-info-entry.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * Licensed under the Gitpod Enterprise Source Code License,
+ * See License.enterprise.txt in the project root folder.
+ */
+
+import { Entity, Column, PrimaryColumn } from "typeorm";
+import { PrebuildInfo } from "@gitpod/gitpod-protocol";
+
+import { TypeORM } from "../../typeorm/typeorm";
+
+@Entity()
+export class DBPrebuildInfo  {
+
+    @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
+    prebuildId: string;
+
+    @Column({
+        type: 'simple-json',
+        transformer: (() => {
+            return {
+                to(value: any): any {
+                    return JSON.stringify(value);
+                },
+                from(value: any): any {
+                    try {
+                        const obj = JSON.parse(value);
+                        return PrebuildInfo.is(obj) ? obj : undefined;
+                    } catch (error) {
+                    }
+                }
+            };
+        })()
+    })
+    info: PrebuildInfo;
+
+}

components/gitpod-db/src/typeorm/migration/1628160315471-AddPrebuildInfo.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 {MigrationInterface, QueryRunner} from "typeorm";
+
+export class AddPrebuildInfo1628160315471 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<any> {
+        await queryRunner.query("CREATE TABLE IF NOT EXISTS `d_b_prebuild_info` ( `prebuildId` char(36) NOT NULL, `info` text NOT NULL, `deleted` tinyint(4) NOT NULL DEFAULT '0', `_lastModified` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), PRIMARY KEY (`prebuildId`), KEY `ind_dbsync` (`_lastModified`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;");
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<any> {
+    }
+
+}

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

@@ -7,7 +7,7 @@
 import { injectable, inject } from "inversify";
 import { Repository, EntityManager, DeepPartial, UpdateQueryBuilder } from "typeorm";
 import { MaybeWorkspace, MaybeWorkspaceInstance, WorkspaceDB, FindWorkspacesOptions, PrebuiltUpdatableAndWorkspace, WorkspaceInstanceSessionWithWorkspace, PrebuildWithWorkspace, WorkspaceAndOwner, WorkspacePortsAuthData, WorkspaceOwnerAndSoftDeleted } from "../workspace-db";
-import { Workspace, WorkspaceInstance, WorkspaceInfo, WorkspaceInstanceUser, WhitelistedRepository, Snapshot, LayoutData, PrebuiltWorkspace, RunningWorkspaceInfo, PrebuiltWorkspaceUpdatable, WorkspaceAndInstance, WorkspaceType } from "@gitpod/gitpod-protocol";
+import { Workspace, WorkspaceInstance, WorkspaceInfo, WorkspaceInstanceUser, WhitelistedRepository, Snapshot, LayoutData, PrebuiltWorkspace, RunningWorkspaceInfo, PrebuiltWorkspaceUpdatable, WorkspaceAndInstance, WorkspaceType, PrebuildInfo } from "@gitpod/gitpod-protocol";
 import { TypeORM } from "./typeorm";
 import { DBWorkspace } from "./entity/db-workspace";
 import { DBWorkspaceInstance } from "./entity/db-workspace-instance";
@@ -19,6 +19,7 @@ import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
 import { DBPrebuiltWorkspace } from "./entity/db-prebuilt-workspace";
 import { DBPrebuiltWorkspaceUpdatable } from "./entity/db-prebuilt-workspace-updatable";
 import { BUILTIN_WORKSPACE_PROBE_USER_NAME } from "../user-db";
+import { DBPrebuildInfo } from "./entity/db-prebuild-info-entry";
 
 type RawTo<T> = (instance: WorkspaceInstance, ws: Workspace) => T;
 interface OrderBy {
@@ -55,6 +56,10 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         return await (await this.getManager()).getRepository<DBPrebuiltWorkspace>(DBPrebuiltWorkspace);
     }
 
+    protected async getPrebuildInfoRepo(): Promise<Repository<DBPrebuildInfo>> {
+        return await (await this.getManager()).getRepository<DBPrebuildInfo>(DBPrebuildInfo);
+    }
+
     protected async getPrebuiltWorkspaceUpdatableRepo(): Promise<Repository<DBPrebuiltWorkspaceUpdatable>> {
         return await (await this.getManager()).getRepository<DBPrebuiltWorkspaceUpdatable>(DBPrebuiltWorkspaceUpdatable);
     }
@@ -826,7 +831,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         const repo = await this.getPrebuiltWorkspaceRepo();
 
         const query = repo.createQueryBuilder('pws')
-            .orderBy('pws.creationTime', 'ASC')
+            .orderBy('pws.creationTime', 'DESC')
             .innerJoinAndMapOne('pws.workspace', DBWorkspace, 'ws', 'pws.buildWorkspaceId = ws.id')
             .andWhere('pws.projectId = :projectId', { projectId });
 
@@ -845,13 +850,31 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         const repo = await this.getPrebuiltWorkspaceRepo();
 
         const query = repo.createQueryBuilder('pws')
-            .orderBy('pws.creationTime', 'ASC')
+            .orderBy('pws.creationTime', 'DESC')
             .innerJoinAndMapOne('pws.workspace', DBWorkspace, 'ws', 'pws.buildWorkspaceId = ws.id')
             .andWhere('pws.id = :id', { id });
 
         return query.getOne();
     }
 
+    async storePrebuildInfo(prebuildInfo: PrebuildInfo): Promise<void> {
+        const repo = await this.getPrebuildInfoRepo();
+        await repo.save({
+            prebuildId: prebuildInfo.id,
+            info: prebuildInfo
+        });
+    }
+
+    async findPrebuildInfo(prebuildId: string): Promise<PrebuildInfo | undefined>{
+        const repo = await this.getPrebuildInfoRepo();
+
+        const query = repo.createQueryBuilder('pi')
+            .andWhere('pi.prebuildId = :prebuildId', { prebuildId });
+
+        const entry = await query.getOne();
+        return entry?.info;
+    }
+
 }
 
 @injectable()

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

@@ -6,7 +6,7 @@
 
 import { DeepPartial } from 'typeorm';
 
-import { Workspace, WorkspaceInfo, WorkspaceInstance, WorkspaceInstanceUser, WhitelistedRepository, Snapshot, LayoutData, PrebuiltWorkspace, PrebuiltWorkspaceUpdatable, RunningWorkspaceInfo, WorkspaceAndInstance, WorkspaceType } from '@gitpod/gitpod-protocol';
+import { Workspace, WorkspaceInfo, WorkspaceInstance, WorkspaceInstanceUser, WhitelistedRepository, Snapshot, LayoutData, PrebuiltWorkspace, PrebuiltWorkspaceUpdatable, RunningWorkspaceInfo, WorkspaceAndInstance, WorkspaceType, PrebuildInfo } from '@gitpod/gitpod-protocol';
 
 export type MaybeWorkspace = Workspace | undefined;
 export type MaybeWorkspaceInstance = WorkspaceInstance | undefined;
@@ -115,4 +115,7 @@ export interface WorkspaceDB {
 
     findPrebuiltWorkspacesByProject(projectId: string, branch?: string, limit?: number): Promise<PrebuiltWorkspace[]>;
     findPrebuiltWorkspacesById(prebuildId: string): Promise<PrebuiltWorkspace | undefined>;
+
+    storePrebuildInfo(prebuildInfo: PrebuildInfo): Promise<void>;
+    findPrebuildInfo(prebuildId: string): Promise<PrebuildInfo | undefined>;
 }

components/gitpod-protocol/src/gitpod-service.ts

@@ -13,7 +13,7 @@ import {
 } from './protocol';
 import {
     Team, TeamMemberInfo,
-    TeamMembershipInvite, Project, PrebuildInfo, TeamMemberRole
+    TeamMembershipInvite, Project, PrebuildInfo, TeamMemberRole, PrebuildUpdate
 } from './teams-projects-protocol';
 import { JsonRpcProxy, JsonRpcServer } from './messaging/proxy-factory';
 import { Disposable, CancellationTokenSource } from 'vscode-jsonrpc';
@@ -34,6 +34,8 @@ export interface GitpodClient {
     onInstanceUpdate(instance: WorkspaceInstance): void;
     onWorkspaceImageBuildLogs: WorkspaceImageBuild.LogCallback;
 
+    onPrebuildUpdate(update: PrebuildUpdate): void;
+
     onCreditAlert(creditAlert: CreditAlert): void;
 
     //#region propagating reconnection to iframe
@@ -376,6 +378,18 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
         }
     }
 
+    onPrebuildUpdate(update: PrebuildUpdate): void {
+        for (const client of this.clients) {
+            if (client.onPrebuildUpdate) {
+                try {
+                    client.onPrebuildUpdate(update);
+                } catch (error) {
+                    console.error(error)
+                }
+            }
+        }
+    }
+
     onWorkspaceImageBuildLogs(info: WorkspaceImageBuild.StateInfo, content: WorkspaceImageBuild.LogContent | undefined): void {
         for (const client of this.clients) {
             if (client.onWorkspaceImageBuildLogs) {

components/gitpod-protocol/src/teams-projects-protocol.ts

@@ -54,14 +54,24 @@ export namespace Project {
     }
 }
 
+export interface PrebuildUpdate {
+    prebuildInfo: PrebuildInfo;
+    status: PrebuiltWorkspaceState;
+}
+
 export interface PrebuildInfo {
     id: string;
-    teamId: string;
+    buildWorkspaceId: string;
+
+    teamId?: string;
+    userId?: string;
+
+    projectId: string;
     projectName: string;
+
     cloneUrl: string;
     branch: string;
     branchPrebuildNumber: string;
-    buildWorkspaceId: string;
 
     startedAt: string;
     startedBy: string;
@@ -75,6 +85,11 @@ export interface PrebuildInfo {
     changeUrl?: string;
     changeHash: string;
 }
+export namespace PrebuildInfo {
+    export function is(data?: any): data is PrebuildInfo {
+        return typeof data === "object" && ["id", "buildWorkspaceId", "projectId", "branch"].every(p => p in data);
+    }
+}
 
 export interface Team {
     id: string;

components/server/ee/src/workspace/workspace-factory.ts

@@ -15,11 +15,14 @@ import { Feature } from '@gitpod/licensor/lib/api';
 import { ResponseError } from 'vscode-jsonrpc';
 import { ErrorCodes } from '@gitpod/gitpod-protocol/lib/messaging/error';
 import { generateWorkspaceID } from '@gitpod/gitpod-protocol/lib/util/generate-workspace-id';
+import { HostContextProvider } from '../../../src/auth/host-context-provider';
+import { parseRepoUrl } from '../../../src/repohost';
 
 @injectable()
 export class WorkspaceFactoryEE extends WorkspaceFactory {
 
     @inject(LicenseEvaluator) protected readonly licenseEvaluator: LicenseEvaluator;
+    @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
 
     protected requireEELicense(feature: Feature) {
         if (!this.licenseEvaluator.isEnabled(feature)) {
@@ -127,6 +130,47 @@ export class WorkspaceFactoryEE extends WorkspaceFactory {
                 branch
             });
 
+
+            { // TODO(at) store prebuild info
+                if (project) {
+                    const { userId, teamId, name: projectName, id: projectId } = project;
+                    const prebuild = pws;
+                    const parsedUrl = parseRepoUrl(project.cloneUrl);
+                    if (parsedUrl) {
+                        const { owner, repo, host } = parsedUrl;
+                        const repositoryProvider = this.hostContextProvider.get(host)?.services?.repositoryProvider;
+                        if (repositoryProvider) {
+                            const commit = await repositoryProvider.getCommitInfo(user, owner, repo, prebuild.commit);
+                            if (commit) {
+                                await this.db.trace({span}).storePrebuildInfo({
+                                    id: prebuild.id,
+                                    status: prebuild.state,
+                                    buildWorkspaceId: prebuild.buildWorkspaceId,
+                                    teamId,
+                                    userId,
+                                    projectName,
+                                    projectId,
+                                    startedAt: prebuild.creationTime,
+                                    startedBy: "", // TODO
+                                    startedByAvatar: "", // TODO
+                                    cloneUrl: prebuild.cloneURL,
+                                    branch: prebuild.branch || "unknown",
+                                    branchPrebuildNumber: "42", // TODO
+                                    changeAuthor: commit.author,
+                                    changeAuthorAvatar: commit.authorAvatarUrl,
+                                    changeDate: commit.authorDate || "",
+                                    changeHash: commit.sha,
+                                    changeTitle: commit.commitMessage,
+                                    // changePR
+                                    // changeUrl
+                                });
+                            }
+                        }
+                    }
+                }
+            }
+
+
             log.debug({ userId: user.id, workspaceId: ws.id }, `Registered workspace prebuild: ${pws.id} for ${commitContext.repository.cloneUrl}:${commitContext.revision}`);
 
             return ws;