Migrate StoriesSaga to use helper

Original implementation in bbf4f09.

Adapted to match current state of codebase.

---------

Co-authored-by: Lee Yi <[email protected]>

Author: RichDom2185

src/commons/redux/utils.ts

@@ -47,7 +47,9 @@ export function combineSagaHandlers<
 >(
   actions: TActions,
   handlers: {
-    [K in keyof TActions]: (action: ReturnType<TActions[K]>) => SagaIterator;
+    // TODO: Maybe this can be stricter? And remove the optional type after
+    // migration is fully done
+    [K in keyof TActions]?: (action: ReturnType<TActions[K]>) => SagaIterator;
   },
   others?: (takeEvery: typeof saferTakeEvery) => SagaIterator
 ): () => SagaIterator {

src/commons/sagas/StoriesSaga.ts

@@ -1,6 +1,6 @@
 import { Context } from 'js-slang';
-import { SagaIterator } from 'redux-saga';
-import { call, put, select, takeLatest } from 'redux-saga/effects';
+import { call, put, select } from 'redux-saga/effects';
+import StoriesActions from 'src/features/stories/StoriesActions';
 import {
   deleteStory,
   getStories,
@@ -9,68 +9,51 @@ import {
   postStory,
   updateStory
 } from 'src/features/stories/storiesComponents/BackendAccess';
-import {
-  CREATE_STORY,
-  DELETE_STORY,
-  EVAL_STORY,
-  GET_STORIES_LIST,
-  GET_STORIES_USER,
-  SAVE_STORY,
-  SET_CURRENT_STORY_ID,
-  StoryData,
-  StoryListView,
-  StoryView
-} from 'src/features/stories/StoriesTypes';
+import { StoryData, StoryListView, StoryView } from 'src/features/stories/StoriesTypes';
 
 import { OverallState, StoriesRole } from '../application/ApplicationTypes';
 import { Tokens } from '../application/types/SessionTypes';
+import { combineSagaHandlers } from '../redux/utils';
 import { resetSideContent } from '../sideContent/SideContentActions';
 import { actions } from '../utils/ActionsHelper';
 import { showWarningMessage } from '../utils/notifications/NotificationsHelper';
 import { defaultStoryContent } from '../utils/StoriesHelper';
 import { selectTokens } from './BackendSaga';
-import { safeTakeEvery as takeEvery } from './SafeEffects';
 import { evalCode } from './WorkspaceSaga/helpers/evalCode';
 
-export function* storiesSaga(): SagaIterator {
-  yield takeLatest(GET_STORIES_LIST, function* () {
+const StoriesSaga = combineSagaHandlers(StoriesActions, {
+  // TODO: This should be using `takeLatest`, not `takeEvery`
+  getStoriesList: function* () {
     const tokens: Tokens = yield selectTokens();
     const allStories: StoryListView[] = yield call(async () => {
       const resp = await getStories(tokens);
       return resp ?? [];
     });
 
     yield put(actions.updateStoriesList(allStories));
-  });
-
-  // takeEvery used to ensure that setting to null (clearing the story) is always
-  // handled even if a refresh is triggered later.
-  yield takeEvery(
-    SET_CURRENT_STORY_ID,
-    function* (action: ReturnType<typeof actions.setCurrentStoryId>) {
-      const tokens: Tokens = yield selectTokens();
-      const storyId = action.payload;
-      if (storyId) {
-        const story: StoryView = yield call(getStory, tokens, storyId);
-        yield put(actions.setCurrentStory(story));
-      } else {
-        const defaultStory: StoryData = {
-          title: '',
-          content: defaultStoryContent,
-          pinOrder: null
-        };
-        yield put(actions.setCurrentStory(defaultStory));
-      }
+  },
+  setCurrentStoryId: function* (action) {
+    const tokens: Tokens = yield selectTokens();
+    const storyId = action.payload;
+    if (storyId) {
+      const story: StoryView = yield call(getStory, tokens, storyId);
+      yield put(actions.setCurrentStory(story));
+    } else {
+      const defaultStory: StoryData = {
+        title: '',
+        content: defaultStoryContent,
+        pinOrder: null
+      };
+      yield put(actions.setCurrentStory(defaultStory));
     }
-  );
-
-  yield takeEvery(CREATE_STORY, function* (action: ReturnType<typeof actions.createStory>) {
+  },
+  createStory: function* (action) {
     const tokens: Tokens = yield selectTokens();
     const story = action.payload;
     const userId: number | undefined = yield select((state: OverallState) => state.stories.userId);
 
     if (userId === undefined) {
-      showWarningMessage('Failed to create story: Invalid user');
+      yield call(showWarningMessage, 'Failed to create story: Invalid user');
       return;
     }
 
@@ -89,9 +72,8 @@ export function* storiesSaga(): SagaIterator {
     }
 
     yield put(actions.getStoriesList());
-  });
-
-  yield takeEvery(SAVE_STORY, function* (action: ReturnType<typeof actions.saveStory>) {
+  },
+  saveStory: function* (action) {
     const tokens: Tokens = yield selectTokens();
     const { story, id } = action.payload;
     const updatedStory: StoryView | null = yield call(
@@ -109,17 +91,17 @@ export function* storiesSaga(): SagaIterator {
     }
 
     yield put(actions.getStoriesList());
-  });
+  },
 
-  yield takeEvery(DELETE_STORY, function* (action: ReturnType<typeof actions.deleteStory>) {
+  deleteStory: function* (action) {
     const tokens: Tokens = yield selectTokens();
     const storyId = action.payload;
     yield call(deleteStory, tokens, storyId);
 
     yield put(actions.getStoriesList());
-  });
+  },
 
-  yield takeEvery(GET_STORIES_USER, function* () {
+  getStoriesUser: function* () {
     const tokens: Tokens = yield selectTokens();
     const me: {
       id: number;
@@ -136,9 +118,8 @@ export function* storiesSaga(): SagaIterator {
     }
     yield put(actions.setCurrentStoriesUser(me.id, me.name));
     yield put(actions.setCurrentStoriesGroup(me.groupId, me.groupName, me.role));
-  });
-
-  yield takeEvery(EVAL_STORY, function* (action: ReturnType<typeof actions.evalStory>) {
+  },
+  evalStory: function* (action) {
     const env = action.payload.env;
     const code = action.payload.code;
     const execTime: number = yield select(
@@ -150,8 +131,8 @@ export function* storiesSaga(): SagaIterator {
       [codeFilePath]: code
     };
     yield put(resetSideContent(`stories.${env}`));
-    yield call(evalCode, codeFiles, codeFilePath, context, execTime, 'stories', EVAL_STORY, env);
-  });
-}
+    yield call(evalCode, codeFiles, codeFilePath, context, execTime, 'stories', action.type, env);
+  }
+});
 
-export default storiesSaga;
+export default StoriesSaga;