From 3d1b1f6f48aed6c41996fd25d26325cae6bd6ee7 Mon Sep 17 00:00:00 2001
From: Mishig Davaadorj <dmishig@gmail.com>
Date: Mon, 30 Oct 2023 18:19:46 +0100
Subject: [PATCH] [Widgets refactor] typing use `enum`s

---
 .../shared/WidgetInfo/WidgetInfo.svelte       | 25 +++++++++----------
 .../InferenceWidget/shared/helpers.ts         |  3 ++-
 .../InferenceWidget/shared/types.ts           | 12 +++++++--
 3 files changed, 24 insertions(+), 16 deletions(-)

diff --git a/js/src/lib/components/InferenceWidget/shared/WidgetInfo/WidgetInfo.svelte b/js/src/lib/components/InferenceWidget/shared/WidgetInfo/WidgetInfo.svelte
index 0cb49b5825..fde9999166 100644
--- a/js/src/lib/components/InferenceWidget/shared/WidgetInfo/WidgetInfo.svelte
+++ b/js/src/lib/components/InferenceWidget/shared/WidgetInfo/WidgetInfo.svelte
@@ -1,6 +1,5 @@
 <script lang="ts">
-	import type { WidgetProps, ModelLoadInfo, LoadState } from "../types";
-
+	import { type WidgetProps, type ModelLoadInfo, LoadState, ComputeType } from "../types";
 	import IconAzureML from "../../../Icons/IconAzureML.svelte";
 
 	export let model: WidgetProps["model"];
@@ -9,19 +8,19 @@
 	export let modelLoadInfo: ModelLoadInfo | undefined = undefined;
 
 	const state = {
-		Loadable: "This model can be loaded on the Inference API on-demand.",
-		Loaded: "This model is currently loaded and running on the Inference API.",
-		TooBig:
+		[LoadState.Loadable]: "This model can be loaded on the Inference API on-demand.",
+		[LoadState.Loaded]: "This model is currently loaded and running on the Inference API.",
+		[LoadState.TooBig]:
 			"Model is too large to load onto the free Inference API. To try the model, launch it on Inference Endpoints instead.",
-		error: "⚠️ This model could not be loaded by the inference API. ⚠️",
+		[LoadState.Error]: "⚠️ This model could not be loaded by the inference API. ⚠️",
 	} as const;
 
 	const azureState = {
-		Loadable: "This model can be loaded loaded on AzureML Managed Endpoint",
-		Loaded: "This model is loaded and running on AzureML Managed Endpoint",
-		TooBig:
+		[LoadState.Loadable]: "This model can be loaded loaded on AzureML Managed Endpoint",
+		[LoadState.Loaded]: "This model is loaded and running on AzureML Managed Endpoint",
+		[LoadState.TooBig]:
 			"Model is too large to load onto the free Inference API. To try the model, launch it on Inference Endpoints instead.",
-		error: "⚠️ This model could not be loaded.",
+		[LoadState.Error]: "⚠️ This model could not be loaded.",
 	} as const;
 
 	function getStatusReport(
@@ -32,15 +31,15 @@
 		if (!modelLoadInfo) {
 			return "Model state unknown";
 		}
-		if (modelLoadInfo.compute_type === "cpu" && modelLoadInfo.state === "Loaded" && !isAzure) {
+		if (modelLoadInfo.compute_type === ComputeType.CPU && modelLoadInfo.state === LoadState.Loaded && !isAzure) {
 			return `The model is loaded and running on <a class="hover:underline" href="https://huggingface.co/intel" target="_blank">Intel Xeon 3rd Gen Scalable CPU</a>`;
 		}
 		return statuses[modelLoadInfo.state];
 	}
 
 	function getComputeTypeMsg(): string {
-		const computeType = modelLoadInfo?.compute_type ?? "cpu";
-		if (computeType === "cpu") {
+		const computeType = modelLoadInfo?.compute_type ?? ComputeType.CPU;
+		if (computeType === ComputeType.CPU) {
 			return "Intel Xeon 3rd Gen Scalable cpu";
 		}
 		return computeType;
diff --git a/js/src/lib/components/InferenceWidget/shared/helpers.ts b/js/src/lib/components/InferenceWidget/shared/helpers.ts
index f89c165be2..72f0842cb6 100644
--- a/js/src/lib/components/InferenceWidget/shared/helpers.ts
+++ b/js/src/lib/components/InferenceWidget/shared/helpers.ts
@@ -2,6 +2,7 @@ import type { ModelData } from "../../../interfaces/Types";
 import { randomItem, parseJSON } from "../../../utils/ViewUtils";
 import type { WidgetExample } from "./WidgetExample";
 import type { ModelLoadInfo, TableData } from "./types";
+import { LoadState } from "./types";
 
 type KeysOfUnion<T> = T extends any ? keyof T : never;
 export type QueryParam = KeysOfUnion<WidgetExample>;
@@ -186,7 +187,7 @@ export async function getModelLoadInfo(
 		return { compute_type, state };
 	} else {
 		console.warn(response.status, output.error);
-		return { state: "error" };
+		return { state: LoadState.Error };
 	}
 }
 
diff --git a/js/src/lib/components/InferenceWidget/shared/types.ts b/js/src/lib/components/InferenceWidget/shared/types.ts
index b08003e1e6..37750d5cd4 100644
--- a/js/src/lib/components/InferenceWidget/shared/types.ts
+++ b/js/src/lib/components/InferenceWidget/shared/types.ts
@@ -24,9 +24,17 @@ export interface ExampleRunOpts {
 	inferenceOpts?: InferenceRunOpts;
 }
 
-export type LoadState = "Loadable" | "Loaded" | "TooBig" | "error";
+export enum LoadState {
+	Loadable = "Loadable",
+	Loaded = "Loaded",
+	TooBig = "TooBig",
+	Error = "error",
+}
 
-export type ComputeType = "cpu" | "gpu";
+export enum ComputeType {
+	CPU = "cpu",
+	GPU = "gpu",
+}
 
 export interface ModelLoadInfo {
 	state:         LoadState;