[MS] Update workspace context menu to hide/unhide "Mount" and "Unmount" based on workspace hidden state

Author: fabienSvstr

client/src/components/workspaces/utils.ts

@@ -10,8 +10,10 @@ import {
   WorkspaceRole,
   getClientProfile,
   getSystemPath,
+  mountWorkspace,
   getPathLink as parsecGetPathLink,
   renameWorkspace as parsecRenameWorkspace,
+  unmountWorkspace,
 } from '@/parsec';
 import { Routes, navigateTo } from '@/router';
 import { EventDistributor } from '@/services/eventDistributor';
@@ -138,6 +140,7 @@ export async function openWorkspaceContextMenu(
         clientProfile: clientProfile,
         clientRole: workspace.currentSelfRole,
         isFavorite: workspaceAttributes.isFavorite(workspace.id),
+        isHidden: workspaceAttributes.isHidden(workspace.id),
       },
     });
 
@@ -156,6 +159,7 @@ export async function openWorkspaceContextMenu(
         clientProfile: clientProfile,
         clientRole: workspace.currentSelfRole,
         isFavorite: workspaceAttributes.isFavorite(workspace.id),
+        isHidden: workspaceAttributes.isHidden(workspace.id),
       },
     });
 
@@ -184,12 +188,84 @@ export async function openWorkspaceContextMenu(
       case WorkspaceAction.ShowHistory:
         await navigateTo(Routes.History, { query: { documentPath: '/', workspaceHandle: workspace.handle } });
         break;
+      case WorkspaceAction.Mount:
+        await showWorkspace(workspace, workspaceAttributes, informationManager);
+        break;
+      case WorkspaceAction.UnMount:
+        await hideWorkspace(workspace, workspaceAttributes, informationManager);
+        break;
       default:
         console.warn('No WorkspaceAction match found');
     }
   }
 }
 
+export async function showWorkspace(
+  workspace: WorkspaceInfo,
+  workspaceAttributes: WorkspaceAttributes,
+  informationManager: InformationManager,
+): Promise<void> {
+  const result = await mountWorkspace(workspace.handle);
+
+  if (result.ok) {
+    workspaceAttributes.removeHidden(workspace.id);
+    informationManager.present(
+      new Information({
+        message: {
+          key: 'WorkspacesPage.showHideWorkspace.successShown',
+          data: { workspace: workspace.currentName },
+        },
+        level: InformationLevel.Success,
+      }),
+      PresentationMode.Toast,
+    );
+  } else {
+    informationManager.present(
+      new Information({
+        message: {
+          key: 'WorkspacesPage.showHideWorkspace.failedShown',
+          data: { workspace: workspace.currentName },
+        },
+        level: InformationLevel.Error,
+      }),
+      PresentationMode.Toast,
+    );
+  }
+}
+
+export async function hideWorkspace(
+  workspace: WorkspaceInfo,
+  workspaceAttributes: WorkspaceAttributes,
+  informationManager: InformationManager,
+): Promise<void> {
+  const result = await unmountWorkspace(workspace);
+
+  if (result.ok) {
+    workspaceAttributes.addHidden(workspace.id);
+    informationManager.present(
+      new Information({
+        message: {
+          key: 'WorkspacesPage.showHideWorkspace.successHidden',
+          data: { workspace: workspace.currentName },
+        },
+        level: InformationLevel.Success,
+      }),
+      PresentationMode.Toast,
+    );
+  } else {
+    informationManager.present(
+      new Information({
+        message: {
+          key: 'WorkspacesPage.showHideWorkspace.failedHidden',
+          data: { workspace: workspace.currentName },
+        },
+        level: InformationLevel.Error,
+      }),
+      PresentationMode.Toast,
+    );
+  }
+}
+
 async function openWorkspace(workspace: WorkspaceInfo, informationManager: InformationManager): Promise<void> {
   const result = await getSystemPath(workspace.handle, '/');
 

client/src/locales/en-US.json

@@ -646,6 +646,8 @@
             "actionHistory": "History",
             "actionShare": "Sharing and roles",
             "actionDetails": "Details",
+            "actionHide": "Hide this workspace",
+            "actionShow": "Show this workspace",
             "actionCopyLink": "Copy link",
             "actionAddFavorite": "Pin",
             "actionRemoveFavorite": "Unpin"
@@ -695,6 +697,13 @@
         "filter": {
             "title": "Filter",
             "roles": "Role"
+        },
+        "showHideWorkspace": {
+            "failedStarted": "Failed to get started workspace information. Please try again.",
+            "successHidden": "The workspace is now hidden and will no longer appear in your explorer.",
+            "failedHidden": "Failed to hide the workspace. Please try again.",
+            "successShown": "The workspace is now visible in Parsec and your explorer.",
+            "failedShown": "Failed to show the workspace. Please try again."
         }
     },
     "FoldersPage": {

client/src/locales/fr-FR.json

@@ -646,6 +646,8 @@
             "actionShare": "Partage et rôles",
             "actionDetails": "Détails",
             "actionCopyLink": "Copier le lien",
+            "actionHide": "Masquer cet espace",
+            "actionShow": "Afficher cet espace",
             "actionAddFavorite": "Épingler",
             "actionRemoveFavorite": "Désépingler"
         },
