Assessments & Grading Workspace: Add folders mode #2765

accountexeregister · 2024-02-07T15:25:20Z

Description

To be merged with Grader #319 and Backend #1110

Adds folder support to Assessment & Grading workspaces
Folder mode is only supported for Source >= S2
Support for test cases to be ran on the existing Grader [See grader repo PR]
Support for test cases to be ran locally

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update
Code quality improvements

Note: This PR might break "Teams" functionality. The shouldDisableSaveButton() function on line 805 in src\commons\assessmentWorkspace\AssessmentWorkspace.tsx causes the save button to always be disabled in Assessments. Hence we had to comment it out.

How to test

Enter any Assessment and enable folder mode
Question files from future questions that do not have a submission yet should not appear in the Folder Mode
All question files should not be editable except for the current question
Testcases should have an entrypoint file for the current question (targetting the current question)
After a submission is made, the Grading workspace should be able to view the submission and also run all files in Folder Mode
If testcases are present, and auto grading is enabled, it should auto grade using Grader

Checklist

I have tested this code
I have updated the documentation

…-only-workspace

coveralls · 2024-02-07T15:30:11Z

Pull Request Test Coverage Report for Build 7817133053

-4 of 10 (60.0%) changed or added relevant lines in 1 file are covered.
1 unchanged line in 1 file lost coverage.
Overall coverage decreased (-0.004%) to 37.198%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/commons/assessmentWorkspace/AssessmentWorkspace.tsx	6	10	60.0%

Files with Coverage Reduction	New Missed Lines	%
src/commons/assessmentWorkspace/AssessmentWorkspace.tsx	1	69.71%

Totals
Change from base Build 7812213802:	-0.004%
Covered Lines:	5729
Relevant Lines:	14468

💛 - Coveralls

RichDom2185 · 2024-02-08T10:56:14Z

Is this PR ready or still in draft state?

accountexeregister · 2024-02-08T12:58:54Z

It is PR ready. The draft means we plan to expand on it.

accountexeregister · 2024-02-08T17:11:00Z

Update: Sorry, it is not PR ready yet.

…end into read-only-workspace

…nto read-only-workspace

martin-henz · 2024-03-11T05:57:03Z

@accountexeregister what is the status of this PR?

accountexeregister · 2024-03-14T09:48:33Z

Sorry prof, I just saw this message. We will still have to work on the backend before integrating it fully.

…nto read-only-workspace

RichDom2185

Hi, thanks for working on this, I did a quick run through and have the following comments, thanks!

RichDom2185 · 2024-04-15T16:18:20Z

src/commons/controlBar/ControlBarFileModeButton.tsx

+/**
+ * @prop fileMode an integer for the mode of the file where
+ *   0 = read-only and 1 = read-write.
+ */
+type ControlBarFileModeButtonProps = {
+  fileMode: number | null;
+};


Why are we using an integer when we can use an enum?

RichDom2185 · 2024-04-15T16:18:46Z

src/commons/controlBar/ControlBarFileModeButton.tsx

+export const ControlBarFileModeButton: React.FC<ControlBarFileModeButtonProps> = ({ fileMode }) => {
+  if (fileMode === 0) {
+    return <ControlButton label={'Read-Only'} icon={IconNames.LOCK} isDisabled />;
+  }
+  return <ControlButton label={'Read-Write'} icon={IconNames.UNLOCK} isDisabled />;
+};


If the button is always disabled, is a button the most appropriate?

RichDom2185 · 2024-04-15T16:19:18Z

src/commons/controlBar/ControlBarRunButton.tsx

+
+  /*
+  ? props.readOnly
+      ? 'Evaluation is disabled in read-only mode'
+      : '...or press shift-enter in the editor'
+    : 'Open a file to evaluate the program with the file as the entrypoint';
+  */


Is this still needed? If not, please remove the commented code.

RichDom2185 · 2024-04-15T16:20:34Z

src/commons/controlBar/ControlBarToggleFolderModeButton.tsx

