Merge branch 'folders-public-wip' of github.com:source-academy/frontend into folders-public-wip

linedoestrolling · linedoestrolling · commit 808ee63a5a34 · 2024-04-14T17:51:05.000+08:00
diff --git a/src/commons/application/ApplicationTypes.ts b/src/commons/application/ApplicationTypes.ts
@@ -413,9 +413,8 @@ export const createDefaultWorkspace = (workspaceLocation: WorkspaceLocation): Wo
 });
 
 const defaultFileName = 'program.js';
-const defaultTopLevelFolderName = 'proj';
 export const getDefaultFilePath = (workspaceLocation: WorkspaceLocation) =>
-  `${WORKSPACE_BASE_PATHS[workspaceLocation]}/${defaultTopLevelFolderName}/${defaultFileName}`;
+  `${WORKSPACE_BASE_PATHS[workspaceLocation]}/${defaultFileName}`;
 
 export const defaultWorkspaceManager: WorkspaceManagerState = {
   assessment: {
diff --git a/src/commons/sagas/PersistenceSaga.tsx b/src/commons/sagas/PersistenceSaga.tsx
@@ -22,7 +22,6 @@ import {
 } from '../../features/persistence/PersistenceTypes';
 import { store } from '../../pages/createStore';
 import { OverallState } from '../application/ApplicationTypes';
-import { ExternalLibraryName } from '../application/types/ExternalTypes';
 import { LOGIN_GOOGLE, LOGOUT_GOOGLE } from '../application/types/SessionTypes';
 import {
   retrieveFilesInWorkspaceAsRecord,
@@ -107,6 +106,13 @@ export function* persistenceSaga(): SagaIterator {
     let toastKey: string | undefined;
     try {
       yield call(ensureInitialisedAndAuthorised);
+      const fileSystem: FSModule | null = yield select(
+        (state: OverallState) => state.fileSystem.inBrowserFileSystem
+      );
+      // If the file system is not initialised, do nothing.
+      if (fileSystem === null) {
+        throw new Error("No filesystem!");
+      }
       const { id, name, mimeType, picked, parentId } = yield call(
         pickFile,
         'Pick a file/folder to open',
@@ -125,7 +131,7 @@ export function* persistenceSaga(): SagaIterator {
         contents: (
           <p>
             Opening <strong>{name}</strong> will overwrite the current contents of your workspace.
-            Are you sure?
+            All local files/folders will be deleted. Are you sure?
           </p>
         ),
         positiveLabel: 'Open',
@@ -147,14 +153,6 @@ export function* persistenceSaga(): SagaIterator {
         const fileList = yield call(getFilesOfFolder, id, name); // this needed the extra scope mimetypes to have every file
         yield call(console.log, 'fileList', fileList);
 
-        const fileSystem: FSModule | null = yield select(
-          (state: OverallState) => state.fileSystem.inBrowserFileSystem
-        );
-        // If the file system is not initialised, do nothing.
-        if (fileSystem === null) {
-          throw new Error("No filesystem!");
-        }
-
         yield call(rmFilesInDirRecursively, fileSystem, '/playground');
         yield call(store.dispatch, actions.deleteAllPersistenceFiles());
 
@@ -221,14 +219,13 @@ export function* persistenceSaga(): SagaIterator {
           actions.chapterSelect(parseInt('4', 10) as Chapter, Variant.DEFAULT, 'playground')
         );
 
-        yield call(store.dispatch, actions.enableFileSystemContextMenus());
         yield call(
           store.dispatch,
           actions.removeEditorTabsForDirectory('playground', WORKSPACE_BASE_PATHS['playground'])
         );
 
         yield put(
-          actions.playgroundUpdatePersistenceFolder({ id, name, parentId, lastSaved: new Date() })
+          actions.playgroundUpdatePersistenceFile({ id, name, parentId, lastSaved: new Date(), isFolder: true })
         );
 
         // delay to increase likelihood addPersistenceFile for last loaded file has completed
@@ -245,36 +242,32 @@ export function* persistenceSaga(): SagaIterator {
         intent: Intent.PRIMARY
       });
 
-      const { result: meta } = yield call([gapi.client.drive.files, 'get'], {
-        // get fileid here using gapi.client.drive.files
-        fileId: id,
-        fields: 'appProperties'
-      });
       const contents = yield call([gapi.client.drive.files, 'get'], { fileId: id, alt: 'media' });
-      const activeEditorTabIndex: number | null = yield select(
-        (state: OverallState) => state.workspaces.playground.activeEditorTabIndex
+
+      yield call(rmFilesInDirRecursively, fileSystem, '/playground');
+      yield call(store.dispatch, actions.deleteAllPersistenceFiles());
+
+      // add file to BrowserFS
+      yield call(
+        writeFileRecursively,
+        fileSystem,
+        '/playground/' + name,
+        contents.body
       );
-      if (activeEditorTabIndex === null) {
-        throw new Error('No active editor tab found.');
-      }
-      yield put(actions.updateEditorValue('playground', activeEditorTabIndex, contents.body)); // CONTENTS OF SELECTED FILE LOADED HERE
-      yield put(actions.playgroundUpdatePersistenceFile({ id, name, lastSaved: new Date() }));
-      if (meta && meta.appProperties) {
-        yield put(
-          actions.chapterSelect(
-            parseInt(meta.appProperties.chapter || '4', 10) as Chapter,
-            meta.appProperties.variant || Variant.DEFAULT,
-            'playground'
-          )
-        );
-        yield put(
-          actions.externalLibrarySelect(
-            Object.values(ExternalLibraryName).find(v => v === meta.appProperties.external) ||
-              ExternalLibraryName.NONE,
-            'playground'
-          )
-        );
-      }
+      // update playground PersistenceFile
+      const newPersistenceFile = { id, name, lastSaved: new Date(), path: '/playground/' + name};
+      yield put(actions.playgroundUpdatePersistenceFile(newPersistenceFile));
+      // add file to persistenceFileArray
+      yield put(actions.addPersistenceFile(newPersistenceFile));
+
+      yield call(
+        store.dispatch,
+        actions.removeEditorTabsForDirectory('playground', WORKSPACE_BASE_PATHS['playground'])
+      );
+      
+      // delay to increase likelihood addPersistenceFile for last loaded file has completed
+      // and for the toasts to not overlap
+      yield call(() => new Promise( resolve => setTimeout(resolve, 1000)));
       yield call(showSuccessMessage, `Loaded ${name}.`, 1000);
     } catch (ex) {
       console.error(ex);
@@ -283,6 +276,7 @@ export function* persistenceSaga(): SagaIterator {
       if (toastKey) {
         dismiss(toastKey);
       }
+      yield call(store.dispatch, actions.enableFileSystemContextMenus());
       yield call(store.dispatch, actions.updateRefreshFileViewKey());
     }
   });
@@ -310,7 +304,8 @@ export function* persistenceSaga(): SagaIterator {
       );
 
       if (activeEditorTabIndex === null) {
-        throw new Error('No active editor tab found.');
+        yield call(showWarningMessage, `Please open an editor tab.`, 1000);
+        return;
       }
       const code = editorTabs[activeEditorTabIndex].value;
 
@@ -420,11 +415,12 @@ export function* persistenceSaga(): SagaIterator {
             );
             if (areAllFilesSavedGoogleDrive(updatedPersistenceFileArray)) {
               yield put(
-                actions.playgroundUpdatePersistenceFolder({
+                actions.playgroundUpdatePersistenceFile({
                   id: currPersistenceFile.id,
                   name: currPersistenceFile.name,
                   parentId: currPersistenceFile.parentId,
-                  lastSaved: new Date()
+                  lastSaved: new Date(),
+                  isFolder: true
                 })
               );
             }
@@ -438,8 +434,10 @@ export function* persistenceSaga(): SagaIterator {
           );
           return;
         }
-        yield put(actions.playgroundUpdatePersistenceFile(pickedFile));
-        yield put(actions.persistenceSaveFile(pickedFile));
+        // Single file mode case
+        const singleFileModePersFile: PersistenceFile = {...pickedFile, lastSaved: new Date(), path: '/playground/' + pickedFile.name};
+        yield put(actions.playgroundUpdatePersistenceFile(singleFileModePersFile));
+        yield put(actions.persistenceSaveFile(singleFileModePersFile));
       } else {
         const response: AsyncReturnType<typeof showSimplePromptDialog> = yield call(
           showSimplePromptDialog,
@@ -465,8 +463,6 @@ export function* persistenceSaga(): SagaIterator {
           return;
         }
 
-        // yield call(store.dispatch, actions.disableFileSystemContextMenus());
-
         const config: IPlaygroundConfig = {
           chapter,
           variant,
@@ -542,7 +538,21 @@ export function* persistenceSaga(): SagaIterator {
           return;
         }
 
-        yield put(actions.playgroundUpdatePersistenceFile({ ...newFile, lastSaved: new Date() }));
+        
+        // Single file case
+        const newPersFile: PersistenceFile = {...newFile, lastSaved: new Date(), path: "/playground/" + newFile.name};
+        if (!currPersistenceFile) { // no file loaded prior
+          // update playground pers file
+          yield put(actions.playgroundUpdatePersistenceFile(newPersFile));
+          // add new pers file to persFileArray
+        } else { // file loaded prior
+          // update playground pers file
+          yield put(actions.playgroundUpdatePersistenceFile(newPersFile));
+          // remove old pers file from persFileArray
+          // add new pers file to persFileArray
+        }
+
+        // 
         yield call(
           showSuccessMessage,
           `${response.value} successfully saved to Google Drive.`,
@@ -760,11 +770,12 @@ export function* persistenceSaga(): SagaIterator {
         }
 
         yield put(
-          actions.playgroundUpdatePersistenceFolder({
+          actions.playgroundUpdatePersistenceFile({
             id: topLevelFolderId,
             name: topLevelFolderName,
             parentId: saveToDir.id,
-            lastSaved: new Date()
+            lastSaved: new Date(),
+            isFolder: true
           })
         );
 
@@ -860,11 +871,12 @@ export function* persistenceSaga(): SagaIterator {
       }
 
       yield put(
-        actions.playgroundUpdatePersistenceFolder({
+        actions.playgroundUpdatePersistenceFile({
           id: currFolderObject.id,
           name: currFolderObject.name,
           parentId: currFolderObject.parentId,
-          lastSaved: new Date()
+          lastSaved: new Date(),
+          isFolder: true
         })
       );
       yield call(store.dispatch, actions.updateRefreshFileViewKey());
@@ -891,7 +903,7 @@ export function* persistenceSaga(): SagaIterator {
       yield call(store.dispatch, actions.disableFileSystemContextMenus());
       let toastKey: string | undefined;
 
-      const [currFolderObject] = yield select(
+      const [playgroundPersistenceFile] = yield select(
         (state: OverallState) => [state.playground.persistenceFile]
       );
 
@@ -908,8 +920,9 @@ export function* persistenceSaga(): SagaIterator {
       );
 
       try {
-        if (activeEditorTabIndex === null) {
-          throw new Error('No active editor tab found.');
+        if (activeEditorTabIndex === null && !playgroundPersistenceFile.isFolder) {
+          yield call(showWarningMessage, `Please have ${name} open as the active editor tab.`, 1000);
+          return;
         }
         const code = editorTabs[activeEditorTabIndex].value;
 
@@ -918,7 +931,7 @@ export function* persistenceSaga(): SagaIterator {
           variant,
           external
         };
-        if ((currFolderObject as PersistenceFile).isFolder) {
+        if ((playgroundPersistenceFile as PersistenceFile).isFolder) {
           yield call(console.log, 'folder opened! updating pers specially');
           const persistenceFileArray: PersistenceFile[] = yield select(
             (state: OverallState) => state.fileSystem.persistenceFileArray
@@ -957,27 +970,36 @@ export function* persistenceSaga(): SagaIterator {
           );
           if (areAllFilesSavedGoogleDrive(updatedPersistenceFileArray)) {
             yield put(
-              actions.playgroundUpdatePersistenceFolder({
-                id: currFolderObject.id,
-                name: currFolderObject.name,
-                parentId: currFolderObject.parentId,
-                lastSaved: new Date()
+              actions.playgroundUpdatePersistenceFile({
+                id: playgroundPersistenceFile.id,
+                name: playgroundPersistenceFile.name,
+                parentId: playgroundPersistenceFile.parentId,
+                lastSaved: new Date(),
+                isFolder: true
               })
             );
           }
 
           return;
         }
 
+        if ((editorTabs[activeEditorTabIndex] as EditorTabState).filePath !== playgroundPersistenceFile.path) {
+           yield call(showWarningMessage, `Please have ${name} open as the active editor tab.`, 1000);
+           return;
+        }
+
         toastKey = yield call(showMessage, {
           message: `Saving as ${name}...`,
           timeout: 0,
           intent: Intent.PRIMARY
         });
 
         yield call(updateFile, id, name, MIME_SOURCE, code, config);
-        yield put(actions.playgroundUpdatePersistenceFile({ id, name, lastSaved: new Date() }));
+        const updatedPlaygroundPersFile = { ...playgroundPersistenceFile, lastSaved: new Date() };
+        yield put(actions.addPersistenceFile(updatedPlaygroundPersFile));
+        yield put(actions.playgroundUpdatePersistenceFile(updatedPlaygroundPersFile));
         yield call(showSuccessMessage, `${name} successfully saved to Google Drive.`, 1000);
+        yield call(store.dispatch, actions.updateRefreshFileViewKey());
       } catch (ex) {
         console.error(ex);
         yield call(showWarningMessage, `Error while saving file.`, 1000);
@@ -1312,7 +1334,7 @@ export function* persistenceSaga(): SagaIterator {
         if (currFolderObject.name === oldFolderName) {
           // update playground PersistenceFile
           yield put(
-            actions.playgroundUpdatePersistenceFolder({ ...currFolderObject, name: newFolderName })
+            actions.playgroundUpdatePersistenceFile({ ...currFolderObject, name: newFolderName, isFolder: true })
           );
         }
       } catch (ex) {
diff --git a/src/commons/sagas/WorkspaceSaga/index.ts b/src/commons/sagas/WorkspaceSaga/index.ts
@@ -10,8 +10,6 @@ import { EVAL_STORY } from 'src/features/stories/StoriesTypes';
 import { EventType } from '../../../features/achievement/AchievementTypes';
 import DataVisualizer from '../../../features/dataVisualizer/dataVisualizer';
 import {
-  defaultEditorValue,
-  getDefaultFilePath,
   OverallState,
   styliseSublanguage
 } from '../../application/ApplicationTypes';
@@ -24,7 +22,6 @@ import {
 } from '../../application/types/InterpreterTypes';
 import { Library, Testcase } from '../../assessment/AssessmentTypes';
 import { Documentation } from '../../documentation/Documentation';
-import { writeFileRecursively } from '../../fileSystem/FileSystemUtils';
 import { resetSideContent } from '../../sideContent/SideContentActions';
 import { actions } from '../../utils/ActionsHelper';
 import {
@@ -42,7 +39,6 @@ import {
   ADD_HTML_CONSOLE_ERROR,
   BEGIN_CLEAR_CONTEXT,
   CHAPTER_SELECT,
-  EditorTabState,
   EVAL_EDITOR,
   EVAL_EDITOR_AND_TESTCASES,
   EVAL_REPL,
@@ -101,45 +97,6 @@ export default function* WorkspaceSaga(): SagaIterator {
     if (isFolderModeEnabled) {
       return;
     }
-
-    const editorTabs: EditorTabState[] = yield select(
-      (state: OverallState) => state.workspaces[workspaceLocation].editorTabs
-    );
-    // If Folder mode is disabled and there are no open editor tabs, add an editor tab.
-    if (editorTabs.length === 0) {
-      const defaultFilePath = getDefaultFilePath(workspaceLocation);
-      const fileSystem: FSModule | null = yield select(
-        (state: OverallState) => state.fileSystem.inBrowserFileSystem
-      );
-      // If the file system is not initialised, add an editor tab with the default editor value.
-      if (fileSystem === null) {
-        yield put(actions.addEditorTab(workspaceLocation, defaultFilePath, defaultEditorValue));
-        return;
-      }
-      const editorValue: string = yield new Promise((resolve, reject) => {
-        fileSystem.exists(defaultFilePath, fileExists => {
-          if (!fileExists) {
-            // If the file does not exist, we need to also create it in the file system.
-            writeFileRecursively(fileSystem, defaultFilePath, defaultEditorValue)
-              .then(() => resolve(defaultEditorValue))
-              .catch(err => reject(err));
-            return;
-          }
-          fileSystem.readFile(defaultFilePath, 'utf-8', (err, fileContents) => {
-            if (err) {
-              reject(err);
-              return;
-            }
-            if (fileContents === undefined) {
-              reject(new Error('File exists but has no contents.'));
-              return;
-            }
-            resolve(fileContents);
-          });
-        });
-      });
-      yield put(actions.addEditorTab(workspaceLocation, defaultFilePath, editorValue));
-    }
   });
 
   // Mirror editor updates to the associated file in the filesystem.
diff --git a/src/pages/playground/Playground.tsx b/src/pages/playground/Playground.tsx
