Add debug lib

frontend/player/sagas.ts

@@ -370,8 +370,7 @@ function* computeInstants(replayApi: ReplayApi, replayContext: ReplayContext) {
 
         // Get Redux state and context state and store them
         const instantState = createDraft(replayStore.getState());
-        const context = quickAlgoLibraries.getContext(null, 'replay');
-        instantState.task.state = getCurrentImmerState(context.getInnerState());
+        instantState.task.state = quickAlgoLibraries.getLibrariesInnerState('replay');
         instant.state = finishDraft(instantState);
 
         Object.freeze(instant);

frontend/stepper/api.ts

@@ -28,6 +28,7 @@ import {QuickAlgoLibrary} from '../task/libs/quickalgo_library';
 import {CodecastPlatform} from './platforms';
 import {LibraryTestResult} from '../task/libs/library_test_result';
 import {createQuickAlgoLibraryExecutor} from './quickalgo_executor';
+import {appSelect} from '../hooks';
 
 export interface QuickalgoLibraryCall {
     module: string,
@@ -85,7 +86,7 @@ export interface StepperApi {
     addSaga?: Function,
     onEffect?: Function,
     addBuiltin?: Function,
-    buildState?: (state: AppStoreReplay, environment: string) => Generator<any, StepperState>,
+    buildState?: () => Generator<any, StepperState>,
     rootStepperSaga?: any,
     executeEffects?: Function,
 }
@@ -136,7 +137,9 @@ export default function(bundle: Bundle) {
 
 
     /* Build a stepper state from the given init data. */
-    function* buildState(state: AppStoreReplay, environment: string): Generator<any, StepperState> {
+    function* buildState(): Generator<any, StepperState> {
+        const state = yield* appSelect();
+        const environment = state.environment;
         const {platform} = state.options;
 
         log.getLogger('stepper').debug('do build state', state, environment);

frontend/stepper/index.ts

@@ -65,7 +65,12 @@ import {TermBuffer} from "./io/terminal";
 import {delay} from "../player/sagas";
 import {Bundle} from "../linker";
 import {App, Codecast} from "../index";
-import {mainQuickAlgoLogger, quickAlgoLibraries, QuickAlgoLibrariesActionType} from "../task/libs/quickalgo_libraries";
+import {
+    mainQuickAlgoLogger,
+    quickAlgoLibraries,
+    QuickAlgoLibrariesActionType,
+    quickAlgoLibraryResetAndReloadStateSaga
+} from "../task/libs/quickalgo_libraries";
 import {selectCurrentTestData, taskResetDone, updateCurrentTestId} from "../task/task_slice";
 import {getCurrentImmerState} from "../task/utils";
 import PythonRunner from "./python/python_runner";
@@ -161,7 +166,6 @@ const initialStateStepperState = {
         stackSize: 4096
     },
     isFinished: false, // Only used for python
-    contextState: {} as any,
     currentBlockId: null, // Only used for Blockly
 };
 
@@ -574,7 +578,6 @@ function stepperProgressReducer(state: AppStoreReplay, {payload: {stepperContext
     /**
      * TODO: stepperState comes from an action so it's not an immer draft.
      */
-    // log.getLogger('stepper').debug('previous state', stepperContext.state.contextState, 'and progress', progress);
     stepperContext.state = {...stepperContext.state};
 
     if (false !== progress) {
@@ -588,11 +591,7 @@ function stepperProgressReducer(state: AppStoreReplay, {payload: {stepperContext
         enrichStepperState(stepperContext.state, 'Stepper.Progress', stepperContext);
     }
 
-    const context = quickAlgoLibraries.getContext(null, state.environment);
-    if (context) {
-        state.task.state = getCurrentImmerState(context.getInnerState());
-    }
-
+    state.task.state = quickAlgoLibraries.getLibrariesInnerState(state.environment);
     state.stepper.currentStepperState = stepperContext.state;
     if (state.compile.status === CompileStatus.Error) {
         state.stepper.currentStepperState.isFinished = false;
@@ -740,15 +739,10 @@ function* compileSucceededSaga(app: App) {
         Codecast.runner = yield* call(createRunnerSaga);
 
         /* Build the stepper state. This automatically runs into user source code. */
-        let state = yield* appSelect();
-
-        let stepperState = yield* call(app.stepperApi.buildState, state, state.environment);
-        log.getLogger('stepper').debug('[stepper init] current state', state.task.state, 'context state', stepperState.contextState);
-        const newState = yield* appSelect();
-        log.getLogger('stepper').debug('[stepper init] new state', newState.task.state);
-
+        let stepperState = yield* call(app.stepperApi.buildState);
+        const state = yield* appSelect();
+        log.getLogger('stepper').debug('[stepper init] new state', state.task.state);
         // buildState may have triggered an error.
-        state = yield* appSelect();
         if (state.compile.status !== 'error') {
             /* Enable the stepper */
             yield* put({type: ActionTypes.StepperEnabled});
@@ -856,8 +850,6 @@ function* stepperInteractSaga(app: App, {payload: {stepperContext, arg}, meta: {
     let state = yield* appSelect();
 
     if (!state.stepper.synchronizingAnalysis) {
-        // log.getLogger('stepper').debug('current stepper state', stepperContext.state.contextState);
-
         /* Emit a progress action so that an up-to-date state gets displayed. */
 
         yield* put({type: ActionTypes.StepperProgress, payload: {stepperContext, progress: arg.progress}});
@@ -871,8 +863,6 @@ function* stepperInteractSaga(app: App, {payload: {stepperContext, arg}, meta: {
         completed = yield* call(saga, stepperContext);
     }
 
-    // log.getLogger('stepper').debug('current stepper state2', stepperContext.state.contextState);
-
     if (state.stepper.synchronizingAnalysis) {
         yield* call(resolve, completed);
         return;
@@ -883,8 +873,6 @@ function* stepperInteractSaga(app: App, {payload: {stepperContext, arg}, meta: {
     state = yield* appSelect();
     stepperContext.state = {...getCurrentStepperState(state)};
 
-    // log.getLogger('stepper').debug('current stepper state3', stepperContext.state.contextState);
-
     /* Continue stepper execution, passing the saga's return value as the
        result of yielding the interact effect. */
     yield* call(resolve, completed);
@@ -1071,9 +1059,8 @@ function* stepperRunFromBeginningIfNecessary(stepperContext: StepperContext) {
             taskContext.display = false;
         }
         stepperContext.taskDisplayNoneStatus = 'running';
-        taskContext.resetAndReloadState(selectCurrentTestData(state), state);
-        stepperContext.state.contextState = getCurrentImmerState(taskContext.getInnerState());
-        log.getLogger('stepper').debug('current task state', taskContext.getInnerState());
+
+        yield* call(quickAlgoLibraryResetAndReloadStateSaga);
 
         if (!Codecast.runner) {
             Codecast.runner = yield* call(createRunnerSaga);

frontend/stepper/quickalgo_executor.ts

@@ -53,10 +53,6 @@ class QuickalgoExecutor {
             context.infos.actionDelay = context.plannedNewDelay;
         }
 
-        if (this.stepperContext.state) {
-            log.getLogger('quickalgo_executor').debug('[quickalgo_executor] stepper context before', this.stepperContext.state.contextState);
-        }
-
         if (this.stepperContext.quickAlgoCallsLogger) {
             const quickAlgoLibraryCall: QuickalgoLibraryCall = {module, action, args};
             this.stepperContext.quickAlgoCallsLogger(quickAlgoLibraryCall);
@@ -119,14 +115,6 @@ class QuickalgoExecutor {
         const newState = getCurrentImmerState(context.getInnerState());
         log.getLogger('quickalgo_executor').debug('[quickalgo_executor] NEW LIBRARY STATE', newState);
 
-        if (this.stepperContext.state) {
-            this.stepperContext.state = {
-                ...this.stepperContext.state,
-                contextState: newState,
-            };
-            log.getLogger('quickalgo_executor').debug('[quickalgo_executor] stepper context after', this.stepperContext.state.contextState);
-        }
-
         if (context.callsToExecute.length) {
             const newCall = context.callsToExecute.pop();
             libraryCallResult = await this.execute(module, newCall.action, newCall.args, newCall.callback);

frontend/stepper/replay.ts

@@ -5,7 +5,11 @@ import {ActionTypes as PlayerActionTypes} from '../player/actionTypes';
 import {ActionTypes, stepperRunBackgroundFinished} from './actionTypes';
 import {PlayerInstant} from '../player';
 import log from 'loglevel';
-import {mainQuickAlgoLogger, quickAlgoLibraries} from '../task/libs/quickalgo_libraries';
+import {
+    mainQuickAlgoLogger,
+    quickAlgoLibraries,
+    quickAlgoLibraryResetAndReloadStateSaga
+} from '../task/libs/quickalgo_libraries';
 import {selectCurrentTestData} from '../task/task_slice';
 import {getCurrentStepperState, isStepperInterrupting} from './selectors';
 import {App, Codecast} from '../index';
@@ -43,11 +47,7 @@ export function addStepperRecordAndReplayHooks(app: App) {
         yield* put({type: ActionTypes.StepperExit});
         replayContext.addSaga(function* () {
             log.getLogger('stepper').debug('make reset saga');
-            const context = quickAlgoLibraries.getContext(null, 'main');
-            if (context) {
-                const state = yield* appSelect();
-                context.resetAndReloadState(selectCurrentTestData(state), state);
-            }
+            yield* call(quickAlgoLibraryResetAndReloadStateSaga);
         })
     });
 
@@ -188,8 +188,7 @@ export function addStepperRecordAndReplayHooks(app: App) {
     });
 
     replayApi.on('stepper.restart', function* () {
-        const state = yield* appSelect();
-        const stepperState = yield* call(app.stepperApi.buildState, state, state.environment);
+        const stepperState = yield* call(app.stepperApi.buildState);
 
         yield* put({type: ActionTypes.StepperEnabled});
         yield* put({type: ActionTypes.StepperRestart, payload: {stepperState}});

frontend/submission/submission.ts

@@ -15,7 +15,6 @@ import {updateCurrentTestId} from '../task/task_slice';
 import {stepperClearError, stepperDisplayError} from '../stepper/actionTypes';
 import {
     quickAlgoLibraries,
-    QuickAlgoLibrariesActionType,
     quickAlgoLibraryResetAndReloadStateSaga
 } from '../task/libs/quickalgo_libraries';
 import {CodecastPlatform} from '../stepper/platforms';
@@ -172,7 +171,7 @@ export default function (bundle: Bundle) {
         yield* takeEvery(submissionChangeCurrentSubmissionId, function* ({payload}) {
             const submissionId = yield* appSelect(state => state.submission.currentSubmissionId);
             if (null === submissionId) {
-                yield* call(quickAlgoLibraryResetAndReloadStateSaga, app);
+                yield* call(quickAlgoLibraryResetAndReloadStateSaga);
                 yield* put(stepperClearError());
             }
         });

frontend/task/index.ts

@@ -432,12 +432,9 @@ function* handleLibrariesEventListenerSaga(app: App) {
 
             yield stepperContext.quickAlgoCallsExecutor(module, method, args, () => {
                 log.getLogger('task').debug('exec done, update task state');
-                const context = quickAlgoLibraries.getContext(null, state.environment);
-                if (context) {
-                    const contextState = getCurrentImmerState(context.getInnerState());
-                    log.getLogger('task').debug('get new state', contextState);
-                    app.dispatch(taskUpdateState(contextState));
-                }
+                const contextState = quickAlgoLibraries.getLibrariesInnerState(state.environment);
+                log.getLogger('task').debug('get new state', contextState);
+                app.dispatch(taskUpdateState(contextState));
             });
         });
     }
@@ -541,7 +538,7 @@ function* taskUpdateCurrentTestIdSaga(app: App, {payload}) {
 
     // Save context state for the test we have just left
     if (context && !payload.recreateContext && null !== state.task.previousTestId) {
-        const currentState = getCurrentImmerState(context.getInnerState());
+        const currentState = quickAlgoLibraries.getLibrariesInnerState(state.environment);
         yield* put(updateTestContextState({testId: state.task.previousTestId, contextState: currentState}));
     }
 
@@ -563,16 +560,8 @@ function* taskUpdateCurrentTestIdSaga(app: App, {payload}) {
 
         if (!payload.withoutContextState) {
             const contextState = state.task.taskTests[state.task.currentTestId]?.contextState;
-            if (null !== contextState && undefined !== contextState) {
-                const currentTest = selectCurrentTestData(state);
-                log.getLogger('task').debug('[taskUpdateCurrentTestIdSaga] reload current test', currentTest, contextState);
-                context.resetAndReloadState(currentTest, state, contextState);
-            } else {
-                const currentTest = selectCurrentTestData(state);
-                log.getLogger('task').debug('[taskUpdateCurrentTestIdSaga] reload current test without state', currentTest);
-                context.resetAndReloadState(currentTest, state);
-            }
-
+            yield* call(quickAlgoLibraryResetAndReloadStateSaga, contextState);
+            log.getLogger('task').debug('[taskUpdateCurrentTestIdSaga] reload current test', contextState);
             yield* put({type: QuickAlgoLibrariesActionType.QuickAlgoLibrariesRedrawDisplay});
         }
     }
@@ -822,7 +811,7 @@ export default function (bundle: Bundle) {
                 Codecast.runner.stop();
             }
             yield* call(clearSourceHighlightSaga);
-            yield* call(quickAlgoLibraryResetAndReloadStateSaga, app);
+            yield* call(quickAlgoLibraryResetAndReloadStateSaga);
             log.getLogger('task').debug('put task reset done to true');
             yield* put(taskResetDone(true));
         });
@@ -925,11 +914,7 @@ export default function (bundle: Bundle) {
         app.recordApi.onStart(function* (init) {
             const state = yield* appSelect();
             init.testId = state.task.currentTestId;
-            const context = quickAlgoLibraries.getContext(null, 'main');
-            if (context) {
-                const currentState = getCurrentImmerState(context.getInnerState());
-                init.contextState = currentState;
-            }
+            init.contextState = quickAlgoLibraries.getLibrariesInnerState(state.environment);
         });
 
         app.replayApi.on('start', function*(replayContext: ReplayContext, event) {
@@ -938,7 +923,7 @@ export default function (bundle: Bundle) {
                 yield* put(updateCurrentTestId({testId, withoutContextState: !!contextState}));
             }
             if (contextState) {
-                yield* call(quickAlgoLibraryResetAndReloadStateSaga, app, contextState);
+                yield* call(quickAlgoLibraryResetAndReloadStateSaga, contextState);
             }
         });
 
@@ -999,7 +984,7 @@ export default function (bundle: Bundle) {
 
             const context = quickAlgoLibraries.getContext(null, 'main');
             if (context && (!quick || (instant.event && -1 !== ['compile.success'].indexOf(instant.event[1])) || hasChangedLevel || hasChangedTest)) {
-                yield* call(quickAlgoLibraryResetAndReloadStateSaga, app, taskData && taskData.state ? taskData.state : null);
+                yield* call(quickAlgoLibraryResetAndReloadStateSaga, taskData && taskData.state ? taskData.state : null);
                 log.getLogger('replay').debug('DO RESET DISPLAY');
                 yield* put({type: QuickAlgoLibrariesActionType.QuickAlgoLibrariesRedrawDisplay});
             }
@@ -1032,16 +1017,10 @@ export default function (bundle: Bundle) {
             })
         });
 
-        app.stepperApi.onInit(function* (stepperState: StepperState, state: AppStore) {
-            const currentTest = selectCurrentTestData(state);
-
-            log.getLogger('task').debug('stepper init, current test', currentTest, state.environment);
-
-            const context = quickAlgoLibraries.getContext(null, state.environment);
-            context.resetAndReloadState(currentTest, state);
+        app.stepperApi.onInit(function* () {
+            log.getLogger('task').debug('stepper init');
+            yield* call(quickAlgoLibraryResetAndReloadStateSaga);
             yield* put({type: QuickAlgoLibrariesActionType.QuickAlgoLibrariesRedrawDisplay});
-
-            stepperState.contextState = getCurrentImmerState(context.getInnerState());
         });
     });
 }

frontend/task/libs/debug/DebugLibView.tsx

@@ -0,0 +1,29 @@
+import React, {useEffect, useRef} from "react";
+import {useAppSelector} from '../../../hooks';
+import {DebugLibState} from './debug_lib';
+import {FontAwesomeIcon} from '@fortawesome/react-fontawesome';
+import {faChevronRight} from '@fortawesome/free-solid-svg-icons/faChevronRight';
+
+export function DebugLibView() {
+    const taskState: DebugLibState = useAppSelector(state => state.task.state?.debug);
+    const containerRef = useRef<HTMLDivElement>();
+
+    useEffect(() => {
+        containerRef.current.scrollTop = containerRef.current.scrollHeight;
+    }, [taskState?.linesLogged]);
+
+    if (!taskState?.linesLogged?.length) {
+        return null;
+    }
+
+    return (
+        <div className="debug-lib-container" ref={containerRef}>
+            {taskState?.linesLogged.map((line, lineIndex) =>
+                <div className="debug-lib-line" key={lineIndex}>
+                    <FontAwesomeIcon icon={faChevronRight}/>
+                    <span>{line}</span>
+                </div>
+            )}
+        </div>
+    );
+}