[papi] add ListWorkspaces API

Author: mustard-mh

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

@@ -12,9 +12,13 @@ import {
     GetWorkspaceResponse,
     WatchWorkspaceStatusRequest,
     WatchWorkspaceStatusResponse,
+    ListWorkspacesRequest,
+    ListWorkspacesRequest_Scope,
+    ListWorkspacesResponse,
 } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { converter } from "./public-api";
 import { getGitpodService } from "./service";
+import { PaginationResponse } from "@gitpod/public-api/lib/gitpod/v1/pagination_pb";
 import { generateAsyncGenerator } from "@gitpod/gitpod-protocol/lib/generate-async-generator";
 import { WorkspaceInstance } from "@gitpod/gitpod-protocol";
 
@@ -80,4 +84,30 @@ export class JsonRpcWorkspaceClient implements PromiseClient<typeof WorkspaceSer
             yield response;
         }
     }
+
+    async listWorkspaces(
+        request: PartialMessage<ListWorkspacesRequest>,
+        _options?: CallOptions,
+    ): Promise<ListWorkspacesResponse> {
+        request.scope = request.scope ?? ListWorkspacesRequest_Scope.MY_WORKSPACES_IN_ORGANIZATION;
+        if (
+            request.scope === ListWorkspacesRequest_Scope.MY_WORKSPACES_IN_ORGANIZATION ||
+            request.scope === ListWorkspacesRequest_Scope.ALL_WORKSPACES_IN_ORGANIZATION
+        ) {
+            throw new ConnectError("organization_id is required", Code.InvalidArgument);
+        }
+        const server = getGitpodService().server;
+        const pageSize = request.pagination?.pageSize || 100;
+        const workspaces = await server.getWorkspaces({
+            organizationId: request.organizationId,
+            pinnedOnly: request.pinned === true ? true : undefined,
+            limit: pageSize,
+            offset: (request.pagination?.page ?? 0) * pageSize,
+        });
+        const response = new ListWorkspacesResponse();
+        response.workspaces = workspaces.map((info) => converter.toWorkspace(info));
+        response.pagination = new PaginationResponse();
+        response.pagination.total = workspaces.length;
+        return response;
+    }
 }

components/dashboard/src/service/public-api.ts

@@ -46,6 +46,9 @@ export const organizationClient = createServiceClient(
     "organization",
 );
 
