Implement ListOrganizationPrebuilds (#19326)

* Define `ListOrganizationPrebuilds`

* Fix because of name changes

* Add unimplemented `listOrganizationPrebuilds`

* Crazy stuff right here

* Address huiwen's comments

* Fix more types

* sad™

* trrr

* WIP API changes

* Add configuration id and search term filtering

* Filtering

* Offload prebuild listing to prebuild manager

* unused thingy delete

* Add filtering by status

* `listPrebuilds` -> `listOrganizationPrebuilds`

* Configuration filtering could be done with a branch

... what do you say?

* Implement branch filtering

* Update pagination rules

* Fix pagination limit validation error

* Migrate one more

* Fix org id for prebuild listing

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

Co-authored-by: Siddhant Khare <[email protected]>

* Apply code suggestions

* Align pagination with config service

* Status filter validation

* Align org id usage

* Revert back to `listPrebuilds`

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

Co-authored-by: Siddhant Khare <[email protected]>

* Bring in search

* Fix proj id instead of org id

* Fix search query‽‽‽

* nit 💄

---------

Co-authored-by: Siddhant Khare <[email protected]>
Co-authored-by: Huiwen Huang <[email protected]>

Author: 3 people

components/dashboard/src/service/json-rpc-prebuild-client.ts

@@ -148,6 +148,6 @@ export class JsonRpcPrebuildClient implements PromiseClient<typeof PrebuildServi
     async listOrganizationPrebuilds(
         request: PartialMessage<ListOrganizationPrebuildsRequest>,
     ): Promise<ListOrganizationPrebuildsResponse> {
-        return new ListOrganizationPrebuildsResponse({});
+        throw new ApplicationError(ErrorCodes.UNIMPLEMENTED, "Not implemented (for jrpc)");
     }
 }

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

@@ -57,6 +57,7 @@ import {
 import { TransactionalDBImpl } from "./transactional-db-impl";
 import { TypeORM } from "./typeorm";
 import { ApplicationError, ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
+import { DBProject } from "./entity/db-project";
 
 type RawTo<T> = (instance: WorkspaceInstance, ws: Workspace) => T;
 interface OrderBy {
@@ -1036,6 +1037,67 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
         return res;
     }
 
+    /**
+     * Finds prebuilt workspaces by organization with optional filtering and pagination.
+     * @param organizationId The ID of the organization.
+     * @param offset Offset for pagination.
+     * @param limit Limit for pagination.
+     * @param filter Filters for the search.
+     * @returns A promise that resolves to an array of PrebuiltWorkspace objects.
+     */
+    async findPrebuiltWorkspacesByOrganization(
+        organizationId: string,
+        offset = 0,
+        limit = 25,
+        filter?: {
+            configuration?: {
+                id: string;
+                branch?: string;
+            };
+            status: PrebuiltWorkspaceState;
+            searchTerm?: string;
+        },
+    ): Promise<PrebuiltWorkspace[]> {
+        const repo = await this.getPrebuiltWorkspaceRepo();
+        const query = repo
+            .createQueryBuilder("pws")
+            .orderBy("pws.creationTime", "DESC")
+            .innerJoinAndMapOne(
+                "pws.workspace",
+                DBWorkspace,
+                "ws",
+                "pws.buildWorkspaceId = ws.id AND ws.organizationId = :organizationId",
+                { organizationId },
+            )
+            .skip(offset)
+            .take(limit);
+
+        if (filter?.status) {
+            query.andWhere("pws.state = :state", { state: filter.status });
+        }
+
+        if (filter?.configuration?.id) {
+            query.andWhere("pws.projectId = :projectId", { projectId: filter.configuration.id });
+            if (filter.configuration.branch) {
+                query.andWhere("pws.branch = :branch", { branch: filter.configuration.branch });
+            }
+        }
+
+        const normalizedSearchTerm = filter?.searchTerm?.trim();
+        if (normalizedSearchTerm) {
+            query.innerJoinAndMapOne("pws.project", DBProject, "project", "pws.projectId = project.id");
+            query.andWhere(
+                new Brackets((qb) => {
+                    qb.where("project.cloneUrl LIKE :searchTerm", {
+                        searchTerm: `%${normalizedSearchTerm}%`,
+                    }).orWhere("project.name LIKE :searchTerm", { searchTerm: `%${normalizedSearchTerm}%` });
+                }),
+            );
+        }
+
+        return query.getMany();
+    }
+
     async findPrebuiltWorkspaceById(id: string): Promise<PrebuiltWorkspace | undefined> {
         const repo = await this.getPrebuiltWorkspaceRepo();
 

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

@@ -20,6 +20,7 @@ import {
     PrebuildInfo,
     AdminGetWorkspacesQuery,
     SnapshotState,
+    PrebuiltWorkspaceState,
 } from "@gitpod/gitpod-protocol";
 
 export type MaybeWorkspace = Workspace | undefined;
@@ -170,6 +171,19 @@ export interface WorkspaceDB {
     hardDeleteWorkspace(workspaceID: string): Promise<void>;
 
     findPrebuiltWorkspacesByProject(projectId: string, branch?: string, limit?: number): Promise<PrebuiltWorkspace[]>;
+    findPrebuiltWorkspacesByOrganization(
+        organizationId: string,
+        offset?: number,
+        limit?: number,
+        filter?: {
+            configuration?: {
+                id: string;
+                branch?: string;
+            };
+            status?: PrebuiltWorkspaceState;
+            searchTerm?: string;
+        },
+    ): Promise<PrebuiltWorkspace[]>;
     findPrebuiltWorkspaceById(prebuildId: string): Promise<PrebuiltWorkspace | undefined>;
 
     storePrebuildInfo(prebuildInfo: PrebuildInfo): Promise<void>;

components/public-api/gitpod/v1/prebuild.proto

@@ -66,8 +66,12 @@ message WatchPrebuildResponse {
 
 message ListOrganizationPrebuildsRequest {
   message Filter {
+    message Configuration {
+      string id = 1;
+      string branch = 2;
+    }
     PrebuildPhase.Phase status = 1;
-    string configuration_id = 2;
+    Configuration configuration = 2;
     // Filter the search down by searching for configuration names matching the
     // query
     string search_term = 3;