+  isSupportedSource: boolean;
  toggleFolderMode: () => void;
 };

 export const ControlBarToggleFolderModeButton: React.FC<Props> = ({
  isFolderModeEnabled,
  isSessionActive,
  isPersistenceActive,
+  isSupportedSource,
  toggleFolderMode
 }) => {
  const tooltipContent = isSessionActive
    ? 'Currently unsupported while a collaborative session is active'
    : isPersistenceActive
    ? 'Currently unsupported while a persistence method is active'
+    : !isSupportedSource
+    ? 'Folder mode is not available for this version of Source'
    : `${isFolderModeEnabled ? 'Disable' : 'Enable'} Folder mode`;
  return (
    <Tooltip content={tooltipContent}>


I'd argue that if the language does not support it, the button should just be hidden (not disabled), like on the Playground.

What do you think?

RichDom2185 · 2024-04-15T16:20:52Z

src/commons/editor/tabs/EditorTab.tsx

@@ -24,6 +25,10 @@ const EditorTab: React.FC<Props> = ({ filePath, isActive, setActive, remove }) =
      })}
      onClick={setActive}
    >
+      {' '}


Is this space intentional?

RichDom2185 · 2024-04-15T16:27:18Z

src/commons/workspace/WorkspaceReducer.ts

+          : editorTab
+      );
+
+      if (isEqual(editorTabs, newEditorTabs)) {


Equality does not work properly with drafts. See https://immerjs.github.io/immer/pitfalls/#drafts-arent-referentially-equal

RichDom2185 · 2024-04-15T16:27:42Z

src/commons/workspace/WorkspaceReducer.ts

+      return {
+        ...state,
+        [workspaceLocation]: {
+          ...state[workspaceLocation],
+          editorTabs: newEditorTabs
+        }
+      };


Try to use mutation instead of returning a new object.

RichDom2185 · 2024-04-15T16:28:59Z

src/commons/workspace/WorkspaceReducer.ts

+      );
+
+      if (isEqual(editorTabs, newEditorTabs)) {
+        return state;


Instead of doing this very expensive computation, just read the old state (O(1) time), and read its readOnly old value (also O(1) time). Then compare it with the payload. If they are equal, return the old state. If they are not equal, compute the new state and return it.

RichDom2185 · 2024-04-15T16:29:29Z

src/commons/assessmentWorkspace/AssessmentWorkspace.tsx

  QuestionTypes,
  Testcase
 } from '../assessment/AssessmentTypes';
 import { ControlBarProps } from '../controlBar/ControlBar';
 import { ControlBarChapterSelect } from '../controlBar/ControlBarChapterSelect';
 import { ControlBarClearButton } from '../controlBar/ControlBarClearButton';
 import { ControlBarEvalButton } from '../controlBar/ControlBarEvalButton';
+// import { ControlBarFileModeButton } from '../controlBar/ControlBarFileModeButton';


Commented code should be removed in unused.

RichDom2185 · 2024-04-15T16:29:44Z

src/commons/assessmentWorkspace/AssessmentWorkspace.tsx

-  }, []);
+    setIsEditable(false);
+    dispatch(updateTabReadOnly(workspaceLocation, activeEditorTabIndex, true));
+  }, [activeEditorTabIndex, editorTabs, questionId]);


Please fix the lint warnings.

…nto read-only-workspace

accountexeregister added 3 commits February 7, 2024 19:13

Merge branch 'master' of github.com:source-academy/frontend into read…

026df68

…-only-workspace

Add draft read-only workspace feature

68abcad

Change isEditable to true

bfcc2a6

accountexeregister requested review from sayomaki and RichDom2185 February 7, 2024 15:25

Add file view to assessments

a5395e5

RichDom2185 marked this pull request as draft February 8, 2024 17:14

accountexeregister and others added 19 commits February 13, 2024 12:34

Move enable read-only workspace to onEditorValueChange

07de9ac

Change control bar for read only mode

4e6d2cf

Add file mode control bar button

f410803

Ignore read-only unsaved changes

5a72759

Readd previous,next question button in read-only

b4aa8aa

Add key to fileModeButton in AssessmentWorkspace

