(Med.)[BFF-403] Add "Go to location" option to FileAccessContextMenu

packages/core/errors/FileNotFoundError.ts

@@ -0,0 +1,9 @@
+// Intended to be raised when a user attempts to open a local file path,
+//  but that file path is not available on their machine.
+export default class FileNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+
+        this.name = "FileNotFoundError";
+    }
+}

packages/core/errors/index.ts

@@ -1,3 +1,4 @@
 export { default as DownloadFailure } from "./DownloadFailure";
+export { default as FileNotFoundError } from "./FileNotFoundError";
 export { default as IndexError } from "./IndexError";
 export { default as ValueError } from "./ValueError";

packages/core/hooks/useFileAccessContextMenu.ts

@@ -1,4 +1,5 @@
 import { ContextualMenuItemType, IContextualMenuItem } from "@fluentui/react";
+import { isNil } from "lodash";
 import * as React from "react";
 import { useDispatch, useSelector } from "react-redux";
 
@@ -68,6 +69,24 @@ export default (filters?: FileFilter[], onDismiss?: () => void) => {
                         items: openWithSubMenuItems,
                     },
                 },
+                ...(isQueryingAicsFms && !isOnWeb
+                    ? [
+                          {
+                              key: "go-to-file-location",
+                              text: "Go to file location",
+                              title: "Show selected file in your native file browser",
+                              disabled: isNil(fileDetails?.localPath),
+                              iconProps: { iconName: "FolderOpen" },
+                              onClick() {
+                                  if (fileDetails) {
+                                      dispatch(
+                                          interaction.actions.openNativeFileBrowser(fileDetails)
+                                      );
+                                  }
+                              },
+                          },
+                      ]
+                    : []),
                 {
                     key: "save-as",
                     text: "Save metadata as",

packages/core/services/FileViewerService/FileViewerServiceNoop.ts

@@ -4,4 +4,8 @@ export default class FileViewerServiceNoop implements FileViewerService {
     public open() {
         return Promise.resolve();
     }
+
+    public openNativeFileBrowser(): void {
+        console.log("ExecutionEnvServiceNoop::openNativeFileBrowser");
+    }
 }

packages/core/services/FileViewerService/index.ts

@@ -1,3 +1,5 @@
+import FileDetail from "../../entity/FileDetail";
+
 /**
  * Interface that defines a platform-dependent service for showing files using other applications.
  */
@@ -9,6 +11,13 @@ export default interface FileViewerService {
      * @param filePaths The paths to the files to open
      */
     open(executablePath: string, filePaths: string[]): Promise<void>;
+
+    /**
+     * Opens the user's native file browser at a given path.
+     *
+     * @param fileDetails
+     */
+    openNativeFileBrowser(fileDetails: FileDetail): void;
 }
 
 /**

packages/core/state/interaction/actions.ts

@@ -470,6 +470,29 @@ export function showManifestDownloadDialog(
     };
 }
 
+/**
+ * OPEN_NATIVE_FILE_BROWSER
+ *
+ * Open the user's native file browser. Only works in desktop mode.
+ */
+export const OPEN_NATIVE_FILE_BROWSER = makeConstant(STATE_BRANCH_NAME, "open-native-file-browser");
+
+export interface OpenNativeFileBrowserAction {
+    type: string;
+    payload: {
+        fileDetails: FileDetail;
+    };
+}
+
+export function openNativeFileBrowser(fileDetails: FileDetail): OpenNativeFileBrowserAction {
+    return {
+        type: OPEN_NATIVE_FILE_BROWSER,
+        payload: {
+            fileDetails,
+        },
+    };
+}
+
 /**
  * PROMPT_FOR_NEW_EXECUTABLE
  *

packages/core/state/interaction/logics.ts

@@ -33,6 +33,8 @@ import {
     hideVisibleModal,
     CopyFilesAction,
     COPY_FILES,
+    OpenNativeFileBrowserAction,
+    OPEN_NATIVE_FILE_BROWSER,
 } from "./actions";
 import * as interactionSelectors from "./selectors";
 import { DownloadResolution, FileInfo } from "../../services/FileDownloadService";
@@ -664,11 +666,32 @@ const copyFilesLogic = createLogic({
     type: COPY_FILES,
 });
 
+const openNativeFileBrowser = createLogic({
+    async process(deps: ReduxLogicDeps, dispatch, done) {
+        const {
+            payload: { fileDetails },
+        } = deps.action as OpenNativeFileBrowserAction;
+        const { fileViewerService } = interactionSelectors.getPlatformDependentServices(
+            deps.getState()
+        );
+        try {
+            fileViewerService.openNativeFileBrowser(fileDetails);
+        } catch (err) {
+            const errorMsg = err instanceof Error ? err.message : String(err);
+            dispatch(processError("openNativeFileBrowserError", errorMsg));
+        } finally {
+            done();
+        }
+    },
+    type: OPEN_NATIVE_FILE_BROWSER,
+});
+
 export default [
     initializeApp,
     downloadManifest,
     cancelFileDownloadLogic,
     promptForNewExecutable,
+    openNativeFileBrowser,
     openWithDefault,
     openWithLogic,
     downloadFilesLogic,

packages/core/state/interaction/test/logics.test.ts

@@ -58,6 +58,10 @@ describe("Interaction logics", () => {
         open() {
             return Promise.resolve();
         }
+
+        openNativeFileBrowser(): void {
+            console.log("Not implemented");
+        }
     }
 
     class MockDatabaseService extends DatabaseServiceNoop {
@@ -1269,6 +1273,10 @@ describe("Interaction logics", () => {
                     actualExecutablePath = executablePath;
                     return Promise.resolve();
                 }
+
+                openNativeFileBrowser(): void {
+                    console.log("Not implemented");
+                }
             }
 
             class FakeExecutionEnvService extends ExecutionEnvServiceNoop {

packages/desktop/src/services/FileViewerServiceElectron.ts

@@ -7,6 +7,10 @@ import fijiViewerStrategy from "./file-viewer-strategy/fijiViewerStrategy";
 import ViewerStrategy from "./file-viewer-strategy/ViewerStrategy";
 import macViewerStrategy from "./file-viewer-strategy/macViewerStrategy";
 import systemDefaultViewerStrategy from "./file-viewer-strategy/systemDefaultViewerStrategy";
+import { FileNotFoundError } from "../../../core/errors";
+import { existsSync } from "fs";
+import FileDetail from "../../../core/entity/FileDetail";
+import { shell } from "electron";
 
 export default class FileViewerServiceElectron implements FileViewerService {
     private notificationService: NotificationServiceElectron;
@@ -44,4 +48,16 @@ export default class FileViewerServiceElectron implements FileViewerService {
             await reportErrorToUser(error);
         }
     }
+
+    // Open the user's native file browser at the localPath of the given file
+    public openNativeFileBrowser(fileDetails: FileDetail): void {
+        if (fileDetails.localPath) {
+            if (!existsSync(fileDetails.localPath)) {
+                throw new FileNotFoundError(
+                    `Cannot open "${fileDetails.localPath}". Is the path accessible?`
+                );
+            }
+            shell.showItemInFolder(fileDetails.localPath);
+        }
+    }
 }

packages/desktop/src/services/test/FileViewerServiceElectron.test.ts

@@ -1,11 +1,15 @@
 import childProcess from "child_process";
 
+import * as fs from "fs";
+
 import { expect } from "chai";
-import { createSandbox } from "sinon";
+import { createSandbox, SinonStub, stub } from "sinon";
 
 import FileViewerServiceElectron from "../FileViewerServiceElectron";
 import NotificationServiceElectron from "../NotificationServiceElectron";
-import { RUN_IN_RENDERER } from "../../util/constants";
+import { Environment, RUN_IN_RENDERER } from "../../util/constants";
+import FileDetail from "../../../../core/entity/FileDetail";
+import { FileNotFoundError } from "../../../../core/errors";
 
 describe(`${RUN_IN_RENDERER} FileViewerServiceElectron`, () => {
     const sandbox = createSandbox();
@@ -69,4 +73,41 @@ describe(`${RUN_IN_RENDERER} FileViewerServiceElectron`, () => {
             expect(attemptedToShowError).to.be.true;
         });
     });
+
+    describe("openNativeFileBrowser", () => {
+        let existsSyncStub: SinonStub;
+
+        before(() => {
+            existsSyncStub = stub(fs, "existsSync");
+        });
+
+        after(() => {
+            existsSyncStub.restore();
+        });
+
+        it("throws an error if file path does not exist", () => {
+            // Arrange
+            existsSyncStub.returns(false);
+
+            const service = new FileViewerServiceElectron(new UselessNotificationService());
+
+            const fileDetail = new FileDetail(
+                {
+                    annotations: [
+                        {
+                            name: "Cache Eviction Date",
+                            values: ["2000-01-01"],
+                        },
+                    ],
+                    file_path: "/allen/aics/path/to/file.txt",
+                },
+                Environment.TEST
+            );
+
+            // Act + Assert
+            expect(() => {
+                service.openNativeFileBrowser(fileDetail);
+            }).to.throw(FileNotFoundError);
+        });
+    });
 });

packages/web/src/services/FileViewerServiceWeb.ts

@@ -4,4 +4,8 @@ export default class FileViewerServiceWeb implements FileViewerService {
     public async open(): Promise<void> {
         throw new Error("FileViewerServiceWeb::open is not yet implemented");
     }
+
+    public openNativeFileBrowser(): void {
+        throw Error("ExecutionEnvServiceWeb::openNativeFileBrowser not yet implemented");
+    }
 }

packages/web/src/services/test/FileViewerServiceWeb.test.ts

@@ -18,4 +18,20 @@ describe("FileViewerServiceWeb", () => {
             }
         });
     });
+
+    describe("openNativeFileBrowser", () => {
+        it("throws error (not implemented)", () => {
+            // Arrange
+            const service = new FileViewerServiceWeb();
+
+            // Act / Assert
+            try {
+                service.openNativeFileBrowser();
+            } catch (error) {
+                expect((error as Error).message).to.equal(
+                    "ExecutionEnvServiceWeb::openNativeFileBrowser not yet implemented"
+                );
+            }
+        });
+    });
 });