Refactor: simple usage summary using /executions/summary backend API

Author: vitvakatu

app/common/src/services/Backend.ts

@@ -1328,6 +1328,29 @@ export interface ListExecutionsRequestParams {
   readonly lastExecutionId?: ProjectExecutionId | null
 }
 
+/** URL query string parameters for the "list execution usage summary" endpoint. */
+export interface ListExecutionsSummaryRequestParams {
+  readonly month?: string | null | undefined
+}
+
+export interface ExecutionUsageSummaryProject {
+  readonly projectId: ProjectId
+  readonly name: string | null
+}
+
+export interface ExecutionUsageSummaryUser {
+  readonly name: string | null
+  readonly email: EmailAddress | null
+}
+
+export interface ExecutionUsageSummary {
+  readonly project: ExecutionUsageSummaryProject
+  readonly user: ExecutionUsageSummaryUser
+  readonly totalSessions: number
+  readonly totalUptimeSeconds: number
+  readonly averageUptimeSeconds: number
+}
+
 export type AssetSortExpression = 'asset_id_discriminator_and_modified_at' | 'modified_at' | 'title'
 
 export type AssetSortDirection = 'ascending' | 'descending'
@@ -1894,6 +1917,10 @@ export abstract class Backend {
   ): Promise<readonly ProjectExecution[]>
   /** Return a list of executions for an organization (if admin) or a user. */
   abstract listExecutions(params: ListExecutionsRequestParams): Promise<readonly ProjectExecution[]>
+  /** Return usage summary rows for an organization (if admin) or a user. */
+  abstract listExecutionsSummary(
+    params: ListExecutionsSummaryRequestParams,
+  ): Promise<readonly ExecutionUsageSummary[]>
   abstract syncProjectExecution(
     executionId: ProjectExecutionId,
     projectTitle: string,

app/common/src/services/Backend/remoteBackendPaths.ts

@@ -103,6 +103,8 @@ export const LIST_API_KEYS_PATH = 'credentials'
 export const CREATE_API_KEY_PATH = 'credentials'
 /** Relative HTTP path to the "create API key" endpoint of the Cloud backend API. */
 export const LIST_EXECUTIONS_PATH = 'executions'
+/** Relative HTTP path to the "list execution usage summary" endpoint of the Cloud backend API. */
+export const LIST_EXECUTIONS_SUMMARY_PATH = 'executions/summary'
 /** Relative HTTP path to the "delete API key" endpoint of the Cloud backend API. */
 export function deleteApiKeyPath(apiKeyId: ApiKeyId) {
   return `credentials/${apiKeyId}`

app/common/src/services/LocalBackend.ts

@@ -1011,6 +1011,11 @@ export class LocalBackend extends backend.Backend {
     return this.invalidOperation()
   }
 
+  /** Invalid operation. */
+  override listExecutionsSummary() {
+    return this.invalidOperation()
+  }
+
   /** Invalid operation. */
   override syncProjectExecution() {
     return this.invalidOperation()

app/common/src/services/RemoteBackend.ts

@@ -749,10 +749,12 @@ export class RemoteBackend extends backend.Backend {
    * Return a list of executions for an organization (if called by an admin) or a request user.
    * @throws An error if a non-successful status code (not 200-299) was received.
    */
-  override async listExecutions(params: backend.ListExecutionsRequestParams): Promise<readonly backend.ProjectExecution[]> {
+  override async listExecutions(
+    params: backend.ListExecutionsRequestParams,
+  ): Promise<readonly backend.ProjectExecution[]> {
     const paramsString = new URLSearchParams({
       /* eslint-disable camelcase */
-      ...(params.lastExecutionId != null ? { last_execution_id: params.lastExecutionId } : {})
+      ...(params.lastExecutionId != null ? { last_execution_id: params.lastExecutionId } : {}),
       /* eslint-enable camelcase */
     }).toString()
     const path = `${remoteBackendPaths.LIST_EXECUTIONS_PATH}?${paramsString}`
@@ -764,6 +766,24 @@ export class RemoteBackend extends backend.Backend {
     }
   }
 
+  /**
+   * Return usage summary rows for an organization (if admin) or a user.
+   * @throws An error if a non-successful status code (not 200-299) was received.
+   */
+  override async listExecutionsSummary(
+    params: backend.ListExecutionsSummaryRequestParams,
+  ): Promise<readonly backend.ExecutionUsageSummary[]> {
+    const response = await this.get<readonly backend.ExecutionUsageSummary[]>(
+      remoteBackendPaths.LIST_EXECUTIONS_SUMMARY_PATH,
+      params.month != null ? { month: params.month } : undefined,
+    )
+    if (!response.ok) {
+      return await this.throw(response, 'listExecutionsSummaryBackendError')
+    } else {
+      return await response.json()
+    }
+  }
+
   /**
    * Return a list of executions for a project.
    * @throws An error if a non-successful status code (not 200-299) was received.

app/common/src/text/english.json

@@ -152,6 +152,7 @@
   "deleteProjectExecutionBackendError": "Could not delete project execution for project '$0'",
   "listProjectExecutionsBackendError": "Could not list project executions for project '$0'",
   "listExecutionsBackendError": "Could not list executions",
+  "listExecutionsSummaryBackendError": "Could not list usage summary",
   "syncProjectExecutionBackendError": "Could not sync project execution of project '$0'",
   "getProjectDetailsBackendError": "Could not get details of project",
   "getProjectLogsBackendError": "Could not get logs for project '$0'",
@@ -1071,15 +1072,25 @@
   "keyboardShortcutsSettingsSection": "Keyboard Shortcuts",
   "keyboardShortcutsSettingsCustomEntryAliases": "keyboard shortcuts",
   "securitySettingsTabSection": "Security",
-  "financesSettingsTabSection": "Finances",
+  "usageSettingsTabSection": "Usage",
   "activityLogSettingsTab": "Activity log",
   "activityLogSettingsSection": "Activity Log",
   "apiKeysSettingsTab": "API Keys",
-  "financesSettingsTab": "Finances",
+  "usageSettingsTab": "Usage",
   "apiKeysSettingsSection": "API Keys",
-  "financesSettingsSection": "Finances",
+  "usageSettingsSection": "Usage Summary",
   "apiKeysSettingsCustomEntryAliases": "api keys\napi key",
-  "financesSettingsCustomEntryAliases": "Finances",
+  "usageSettingsCustomEntryAliases": "usage\nusage summary",
+  "executionSummaryMonthLabel": "Month",
+  "executionSummaryUserColumn": "User",
+  "executionSummaryProjectColumn": "Project",
+  "executionSummaryCountOfExecutionsColumn": "Count of executions",
+  "executionSummaryTotalUptimeColumn": "Total uptime",
+  "executionSummaryAverageUptimeColumn": "Average uptime",
+  "executionSummaryLoading": "Loading usage summary...",
+  "executionSummaryEmpty": "No usage found for selected month.",
+  "executionSummaryUnknownUser": "Unknown user",
+  "executionSummaryUnknownProject": "Unknown project",
   "free": "Community",
   "freePlan": "Community Plan",
   "solo": "Solo",

app/gui/src/dashboard/layouts/Settings/FinancesSettingsSection.tsx

@@ -18,7 +18,7 @@ enum SettingsTabType {
   // compliance = 'compliance',
   // usageStatistics = 'usage-statistics',
   apiKeys = 'api-keys',
-  finances = 'finances',
+  usage = 'usage',
 }
 
 export default SettingsTabType