Minor refactoring

Author: leeyi45

src/commons/application/ApplicationTypes.ts

@@ -1,4 +1,4 @@
-import { Chapter, Language, type SourceError, Variant } from 'js-slang/dist/types';
+import { Chapter, Language, type SourceError, type Value, Variant } from 'js-slang/dist/types';
 
 import type { AchievementState } from '../../features/achievement/AchievementTypes';
 import type { DashboardState } from '../../features/dashboard/DashboardTypes';
@@ -74,7 +74,7 @@ export type CodeOutput = {
  */
 export type ResultOutput = {
   type: 'result';
-  value: any;
+  value: Value;
   consoleLogs: string[];
   runtime?: number;
   isProgram?: boolean;

src/commons/sagas/PlaygroundSaga.ts

@@ -1,5 +1,5 @@
 import { FSModule } from 'browserfs/dist/node/core/FS';
-import { Chapter, Variant } from 'js-slang/dist/types';
+import { Chapter } from 'js-slang/dist/types';
 import { compressToEncodedURIComponent } from 'lz-string';
 import qs from 'query-string';
 import { SagaIterator } from 'redux-saga';
@@ -8,16 +8,19 @@ import CseMachine from 'src/features/cseMachine/CseMachine';
 import { CseMachine as JavaCseMachine } from 'src/features/cseMachine/java/CseMachine';
 
 import PlaygroundActions from '../../features/playground/PlaygroundActions';
-import { isSchemeLanguage, isSourceLanguage, OverallState } from '../application/ApplicationTypes';
-import { ExternalLibraryName } from '../application/types/ExternalTypes';
+import {
+  isSchemeLanguage,
+  isSourceLanguage,
+  type OverallState
+} from '../application/ApplicationTypes';
 import { retrieveFilesInWorkspaceAsRecord } from '../fileSystem/utils';
 import { visitSideContent } from '../sideContent/SideContentActions';
 import { SideContentType } from '../sideContent/SideContentTypes';
 import Constants from '../utils/Constants';
 import { showSuccessMessage, showWarningMessage } from '../utils/notifications/NotificationsHelper';
 import WorkspaceActions from '../workspace/WorkspaceActions';
-import { EditorTabState, PlaygroundWorkspaceState } from '../workspace/WorkspaceTypes';
-import { safeTakeEvery as takeEvery } from './SafeEffects';
+import type { PlaygroundWorkspaceState } from '../workspace/WorkspaceTypes';
+import { safeTakeEvery as takeEvery, selectWorkspace } from './SafeEffects';
 
 export default function* PlaygroundSaga(): SagaIterator {
   yield takeEvery(PlaygroundActions.generateLzString.type, updateQueryString);
@@ -127,9 +130,6 @@ export default function* PlaygroundSaga(): SagaIterator {
 }
 
 function* updateQueryString() {
-  const isFolderModeEnabled: boolean = yield select(
-    (state: OverallState) => state.workspaces.playground.isFolderModeEnabled
-  );
   const fileSystem: FSModule = yield select(
     (state: OverallState) => state.fileSystem.inBrowserFileSystem
   );
@@ -138,27 +138,20 @@ function* updateQueryString() {
     'playground',
     fileSystem
   );
-  const editorTabs: EditorTabState[] = yield select(
-    (state: OverallState) => state.workspaces.playground.editorTabs
-  );
+
+  const {
+    activeEditorTabIndex,
+    context: { chapter, variant },
+    editorTabs,
+    execTime,
+    externalLibrary: external,
+    isFolderModeEnabled
+  } = yield* selectWorkspace('playground');
+
   const editorTabFilePaths = editorTabs
-    .map((editorTab: EditorTabState) => editorTab.filePath)
+    .map(editorTab => editorTab.filePath)
     .filter((filePath): filePath is string => filePath !== undefined);
-  const activeEditorTabIndex: number | null = yield select(
-    (state: OverallState) => state.workspaces.playground.activeEditorTabIndex
-  );
-  const chapter: Chapter = yield select(
-    (state: OverallState) => state.workspaces.playground.context.chapter
-  );
-  const variant: Variant = yield select(
-    (state: OverallState) => state.workspaces.playground.context.variant
-  );
-  const external: ExternalLibraryName = yield select(
-    (state: OverallState) => state.workspaces.playground.externalLibrary
-  );
-  const execTime: number = yield select(
-    (state: OverallState) => state.workspaces.playground.execTime
-  );
+
   const newQueryString = qs.stringify({
     isFolder: isFolderModeEnabled,
     files: compressToEncodedURIComponent(qs.stringify(files)),

src/commons/sagas/SafeEffects.ts

@@ -102,11 +102,15 @@ export function safeTakeLeading<P extends ActionPattern, Fn extends (...args: an
 }
 
 export function* selectWorkspace<T extends WorkspaceLocation>(workspaceLocation: T) {
-  const workspace: WorkspaceManagerState[T] = yield select((state: OverallState) => state.workspaces[workspaceLocation])
-  return workspace
+  const workspace: WorkspaceManagerState[T] = yield select(
+    (state: OverallState) => state.workspaces[workspaceLocation]
+  );
+  return workspace;
 }
 
 export function* selectStoryEnv(storyEnv: string) {
-  const workspace: StoriesEnvState = yield select((state: OverallState) => state.stories.envs[storyEnv])
-  return workspace
+  const workspace: StoriesEnvState = yield select(
+    (state: OverallState) => state.stories.envs[storyEnv]
+  );
+  return workspace;
 }

src/commons/sagas/StoriesSaga.ts

@@ -12,10 +12,10 @@ import {
   putStoriesUserRole,
   updateStory
 } from 'src/features/stories/storiesComponents/BackendAccess';
-import { StoryData, StoryListView, StoryView } from 'src/features/stories/StoriesTypes';
+import type { StoryData, StoryListView, StoryView } from 'src/features/stories/StoriesTypes';
 
 import SessionActions from '../application/actions/SessionActions';
-import { OverallState, StoriesRole } from '../application/ApplicationTypes';
+import { type OverallState, StoriesRole } from '../application/ApplicationTypes';
 import { Tokens } from '../application/types/SessionTypes';
 import { combineSagaHandlers } from '../redux/utils';
 import { resetSideContent } from '../sideContent/SideContentActions';
@@ -143,8 +143,8 @@ const StoriesSaga = combineSagaHandlers(sagaActions, {
       codeFilePath,
       context,
       execTime,
-      'stories',
       action.type,
+      'stories',
       env
     );
   },

src/commons/sagas/WorkspaceSaga/helpers/blockExtraMethods.ts

@@ -1,12 +1,12 @@
-import { Context } from 'js-slang';
+import type { Context } from 'js-slang';
 import { call } from 'redux-saga/effects';
 
 import {
   getBlockExtraMethodsString,
   getDifferenceInMethods,
   getStoreExtraMethodsString
 } from '../../../utils/JsSlangHelper';
-import { EVAL_SILENT, WorkspaceLocation } from '../../../workspace/WorkspaceTypes';
+import { EVAL_SILENT, type WorkspaceLocation } from '../../../workspace/WorkspaceTypes';
 import { evalCodeSaga } from './evalCode';
 
 export function* blockExtraMethods(
@@ -30,8 +30,8 @@ export function* blockExtraMethods(
       storeValuesFilePath,
       elevatedContext,
       execTime,
-      workspaceLocation,
-      EVAL_SILENT
+      EVAL_SILENT,
+      workspaceLocation
     );
   }
 
@@ -46,7 +46,7 @@ export function* blockExtraMethods(
     nullifierFilePath,
     elevatedContext,
     execTime,
-    workspaceLocation,
-    EVAL_SILENT
+    EVAL_SILENT,
+    workspaceLocation
   );
 }

src/commons/sagas/WorkspaceSaga/helpers/clearContext.ts

@@ -1,28 +1,19 @@
 import type { Context } from 'js-slang';
 import { defineSymbol } from 'js-slang/dist/createContext';
-import type { Variant } from 'js-slang/dist/types';
 import { put, select, take } from 'redux-saga/effects';
 import WorkspaceActions from 'src/commons/workspace/WorkspaceActions';
 
 import type { OverallState } from '../../../application/ApplicationTypes';
-import { ExternalLibraryName } from '../../../application/types/ExternalTypes';
 import { actions } from '../../../utils/ActionsHelper';
 import type { WorkspaceLocation } from '../../../workspace/WorkspaceTypes';
+import { selectWorkspace } from '../../SafeEffects';
 
 export function* clearContext(workspaceLocation: WorkspaceLocation, entrypointCode: string) {
-  const [chapter, symbols, externalLibraryName, globals, variant]: [
-    number,
-    string[],
-    ExternalLibraryName,
-    Array<[string, any]>,
-    Variant
-  ] = yield select((state: OverallState) => [
-    state.workspaces[workspaceLocation].context.chapter,
-    state.workspaces[workspaceLocation].context.externalSymbols,
-    state.workspaces[workspaceLocation].externalLibrary,
-    state.workspaces[workspaceLocation].globals,
-    state.workspaces[workspaceLocation].context.variant
-  ]);
+  const {
+    context: { chapter, externalSymbols: symbols, variant },
+    externalLibrary: externalLibraryName,
+    globals
+  } = yield* selectWorkspace(workspaceLocation);
 
   const library = {
     chapter,