@@ -694,6 +696,13 @@
         "filter": {
             "title": "Filtrer",
             "roles": "Rôle"
+        },
+        "showHideWorkspace": {
+            "failedStarted": "Impossible d'obtenir les informations relatives à l'espace de travail. Veuillez réessayer.",
+            "successHidden": "L'espace de travail est maintenant masqué et n'apparaîtra plus dans votre explorateur.",
+            "failedHidden": "Impossible de masquer l'espace de travail. Veuillez réessayer.",
+            "successShown": "L'espace de travail est maintenant visible dans Parsec et votre explorateur.",
+            "failedShown": "Impossible d'afficher l'espace de travail. Veuillez réessayer."
         }
     },
     "FoldersPage": {

client/src/parsec/workspace.ts

@@ -32,7 +32,7 @@ import {
   WorkspaceRole,
 } from '@/parsec/types';
 import { generateNoHandleError } from '@/parsec/utils';
-import { WorkspaceStopError, libparsec } from '@/plugins/libparsec';
+import { MountpointUnmountError, WorkspaceStopError, libparsec } from '@/plugins/libparsec';
 import { getConnectionHandle } from '@/router';
 import { DateTime } from 'luxon';
 
@@ -240,7 +240,7 @@ export async function mountWorkspace(
   const startedWorkspaceResult = await getWorkspaceInfo(workspaceHandle);
   if (!startedWorkspaceResult.ok) {
     console.error(`Failed to get started workspace info: ${startedWorkspaceResult.error}`);
-    return { ok: false, error: { tag: WorkspaceMountErrorTag.Internal, error: '' } };
+    return { ok: false, error: { tag: WorkspaceMountErrorTag.Internal, error: startedWorkspaceResult.error.error } };
   } else {
     if (startedWorkspaceResult.value.mountpoints.length > 0) {
       return { ok: true, value: startedWorkspaceResult.value.mountpoints[0] };
@@ -249,6 +249,25 @@ export async function mountWorkspace(
   return await libparsec.workspaceMount(workspaceHandle);
 }
 
+export async function unmountWorkspace(workspace: WorkspaceInfo): Promise<Result<null, MountpointUnmountError>> {
+  let error: MountpointUnmountError | null = null;
+
+  for (let i = workspace.mountpoints.length - 1; i >= 0; i--) {
+    const result = await libparsec.mountpointUnmount(workspace.mountpoints[i][0]);
+    if (result.ok) {
+      workspace.mountpoints.splice(i, 1);
+    } else {
+      error = result.error;
+    }
+  }
+
+  if (error) {
+    return generateNoHandleError<MountpointUnmountError>();
+  }
+
+  return { ok: true, value: null };
+}
+
 export async function getPathLink(
   workspaceHandle: WorkspaceHandle,
   path: string,

client/src/views/workspaces/SmallDisplayWorkspaceContextMenu.vue

@@ -48,7 +48,10 @@
             @click="onClick(WorkspaceAction.OpenInExplorer)"
             class="ion-no-padding list-group-item"
           >
-            <ion-icon :icon="open" />
+            <ion-icon
+              class="list-group-item__icon"
+              :icon="open"
+            />
             <ion-text class="button-large list-group-item__label-small">
               {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionOpenInExplorer') }}
             </ion-text>
@@ -83,6 +86,36 @@
               {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionDetails') }}
             </ion-text>
           </ion-item>
+
+          <ion-item
+            button
+            v-show="isDesktop() && !isHidden"
+            @click="onClick(WorkspaceAction.UnMount)"
+            class="ion-no-padding list-group-item"
+          >
+            <ion-icon
+              class="list-group-item__icon"
+              :icon="eyeOff"
+            />
+            <ion-text class="button-large list-group-item__label-small">
+              {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionHide') }}
+            </ion-text>
+          </ion-item>
+
+          <ion-item
+            button
+            v-show="isDesktop() && isHidden"
+            @click="onClick(WorkspaceAction.Mount)"
+            class="ion-no-padding list-group-item"
+          >
+            <ion-icon
+              class="list-group-item__icon"
+              :icon="eye"
+            />
+            <ion-text class="button-large list-group-item__label-small">
+              {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionShow') }}
+            </ion-text>
+          </ion-item>
         </ion-item-group>
         <ion-item-group class="list-group">
           <ion-item
@@ -144,7 +177,7 @@
 import { UserProfile, WorkspaceName, WorkspaceRole, isDesktop } from '@/parsec';
 import { WorkspaceAction } from '@/views/workspaces/types';
 import { IonContent, IonIcon, IonItem, IonItemGroup, IonList, IonPage, IonText, modalController } from '@ionic/vue';
-import { cloudy, informationCircle, link, open, shareSocial, star, time } from 'ionicons/icons';
+import { cloudy, eye, eyeOff, informationCircle, link, open, shareSocial, star, time } from 'ionicons/icons';
 import { MsImage, RenameIcon } from 'megashark-lib';
 
 function onClick(action: WorkspaceAction): Promise<boolean> {
@@ -156,6 +189,7 @@ defineProps<{
   clientProfile: UserProfile;
   clientRole: WorkspaceRole;
   isFavorite: boolean;
+  isHidden: boolean;
 }>();
 </script>
 

client/src/views/workspaces/WorkspaceContextMenu.vue

@@ -106,6 +106,35 @@
             {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionDetails') }}
           </ion-text>
         </ion-item>
+
+        <ion-item
+          button
+          v-show="isDesktop() && !isHidden"
+          @click="onClick(WorkspaceAction.UnMount)"
+          class="ion-no-padding list-group-item"
+        >
+          <ion-icon
+            class="list-group-item__icon"
+            :icon="eyeOff"
+          />
+          <ion-text class="body list-group-item__label">
+            {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionHide') }}
+          </ion-text>
+        </ion-item>
+        <ion-item
+          button
+          v-show="isDesktop() && isHidden"
+          @click="onClick(WorkspaceAction.Mount)"
+          class="ion-no-padding list-group-item"
+        >
+          <ion-icon
+            class="list-group-item__icon"
+            :icon="eye"
+          />
+          <ion-text class="body list-group-item__label">
+            {{ $msTranslate('WorkspacesPage.workspaceContextMenu.actionShow') }}
+          </ion-text>
+        </ion-item>
       </ion-item-group>
       <ion-item-group class="list-group">
         <ion-item class="list-group-title button-small">
@@ -176,7 +205,7 @@
 import { UserProfile, WorkspaceName, WorkspaceRole, isDesktop } from '@/parsec';
 import { WorkspaceAction } from '@/views/workspaces/types';
 import { IonContent, IonIcon, IonItem, IonItemGroup, IonList, IonText, popoverController } from '@ionic/vue';
-import { cloudy, informationCircle, link, open, shareSocial, star, time } from 'ionicons/icons';
+import { cloudy, eye, eyeOff, informationCircle, link, open, shareSocial, star, time } from 'ionicons/icons';
 import { MsImage, RenameIcon } from 'megashark-lib';
 
 function onClick(action: WorkspaceAction): Promise<boolean> {
@@ -188,6 +217,7 @@ defineProps<{
   clientProfile: UserProfile;
   clientRole: WorkspaceRole;
   isFavorite: boolean;
+  isHidden: boolean;
 }>();
 </script>
 

client/src/views/workspaces/WorkspacesPage.vue

@@ -439,6 +439,7 @@ async function refreshWorkspacesList(): Promise<void> {
   querying.value = true;
   window.electronAPI.log('debug', 'Starting Parsec list workspaces');
   const result = await parsecListWorkspaces();
+  const hidden = workspaceAttributes.getHidden();
   if (result.ok) {
     for (const wk of result.value) {
       window.electronAPI.log('debug', `Processing workspace: ${wk.currentName}`);
@@ -448,7 +449,7 @@ async function refreshWorkspacesList(): Promise<void> {
       } else {
         window.electronAPI.log('warn', `Failed to get sharing for ${wk.currentName}`);
       }
-      if (isDesktop() && wk.mountpoints.length === 0) {
+      if (isDesktop() && wk.mountpoints.length === 0 && !hidden.value.includes(wk.id)) {
         const mountResult = await parsecMountWorkspace(wk.handle);
         if (mountResult.ok) {
           wk.mountpoints.push(mountResult.value);

client/src/views/workspaces/types.ts

@@ -10,6 +10,7 @@ enum WorkspaceAction {
   ShowHistory = 'workspace-show-history',
   OpenInExplorer = 'workspace-open-in-explorer',
   Mount = 'workspace-mount',
+  UnMount = 'workspace-unmount',
   Favorite = 'workspace-favorite',
 }