91ac95e

Disable renaming/deleting of files

040cbe1

Fix clicking on files causing crashes

80944df

Disable saving etc when not viewing question file

b77ebb2

Disable some control bar button in readonly mode

ccc2edc

Reset to original question content after disabling folder mode

6e5c043

Disable handleEval for read-only mode

3d249db

Fix reset

2c53b09

Linting

b197585

Change ControlBarRunButton tooltip content when read-only

cb937e7

Merge branch 'read-only-workspace' of github.com:source-academy/front…

5c7f0f3

…end into read-only-workspace

Linting

13ac129

fix return to original file

40c9ac9

Merge branch 'master' into read-only-workspace

9095928

Tkaixiang and others added 4 commits February 23, 2024 19:05

lint

0695486

Merge branch 'master' of https://github.com/source-academy/frontend i…

52ac1cb

…nto read-only-workspace

Merge branch 'master' into read-only-workspace

a9ff438

Merge branch 'master' into read-only-workspace

14b3e87

JovenSoh and others added 8 commits March 15, 2024 22:09

Enable folder mode for grading workspace

f6e969a

debug

4dcee99

remove debug

fc6046f

Merge branch 'master' of https://github.com/source-academy/frontend i…

41bc7ea

…nto read-only-workspace

Re-add folder functionality to workspace sagas

30bf558

Merge branch 'master' into read-only-workspace

04e0d76

Modify evalEditor to add prepend,postpend to files

a5698a6

Modify runTestCase to add prepend,postpend to files

14f2069

Tkaixiang changed the title ~~Folders: (Draft) Add read-only workspace~~ Assessments & Grading Workspace: Add folders mode Apr 15, 2024

Tkaixiang added 4 commits April 15, 2024 13:27

Merge branch 'master' of https://github.com/source-academy/frontend i…

82627fc

…nto read-only-workspace

lint

fe3e1c8

update snapshots

a31bef6

Fix types in test

41439e6

Tkaixiang mentioned this pull request Apr 15, 2024

Adds Folder Support to Autograding source-academy/backend#1110

Open

7 tasks

fix prettier errors

96b1ff2

Tkaixiang mentioned this pull request Apr 15, 2024

Adds folder support for auto grader source-academy/grader#319

Open

7 tasks

Tkaixiang and others added 4 commits April 15, 2024 17:33

fix error

949ecd4

lint

87b1d0c

fix

0739bc3

Merge branch 'master' into read-only-workspace

62df664

RichDom2185 marked this pull request as ready for review April 15, 2024 16:14

Revert unnecessary changes

6195fa7

RichDom2185 requested changes Apr 15, 2024

View reviewed changes

Merge branch 'master' of https://github.com/source-academy/frontend i…

fef24d5

…nto read-only-workspace

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Assessments & Grading Workspace: Add folders mode #2765

Assessments & Grading Workspace: Add folders mode #2765

accountexeregister commented Feb 7, 2024 •

edited by Tkaixiang

Loading

coveralls commented Feb 7, 2024

RichDom2185 commented Feb 8, 2024

accountexeregister commented Feb 8, 2024

accountexeregister commented Feb 8, 2024

martin-henz commented Mar 11, 2024

accountexeregister commented Mar 14, 2024

RichDom2185 left a comment

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

RichDom2185 Apr 15, 2024

Assessments & Grading Workspace: Add folders mode #2765

Are you sure you want to change the base?

Assessments & Grading Workspace: Add folders mode #2765

Conversation

accountexeregister commented Feb 7, 2024 • edited by Tkaixiang Loading

Description

Type of change

How to test

Checklist

coveralls commented Feb 7, 2024

Pull Request Test Coverage Report for Build 7817133053

💛 - Coveralls

RichDom2185 commented Feb 8, 2024

accountexeregister commented Feb 8, 2024

accountexeregister commented Feb 8, 2024

martin-henz commented Mar 11, 2024

accountexeregister commented Mar 14, 2024

RichDom2185 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

accountexeregister commented Feb 7, 2024 •

edited by Tkaixiang

Loading