Refactor playground language switching

Author: chownces

src/commons/application/Application.tsx

@@ -28,7 +28,7 @@ export type DispatchProps = {
   handleLogOut: () => void;
   handleGitHubLogIn: () => void;
   handleGitHubLogOut: () => void;
-  fetchUserAndCourse: (updateSublanguage: boolean) => void;
+  fetchUserAndCourse: () => void;
   updateLatestViewedCourse: (courseId: number) => void;
   handleCreateCourse: (courseConfig: UpdateCourseConfiguration) => void;
 };
@@ -55,17 +55,7 @@ const Application: React.FC<ApplicationProps> = props => {
   // if the user was previously logged in
   React.useEffect(() => {
     if (props.name) {
-      // Do not update the sublanguage in the Playground context to the fetched course configuration
-      // if it is a shared link with chapter
-      if (
-        props.location.pathname === '/playground' &&
-        props.location.hash &&
-        parseQuery(props.location.hash).chap
-      ) {
-        props.fetchUserAndCourse(false);
-      } else {
-        props.fetchUserAndCourse(true);
-      }
+      props.fetchUserAndCourse();
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);

src/commons/application/actions/SessionActions.ts

@@ -70,8 +70,7 @@ import {
 export const fetchAuth = (code: string, providerId?: string) =>
   action(FETCH_AUTH, { code, providerId });
 
-export const fetchUserAndCourse = (updateSublanguage: boolean) =>
-  action(FETCH_USER_AND_COURSE, updateSublanguage);
+export const fetchUserAndCourse = () => action(FETCH_USER_AND_COURSE);
 
 export const fetchCourseConfig = () => action(FETCH_COURSE_CONFIG);
 

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

@@ -108,11 +108,9 @@ test('fetchAuth generates correct action object', () => {
 });
 
 test('fetchUserAndCourse generates correct action object', () => {
-  const updateSublanguage: boolean = true;
-  const action = fetchUserAndCourse(updateSublanguage);
+  const action = fetchUserAndCourse();
   expect(action).toEqual({
-    type: FETCH_USER_AND_COURSE,
-    payload: updateSublanguage
+    type: FETCH_USER_AND_COURSE
   });
 });
 

src/commons/application/types/SessionTypes.ts

@@ -89,6 +89,8 @@ export type SessionState = {
   readonly enableGame?: boolean;
   readonly enableAchievements?: boolean;
   readonly enableSourcecast?: boolean;
+  readonly sourceChapter?: number;
+  readonly sourceVariant?: Variant;
   readonly moduleHelpText?: string;
 
   readonly assessmentConfigurations?: AssessmentConfiguration[];

src/commons/sagas/BackendSaga.ts

@@ -5,7 +5,7 @@ import { call, put, select } from 'redux-saga/effects';
 import { ADD_NEW_USERS_TO_COURSE, CREATE_COURSE } from 'src/features/academy/AcademyTypes';
 import { UsernameRoleGroup } from 'src/pages/academy/adminPanel/subcomponents/AddUserPanel';
 
-import { OverallState, Role, styliseSublanguage } from '../../commons/application/ApplicationTypes';
+import { OverallState, Role } from '../../commons/application/ApplicationTypes';
 import {
   Assessment,
   AssessmentConfiguration,
@@ -168,16 +168,6 @@ function* BackendSaga(): SagaIterator {
       yield put(actions.setCourseRegistration(courseRegistration));
       yield put(actions.setCourseConfiguration(courseConfiguration));
       yield put(actions.setAssessmentConfigurations(assessmentConfigurations));
-      yield put(
-        actions.updateSublanguage({
-          chapter: courseConfiguration.sourceChapter,
-          variant: courseConfiguration.sourceVariant,
-          displayName: styliseSublanguage(
-            courseConfiguration.sourceChapter,
-            courseConfiguration.sourceVariant
-          )
-        })
-      );
     }
     yield history.push('/academy');
   });
@@ -187,13 +177,6 @@ function* BackendSaga(): SagaIterator {
     function* (action: ReturnType<typeof actions.fetchUserAndCourse>): any {
       const tokens = yield selectTokens();
 
-      /**
-       * The updateSublanguage boolean is used to determine whether to update the sublanguage
-       * in the Playground context to match the latest course configuration. We do not want to
-       * update it when the user is accessing the Playground via a shared link.
-       */
-      const updateSublanguage: boolean = action.payload;
-
       const {
         user,
         courseRegistration,
@@ -222,18 +205,6 @@ function* BackendSaga(): SagaIterator {
         yield put(actions.setCourseRegistration(courseRegistration));
         yield put(actions.setCourseConfiguration(courseConfiguration));
         yield put(actions.setAssessmentConfigurations(assessmentConfigurations));
-        if (updateSublanguage) {
-          yield put(
-            actions.updateSublanguage({
-              chapter: courseConfiguration.sourceChapter,
-              variant: courseConfiguration.sourceVariant,
-              displayName: styliseSublanguage(
-                courseConfiguration.sourceChapter,
-                courseConfiguration.sourceVariant
-              )
-            })
-          );
-        }
       }
     }
   );
@@ -243,13 +214,6 @@ function* BackendSaga(): SagaIterator {
     const { config }: { config: CourseConfiguration | null } = yield call(getCourseConfig, tokens);
     if (config) {
       yield put(actions.setCourseConfiguration(config));
-      yield put(
-        actions.updateSublanguage({
-          chapter: config.sourceChapter,
-          variant: config.sourceVariant,
-          displayName: styliseSublanguage(config.sourceChapter, config.sourceVariant)
-        })
-      );
     }
   });
 
@@ -619,7 +583,6 @@ function* BackendSaga(): SagaIterator {
           sourceVariant: sublang.variant
         })
       );
-      yield put(actions.updateSublanguage(sublang));
       yield call(showSuccessMessage, 'Updated successfully!', 1000);
     }
   );
@@ -653,16 +616,6 @@ function* BackendSaga(): SagaIterator {
       yield put(actions.setCourseRegistration(courseRegistration));
       yield put(actions.setCourseConfiguration(courseConfiguration));
       yield put(actions.setAssessmentConfigurations(assessmentConfigurations));
-      yield put(
-        actions.updateSublanguage({
-          chapter: courseConfiguration.sourceChapter,
-          variant: courseConfiguration.sourceVariant,
-          displayName: styliseSublanguage(
-            courseConfiguration.sourceChapter,
-            courseConfiguration.sourceVariant
-          )
-        })
-      );
       yield call(showSuccessMessage, `Switched to ${courseConfiguration.courseName}!`, 5000);
       yield history.push('/academy');
     }
@@ -792,16 +745,6 @@ function* BackendSaga(): SagaIterator {
       return yield handleResponseError(resp);
     }
     yield put(actions.setAssessmentConfigurations(placeholderAssessmentConfig));
-    yield put(
-      actions.updateSublanguage({
-        chapter: courseConfiguration.sourceChapter,
-        variant: courseConfiguration.sourceVariant,
-        displayName: styliseSublanguage(
-          courseConfiguration.sourceChapter,
-          courseConfiguration.sourceVariant
-        )
-      })
-    );
     yield call(showSuccessMessage, 'Successfully created your new course!');
     yield history.push('/academy');
   });