macos: disable spotlight

MacOS fixes

.github/workflows/test.yml

@@ -17,4 +17,8 @@ jobs:
     - run: yarn test
     - name: Install Nix
       uses: ./
+    - run: nix-env -iA cachix -f https://github.com/NixOS/nixpkgs/tarball/ab5863afada3c1b50fc43bf774b75ea71b287cde
+    - run: cat /etc/nix/nix.conf
+    # cachix should be available and be able to configure a cache
+    - run: cachix use cachix
     - run: nix-build test.nix

README.md

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - uses: cachix/install-nix-action@v3
+    - uses: cachix/install-nix-action@v6
     - run: nix-build
 ```
 

lib/create-darwin-volume.sh

@@ -0,0 +1,102 @@
+#!/usr/bin/env bash
+set -e
+
+root_disks() {
+    diskutil list -plist /
+}
+
+apfs_volumes_for() {
+    disk=$1
+    diskutil apfs list -plist "$disk"
+}
+
+disk_identifier() {
+    xpath "/plist/dict/key[text()='WholeDisks']/following-sibling::array[1]/string/text()" 2>/dev/null
+}
+
+volume_get() {
+    key=$1 i=$2
+    xpath "/plist/dict/array/dict/key[text()='Volumes']/following-sibling::array/dict[$i]/key[text()='$key']/following-sibling::string[1]/text()" 2> /dev/null
+}
+
+find_nix_volume() {
+    disk=$1
+    i=1
+    volumes=$(apfs_volumes_for "$disk")
+    while true; do
+        name=$(echo "$volumes" | volume_get "Name" "$i")
+        if [ -z "$name" ]; then
+            break
+        fi
+        case "$name" in
+            [Nn]ix*)
+                echo "$name"
+                break
+                ;;
+        esac
+        i=$((i+1))
+    done
+}
+
+test_fstab() {
+    grep -q "/nix" /etc/fstab 2>/dev/null
+}
+
+test_synthetic_conf() {
+    grep -q "^nix" /etc/synthetic.conf 2>/dev/null
+}
+
+test_nix() {
+    test -d "/nix"
+}
+
+main() {
+    (
+        echo ""
+        echo "     ------------------------------------------------------------------ "
+        echo "    | This installer will create a volume for the nix store and        |"
+        echo "    | configure it to mount at /nix.  Follow these steps to uninstall. |"
+        echo "     ------------------------------------------------------------------ "
+        echo ""
+        echo "  1. Remove the entry from fstab using 'sudo vifs'"
+        echo "  2. Destroy the data volume using 'diskutil apfs deleteVolume'"
+        echo "  3. Delete /etc/synthetic.conf"
+        echo ""
+    ) >&2
+
+    if [ -L "/nix" ]; then
+        echo "error: /nix is a symlink, please remove it or edit synthetic.conf (requires reboot)" >&2
+        echo "  /nix -> $(readlink "/nix")" >&2
+        exit 2
+    fi
+
+    if ! test_synthetic_conf; then
+        echo "Configuring /etc/synthetic.conf..." >&2
+        echo nix | sudo tee /etc/synthetic.conf
+        /System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util -B
+    fi
+
+    if ! test_nix; then
+        echo "Creating mountpoint for /nix..." >&2
+        sudo mkdir /nix
+    fi
+
+    disk=$(root_disks | disk_identifier)
+    volume=$(find_nix_volume "$disk")
+    if [ -z "$volume" ]; then
+        echo "Creating a Nix Store volume..." >&2
+        sudo diskutil apfs addVolume "$disk" APFS 'Nix Store' -mountpoint /nix
+        volume="Nix Store"
+    else
+        echo "Using existing '$volume' volume" >&2
+    fi
+
+    if ! test_fstab; then
+        echo "Configuring /etc/fstab..." >&2
+        label=$(echo "$volume" | sed 's/ /\\040/g')
+        printf "\$a\nLABEL=%s /nix apfs rw\n.\nwq\n" "$label" | EDITOR=ed sudo vifs
+        sudo defaults write /Library/Preferences/SystemConfiguration/autodiskmount AutomountDisksWithoutUserLogin -bool true
+    fi
+}
+
+main "$@"

lib/main.js

@@ -19,36 +19,48 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const exec = __importStar(require("@actions/exec"));
 const tc = __importStar(require("@actions/tool-cache"));
+const child_process_1 = require("child_process");
 const os_1 = require("os");
-const fs_1 = require("fs");
+const process_1 = require("process");
+const net_1 = require("net");
+function nixConf() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Workaround a segfault: https://github.com/NixOS/nix/issues/2733
+        yield exec.exec("sudo", ["mkdir", "-p", "/etc/nix"]);
+        yield exec.exec("sudo", ["sh", "-c", "echo http2 = false >> /etc/nix/nix.conf"]);
+        // Set jobs to number of cores
+        yield exec.exec("sudo", ["sh", "-c", "echo max-jobs = auto >> /etc/nix/nix.conf"]);
+        // Allow binary caches for runner user
+        yield exec.exec("sudo", ["sh", "-c", "echo trusted-users = root runner >> /etc/nix/nix.conf"]);
+    });
+}
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const home = os_1.homedir();
-            const { username } = os_1.userInfo();
             const PATH = process.env.PATH;
-            const INSTALL_PATH = '/opt/nix';
+            yield nixConf();
-            const CERTS_PATH = home + '/.nix-profile/etc/ssl/certs/ca-bundle.crt';
-            // Workaround a segfault: https://github.com/NixOS/nix/issues/2733
-            yield exec.exec("sudo", ["mkdir", "-p", "/etc/nix"]);
-            yield exec.exec("sudo", ["sh", "-c", "echo http2 = false >> /etc/nix/nix.conf"]);
-            // Set jobs to number of cores
-            yield exec.exec("sudo", ["sh", "-c", "echo max-jobs = auto >> /etc/nix/nix.conf"]);
             // Catalina workaround https://github.com/NixOS/nix/issues/2925
             if (os_1.type() == "Darwin") {
-                yield exec.exec("sudo", ["sh", "-c", `echo \"nix\t${INSTALL_PATH}\"  >> /etc/synthetic.conf`]);
+                child_process_1.execFileSync(`${__dirname}/create-darwin-volume.sh`, { stdio: 'inherit' });
-                yield exec.exec("sudo", ["sh", "-c", `mkdir -m 0755 ${INSTALL_PATH} && chown runner ${INSTALL_PATH}`]);
+                // Disable spotlight indexing of /nix to speed up performance
-                yield exec.exec("/System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util", ["-B"]);
+                yield exec.exec("sudo", ["mdutil", "-i", "off", "/nix"]);
-                core.exportVariable('NIX_IGNORE_SYMLINK_STORE', "1");
             }
