refactor(playground): Add and use type guards for playground input type

Arize-ai · Oct 15, 2024 · e30cbd7 · e30cbd7
1 parent 61addf3
commit e30cbd7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/app/src/store/playground/playgroundStore.tsx b/app/src/store/playground/playgroundStore.tsx
@@ -9,6 +9,7 @@ import { assertUnreachable } from "@phoenix/typeUtils";
 import {
   GenAIOperationType,
   InitialPlaygroundState,
+  isManualInput,
   PlaygroundChatTemplate,
   PlaygroundInputMode,
   PlaygroundInstance,
@@ -294,7 +295,7 @@ export const createPlaygroundStore = (
     },
     setVariableValue: (key: string, value: string) => {
       const input = get().input;
-      if ("variablesValueCache" in input) {
+      if (isManualInput(input)) {
         set({
           input: {
             ...input,
@@ -316,7 +317,7 @@ export type PlaygroundStore = ReturnType<typeof createPlaygroundStore>;
  * @returns the variable keys
  */
 export const selectInputVariableKeys = (state: PlaygroundState) => {
-  if ("variableKeys" in state.input) {
+  if (isManualInput(state.input)) {
     return state.input.variableKeys;
   }
   return [];
@@ -328,7 +329,7 @@ export const selectInputVariableKeys = (state: PlaygroundState) => {
  * @returns the derived input variables
  */
 export const selectDerivedInputVariables = (state: PlaygroundState) => {
-  if ("variableKeys" in state.input) {
+  if (isManualInput(state.input)) {
     const input = state.input;
     const variableKeys = input.variableKeys;
     const variablesValueCache = input.variablesValueCache;

diff --git a/app/src/store/playground/types.ts b/app/src/store/playground/types.ts
@@ -48,7 +48,7 @@ type DatasetInput = {
 };
 
 type ManualInput = {
-  variablesValueCache: Record<string, string>;
+  variablesValueCache: Record<string, string | undefined>;
   variableKeys: string[];
 };
 
@@ -183,3 +183,19 @@ export interface PlaygroundState extends PlaygroundProps {
 
   setVariableValue: (key: string, value: string) => void;
 }
+
+/**
+ * Check if the input is manual
+ */
+export const isManualInput = (input: PlaygroundInput): input is ManualInput => {
+  return "variablesValueCache" in input && "variableKeys" in input;
+};
+
+/**
+ * Check if the input is a dataset
+ */
+export const isDatasetInput = (
+  input: PlaygroundInput
+): input is DatasetInput => {
+  return "datasetId" in input;
+};