Merge branch 'main' into refactor/primer-design-system

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

Author: setchy

README.md

@@ -1,6 +1,6 @@
 # Gitify 
 
-[![Build Workflow][build-workflow-badge]][github-actions] [![Release Workflow][release-workflow-badge]][github-actions] [![Coveralls][coveralls-badge]][coveralls] [![Renovate enabled][renovate-badge]][renovate] [![Libraries.io dependency status][librariesio-badge]][librariesio] [![Contributors][contributors-badge]][github] [![Downloads - Total][downloads-total-badge]][website] [![Downloads - Latest Release][downloads-latest-badge]][website] [![OSS License][license-badge]][license] [![Latest Release][github-release-badge]][github-releases] [![Homebrew Cask][homebrew-cask-badge]][homebrew-cask]
+[![CI Workflow][ci-workflow-badge]][github-actions] [![Release Workflow][release-workflow-badge]][github-actions] [![Coveralls][coveralls-badge]][coveralls] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![Downloads - Total][downloads-total-badge]][website] [![Downloads - Latest Release][downloads-latest-badge]][website] [![OSS License][license-badge]][license] [![Latest Release][github-release-badge]][github-releases] [![Homebrew Cask][homebrew-cask-badge]][homebrew-cask]
 
 > GitHub Notifications on your menu bar. Available on macOS, Windows and Linux.
 
@@ -33,22 +33,22 @@ For more information, see [LICENSE](LICENSE).
 <!-- LINK LABELS -->
 [website]: https://www.gitify.io
 [faqs]: https://www.gitify.io/faq/
+
 [github]: https://github.com/gitify-app/gitify
 [github-actions]: https://github.com/gitify-app/gitify/actions
 [github-releases]: https://github.com/gitify-app/gitify/releases/latest
 [github-website]: https://github.com/gitify-app/website
 [github-website-pulls]: https://github.com/gitify-app/website/pulls
 [brew]: https://brew.sh/
 [homebrew-cask]: https://formulae.brew.sh/cask/gitify
+
 [coveralls]: https://coveralls.io/github/gitify-app/gitify
 [coveralls-badge]: https://img.shields.io/coverallsCoverage/github/gitify-app/gitify?logo=coveralls
-[build-workflow-badge]: https://github.com/gitify-app/gitify/actions/workflows/build.yml/badge.svg
+[ci-workflow-badge]: https://github.com/gitify-app/gitify/actions/workflows/ci.yml/badge.svg
 [release-workflow-badge]: https://github.com/gitify-app/gitify/actions/workflows/release.yml/badge.svg
 [downloads-total-badge]: https://img.shields.io/github/downloads/gitify-app/gitify/total?label=downloads@all&logo=github
 [downloads-latest-badge]: https://img.shields.io/github/downloads/gitify-app/gitify/latest/total?logo=github
 [contributors-badge]: https://img.shields.io/github/contributors/gitify-app/gitify?logo=github
-[librariesio]: https://libraries.io/
-[librariesio-badge]: https://img.shields.io/librariesio/github/gitify-app/gitify?logo=librariesdotio
 [license]: LICENSE
 [license-badge]: https://img.shields.io/github/license/gitify-app/gitify?logo=github
 [github-release-badge]: https://img.shields.io/github/v/release/gitify-app/gitify?logo=github

package.json

@@ -65,7 +65,7 @@
   "bugs": {
     "url": "https://github.com/gitify-app/gitify/issues"
   },
