add sorting

Author: Laurie T. Malau

components/dashboard/src/teams/TeamUsage.tsx

@@ -8,7 +8,7 @@ import { useContext, useEffect, useState } from "react";
 import { Redirect, useLocation } from "react-router";
 import { getCurrentTeam, TeamsContext } from "./teams-context";
 import { getGitpodService, gitpodHostUrl } from "../service/service";
-import { BillableSession, BillableWorkspaceType } from "@gitpod/gitpod-protocol/lib/usage";
+import { BillableSession, BillableWorkspaceType, SortOrder } from "@gitpod/gitpod-protocol/lib/usage";
 import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
 import { Item, ItemField, ItemsList } from "../components/ItemsList";
 import moment from "moment";
@@ -34,19 +34,22 @@ function TeamUsage() {
     const [startDateOfBillMonth, setStartDateOfBillMonth] = useState(timestampStartOfCurrentMonth);
     const [endDateOfBillMonth, setEndDateOfBillMonth] = useState(Date.now());
     const [isLoading, setIsLoading] = useState<boolean>(true);
+    const [startedTimeOrder] = useState<SortOrder>(SortOrder.Descending);
 
     useEffect(() => {
         if (!team) {
             return;
         }
         (async () => {
             const attributionId = AttributionId.render({ kind: "team", teamId: team.id });
+            const request = {
+                attributionId,
+                startedTimeOrder,
+                startDateOfBillMonth,
+                endDateOfBillMonth,
+            };
             try {
-                const billedUsageResult = await getGitpodService().server.listBilledUsage(
-                    attributionId,
-                    startDateOfBillMonth,
-                    endDateOfBillMonth,
-                );
+                const billedUsageResult = await getGitpodService().server.listBilledUsage(request);
                 setBilledUsage(billedUsageResult);
             } catch (error) {
                 if (error.code === ErrorCodes.PERMISSION_DENIED) {
@@ -56,7 +59,7 @@ function TeamUsage() {
                 setIsLoading(false);
             }
         })();
-    }, [team, startDateOfBillMonth, endDateOfBillMonth]);
+    }, [team, startDateOfBillMonth, endDateOfBillMonth, startedTimeOrder]);
 
     if (!showUsageBasedPricingUI) {
         return <Redirect to="/" />;

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

@@ -61,7 +61,7 @@ import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./
 import { IDEServer } from "./ide-protocol";
 import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
 import { Currency } from "./plans";
-import { BillableSession } from "./usage";
+import { BillableSession, BillableSessionRequest } from "./usage";
 import { SupportedWorkspaceClass } from "./workspace-class";
 
 export interface GitpodClient {
@@ -294,7 +294,8 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getSpendingLimitForTeam(teamId: string): Promise<number | undefined>;
     setSpendingLimitForTeam(teamId: string, spendingLimit: number): Promise<void>;
 
-    listBilledUsage(attributionId: string, from?: number, to?: number): Promise<BillableSession[]>;
+    listBilledUsage(req: BillableSessionRequest): Promise<BillableSession[]>;
+
     setUsageAttribution(usageAttribution: string): Promise<void>;
 
     /**
@@ -308,7 +309,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      * Frontend notifications
      */
     getNotifications(): Promise<string[]>;
-    
+
     getSupportedWorkspaceClasses(): Promise<SupportedWorkspaceClass[]>;
 }
 

components/gitpod-protocol/src/usage.ts

@@ -35,4 +35,16 @@ export interface BillableSession {
     projectId?: string;
 }
 
+export interface BillableSessionRequest {
+    attributionId: string;
+    startedTimeOrder: SortOrder;
+    from?: number;
+    to?: number;
+}
+
 export type BillableWorkspaceType = WorkspaceType;
+
+export enum SortOrder {
+    Descending = 0,
+    Ascending = 1,
+}

components/server/ee/src/workspace/gitpod-server-impl.ts

@@ -72,7 +72,7 @@ import { BlockedRepository } from "@gitpod/gitpod-protocol/lib/blocked-repositor
 import { EligibilityService } from "../user/eligibility-service";
 import { AccountStatementProvider } from "../user/account-statement-provider";
 import { GithubUpgradeURL, PlanCoupon } from "@gitpod/gitpod-protocol/lib/payment-protocol";
-import { BillableSession } from "@gitpod/gitpod-protocol/lib/usage";
+import { BillableSession, BillableSessionRequest, SortOrder } from "@gitpod/gitpod-protocol/lib/usage";
 import {
     AssigneeIdentityIdentifier,
     TeamSubscription,
@@ -2080,7 +2080,13 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         const result = await super.getNotifications(ctx);
         const user = this.checkAndBlockUser("getNotifications");
         if (user.usageAttributionId) {
-            const allSessions = await this.listBilledUsage(ctx, user.usageAttributionId);
+            // This change doesn't matter much because the listBilledUsage() call
+            // will be removed anyway in https://github.com/gitpod-io/gitpod/issues/11692
+            const request = {
+                attributionId: user.usageAttributionId,
+                startedTimeOrder: SortOrder.Descending,
+            };
+            const allSessions = await this.listBilledUsage(ctx, request);
             const totalUsage = allSessions.map((s) => s.credits).reduce((a, b) => a + b, 0);
             const costCenter = await this.costCenterDB.findById(user.usageAttributionId);
             if (costCenter) {
@@ -2096,12 +2102,8 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         return result;
     }
 
-    async listBilledUsage(
-        ctx: TraceContext,
-        attributionId: string,
-        from?: number,
-        to?: number,
-    ): Promise<BillableSession[]> {
+    async listBilledUsage(ctx: TraceContext, req: BillableSessionRequest): Promise<BillableSession[]> {
+        const { attributionId, startedTimeOrder, from, to } = req;
         traceAPIParams(ctx, { attributionId });
         let timestampFrom;
         let timestampTo;
@@ -2116,7 +2118,13 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
             timestampTo = Timestamp.fromDate(new Date(to));
         }
         const usageClient = this.usageServiceClientProvider.getDefault();
-        const response = await usageClient.listBilledUsage(ctx, attributionId, timestampFrom, timestampTo);
+        const response = await usageClient.listBilledUsage(
+            ctx,
+            attributionId,
+            startedTimeOrder as number,
+            timestampFrom,
+            timestampTo,
+        );
         const sessions = response.getSessionsList().map((s) => this.mapBilledSession(s));
 
         return sessions;

components/server/src/workspace/gitpod-server-impl.ts

@@ -169,7 +169,7 @@ import { LicenseEvaluator } from "@gitpod/licensor/lib";
 import { Feature } from "@gitpod/licensor/lib/api";
 import { Currency } from "@gitpod/gitpod-protocol/lib/plans";
 import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
-import { BillableSession } from "@gitpod/gitpod-protocol/lib/usage";
+import { BillableSession, BillableSessionRequest } from "@gitpod/gitpod-protocol/lib/usage";
 import { WorkspaceClusterImagebuilderClientProvider } from "./workspace-cluster-imagebuilder-client-provider";
 
 // shortcut
@@ -3207,12 +3207,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         throw new ResponseError(ErrorCodes.SAAS_FEATURE, `Not implemented in this version`);
     }
 
-    async listBilledUsage(
-        ctx: TraceContext,
-        attributionId: string,
-        from?: number,
-        to?: number,
-    ): Promise<BillableSession[]> {
+    async listBilledUsage(ctx: TraceContext, req: BillableSessionRequest): Promise<BillableSession[]> {
         throw new ResponseError(ErrorCodes.SAAS_FEATURE, `Not implemented in this version`);
     }
     async getSpendingLimitForTeam(ctx: TraceContext, teamId: string): Promise<number | undefined> {

components/usage-api/typescript/src/usage/v1/sugar.ts

@@ -91,14 +91,15 @@ export class PromisifiedUsageServiceClient {
         );
     }
 
-    public async listBilledUsage(_ctx: TraceContext, attributionId: string, from?: Timestamp, to?: Timestamp): Promise<ListBilledUsageResponse> {
+    public async listBilledUsage(_ctx: TraceContext, attributionId: string, order: ListBilledUsageRequest.Ordering, from?: Timestamp, to?: Timestamp): Promise<ListBilledUsageResponse> {
         const ctx = TraceContext.childContext(`/usage-service/listBilledUsage`, _ctx);
 
         try {
             const req = new ListBilledUsageRequest();
             req.setAttributionId(attributionId);
             req.setFrom(from);
             req.setTo(to);
+            req.setOrder(order);
 
             const response = await new Promise<ListBilledUsageResponse>((resolve, reject) => {
                 this.client.listBilledUsage(