-            // TODO: retry due to all the things that go wrong
+            // Needed due to multi-user being too defensive
+            core.exportVariable('ALLOW_PREEXISTING_INSTALLATION', "1");
+            // TODO: retry due to all the things that can go wrong
             const nixInstall = yield tc.downloadTool('https://nixos.org/nix/install');
-            yield exec.exec("sh", [nixInstall]);
+            yield exec.exec("sh", [nixInstall, "--daemon"]);
-            core.exportVariable('PATH', `${PATH}:${home}/.nix-profile/bin`);
+            // write nix.conf again as installation overwrites it, reload the daemon to pick up changes
-            core.exportVariable('NIX_PATH', `/nix/var/nix/profiles/per-user/${username}/channels`);
+            yield nixConf();
-            // macOS needs certificates hints
+            yield exec.exec("sudo", ["pkill", "-HUP", "nix-daemon"]);
-            if (fs_1.existsSync(CERTS_PATH)) {
+            // setup env
-                core.exportVariable('NIX_SSL_CERT_FILE', CERTS_PATH);
+            core.exportVariable('PATH', `${PATH}:/nix/var/nix/profiles/default/bin:/nix/var/nix/profiles/per-user/runner/profile/bin`);
+            core.exportVariable('NIX_PATH', `/nix/var/nix/profiles/per-user/root/channels`);
+            if (os_1.type() == "Darwin") {
+                // macOS needs certificates hints
+                core.exportVariable('NIX_SSL_CERT_FILE', '/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt');
+                // TODO: nc doesn't work correctly on macOS :(
+                yield awaitSocket();
             }
         }
         catch (error) {
@@ -57,4 +69,17 @@ function run() {
         }
     });
 }
+function awaitSocket() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const daemonSocket = net_1.createConnection({ path: '/nix/var/nix/daemon-socket/socket' });
+        daemonSocket.on('error', () => __awaiter(this, void 0, void 0, function* () {
+            console.log('Waiting for daemon socket to be available, reconnecting...');
+            yield new Promise(resolve => setTimeout(resolve, 500));
+            yield awaitSocket();
+        }));
+        daemonSocket.on('connect', () => {
+            process_1.exit(0);
+        });
+    });
+}
 run();

src/main.ts