-  "homepage": "https://www.gitify.io/",
+  "homepage": "https://gitify.io/",
   "build": {
     "productName": "Gitify",
     "appId": "com.electron.gitify",
@@ -132,7 +132,7 @@
     "menubar": "9.5.1",
     "react": "19.0.0",
     "react-dom": "19.0.0",
-    "react-router-dom": "7.1.1",
+    "react-router-dom": "7.1.3",
     "update-electron-app": "3.1.0"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -2,7 +2,9 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { app, dialog } from 'electron';
 
+import { APPLICATION } from '../shared/constants';
 import { logError } from '../shared/logger';
+import { isMacOS } from '../shared/platform';
 
 export async function onFirstRunMaybe() {
   if (isFirstRun()) {
@@ -12,7 +14,7 @@ export async function onFirstRunMaybe() {
 
 // Ask user if the app should be moved to the applications folder.
 async function promptMoveToApplicationsFolder() {
-  if (process.platform !== 'darwin') return;
+  if (!isMacOS()) return;
 
   const isDevMode = !!process.defaultApp;
   if (isDevMode || app.isInApplicationsFolder()) return;
@@ -31,7 +33,7 @@ async function promptMoveToApplicationsFolder() {
 
 const getConfigPath = () => {
   const userDataPath = app.getPath('userData');
-  return path.join(userDataPath, 'FirstRun', 'gitify-first-run');
+  return path.join(userDataPath, 'FirstRun', APPLICATION.FIRST_RUN_FOLDER);
 };
 
 // Whether or not the app is being run for the first time.

src/main/first-run.ts

@@ -2,6 +2,9 @@ import { app, globalShortcut, ipcMain as ipc, nativeTheme } from 'electron';
 import log from 'electron-log';
 import { menubar } from 'menubar';
 
+import { APPLICATION } from '../shared/constants';
+import { namespacedEvent } from '../shared/events';
+import { isMacOS, isWindows } from '../shared/platform';
 import { onFirstRunMaybe } from './first-run';
 import { TrayIcons } from './icons';
 import MenuBuilder from './menu';
@@ -38,8 +41,9 @@ const contextMenu = menuBuilder.buildMenu();
  * Electron Auto Updater only supports macOS and Windows
  * https://github.com/electron/update-electron-app
  */
-if (process.platform === 'darwin' || process.platform === 'win32') {
-  new Updater(mb, menuBuilder);
+if (isMacOS() || isWindows()) {
+  const updater = new Updater(mb, menuBuilder);
+  updater.initialize();
 }
 
 let shouldUseAlternateIdleIcon = false;
@@ -48,7 +52,7 @@ app.whenReady().then(async () => {
   await onFirstRunMaybe();
 
   mb.on('ready', () => {
-    mb.app.setAppUserModelId('com.electron.gitify');
+    mb.app.setAppUserModelId(APPLICATION.ID);
 
     /**
      * TODO: Remove @electron/remote use - see #650
@@ -58,7 +62,7 @@ app.whenReady().then(async () => {
     require('@electron/remote/main').enable(mb.window.webContents);
 
     // Tray configuration
-    mb.tray.setToolTip('Gitify');
+    mb.tray.setToolTip(APPLICATION.NAME);
     mb.tray.setIgnoreDoubleClickEvents(true);
     mb.tray.on('right-click', (_event, bounds) => {
       mb.tray.popUpContextMenu(contextMenu, { x: bounds.x, y: bounds.y });
@@ -90,63 +94,66 @@ app.whenReady().then(async () => {
 
   nativeTheme.on('updated', () => {
     if (nativeTheme.shouldUseDarkColors) {
-      mb.window.webContents.send('gitify:update-theme', 'DARK');
+      mb.window.webContents.send(namespacedEvent('update-theme'), 'DARK');
     } else {
-      mb.window.webContents.send('gitify:update-theme', 'LIGHT');
+      mb.window.webContents.send(namespacedEvent('update-theme'), 'LIGHT');
     }
   });
 
   /**
    * Gitify custom IPC events
    */
-  ipc.handle('gitify:version', () => app.getVersion());
+  ipc.handle(namespacedEvent('version'), () => app.getVersion());
 
-  ipc.on('gitify:window-show', () => mb.showWindow());
+  ipc.on(namespacedEvent('window-show'), () => mb.showWindow());
 
-  ipc.on('gitify:window-hide', () => mb.hideWindow());
+  ipc.on(namespacedEvent('window-hide'), () => mb.hideWindow());
 
-  ipc.on('gitify:quit', () => mb.app.quit());
+  ipc.on(namespacedEvent('quit'), () => mb.app.quit());
 
-  ipc.on('gitify:use-alternate-idle-icon', (_, useAlternateIdleIcon) => {
-    shouldUseAlternateIdleIcon = useAlternateIdleIcon;
-  });
+  ipc.on(
+    namespacedEvent('use-alternate-idle-icon'),
+    (_, useAlternateIdleIcon) => {
+      shouldUseAlternateIdleIcon = useAlternateIdleIcon;
+    },
+  );
 
-  ipc.on('gitify:icon-active', () => {
+  ipc.on(namespacedEvent('icon-active'), () => {
     if (!mb.tray.isDestroyed()) {
       mb.tray.setImage(
-        menuBuilder.isUpdateAvailableMenuVisible()
+        menuBuilder.isUpdateAvailable()
           ? TrayIcons.activeUpdateIcon
           : TrayIcons.active,
       );
     }
   });
 
-  ipc.on('gitify:icon-idle', () => {
+  ipc.on(namespacedEvent('icon-idle'), () => {
     if (!mb.tray.isDestroyed()) {
       if (shouldUseAlternateIdleIcon) {
         mb.tray.setImage(
-          menuBuilder.isUpdateAvailableMenuVisible()
+          menuBuilder.isUpdateAvailable()
             ? TrayIcons.idleAlternateUpdateIcon
             : TrayIcons.idleAlternate,
         );
       } else {
         mb.tray.setImage(
-          menuBuilder.isUpdateAvailableMenuVisible()
+          menuBuilder.isUpdateAvailable()
             ? TrayIcons.idleUpdateIcon
             : TrayIcons.idle,
         );
       }
     }
   });
 
-  ipc.on('gitify:update-title', (_, title) => {
+  ipc.on(namespacedEvent('update-title'), (_, title) => {
     if (!mb.tray.isDestroyed()) {
       mb.tray.setTitle(title);
     }
   });
 
   ipc.on(
-    'gitify:update-keyboard-shortcut',
+    namespacedEvent('update-keyboard-shortcut'),
     (_, { enabled, keyboardShortcut }) => {
       if (!enabled) {
         globalShortcut.unregister(keyboardShortcut);
@@ -163,7 +170,7 @@ app.whenReady().then(async () => {
     },
   );
 
-  ipc.on('gitify:update-auto-launch', (_, settings) => {
+  ipc.on(namespacedEvent('update-auto-launch'), (_, settings) => {
     app.setLoginItemSettings(settings);
   });
 });

src/main/main.ts

@@ -0,0 +1,99 @@
+import { Menu, MenuItem } from 'electron';
+import type { Menubar } from 'menubar';
+import MenuBuilder from './menu';
+
+jest.mock('electron', () => ({
+  Menu: {
+    buildFromTemplate: jest.fn(),
+  },
+  MenuItem: jest.fn(),
+}));
+
+describe('main/menu.ts', () => {
+  let menubar: Menubar;
+  let menuBuilder: MenuBuilder;
+
+  beforeEach(() => {
+    menuBuilder = new MenuBuilder(menubar);
+  });
+
+  it('should create menu items correctly', () => {
+    expect(MenuItem).toHaveBeenCalledWith({
+      label: 'Check for updates',
+      enabled: true,
+      click: expect.any(Function),
+    });
+
+    expect(MenuItem).toHaveBeenCalledWith({
+      label: 'No updates available',
+      enabled: false,
+      visible: false,
+    });
+
+    expect(MenuItem).toHaveBeenCalledWith({
+      label: 'An update is available',
+      enabled: false,
+      visible: false,
+    });
+
+    expect(MenuItem).toHaveBeenCalledWith({
+      label: 'Restart to install update',
+      enabled: true,
+      visible: false,
+      click: expect.any(Function),
+    });
+  });
+
+  it('should build menu correctly', () => {
+    menuBuilder.buildMenu();
+    expect(Menu.buildFromTemplate).toHaveBeenCalledWith(expect.any(Array));
+  });
+
+  it('should enable check for updates menu item', () => {
+    menuBuilder.setCheckForUpdatesMenuEnabled(true);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['checkForUpdatesMenuItem'].enabled).toBe(true);
+  });
+
+  it('should disable check for updates menu item', () => {
+    menuBuilder.setCheckForUpdatesMenuEnabled(false);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['checkForUpdatesMenuItem'].enabled).toBe(false);
+  });
+
+  it('should show no update available menu item', () => {
+    menuBuilder.setNoUpdateAvailableMenuVisibility(true);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['noUpdateAvailableMenuItem'].visible).toBe(true);
+  });
+
+  it('should hide no update available  menu item', () => {
+    menuBuilder.setNoUpdateAvailableMenuVisibility(false);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['noUpdateAvailableMenuItem'].visible).toBe(false);
+  });
+
+  it('should show update available menu item', () => {
+    menuBuilder.setUpdateAvailableMenuVisibility(true);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['updateAvailableMenuItem'].visible).toBe(true);
+  });
+
+  it('should hide update available menu item', () => {
+    menuBuilder.setUpdateAvailableMenuVisibility(false);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['updateAvailableMenuItem'].visible).toBe(false);
+  });
+
+  it('should show update ready for install menu item', () => {
+    menuBuilder.setUpdateReadyForInstallMenuVisibility(true);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['updateReadyForInstallMenuItem'].visible).toBe(true);
+  });
+
+  it('should show update ready for install menu item', () => {
+    menuBuilder.setUpdateReadyForInstallMenuVisibility(false);
+    // biome-ignore lint/complexity/useLiteralKeys: This is a test
+    expect(menuBuilder['updateReadyForInstallMenuItem'].visible).toBe(false);
+  });
+});