@gitpod/gitpod-protocol 0.1.5-mp-stripe-finalize-invoice.13 → 0.1.5-mp-revert-dialer-usage.0

package/src/usage.ts

@@ -4,60 +4,68 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { User, WorkspaceType } from "./protocol";
+import { WorkspaceType } from "./protocol";
 
-export interface BillableSession {
-    // The id of the one paying the bill
+// types below are copied over from components/usage-api/typescript/src/usage/v1/usage_pb.d.ts
+export interface ListUsageRequest {
     attributionId: string;
-
-    // Relevant for workspace type. When prebuild, shows "prebuild"
-    userId?: string;
-    teamId?: string;
-
-    instanceId: string;
-
-    workspaceId: string;
-
-    workspaceType: BillableWorkspaceType;
-
-    workspaceClass: string;
-
-    // When the workspace started
-    startTime: string;
-
-    // When the workspace ended. Not set when the workspace is still running.
-    endTime?: string;
-
-    // The credits used for this session
-    credits: number;
-
-    // TODO - maybe
-    projectId?: string;
+    from?: number;
+    to?: number;
+    order: Ordering;
+    pagination?: PaginationRequest;
 }
 
-export interface ExtendedBillableSession extends BillableSession {
-    contextURL?: string;
-    user?: Pick<User.Profile, "name" | "avatarURL">;
+export enum Ordering {
+    ORDERING_DESCENDING = 0,
+    ORDERING_ASCENDING = 1,
 }
 
-/**
- * This is a paginated request
- */
-export interface ListBilledUsageRequest {
-    attributionId: string;
-    fromDate?: number;
-    toDate?: number;
+export interface PaginationRequest {
     perPage: number;
     page: number;
 }
 
-export interface ListBilledUsageResponse {
-    sessions: ExtendedBillableSession[];
-    totalCreditsUsed: number;
-    totalPages: number;
-    totalSessions: number;
+export interface ListUsageResponse {
+    usageEntriesList: Usage[];
+    pagination?: PaginationResponse;
+    creditsUsed: number;
+}
+
+export interface PaginationResponse {
     perPage: number;
+    totalPages: number;
+    total: number;
     page: number;
 }
 
-export type BillableWorkspaceType = WorkspaceType;
+export type UsageKind = "workspaceinstance" | "invoice";
+export interface Usage {
+    id: string;
+    attributionId: string;
+    description: string;
+    credits: number;
+    effectiveTime?: number;
+    kind: UsageKind;
+    workspaceInstanceId: string;
+    draft: boolean;
+    metadata: WorkspaceInstanceUsageData | InvoiceUsageData;
+}
+
+// the equivalent golang shape is maintained in `/workspace/gitpod/`components/usage/pkg/db/usage.go`
+export interface WorkspaceInstanceUsageData {
+    workspaceId: string;
+    workspaceType: WorkspaceType;
+    workspaceClass: string;
+    contextURL: string;
+    startTime: string;
+    endTime?: string;
+    userId: string;
+    userName: string;
+    userAvatarURL: string;
+}
+
+export interface InvoiceUsageData {
+    invoiceId: string;
+    startDate: string;
+    endDate: string;
+}

package/src/util/timeutil.spec.ts

@@ -45,4 +45,25 @@ export class TimeutilSpec {
         const later = oneMonthLater(from.toISOString(), day);
         expect(later, `expected ${later} to be equal ${expectation}`).to.be.equal(expectation.toISOString());
     }
+
+    @test
+    testDaysBefore2() {
+        const tests: { date: Date; daysEarlier: number; expectation: string }[] = [
+            {
+                date: new Date("2021-07-13T00:00:00.000Z"),
+                daysEarlier: 365,
+                expectation: "2020-07-13T00:00:00.000Z",
+            },
+            {
+                date: new Date("2019-02-01T00:00:00.000Z"),
+                daysEarlier: 365,
+                expectation: "2018-02-01T00:00:00.000Z",
+            },
+        ];
+
+        for (const t of tests) {
+            const actual = daysBefore(t.date.toISOString(), t.daysEarlier);
+            expect(actual).to.equal(t.expectation, `expected ${actual} to be equal ${t.expectation}`);
+        }
+    }
 }