feat(desktop): control macOS dock icon visibility (#1053)

Author: aanorbel

.github/workflows/build_native_libraries.yml

@@ -23,8 +23,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Setup
-        uses: ./.github/actions/setup
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
 
       - name: Install dependencies (Linux)
         if: runner.os == 'Linux'

buildSrc/src/main/kotlin/TaskRegistration.kt

@@ -50,12 +50,10 @@ private fun Project.registerDesktopTasks() {
         dependsOn("setupSparkle")
         workingDir = file("src/desktopMain")
         commandLine = listOf("make", "all")
-        doFirst {
-            println("🔨 Building native libraries...")
-        }
-        doLast {
-            println("✅ Native libraries built successfully")
-        }
+
+        inputs.files(fileTree("src/desktopMain/c") {
+            include("*.m", "*.c")
+        })
     }
 
     tasks.register("cleanLibrary", Exec::class) {

composeApp/build.gradle.kts

@@ -385,8 +385,6 @@ compose.desktop {
                 entitlementsFile.set(project.file("OONIProbe.entitlements"))
                 infoPlist {
                     extraKeysRawXml = """
-                        <key>LSUIElement</key>
-                        <string>true</string>
                         <key>CFBundleURLTypes</key>
                         <array>
                             <dict>

composeApp/src/desktopMain/Makefile

@@ -1,16 +1,19 @@
-# Makefile for NetworkTypeFinder and UpdateBridge JNI Bridges
+# Makefile for NetworkTypeFinder, UpdateBridge, and MacDockVisibility JNI Bridges
 
 # Variables
 COMPILER = clang
 NETWORK_FILES = c/NetworkTypeFinder.m
 UPDATE_FILES_MAC = c/UpdateBridge.c c/SparkeBridge.m
 UPDATE_FILES_WIN = c/UpdateBridge.c c/WinSparkleBridge.c
+MACDOCK_FILES = c/MacDockVisibility.m
 NETWORK_LIBRARY_NAME = networktypefinder
 UPDATE_LIBRARY_NAME = updatebridge
+MACDOCK_LIBRARY_NAME = macdockvisibility
 NETWORK_LIBRARY_FILE_MAC = lib$(NETWORK_LIBRARY_NAME).dylib
 NETWORK_LIBRARY_FILE_LINUX = lib$(NETWORK_LIBRARY_NAME).so
 UPDATE_LIBRARY_FILE_MAC = lib$(UPDATE_LIBRARY_NAME).dylib
 UPDATE_LIBRARY_FILE_WIN = $(UPDATE_LIBRARY_NAME).dll
+MACDOCK_LIBRARY_FILE_MAC = lib$(MACDOCK_LIBRARY_NAME).dylib
 JAVA_HOME ?= $(shell java -XshowSettings:properties -version 2>&1 > /dev/null | grep 'java.home' | awk '{print $$3}')
 RESOURCES_BASE_DIR = resources
 
@@ -64,13 +67,22 @@ macos:
 	# Fix Sparkle framework reference to use @loader_path
 	install_name_tool -change "@rpath/Sparkle.framework/Versions/B/Sparkle" "@loader_path/Sparkle.framework/Versions/B/Sparkle" $(RESOURCES_BASE_DIR)/macos/$(UPDATE_LIBRARY_FILE_MAC)
 	@echo "UpdateBridge library created at $(RESOURCES_BASE_DIR)/macos/$(UPDATE_LIBRARY_FILE_MAC)"
+	@echo "Compiling MacDockVisibility for macOS..."
+	@mkdir -p $(RESOURCES_BASE_DIR)/macos
+	$(COMPILER) -dynamiclib -o $(RESOURCES_BASE_DIR)/macos/$(MACDOCK_LIBRARY_FILE_MAC) $(MACDOCK_FILES) \
+		-framework Cocoa \
+		-framework Foundation \
+		-I$(JAVA_HOME)/include \
+		-I$(JAVA_HOME)/include/darwin
+	@echo "MacDockVisibility library created at $(RESOURCES_BASE_DIR)/macos/$(MACDOCK_LIBRARY_FILE_MAC)"
 
 linux:
 	@echo "Compiling NetworkTypeFinder for Linux..."
 	@mkdir -p $(RESOURCES_BASE_DIR)/linux
 	$(COMPILER) -shared -fPIC -o $(RESOURCES_BASE_DIR)/linux/$(NETWORK_LIBRARY_FILE_LINUX) $(NETWORK_FILES) -I$(JAVA_HOME)/include -I$(JAVA_HOME)/include/linux
 	@echo "NetworkTypeFinder library created at $(RESOURCES_BASE_DIR)/linux/$(NETWORK_LIBRARY_FILE_LINUX)"
 	@echo "UpdateBridge not supported on Linux"
+	@echo "MacDockVisibility not supported on Linux"
 
 windows:
 	@echo "Compiling NetworkTypeFinder for Windows..."
@@ -80,13 +92,15 @@ windows:
 	@echo "Compiling UpdateBridge for Windows..."
 	$(COMPILER) -shared -m64 -o $(RESOURCES_BASE_DIR)/windows/$(UPDATE_LIBRARY_FILE_WIN) $(UPDATE_FILES_WIN) '-I$(JAVA_HOME)\\include' '-I$(JAVA_HOME)\\include\\win32'
 	@echo "UpdateBridge library created at $(RESOURCES_BASE_DIR)/windows/$(UPDATE_LIBRARY_FILE_WIN)"
+	@echo "MacDockVisibility not supported on Windows"
 
 # Install the library to system path
 install: all
 	@echo "Installing libraries to system path..."
 ifeq ($(PLATFORM_TARGET),macos)
 	cp $(RESOURCES_BASE_DIR)/macos/$(NETWORK_LIBRARY_FILE_MAC) $(HOME)/Library/Java/Extensions
 	cp $(RESOURCES_BASE_DIR)/macos/$(UPDATE_LIBRARY_FILE_MAC) $(HOME)/Library/Java/Extensions
+	cp $(RESOURCES_BASE_DIR)/macos/$(MACDOCK_LIBRARY_FILE_MAC) $(HOME)/Library/Java/Extensions
 else ifeq ($(PLATFORM_TARGET),linux)
 	sudo cp $(RESOURCES_BASE_DIR)/linux/$(NETWORK_LIBRARY_FILE_LINUX) /usr/lib/
 else ifeq ($(PLATFORM_TARGET),windows)
@@ -112,17 +126,18 @@ clean:
 	@echo "Clean complete"
 
 help:
-	@echo "NetworkTypeFinder and UpdateBridge JNI Bridges Makefile"
+	@echo "NetworkTypeFinder, UpdateBridge, and MacDockVisibility JNI Bridges Makefile"
 	@echo ""
 	@echo "Targets:"
-	@echo "  all (default): Compile both libraries for the current platform"
+	@echo "  all (default): Compile all libraries for the current platform"
 	@echo "  install: Install the libraries to system path for the current platform"
 	@echo "  clean: Clean build artifacts"
 	@echo "  help: Show this help message"
 	@echo ""
 	@echo "Libraries built:"
 	@echo "  NetworkTypeFinder: Network type detection"
 	@echo "  UpdateBridge: Sparkle (macOS) / WinSparkle (Windows) integration"
+	@echo "  MacDockVisibility: macOS dock icon visibility control"
 	@echo ""
 	@echo "Example usage:"
 	@echo "  make all      # Compile the libraries for your platform"

composeApp/src/desktopMain/c/MacDockVisibility.m

@@ -0,0 +1,24 @@
+#include <jni.h>
+#import <Cocoa/Cocoa.h>
+
+// JNI function to show the app in dock (NSApp.setActivationPolicy(.regular))
+JNIEXPORT void JNICALL Java_org_ooni_probe_shared_MacDockVisibility_showInDockNative
+  (JNIEnv *env, jclass cls) {
+    @autoreleasepool {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular];
+            NSLog(@"MacDockVisibility: Set activation policy to Regular (show in dock)");
+        });
+    }
+}
+
+// JNI function to remove the app from dock (NSApp.setActivationPolicy(.accessory))
+JNIEXPORT void JNICALL Java_org_ooni_probe_shared_MacDockVisibility_removeFromDockNative
+  (JNIEnv *env, jclass cls) {
+    @autoreleasepool {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [NSApp setActivationPolicy:NSApplicationActivationPolicyAccessory];
+            NSLog(@"MacDockVisibility: Set activation policy to Accessory (remove from dock)");
+        });
+    }
+}

composeApp/src/desktopMain/kotlin/org/ooni/probe/Main.kt

@@ -49,6 +49,7 @@ import org.ooni.probe.shared.DeepLinkParser
 import org.ooni.probe.shared.DesktopOS
 import org.ooni.probe.shared.createUpdateManager
 import org.ooni.probe.shared.InstanceManager
+import org.ooni.probe.shared.MacDockVisibility
 import org.ooni.probe.shared.Platform
 import org.ooni.probe.shared.UpdateState
 import org.ooni.probe.update.DesktopUpdateController
@@ -85,6 +86,9 @@ fun main(args: Array<String>) {
         // Register shutdown callback for update installation when applicable
         updateController.registerShutdownHandler(this)
         var isWindowVisible by remember { mutableStateOf(!autoLaunch.isStartedViaAutostart()) }
+
+        // Set initial dock visibility based on window visibility
+        MacDockVisibility.setDockIconVisible(isWindowVisible)
         val trayIcon = trayIcon()
         val deepLink by deepLinkFlow.collectAsState(null)
         val runBackgroundState by dependencies.runBackgroundStateManager
@@ -97,6 +101,7 @@ fun main(args: Array<String>) {
 
         fun showWindow() {
             isWindowVisible = true
+            MacDockVisibility.showDockIcon()
             if (Desktop.isDesktopSupported() &&
                 Desktop
                     .getDesktop()
@@ -107,7 +112,10 @@ fun main(args: Array<String>) {
         }
 
         Window(
-            onCloseRequest = { isWindowVisible = false },
+            onCloseRequest = {
+                isWindowVisible = false
+                MacDockVisibility.hideDockIcon()
+            },
             visible = isWindowVisible,
             icon = painterResource(Res.drawable.ooni_colored_logo),
             title = stringResource(Res.string.app_name),

composeApp/src/desktopMain/kotlin/org/ooni/probe/shared/MacDockVisibility.kt

@@ -0,0 +1,99 @@
+package org.ooni.probe.shared
+
+import co.touchlab.kermit.Logger
+import org.ooni.probe.platform
+import org.ooni.shared.loadNativeLibrary
+
+/**
+ * Utility for controlling macOS dock icon visibility using JNI.
+ * Calls native macOS functions through NSApp.setActivationPolicy.
+ */
+object MacDockVisibility {
+    private var isNativeLibraryLoaded = false
+
+    init {
+        if (isMacOS()) {
+            loadNativeLibrary()
+        }
+    }
+
+    /**
+     * Shows the dock icon (makes app visible in dock)
+     * Calls native: NSApp.setActivationPolicy(.regular)
+     */
+    fun showDockIcon() {
+        if (!isMacOS()) {
+            Logger.d("MacDockVisibility: Not on macOS, skipping dock icon show")
+            return
+        }
+
+        if (!isNativeLibraryLoaded) {
+            Logger.w("MacDockVisibility: Native library not loaded, cannot show dock icon")
+            return
+        }
+
+        try {
+            showInDockNative()
+            Logger.d("MacDockVisibility: Successfully showed dock icon via JNI")
+        } catch (e: Exception) {
+            Logger.w("MacDockVisibility: Failed to show dock icon via JNI", e)
+        }
+    }
+
+    /**
+     * Hides the dock icon (makes app invisible in dock)
+     * Calls native: NSApp.setActivationPolicy(.accessory)
+     */
+    fun hideDockIcon() {
+        if (!isMacOS()) {
+            Logger.d("MacDockVisibility: Not on macOS, skipping dock icon hide")
+            return
+        }
+
+        if (!isNativeLibraryLoaded) {
+            Logger.w("MacDockVisibility: Native library not loaded, cannot hide dock icon")
+            return
+        }
+
+        try {
+            removeFromDockNative()
+            Logger.d("MacDockVisibility: Successfully hid dock icon via JNI")
+        } catch (e: Exception) {
+            Logger.w("MacDockVisibility: Failed to hide dock icon via JNI", e)
+        }
+    }
+
+    /**
+     * Sets the dock icon visibility based on window visibility
+     */
+    fun setDockIconVisible(visible: Boolean) {
+        if (visible) {
+            showDockIcon()
+        } else {
+            hideDockIcon()
+        }
+    }
+
+    private fun isMacOS(): Boolean = platform.os == DesktopOS.Mac
+
+    private fun loadNativeLibrary() {
+        try {
+            isNativeLibraryLoaded = loadNativeLibrary("macdockvisibility")
+            if (isNativeLibraryLoaded) {
+                Logger.d("MacDockVisibility: Successfully loaded native library")
+            } else {
+                Logger.w("MacDockVisibility: Failed to load native library")
+            }
+        } catch (e: Exception) {
+            Logger.w("MacDockVisibility: Exception while loading native library", e)
+            isNativeLibraryLoaded = false
+        }
+    }
+
+    // JNI native method declarations
+    @JvmStatic
+    private external fun showInDockNative()
+
+    @JvmStatic
+    private external fun removeFromDockNative()
+}