+// @ts-ignore
+window.$workspaceClient = workspaceClient;
+
 export async function listAllProjects(opts: { orgId: string }): Promise<ProtocolProject[]> {
     let pagination = {
         page: 1,

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

@@ -177,7 +177,7 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
         return this.findById(instance.workspaceId);
     }
 
-    public async find(options: FindWorkspacesOptions): Promise<WorkspaceInfo[]> {
+    public async find(options: FindWorkspacesOptions): Promise<{ total: number; rows: WorkspaceInfo[] }> {
         /**
          * With this query we want to list all user workspaces by lastActivity and include the latestWorkspaceInstance (if present).
          * Implementation notes:
@@ -233,7 +233,7 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
         if (projectIds !== undefined) {
             if (projectIds.length === 0 && !options.includeWithoutProject) {
                 // user passed an empty array of projectids and also is not interested in unassigned workspaces -> no results
-                return [];
+                return { total: 0, rows: [] };
             }
             qb.andWhere(
                 new Brackets((qb) => {
@@ -251,15 +251,16 @@ export class TypeORMWorkspaceDBImpl extends TransactionalDBImpl<WorkspaceDB> imp
                 }),
             );
         }
-        const rawResults = (await qb.getMany()) as any as (Workspace & { latestInstance?: WorkspaceInstance })[]; // see leftJoinAndMapOne above
-        return rawResults.map((r) => {
+        const [rawResults, total] = await qb.getManyAndCount();
+        const rows = (rawResults as any as (Workspace & { latestInstance?: WorkspaceInstance })[]).map((r) => {
             const workspace = { ...r };
             delete workspace.latestInstance;
             return {
                 workspace,
                 latestInstance: r.latestInstance,
             };
         });
+        return { total, rows };
     }
 
     public async updateLastHeartbeat(

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

@@ -415,9 +415,9 @@ class WorkspaceDBSpec {
         });
 
         // It should only find one workspace instance
-        expect(dbResult.length).to.eq(1);
+        expect(dbResult.total).to.eq(1);
 
-        expect(dbResult[0].workspace.id).to.eq(this.ws.id);
+        expect(dbResult.rows[0].workspace.id).to.eq(this.ws.id);
     }
 
     @test(timeout(10000))
@@ -437,9 +437,9 @@ class WorkspaceDBSpec {
         });
 
         // It should only find one workspace instance
-        expect(dbResult.length).to.eq(1);
+        expect(dbResult.total).to.eq(1);
 
-        expect(dbResult[0].workspace.id).to.eq(this.ws2.id);
+        expect(dbResult.rows[0].workspace.id).to.eq(this.ws2.id);
     }
 
     @test(timeout(10000))
@@ -458,10 +458,10 @@ class WorkspaceDBSpec {
             includeWithoutProject: false,
         });
 
-        expect(dbResult.length).to.eq(2);
+        expect(dbResult.total).to.eq(2);
 
-        expect(dbResult[0].workspace.id).to.eq(this.ws.id);
-        expect(dbResult[1].workspace.id).to.eq(this.ws2.id);
+        expect(dbResult.rows[0].workspace.id).to.eq(this.ws.id);
+        expect(dbResult.rows[1].workspace.id).to.eq(this.ws2.id);
     }
 
     @test(timeout(10000))
@@ -480,7 +480,7 @@ class WorkspaceDBSpec {
             includeWithoutProject: false,
         });
 
-        expect(dbResult.length).to.eq(0);
+        expect(dbResult.total).to.eq(0);
 
         // expect(dbResult[0].workspace.id).to.eq(this.ws.id);
         // expect(dbResult[1].workspace.id).to.eq(this.ws2.id);
@@ -504,9 +504,9 @@ class WorkspaceDBSpec {
             includeWithoutProject: true,
         });
 
-        expect(dbResult.length).to.eq(1);
+        expect(dbResult.total).to.eq(1);
 
-        expect(dbResult[0].workspace.id).to.eq(this.ws3.id);
+        expect(dbResult.rows[0].workspace.id).to.eq(this.ws3.id);
     }
 
     @test(timeout(10000))
@@ -527,10 +527,10 @@ class WorkspaceDBSpec {
             includeWithoutProject: true,
         });
 
-        expect(dbResult.length).to.eq(2);
+        expect(dbResult.total).to.eq(2);
 
-        expect(dbResult[0].workspace.id).to.eq(this.ws2.id);
-        expect(dbResult[1].workspace.id).to.eq(this.ws3.id);
+        expect(dbResult.rows[0].workspace.id).to.eq(this.ws2.id);
+        expect(dbResult.rows[1].workspace.id).to.eq(this.ws3.id);
     }
 
     @test(timeout(10000))
@@ -792,8 +792,8 @@ class WorkspaceDBSpec {
             organizationId: this.orgidA,
         });
 
-        expect(result.length).to.eq(2);
-        for (const ws of result) {
+        expect(result.total).to.eq(2);
+        for (const ws of result.rows) {
             expect(ws.workspace.organizationId).to.equal(this.orgidA);
         }
 
@@ -802,8 +802,8 @@ class WorkspaceDBSpec {
             organizationId: this.orgidB,
         });
 
-        expect(result.length).to.eq(1);
-        for (const ws of result) {
+        expect(result.total).to.eq(1);
+        for (const ws of result.rows) {
             expect(ws.workspace.organizationId).to.equal(this.orgidB);
         }
 
@@ -812,7 +812,7 @@ class WorkspaceDBSpec {
             organizationId: "no-org",
         });
 
-        expect(result.length).to.eq(0);
+        expect(result.total).to.eq(0);
     }
 
     @test(timeout(10000))

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

@@ -32,6 +32,7 @@ export interface FindWorkspacesOptions {
     projectId?: string | string[];
     includeWithoutProject?: boolean;
     limit?: number;
+    offset?: number;
     searchString?: string;
     includeHeadless?: boolean;
     pinnedOnly?: boolean;
@@ -80,7 +81,7 @@ export interface WorkspaceDB {
     updatePartial(workspaceId: string, partial: DeepPartial<Workspace>): Promise<void>;
     findById(id: string): Promise<MaybeWorkspace>;
     findByInstanceId(id: string): Promise<MaybeWorkspace>;
-    find(options: FindWorkspacesOptions): Promise<WorkspaceInfo[]>;
+    find(options: FindWorkspacesOptions): Promise<{ total: number; rows: WorkspaceInfo[] }>;
     findWorkspacePortsAuthDataById(workspaceId: string): Promise<WorkspacePortsAuthData | undefined>;
 
     storeInstance(instance: WorkspaceInstance): Promise<WorkspaceInstance>;

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

@@ -408,6 +408,7 @@ export interface StartWorkspaceResult {
 export namespace GitpodServer {
     export interface GetWorkspacesOptions {
         limit?: number;
+        offset?: number;
         searchString?: string;
         pinnedOnly?: boolean;
         projectId?: string | string[];

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

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package gitpod.v1;
+
+option go_package = "github.com/gitpod-io/gitpod/components/public-api/go/v1";
+
+enum SortOrder {
+    SORT_ORDER_UNSPECIFIED = 0;
+    SORT_ORDER_ASCENDING = 1;
+    SORT_ORDER_DESCENDING = 2;
+}

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

@@ -3,6 +3,8 @@ syntax = "proto3";
 package gitpod.v1;
 
 import "google/protobuf/timestamp.proto";
+import "gitpod/v1/pagination.proto";
+import "gitpod/v1/sort.proto";
 
 option go_package = "github.com/gitpod-io/gitpod/components/public-api/go/v1";
 
@@ -17,6 +19,9 @@ service WorkspaceService {
   //
   // workspace_id +return NOT_FOUND Workspace does not exist
   rpc WatchWorkspaceStatus(WatchWorkspaceStatusRequest) returns (stream WatchWorkspaceStatusResponse) {}
+
+  // ListWorkspaces returns a list of workspaces that match the query.
+  rpc ListWorkspaces(ListWorkspacesRequest) returns (ListWorkspacesResponse) {}
 }
 
 message GetWorkspaceRequest { string id = 1; }
@@ -38,6 +43,55 @@ message WatchWorkspaceStatusResponse {
   WorkspaceStatus status = 2;
 }
 
+message ListWorkspacesRequest {
+  // pagination contains the pagination options for listing workspaces
+  PaginationRequest pagination = 1;
+
+  repeated WorkspaceSortRequest sorts = 2;
+
+  // scope of the workspaces
+  Scope scope = 3;
+
+  enum Scope {
+    SCOPE_UNSPECIFIED = 0;
+
+    // SCOPE_MY_WORKSPACES_IN_ORGANIZATION scopes workspaces that is owned by current user in the organization
+    SCOPE_MY_WORKSPACES_IN_ORGANIZATION = 1;
+
+    // SCOPE_ALL_WORKSPACES_IN_ORGANIZATION scopes all workspaces in the organization
+    SCOPE_ALL_WORKSPACES_IN_ORGANIZATION = 2;
+
+    // SCOPE_ALL_WORKSPACES_IN_INSTALLATION scopes all workspaces in the installation
+    SCOPE_ALL_WORKSPACES_IN_INSTALLATION = 3;
+  }
+
+  // organization_id is the ID of the organization that contains the workspaces
+  string organization_id = 4;
+
+  // pinned indicates whether to list only pinned workspaces
+  bool pinned = 5;
+
+  // search_term is a search term to filter workspaces by name
+  string search_term = 6;
+}
+
+message ListWorkspacesResponse {
+  // workspaces are the workspaces that matched the query
+  repeated Workspace workspaces = 1;
+
+  // pagination contains the pagination options for listing workspaces
+  PaginationResponse pagination = 2;
+}
+
+enum WorkspaceSortableField {
+  WORKSPACE_SORTABLE_FIELD_UNSPECIFIED = 0;
+}
+
+message WorkspaceSortRequest {
+  WorkspaceSortableField field = 1;
+  SortOrder order = 2;
+}
+
 // +resource get workspace
 message Workspace {
   string id = 1;