Merge branch 'master' into game-quiz2

Author: CYX22222003

src/commons/application/actions/CommonsActions.ts

@@ -1,9 +1,13 @@
-import { createAction } from '@reduxjs/toolkit';
 import { Router } from '@remix-run/router';
+import { createActions } from 'src/commons/redux/utils';
 
-import { LOG_OUT, UPDATE_REACT_ROUTER } from '../types/CommonsTypes';
+const CommonsActions = createActions('commons', {
+  logOut: () => ({}),
+  updateReactRouter: (updatedRouter: Router) => updatedRouter
+});
 
-export const logOut = createAction(LOG_OUT, () => ({ payload: {} }));
-export const updateReactRouter = createAction(UPDATE_REACT_ROUTER, (updatedRouter: Router) => ({
-  payload: updatedRouter
-}));
+// For compatibility with existing code (reducer)
+export const { logOut, updateReactRouter } = CommonsActions;
+
+// For compatibility with existing code (actions helper)
+export default CommonsActions;

src/commons/application/actions/__tests__/CommonsActions.ts

@@ -1,10 +1,9 @@
-import { LOG_OUT } from '../../types/CommonsTypes';
-import { logOut } from '../CommonsActions';
+import CommonsActions from '../CommonsActions';
 
 test('logOut generates correct action object', () => {
-  const action = logOut();
+  const action = CommonsActions.logOut();
   expect(action).toEqual({
-    type: LOG_OUT,
+    type: CommonsActions.logOut.type,
     payload: {}
   });
 });

src/commons/application/reducers/SessionsReducer.ts

@@ -1,9 +1,6 @@
 import { createReducer } from '@reduxjs/toolkit';
 import { Reducer } from 'redux';
-import {
-  remoteExecUpdateDevices,
-  remoteExecUpdateSession
-} from 'src/features/remoteExecution/RemoteExecutionActions';
+import RemoteExecutionActions from 'src/features/remoteExecution/RemoteExecutionActions';
 
 import { SourceActionType } from '../../utils/ActionsHelper';
 import { logOut } from '../actions/CommonsActions';
