refactor: main module (#2180)

Signed-off-by: Adam Setch <[email protected]>

Author: setchy

src/main/first-run.test.ts

@@ -0,0 +1,108 @@
+import path from 'node:path';
+
+// Mocks
+const existsSync = jest.fn();
+const mkdirSync = jest.fn();
+const writeFileSync = jest.fn();
+jest.mock('node:fs', () => ({
+  __esModule: true,
+  default: {
+    existsSync: (...a: unknown[]) => existsSync(...a),
+    mkdirSync: (...a: unknown[]) => mkdirSync(...a),
+    writeFileSync: (...a: unknown[]) => writeFileSync(...a),
+  },
+  existsSync: (...a: unknown[]) => existsSync(...a),
+  mkdirSync: (...a: unknown[]) => mkdirSync(...a),
+  writeFileSync: (...a: unknown[]) => writeFileSync(...a),
+}));
+
+const moveToApplicationsFolder = jest.fn();
+const isInApplicationsFolder = jest.fn(() => false);
+const getPath = jest.fn(() => '/User/Data');
+
+const showMessageBox = jest.fn(async () => ({ response: 0 }));
+
+jest.mock('electron', () => ({
+  app: {
+    getPath: () => getPath(),
+    isInApplicationsFolder: () => isInApplicationsFolder(),
+    moveToApplicationsFolder: () => moveToApplicationsFolder(),
+  },
+  dialog: { showMessageBox: () => showMessageBox() },
+}));
+
+const logError = jest.fn();
+jest.mock('../shared/logger', () => ({
+  logError: (...a: unknown[]) => logError(...a),
+}));
+
+let mac = true;
+jest.mock('../shared/platform', () => ({ isMacOS: () => mac }));
+
+import { APPLICATION } from '../shared/constants';
+
+import { onFirstRunMaybe } from './first-run';
+
+describe('main/first-run', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mac = true;
+  });
+
+  function configPath() {
+    return path.join('/User/Data', 'FirstRun', APPLICATION.FIRST_RUN_FOLDER);
+  }
+
+  it('creates first-run marker when not existing and returns true', async () => {
+    existsSync.mockReturnValueOnce(false); // marker absent
+    existsSync.mockReturnValueOnce(false); // folder absent
+    await onFirstRunMaybe();
+    expect(mkdirSync).toHaveBeenCalledWith(path.dirname(configPath()));
+    expect(writeFileSync).toHaveBeenCalledWith(configPath(), '');
+  });
+
+  it('skips writing when marker exists', async () => {
+    existsSync.mockReturnValueOnce(true); // marker present
+    await onFirstRunMaybe();
+    expect(writeFileSync).not.toHaveBeenCalled();
+    expect(mkdirSync).not.toHaveBeenCalled();
+  });
+
+  it('handles fs write error gracefully', async () => {
+    existsSync.mockReturnValueOnce(false); // marker absent
+    existsSync.mockReturnValueOnce(true); // folder exists
+    writeFileSync.mockImplementation(() => {
+      throw new Error('fail');
+    });
+    await onFirstRunMaybe();
+    expect(logError).toHaveBeenCalledWith(
+      'isFirstRun',
+      'Unable to write firstRun file',
+      expect.any(Error),
+    );
+  });
+
+  it('prompts and moves app on macOS when user accepts', async () => {
+    existsSync.mockReturnValueOnce(false); // marker
+    existsSync.mockReturnValueOnce(false); // folder
+    showMessageBox.mockResolvedValueOnce({ response: 0 });
+    await onFirstRunMaybe();
+    expect(moveToApplicationsFolder).toHaveBeenCalled();
+  });
+
+  it('does not move when user declines', async () => {
+    existsSync.mockReturnValueOnce(false);
+    existsSync.mockReturnValueOnce(false);
+    showMessageBox.mockResolvedValueOnce({ response: 1 });
+    await onFirstRunMaybe();
+    expect(moveToApplicationsFolder).not.toHaveBeenCalled();
+  });
+
+  it('skips prompt on non-macOS', async () => {
+    mac = false;
+    existsSync.mockReturnValueOnce(false);
+    existsSync.mockReturnValueOnce(false);
+    await onFirstRunMaybe();
+    expect(showMessageBox).not.toHaveBeenCalled();
+  });
+});

src/main/first-run.ts

@@ -13,7 +13,9 @@ export async function onFirstRunMaybe() {
   }
 }
 
-// Ask user if the app should be moved to the applications folder.
+/**
+ * Ask user if the app should be moved to the applications folder (masOS).
+ */
 async function promptMoveToApplicationsFolder() {
   if (!isMacOS()) return;
 
@@ -37,7 +39,10 @@ const getConfigPath = () => {
   return path.join(userDataPath, 'FirstRun', APPLICATION.FIRST_RUN_FOLDER);
 };
 
-// Whether or not the app is being run for the first time.
+/**
+ * Determine if this is the first run of the application by checking for the existence of a specific file.
+ * @returns true if this is the first run, false otherwise
+ */
 function isFirstRun() {
   const configPath = getConfigPath();