Move workspace saga helper functions to its own files (#2870)

* Remove global variable from workspace saga

* Update tests

* Move workspace helper functions to it own files

* Undo changes done to the tests

* Fix linting errors

* Fix indent

---------

Co-authored-by: Richard Dominick <34370238+RichDom2185@users.noreply.github.com>

Author: JoelChanZhiYang

src/commons/sagas/WorkspaceSaga.ts

@@ -0,0 +1,52 @@
+import { 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 { evalCode } from './evalCode';
+
+export function* blockExtraMethods(
+  elevatedContext: Context,
+  context: Context,
+  execTime: number,
+  workspaceLocation: WorkspaceLocation,
+  unblockKey?: string
+) {
+  // Extract additional methods available in the elevated context relative to the context
+  const toBeBlocked = getDifferenceInMethods(elevatedContext, context);
+  if (unblockKey) {
+    const storeValues = getStoreExtraMethodsString(toBeBlocked, unblockKey);
+    const storeValuesFilePath = '/storeValues.js';
+    const storeValuesFiles = {
+      [storeValuesFilePath]: storeValues
+    };
+    yield call(
+      evalCode,
+      storeValuesFiles,
+      storeValuesFilePath,
+      elevatedContext,
+      execTime,
+      workspaceLocation,
+      EVAL_SILENT
+    );
+  }
+
+  const nullifier = getBlockExtraMethodsString(toBeBlocked);
+  const nullifierFilePath = '/nullifier.js';
+  const nullifierFiles = {
+    [nullifierFilePath]: nullifier
+  };
+  yield call(
+    evalCode,
+    nullifierFiles,
+    nullifierFilePath,
+    elevatedContext,
+    execTime,
+    workspaceLocation,
+    EVAL_SILENT
+  );
+}

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

@@ -0,0 +1,45 @@
+import { Context } from 'js-slang';
+import { defineSymbol } from 'js-slang/dist/createContext';
+import { Variant } from 'js-slang/dist/types';
+import { put, select, take } from 'redux-saga/effects';
+
+import { OverallState } from '../../../application/ApplicationTypes';
+import { ExternalLibraryName } from '../../../application/types/ExternalTypes';
+import { actions } from '../../../utils/ActionsHelper';
+import { END_CLEAR_CONTEXT, WorkspaceLocation } from '../../../workspace/WorkspaceTypes';
+
+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 library = {
+    chapter,
+    variant,
+    external: {
+      name: externalLibraryName,
+      symbols
+    },
+    globals
+  };
+
+  // Clear the context, with the same chapter and externalSymbols as before.
+  yield put(actions.beginClearContext(workspaceLocation, library, false));
+  // Wait for the clearing to be done.
+  yield take(END_CLEAR_CONTEXT);
+
+  const context: Context = yield select(
+    (state: OverallState) => state.workspaces[workspaceLocation].context
+  );
+  defineSymbol(context, '__PROGRAM__', entrypointCode);
+}

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

@@ -0,0 +1,17 @@
+import { put, StrictEffect } from 'redux-saga/effects';
+
+import { actions } from '../../../utils/ActionsHelper';
+import DisplayBufferService from '../../../utils/DisplayBufferService';
+import { WorkspaceLocation } from '../../../workspace/WorkspaceTypes';
+
+export function* dumpDisplayBuffer(
+  workspaceLocation: WorkspaceLocation,
+  isStoriesBlock: boolean = false,
+  storyEnv?: string
+): Generator<StrictEffect, void, any> {
+  if (!isStoriesBlock) {
+    yield put(actions.handleConsoleLog(workspaceLocation, ...DisplayBufferService.dump()));
+  } else {
+    yield put(actions.handleStoriesConsoleLog(storyEnv!, ...DisplayBufferService.dump()));
+  }
+}