Add compile time check for workspace actions (#2685)

* Move workspace location check to action level

This allows for type-checking to guard against unintended behaviour.

* Improve type safety

Prevents specifying invalid workspace locations.

* Add comments

Also fixed formatiing.

* Fix type errors

* Restore runtime check

For defensive programming.

* Fix incorrect typing

* Alias type for workspace locations with tools

Author: RichDom2185

src/commons/sagas/WorkspaceSaga.ts

@@ -1302,7 +1302,9 @@ export function* evalCode(
   // the total number of steps and the breakpoints are updated in the Environment Visualiser slider.
   if (context.executionMethod === 'ec-evaluator' && needUpdateEnv) {
     yield put(actions.updateEnvStepsTotal(context.runtime.envStepsTotal, workspaceLocation));
-    yield put(actions.toggleUpdateEnv(false, workspaceLocation));
+    // `needUpdateEnv` implies `correctWorkspace`, which satisfies the type constraint.
+    // But TS can't infer that yet, so we need a typecast here.
+    yield put(actions.toggleUpdateEnv(false, workspaceLocation as any));
     yield put(actions.updateBreakpointSteps(context.runtime.breakpointSteps, workspaceLocation));
   }
   // Stop the home icon from flashing for an error if it is doing so since the evaluation is successful

src/commons/workspace/WorkspaceActions.ts

@@ -68,6 +68,7 @@ import {
   UPDATE_SUBMISSIONS_TABLE_FILTERS,
   UPDATE_WORKSPACE,
   WorkspaceLocation,
+  WorkspaceLocationsWithTools,
   WorkspaceState
 } from './WorkspaceTypes';
 
@@ -385,20 +386,24 @@ export const notifyProgramEvaluated = (
     workspaceLocation
   });
 
-export const toggleUsingSubst = (usingSubst: boolean, workspaceLocation: WorkspaceLocation) =>
-  action(TOGGLE_USING_SUBST, { usingSubst, workspaceLocation });
+export const toggleUsingSubst = (
+  usingSubst: boolean,
+  workspaceLocation: WorkspaceLocationsWithTools
+) => action(TOGGLE_USING_SUBST, { usingSubst, workspaceLocation });
 
 export const addHtmlConsoleError = (
   errorMsg: string,
   workspaceLocation: WorkspaceLocation,
   storyEnv?: string
 ) => action(ADD_HTML_CONSOLE_ERROR, { errorMsg, workspaceLocation, storyEnv });
 
-export const toggleUsingEnv = (usingEnv: boolean, workspaceLocation: WorkspaceLocation) =>
+export const toggleUsingEnv = (usingEnv: boolean, workspaceLocation: WorkspaceLocationsWithTools) =>
   action(TOGGLE_USING_ENV, { usingEnv, workspaceLocation });
 
-export const toggleUpdateEnv = (updateEnv: boolean, workspaceLocation: WorkspaceLocation) =>
-  action(TOGGLE_UPDATE_ENV, { updateEnv, workspaceLocation });
+export const toggleUpdateEnv = (
+  updateEnv: boolean,
+  workspaceLocation: WorkspaceLocationsWithTools
+) => action(TOGGLE_UPDATE_ENV, { updateEnv, workspaceLocation });
 
 export const updateEnvSteps = (steps: number, workspaceLocation: WorkspaceLocation) =>
   action(UPDATE_ENVSTEPS, { steps, workspaceLocation });

src/commons/workspace/WorkspaceReducer.ts

@@ -571,7 +571,8 @@ export const WorkspaceReducer: Reducer<WorkspaceManagerState> = (
           isEditorAutorun: !state[workspaceLocation].isEditorAutorun
         }
       };
-    case TOGGLE_USING_SUBST:
+    case TOGGLE_USING_SUBST: {
+      const { workspaceLocation } = action.payload;
       if (workspaceLocation === 'playground' || workspaceLocation === 'sicp') {
         return {
           ...state,
@@ -583,7 +584,9 @@ export const WorkspaceReducer: Reducer<WorkspaceManagerState> = (
       } else {
         return state;
       }
-    case TOGGLE_USING_ENV:
+    }
+    case TOGGLE_USING_ENV: {
+      const { workspaceLocation } = action.payload;
       if (workspaceLocation === 'playground' || workspaceLocation === 'sicp') {
         return {
           ...state,
@@ -595,7 +598,9 @@ export const WorkspaceReducer: Reducer<WorkspaceManagerState> = (
       } else {
         return state;
       }
-    case TOGGLE_UPDATE_ENV:
+    }
+    case TOGGLE_UPDATE_ENV: {
+      const { workspaceLocation } = action.payload;
       if (workspaceLocation === 'playground' || workspaceLocation === 'sicp') {
         return {
           ...state,
@@ -607,6 +612,7 @@ export const WorkspaceReducer: Reducer<WorkspaceManagerState> = (
       } else {
         return state;
       }
+    }
     case UPDATE_SUBMISSIONS_TABLE_FILTERS:
       return {
         ...state,

src/commons/workspace/WorkspaceTypes.ts

@@ -63,6 +63,7 @@ export const UPDATE_BREAKPOINTSTEPS = 'UPDATE_BREAKPOINTSTEPS';
 export const CHANGE_SUBLANGUAGE = 'CHANGE_SUBLANGUAGE';
 
 export type WorkspaceLocation = keyof WorkspaceManagerState;
+export type WorkspaceLocationsWithTools = Extract<WorkspaceLocation, 'playground' | 'sicp'>;
 
 type AssessmentWorkspaceAttr = {
   readonly currentAssessment?: number;