Use camelcase for all of the objects in the JSON blob, update typescript types

Author: Jamesbarford

site/frontend/src/pages/status_new/data.ts

@@ -1,165 +1,139 @@
-import {isObject, isString} from "../../utils/getType";
+type BenchmarkRequestStatusComplete = {
+  state: "completed";
+  completedAt: string;
+  duration: number; // time in milliseconds
+};
 
-type CommitTypeMaster = {
-  sha: string;
-  parent_sha: string;
-  pr: number;
+type BenchmarkRequestStatusInProgress = {
+  state: "in_progress";
 };
 
-type CommitTypeRelease = {
-  tag: string;
+type BenchmarkRequestStatusArtifactsReady = {
+  state: "artifacts_ready";
 };
 
-type CommitTypeTry = {
-  sha: string;
+export type BenchmarkRequestStatus =
+  | BenchmarkRequestStatusComplete
+  | BenchmarkRequestStatusInProgress
+  | BenchmarkRequestStatusArtifactsReady;
+
+type BenchmarkRequestTypeTry = {
+  type: "Try";
+  tag: string | null;
   parent_sha: string | null;
   pr: number;
 };
 
-export type CommitType = CommitTypeRelease | CommitTypeMaster | CommitTypeTry;
-export type CommitTypeString = "Master" | "Try" | "Release";
+type BenchmarkRequestTypeMaster = {
+  type: "Master";
+  tag: string;
+  parent_sha: string;
+  pr: number;
+};
+
+type BenchmarkRequestTypeRelease = {
+  type: "Try";
+  tag: string;
+};
+
+type BenchmarkRequestType =
+  | BenchmarkRequestTypeTry
+  | BenchmarkRequestTypeMaster
+  | BenchmarkRequestTypeRelease;
 
 export type BenchmarkRequestComplete = {
-  commit_type: {
-    [K in CommitTypeString]: CommitType;
-  };
-  commit_date: string | null;
-  created_at: string | null;
-  status: {
-    Completed: {
-      completed_at: string;
-      duration_ms: number;
-    };
-  };
-  backends: string;
-  profile: string;
+  status: BenchmarkRequestStatusComplete;
+  requestType: BenchmarkRequestType;
+  commitDate: string | null;
+  createdAt: string | null;
+  backends: string[];
+  profiles: string;
+  errors: string[];
 };
 
 export type BenchmarkRequestInProgress = {
-  commit_type: {
-    [K in CommitTypeString]: CommitType;
-  };
-  commit_date: string | null;
-  created_at: string | null;
-  status: "InProgress";
-  backends: string;
+  status: BenchmarkRequestStatusInProgress;
+  requestType: BenchmarkRequestType;
+  commitDate: string | null;
+  createdAt: string | null;
+  backends: string[];
   profiles: string;
+  errors: string[];
 };
 
 export type BenchmarkRequestArtifactsReady = {
-  commit_type: {
-    [K in CommitTypeString]: CommitType;
-  };
-  commit_date: string | null;
-  created_at: string | null;
-  status: "ArtifactsReady";
-  backends: string;
+  status: BenchmarkRequestStatusArtifactsReady;
+  requestType: BenchmarkRequestType;
+  commitDate: string | null;
+  createdAt: string | null;
+  backends: string[];
   profiles: string;
+  errors: string[];
 };
 
-type BenchmarkRequest =
+export type BenchmarkRequest =
   | BenchmarkRequestComplete
   | BenchmarkRequestInProgress
   | BenchmarkRequestArtifactsReady;
 
-export function isMasterBenchmarkRequest(
-  commitType: Object
-): commitType is {["Master"]: CommitTypeMaster} {
-  return "Master" in commitType;
-}
-
-export function isReleaseBenchmarkRequest(
-  commitType: Object
-): commitType is {["Release"]: CommitTypeRelease} {
-  return "Release" in commitType;
-}
-
-export function isTryBenchmarkRequest(
-  commitType: Object
-): commitType is {["Try"]: CommitTypeTry} {
-  return "Try" in commitType;
-}
-
-export function isArtifactsReadyBenchmarkRequest(
-  req: BenchmarkRequest
-): req is BenchmarkRequestArtifactsReady {
-  return isString(req.status) && req.status === "ArtifactsReady";
-}
-
-export function isInProgressBenchmarkRequest(
-  req: BenchmarkRequest
-): req is BenchmarkRequestInProgress {
-  return isString(req.status) && req.status === "InProgress";
-}
-
-export function isCompleteBenchmarkRequest(
-  req: BenchmarkRequest
-): req is BenchmarkRequestComplete {
-  return isObject(req.status) && "Completed" in req.status;
-}
+export type BenchmarkJobStatusQueued = {
+  state: "queued";
+};
 
 export type BenchmarkJobStatusInProgress = {
-  started_at: string;
-  collector_name: string;
+  state: "in_progress";
+  startedAt: string;
+  collectorName: string;
 };
 
-export type BenchmarkJobStatusCompleted = {
-  started_at: string;
-  completed_at: string;
-  collector_name: string;
-  success: boolean;
+export type BenchmarkJobStatusFailed = {
+  state: "failed";
+  startedAt: string;
+  completedAt: string;
+  collectorName: string;
 };
 
-export type BenchmarkJobStatusString = "InProgress" | "Completed";
-export type BenchmarkJobStatusQueued = "Queued";
+export type BenchmarkJobStatusSuccess = {
+  state: "success";
+  startedAt: string;
+  completedAt: string;
+  collectorName: string;
+};
+
+export type BenchmarkJobStatus =
+  | BenchmarkJobStatusSuccess
+  | BenchmarkJobStatusFailed
+  | BenchmarkJobStatusInProgress
+  | BenchmarkJobStatusQueued;
 
 export type BenchmarkJob = {
-  id: number;
   target: string;
   backend: string;
-  request_tag: string;
-  benchmark_set: number;
-  created_at: string;
-  status:
-    | BenchmarkJobStatusQueued
-    | {
-        [K in BenchmarkJobStatusQueued]:
-          | BenchmarkJobStatusInProgress
-          | BenchmarkJobStatusCompleted;
-      };
-  deque_counter: number;
-};
-
-export function isQueuedBenchmarkJob(
-  status: unknown
-): status is BenchmarkJobStatusQueued {
-  return isString(status) && status === "Queued";
-}
-
-export function isInProgressBenchmarkJob(
-  status: unknown
-): status is {["InProgress"]: BenchmarkJobStatusInProgress} {
-  return isObject(status) && "InProgress" in status;
-}
-
-export function isCompletedBenchmarkJob(
-  status: unknown
-): status is {["Completed"]: BenchmarkJobStatusCompleted} {
-  return isObject(status) && "Completed" in status;
-}
+  profile: string;
+  requestTag: string;
+  benchmarkSet: number;
+  createdAt: string;
+  status: BenchmarkJobStatus;
+  dequeCounter: number;
+};
 
 export type CollectorConfig = {
   name: string;
   target: string;
-  benchmark_set: number;
-  is_active: boolean;
-  last_heartbeat_at: string;
-  date_added: string;
+  benchmarkSet: number;
+  isActive: boolean;
+  lastHeartbeatAt: string;
+  dateAdded: string;
+};
+
+export type StatusResponseInProgress = {
+  request: BenchmarkRequestInProgress;
+  jobs: BenchmarkJob[];
 };
 
 export type StatusResponse = {
-  completed: [BenchmarkRequestComplete, string[]][];
-  in_progress: [BenchmarkRequestInProgress, BenchmarkJob[]][];
-  collector_configs: CollectorConfig[];
+  completed: BenchmarkRequestComplete[];
+  inProgress: StatusResponseInProgress[];
+  collectorConfigs: CollectorConfig[];
   queue: BenchmarkRequest[];
 };

site/frontend/src/pages/status_new/page.vue

@@ -15,7 +15,7 @@ const loading = ref(true);
 const dataNew: Ref<StatusResponse | null> = ref(null);
 
 function statusClass(c: CollectorConfig): string {
-  return c.is_active ? "active" : "inactive";
+  return c.isActive ? "active" : "inactive";
 }
 
 loadStatusNew(loading);
@@ -34,27 +34,32 @@ loadStatusNew(loading);
 
       <div class="grid">
         <div
-          v-for="c in dataNew.collector_configs"
+          v-for="c in dataNew.collectorConfigs"
           :key="c.name + c.target"
           class="card"
         >
           <div>
             <div class="header">
-              <div class="name">{{ c.name }}:</div>
-              <div class="status" :class="statusClass(c)">
-                {{ c.is_active ? "Active" : "Inactive" }}
+              <div class="name">
+                <strong>{{ c.name }}</strong>
+              </div>
+              <div>
+                <strong>Status:</strong>
+                <span class="status" :class="statusClass(c)">
+                  {{ c.isActive ? "Active" : "Inactive" }}
+                </span>
               </div>
             </div>
             <div class="meta">
               <div><strong>Target:</strong> {{ c.target }}</div>
-              <div><strong>Benchmark Set:</strong> #{{ c.benchmark_set }}</div>
+              <div><strong>Benchmark Set:</strong> #{{ c.benchmarkSet }}</div>
               <div>
                 <strong>Last Heartbeat:</strong>
-                {{ c.last_heartbeat_at }}
+                {{ c.lastHeartbeatAt }}
               </div>
               <div>
                 <strong>Date Added:</strong>
-                {{ c.date_added }}
+                {{ c.dateAdded }}
               </div>
             </div>
           </div>
@@ -103,16 +108,13 @@ loadStatusNew(loading);
 }
 
 .header {
-  display: flex;
-  align-items: center;
 }
 
 .status {
-  padding: 2px 8px;
+  padding: 2px 8px 2px 0px;
   border-radius: 20px;
   font-size: 0.75rem;
   width: 50px;
-  font-weight: bold;
 }
 
 .status.active {

site/src/api.rs

@@ -466,6 +466,7 @@ pub mod status_new {
     }
 
     #[derive(Serialize, Debug)]
+    #[serde(rename_all = "camelCase")]
     pub struct Response {
         /// Completed requests alongside any errors
         pub completed: Vec<BenchmarkRequestUi>,