@@ -84,10 +81,10 @@ const newSessionsReducer = createReducer(defaultSession, builder => {
     .addCase(SessionActions.updateTeamFormationOverview, (state, action) => {
       state.teamFormationOverview = action.payload;
     })
-    .addCase(remoteExecUpdateDevices, (state, action) => {
+    .addCase(RemoteExecutionActions.remoteExecUpdateDevices, (state, action) => {
       state.remoteExecutionDevices = action.payload;
     })
-    .addCase(remoteExecUpdateSession, (state, action) => {
+    .addCase(RemoteExecutionActions.remoteExecUpdateSession, (state, action) => {
       state.remoteExecutionSession = action.payload;
     })
     .addCase(SessionActions.removeGitHubOctokitObjectAndAccessToken, (state, action) => {

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

@@ -8,15 +8,15 @@ import {
   ProgressStatuses
 } from '../../../assessment/AssessmentTypes';
 import { Notification } from '../../../notificationBadge/NotificationBadgeTypes';
+import CommonsActions from '../../actions/CommonsActions';
 import SessionActions from '../../actions/SessionActions';
 import { defaultSession, GameState, Role, Story } from '../../ApplicationTypes';
-import { LOG_OUT } from '../../types/CommonsTypes';
 import { SessionState } from '../../types/SessionTypes';
 import { SessionsReducer } from '../SessionsReducer';
 
 test('LOG_OUT works correctly on default session', () => {
   const action = {
-    type: LOG_OUT,
+    type: CommonsActions.logOut.type,
     payload: {}
   } as const;
   const result: SessionState = SessionsReducer(defaultSession, action);

src/commons/application/types/CommonsTypes.ts

@@ -1,6 +1,3 @@
 import { Router } from '@remix-run/router';
 
-export const LOG_OUT = 'LOG_OUT';
-export const UPDATE_REACT_ROUTER = 'UPDATE_REACT_ROUTER';
-
 export type RouterState = Router | null;

src/commons/collabEditing/CollabEditingActions.ts

@@ -1,38 +1,29 @@
-import { createAction } from '@reduxjs/toolkit';
-
+import { createActions } from '../redux/utils';
 import { WorkspaceLocation } from '../workspace/WorkspaceTypes';
-import {
-  SET_EDITOR_SESSION_ID,
-  SET_SESSION_DETAILS,
-  SET_SHAREDB_CONNECTED
-} from './CollabEditingTypes';
-
-export const setEditorSessionId = createAction(
-  SET_EDITOR_SESSION_ID,
-  (workspaceLocation: WorkspaceLocation, editorSessionId: string) => ({
-    payload: { workspaceLocation, editorSessionId }
-  })
-);
 
-export const setSessionDetails = createAction(
-  SET_SESSION_DETAILS,
-  (
+const CollabEditingActions = createActions('collabEditing', {
+  setEditorSessionId: (workspaceLocation: WorkspaceLocation, editorSessionId: string) => ({
+    workspaceLocation,
+    editorSessionId
+  }),
+  setSessionDetails: (
     workspaceLocation: WorkspaceLocation,
     sessionDetails: { docId: string; readOnly: boolean } | null
-  ) => ({
-    payload: { workspaceLocation, sessionDetails }
+  ) => ({ workspaceLocation, sessionDetails }),
+  /**
+   * Sets ShareDB connection status.
+   *
+   * @param workspaceLocation the workspace to be reset
+   * @param connected whether we are connected to ShareDB
+   */
+  setSharedbConnected: (workspaceLocation: WorkspaceLocation, connected: boolean) => ({
+    workspaceLocation,
+    connected
   })
-);
+});
 
-/**
- * Sets ShareDB connection status.
- *
- * @param workspaceLocation the workspace to be reset
- * @param connected whether we are connected to ShareDB
- */
-export const setSharedbConnected = createAction(
-  SET_SHAREDB_CONNECTED,
-  (workspaceLocation: WorkspaceLocation, connected: boolean) => ({
-    payload: { workspaceLocation, connected }
-  })
-);
+// For compatibility with existing code (reducer)
+export const { setEditorSessionId, setSessionDetails, setSharedbConnected } = CollabEditingActions;
+
+// For compatibility with existing code (actions helper)
+export default CollabEditingActions;

src/commons/collabEditing/CollabEditingTypes.ts

@@ -1,6 +1,5 @@
 import { WorkspaceLocation } from '../../workspace/WorkspaceTypes';
 import { setEditorSessionId, setSharedbConnected } from '../CollabEditingActions';
-import { SET_EDITOR_SESSION_ID, SET_SHAREDB_CONNECTED } from '../CollabEditingTypes';
 
 const gradingWorkspace: WorkspaceLocation = 'grading';
 const playgroundWorkspace: WorkspaceLocation = 'playground';
@@ -9,7 +8,7 @@ test('setEditorSessionId generates correct action object', () => {
   const editorSessionId = 'test-editor-session-id';
   const action = setEditorSessionId(gradingWorkspace, editorSessionId);
   expect(action).toEqual({
-    type: SET_EDITOR_SESSION_ID,
+    type: setEditorSessionId.type,
     payload: {
       workspaceLocation: gradingWorkspace,
       editorSessionId
@@ -21,7 +20,7 @@ test('setSharedbConnected generates correct action object', () => {
   const connected = false;
   const action = setSharedbConnected(playgroundWorkspace, connected);
   expect(action).toEqual({
-    type: SET_SHAREDB_CONNECTED,
+    type: setSharedbConnected.type,
     payload: {
       workspaceLocation: playgroundWorkspace,
       connected

src/commons/collabEditing/__tests__/CollabEditingActions.ts

@@ -16,7 +16,7 @@ import { IconNames } from '@blueprintjs/icons';
 import { Chapter, Variant } from 'js-slang/dist/types';
 import React from 'react';
 import { useDispatch } from 'react-redux';
-import { createCourse } from 'src/features/academy/AcademyActions';
+import AcademyActions from 'src/features/academy/AcademyActions';
 
 import { CourseHelpTextEditorTab } from '../../pages/academy/adminPanel/subcomponents/CourseConfigPanel';
 import { sourceLanguages } from '../application/ApplicationTypes';
@@ -71,7 +71,7 @@ const DropdownCreateCourse: React.FC<Props> = props => {
       showWarningMessage('Course Name cannot be empty!');
       return;
     }
-    dispatch(createCourse(courseConfig));
+    dispatch(AcademyActions.createCourse(courseConfig));
     props.onClose();
   };
 

src/commons/dropdown/DropdownCreateCourse.tsx

@@ -8,7 +8,7 @@ import classes from 'src/styles/FileSystemView.module.scss';
 
 import { rmdirRecursively } from '../fileSystem/utils';
 import { showSimpleConfirmDialog, showSimpleErrorDialog } from '../utils/DialogHelper';
-import { removeEditorTabsForDirectory } from '../workspace/WorkspaceActions';
+import WorkspaceActions from '../workspace/WorkspaceActions';
 import { WorkspaceLocation } from '../workspace/WorkspaceTypes';
 import FileSystemViewContextMenu from './FileSystemViewContextMenu';
 import FileSystemViewFileName from './FileSystemViewFileName';
@@ -78,7 +78,7 @@ const FileSystemViewDirectoryNode: React.FC<Props> = ({
         return;
       }
 
-      dispatch(removeEditorTabsForDirectory(workspaceLocation, fullPath));
+      dispatch(WorkspaceActions.removeEditorTabsForDirectory(workspaceLocation, fullPath));
       rmdirRecursively(fileSystem, fullPath).then(refreshParentDirectory);
     });
   };

src/commons/fileSystemView/FileSystemViewDirectoryNode.tsx

@@ -5,10 +5,7 @@ import { useDispatch } from 'react-redux';
 import classes from 'src/styles/FileSystemView.module.scss';
 
 import { showSimpleErrorDialog } from '../utils/DialogHelper';
-import {
-  renameEditorTabForFile,
-  renameEditorTabsForDirectory
-} from '../workspace/WorkspaceActions';
+import WorkspaceActions from '../workspace/WorkspaceActions';
 import { WorkspaceLocation } from '../workspace/WorkspaceTypes';
 
 type Props = {
@@ -69,9 +66,11 @@ const FileSystemViewFileName: React.FC<Props> = ({
           }
 
           if (isDirectory) {
-            dispatch(renameEditorTabsForDirectory(workspaceLocation, oldPath, newPath));
+            dispatch(
+              WorkspaceActions.renameEditorTabsForDirectory(workspaceLocation, oldPath, newPath)
+            );
           } else {
-            dispatch(renameEditorTabForFile(workspaceLocation, oldPath, newPath));
+            dispatch(WorkspaceActions.renameEditorTabForFile(workspaceLocation, oldPath, newPath));
           }
           refreshDirectory();
         });

src/commons/fileSystemView/FileSystemViewFileName.tsx

@@ -7,7 +7,7 @@ import { useDispatch } from 'react-redux';
 import classes from 'src/styles/FileSystemView.module.scss';
 
 import { showSimpleConfirmDialog } from '../utils/DialogHelper';
-import { addEditorTab, removeEditorTabForFile } from '../workspace/WorkspaceActions';
+import WorkspaceActions from '../workspace/WorkspaceActions';
 import { WorkspaceLocation } from '../workspace/WorkspaceTypes';
 import FileSystemViewContextMenu from './FileSystemViewContextMenu';
 import FileSystemViewFileName from './FileSystemViewFileName';
@@ -44,7 +44,7 @@ const FileSystemViewFileNode: React.FC<Props> = ({
         throw new Error('File contents are undefined.');
       }
 
-      dispatch(addEditorTab(workspaceLocation, fullPath, fileContents));
+      dispatch(WorkspaceActions.addEditorTab(workspaceLocation, fullPath, fileContents));
     });
   };
 
@@ -74,7 +74,7 @@ const FileSystemViewFileNode: React.FC<Props> = ({
           console.error(err);
         }
 
-        dispatch(removeEditorTabForFile(workspaceLocation, fullPath));
+        dispatch(WorkspaceActions.removeEditorTabForFile(workspaceLocation, fullPath));
         refreshDirectory();
       });
     });

src/commons/fileSystemView/FileSystemViewFileNode.tsx

@@ -1,7 +1,7 @@
 import { SagaIterator } from 'redux-saga';
 import { call, put, select, takeEvery } from 'redux-saga/effects';
+import DashboardActions from 'src/features/dashboard/DashboardActions';
 
-import { FETCH_GROUP_GRADING_SUMMARY } from '../../features/dashboard/DashboardTypes';
 import {
   GradingOverviews,
   GradingQuery,
@@ -450,7 +450,7 @@ export function* mockBackendSaga(): SagaIterator {
     }
   );
 
-  yield takeEvery(FETCH_GROUP_GRADING_SUMMARY, function* () {
+  yield takeEvery(DashboardActions.fetchGroupGradingSummary.type, function* () {
     yield put(actions.updateGroupGradingSummary({ ...mockGradingSummary }));
   });
 }

src/commons/mocks/BackendMocks.ts

@@ -14,7 +14,7 @@ import {
 } from 'src/commons/application/ApplicationTypes';
 import SimpleDropdown from 'src/commons/SimpleDropdown';
 import { useTypedSelector } from 'src/commons/utils/Hooks';
-import { chapterSelect } from 'src/commons/workspace/WorkspaceActions';
+import WorkspaceActions from 'src/commons/workspace/WorkspaceActions';
 import { playgroundConfigLanguage } from 'src/features/playground/PlaygroundActions';
 
 // TODO: Hardcoded to use the first sublanguage for each language
@@ -35,7 +35,7 @@ const NavigationBarLangSelectButton = () => {
   const selectLang = (language: SupportedLanguage) => {
     const { chapter, variant } = defaultSublanguages[language];
     dispatch(playgroundConfigLanguage(getLanguageConfig(chapter, variant)));
-    dispatch(chapterSelect(chapter, variant, 'playground'));
+    dispatch(WorkspaceActions.chapterSelect(chapter, variant, 'playground'));
     setIsOpen(false);
   };