@@ -1,17 +1,12 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 import * as tc from '@actions/tool-cache';
-import {homedir, userInfo, type} from 'os';
+import {execFileSync} from 'child_process';
-import {existsSync} from 'fs';
+import {type} from 'os';
-
+import {exit} from 'process';
-async function run() {
+import {createConnection} from 'net';
-  try {
-    const home = homedir();
-    const {username} = userInfo();
-    const PATH = process.env.PATH;  
-    const INSTALL_PATH = '/opt/nix';
-    const CERTS_PATH = home + '/.nix-profile/etc/ssl/certs/ca-bundle.crt';
 
+async function nixConf() {
     // Workaround a segfault: https://github.com/NixOS/nix/issues/2733
     await exec.exec("sudo", ["mkdir", "-p", "/etc/nix"]);
     await exec.exec("sudo", ["sh", "-c", "echo http2 = false >> /etc/nix/nix.conf"]);
@@ -19,23 +14,44 @@ async function run() {
     // Set jobs to number of cores
     await exec.exec("sudo", ["sh", "-c", "echo max-jobs = auto >> /etc/nix/nix.conf"]);
 
+    // Allow binary caches for runner user
+    await exec.exec("sudo", ["sh", "-c", "echo trusted-users = root runner >> /etc/nix/nix.conf"]);
+}
+
+async function run() {
+  try {
+    const PATH = process.env.PATH;
+ 
+    await nixConf();
+
     // Catalina workaround https://github.com/NixOS/nix/issues/2925
     if (type() == "Darwin") {
-      await exec.exec("sudo", ["sh", "-c", `echo \"nix\t${INSTALL_PATH}\"  >> /etc/synthetic.conf`]);
+      execFileSync(`${__dirname}/create-darwin-volume.sh`, { stdio: 'inherit' });
-      await exec.exec("sudo", ["sh", "-c", `mkdir -m 0755 ${INSTALL_PATH} && chown runner ${INSTALL_PATH}`]);
+
-      await exec.exec("/System/Library/Filesystems/apfs.fs/Contents/Resources/apfs.util", ["-B"]);
+      // Disable spotlight indexing of /nix to speed up performance
-      core.exportVariable('NIX_IGNORE_SYMLINK_STORE', "1");  
+      await exec.exec("sudo", ["mdutil", "-i", "off", "/nix"]);
     }
 
-    // TODO: retry due to all the things that go wrong
+    // Needed due to multi-user being too defensive
-    const nixInstall = await tc.downloadTool('https://nixos.org/nix/install');
+    core.exportVariable('ALLOW_PREEXISTING_INSTALLATION', "1"); 
-    await exec.exec("sh", [nixInstall]);
-    core.exportVariable('PATH', `${PATH}:${home}/.nix-profile/bin`)
-    core.exportVariable('NIX_PATH', `/nix/var/nix/profiles/per-user/${username}/channels`)
 
-    // macOS needs certificates hints
+    // TODO: retry due to all the things that can go wrong
-    if (existsSync(CERTS_PATH)) {
+    const nixInstall = await tc.downloadTool('https://nixos.org/nix/install');
-      core.exportVariable('NIX_SSL_CERT_FILE', CERTS_PATH);
+    await exec.exec("sh", [nixInstall, "--daemon"]);
+
+    // write nix.conf again as installation overwrites it, reload the daemon to pick up changes
+    await nixConf();
+    await exec.exec("sudo", ["pkill", "-HUP", "nix-daemon"]);
+
+    // setup env
+    core.exportVariable('PATH', `${PATH}:/nix/var/nix/profiles/default/bin:/nix/var/nix/profiles/per-user/runner/profile/bin`)
+    core.exportVariable('NIX_PATH', `/nix/var/nix/profiles/per-user/root/channels`)
+    if (type() == "Darwin") {
+      // macOS needs certificates hints
+      core.exportVariable('NIX_SSL_CERT_FILE', '/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt');
+
+      // TODO: nc doesn't work correctly on macOS :(
+      await awaitSocket();
     }
   } catch (error) {
     core.setFailed(`Action failed with error: ${error}`);
@@ -43,4 +59,16 @@ async function run() {
   }
 }
 
+async function awaitSocket() {
+  const daemonSocket = createConnection({ path: '/nix/var/nix/daemon-socket/socket' });
+  daemonSocket.on('error', async () => {
+    console.log('Waiting for daemon socket to be available, reconnecting...');
+    await new Promise(resolve => setTimeout(resolve, 500));
+    await awaitSocket();
+  });
+  daemonSocket.on('connect', () => {
+    exit(0);
+  });
+}
+
 run();