Versioning and history (#3659)

* Implement Versioning and History of Editor Code for Assessment Workspaces

* Create tests for versioning and history feature

* Prevent submit answer from displaying success message, as submit status is the same as version history save status.

* Fix updateVersionName API route and getVersionHistory return value

* Fix bug causing double saving, now only submits answer, and allows the submission to save code to backend

* Change restored versions to be named "(name)-restored" instead of "(timestamp)-restored"

* Prevent autosave in team assessments

* Implement UI for Versioning and History feature

* Implement version preview before restoring

* Fix bug causing duplicate versions to be saved

* Prevent save status indicator from showing in team assessments

* Update test to not check for success message upon autosave

* Update snapshots to align with changes

* Reformatted imports

* Fix bug where save status is not correctly checked and updated, always showing saved even on fail

* Refactor restoreVersionSaga and prevent restoring from auto-submitting in team assessments

* Fix bug where renaming updates the timestamp

* Fix bug where restoring was renaming the wrong version

* update snapshots to match changes

* Fix bug where new UI is not updated for mobile view

* Change return type of sagas for better type safety

* Fix bug where restoring will rename an existing version if the code is not updated

* Memoize sorted array of versions to improve performance

* Fix bug where save button appears incorrectly for individual assessments during loading

* Update snapshot to match bug fixes

* Fix formatting

* Fix bug where the restoreVersion action did not take into account the SagaIterator return type of restoreVersionSaga

* Fix bug where one auto-save can prematurely unblock another, causing an incorrectly timed version history refresh

* Fix bug where UI would show a stale name if the rename API fails

* Change all early returns in performAutoSave to return false instead of undefined

* Change onClick prop to match how other control-bar buttons are typed

* Fix bug where backend saga mock never updates save status

* Change saving status watcher to only work in assessment workspaces

* Fix bug where restoring a version always shows saved even while in the process of saving

* Add check to ensure that timestamp is a naive datetime before appending 'Z"

* Add safeguard to prevent blanking the editor when restoring a malformed version

* Edited clickable versions in the panel to be keyboard-focusable and announced correctly by assistive tech

* Add safeguard to prevent slicing the inserted_at when it is null/undefined

* Fix bug where save button for team assessments is enabled even when a student has not joined a team

* Edit autosaves to only fetch version history if the panel is open to improve performance

* Remove redundant code

* Use .reverse() to sort the versions by timestamp instead of .sort() to improve performance

* Update field to match backend change

* Fix bug where wrong version is renamed after restoring

* Add tests for coverage

* Implement diff viewer when previewing version to restore

* Prevent race condition by making concurrent auto saves wait for the first one to complete

* Fix bug where performAutoSave returns true even if save failed

* Fix bug where admin panel configuration switches were not animating

* Fix bug where hasUnsavedCode is not set to false when restoring identical code

* Make code save when history panel is opened

* Update tests

* Implement configuration setting for enabling and disabling autosave per assessment group and per assessment overrides

* Update tests for configuration of autosave

* Update snapshots

* Fix bug causing duplicate versions when restoring

* Fix bug causing hasUnsavedChanges to be false even when save failed from restoring

* Prevent autosaving from fetch and restore when disabled

* Update tests

* Fix bug where autosave was enabled for MCQ

* Change deduplication check for better performance

* Change restoreVersionSaga to return earlier if autosave is disabled

* Make auto save return earlier if it is a team assessment

* Update tests

* Improve performance of restoring version by removing redundant search

* Update tests

* Improve performance of renaming versions when restoring

* Change default to enable autosave for assessments created before this feature was implemented

* Implement lazy loading of versions for previewing

* Implement collapsible grouping of versions in history panel

* Remove redundant work following backend changes

* Edit reset confirmation message

* Update tests

* Prevent race condition from hanging and blocking future autosaves

* Change direct calls to fetchVersionHistorySaga to action dispatches instead

* Prevent possible indefinite hanging of saga

* Add onSelectVersion to the useEffect dependency array

* Fix bug where rapid selection of versions can cause incorrect code to be displayed

* Update lockfile post-merge

* Remove duplicate dependency

* Remove unnecessary type assertion

* Refactor to use SCSS module for scoping

* Fix global

* Update test snapshots

* Remove unnecessary type assertion

---------

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

Author: Nocaxe

package.json

@@ -51,6 +51,7 @@
     "@szhsin/react-menu": "^4.0.0",
     "@tanstack/react-table": "^8.9.3",
     "ace-builds": "^1.42.1",
+    "ace-diff": "^4.0.0",
     "acorn": "^8.9.0",
     "ag-grid-community": "^35.0.0",
     "ag-grid-react": "^35.0.0",

src/bootstrap/agGrid.ts

@@ -9,6 +9,7 @@ import {
   type Module,
   ModuleRegistry,
   PaginationModule,
+  RowApiModule,
   RowDragModule,
   TextEditorModule,
   TextFilterModule,
@@ -24,6 +25,7 @@ const productionModules: readonly Module[] = [
   DateFilterModule,
   InfiniteRowModelModule,
   PaginationModule,
+  RowApiModule,
   RowDragModule,
   TextEditorModule,
   TextFilterModule,

src/commons/application/ApplicationTypes.ts

@@ -392,7 +392,17 @@ export const createDefaultWorkspace = (workspaceLocation: WorkspaceLocation): Wo
   debuggerContext: {} as DebuggerContext,
   lastDebuggerResult: undefined,
   files: {},
-  updateUserRoleCallback: () => {}
+  updateUserRoleCallback: () => {},
+  versionHistory: {
+    versions: [],
+    selectedVersion: null,
+    selectedVersionCode: null,
+    isLoadingCode: false,
+    isLoading: false,
+    isHistoryPanelOpen: false,
+    isAutoSaving: false
+  },
+  saveStatus: 'idle'
 });
 
 const defaultFileName = 'program.js';

src/commons/application/actions/__tests__/SessionActions.test.ts

@@ -268,7 +268,8 @@ test('setAssessmentConfigurations generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 2,
@@ -280,7 +281,8 @@ test('setAssessmentConfigurations generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 3,
@@ -292,7 +294,8 @@ test('setAssessmentConfigurations generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     }
   ];
   const action = SessionActions.setAssessmentConfigurations(assesmentConfigurations);
@@ -726,7 +729,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 2,
@@ -738,7 +742,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 3,
@@ -750,7 +755,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 4,
@@ -762,7 +768,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 5,
@@ -774,7 +781,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 0,
-      earlySubmissionXp: 0
+      earlySubmissionXp: 0,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 6,
@@ -786,7 +794,8 @@ test('updateAssessmentTypes generates correct action object', () => {
       hasTokenCounter: false,
       hasVotingFeatures: false,
       hoursBeforeEarlyXpDecay: 48,
-      earlySubmissionXp: 200
+      earlySubmissionXp: 200,
+      isAutosaveEnabled: true
     }
   ];
   const action = SessionActions.updateAssessmentConfigs(assessmentConfigs);
@@ -807,7 +816,8 @@ test('deleteAssessmentConfig generates correct action object', () => {
     hasTokenCounter: false,
     hasVotingFeatures: false,
     hoursBeforeEarlyXpDecay: 48,
-    earlySubmissionXp: 200
+    earlySubmissionXp: 200,
+    isAutosaveEnabled: true
   };
   const action = SessionActions.deleteAssessmentConfig(assessmentConfig);
   expect(action).toEqual({

src/commons/application/reducers/__tests__/SessionReducer.test.ts

@@ -149,7 +149,8 @@ test('SET_ASSESSMENT_CONFIGURATIONS works correctly', () => {
       displayInDashboard: true,
       isMinigame: false,
       hasTokenCounter: false,
-      hasVotingFeatures: false
+      hasVotingFeatures: false,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 1,
@@ -164,7 +165,8 @@ test('SET_ASSESSMENT_CONFIGURATIONS works correctly', () => {
       displayInDashboard: true,
       isMinigame: false,
       hasTokenCounter: false,
-      hasVotingFeatures: false
+      hasVotingFeatures: false,
+      isAutosaveEnabled: true
     },
     {
       assessmentConfigId: 1,
@@ -179,7 +181,8 @@ test('SET_ASSESSMENT_CONFIGURATIONS works correctly', () => {
       displayInDashboard: true,
       isMinigame: false,
       hasTokenCounter: false,
-      hasVotingFeatures: false
+      hasVotingFeatures: false,
+      isAutosaveEnabled: true
     }
   ];
 

src/commons/assessment/AssessmentTypes.ts

@@ -68,6 +68,7 @@ export type AssessmentOverview = {
   isPublished?: boolean; // refers to assessment as a whole being published
   hasVotingFeatures: boolean;
   hasTokenCounter?: boolean;
+  isAutosaveEnabled?: boolean;
   isVotingPublished?: boolean;
   maxXp: number;
   earlySubmissionXp: number;
@@ -112,6 +113,7 @@ export type AssessmentConfiguration = {
   earlySubmissionXp: number;
   hasTokenCounter: boolean;
   hasVotingFeatures: boolean;
+  isAutosaveEnabled: boolean;
 };
 
 export interface IProgrammingQuestion extends BaseQuestion {

src/commons/assessment/__tests__/Assessment.test.tsx

@@ -20,7 +20,8 @@ const mockAssessmentConfig: AssessmentConfiguration = {
   hasTokenCounter: false,
   hasVotingFeatures: false,
   hoursBeforeEarlyXpDecay: 48,
-  earlySubmissionXp: 200
+  earlySubmissionXp: 200,
+  isAutosaveEnabled: true
 };
 
 const getOverriddenStore = ({