NPM Global Modules Ownership and macOS Tests (#2)

Author: michaelahern

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-macos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24.x
+      - run: npm install -g matterbridge
+      - run: npm ci
+      - run: npm link matterbridge
+      - run: npm run build
+      - run: npm link
+      - run: sudo chown -R root:wheel "$(npm prefix -g --silent)/lib/node_modules"
+      - run: sudo mb-service install
+      - run: mb-service pid
+      - run: launchctl print system/com.matterbridge
+      - run: sleep 10 && curl http://localhost:8283/
+      - run: test -w "$(npm prefix -g --silent)/lib/node_modules"
+      - run: sudo mb-service uninstall

README.md

@@ -5,7 +5,7 @@ A service management command-line utility for [Matterbridge](https://github.com/
 _This is currently experimental and only supports macOS with a default configuration at the moment!_
 
 ```
-% npm -g install matterbridge
+% npm install -g matterbridge
 % git clone https://github.com/michaelahern/mb-service.git
 % cd mb-service
 % npm install

src/mac.ts

@@ -13,22 +13,41 @@ export class MacPlatform extends PlatformCommands {
         this.#checkRoot();
         const userInfo = this.#getUserInfo();
 
-        const pluginPath = resolve(userInfo.homedir, 'Matterbridge');
-        const storagePath = resolve(userInfo.homedir, '.matterbridge');
-
-        mkdirSync(pluginPath, { recursive: true });
-        mkdirSync(storagePath, { recursive: true });
-
-        chownSync(pluginPath, userInfo.uid, userInfo.gid);
-        chownSync(storagePath, userInfo.uid, userInfo.gid);
-
+        // Check if Matterbridge is installed globally
         const matterbridgePath = execSync('eval echo "$(npm prefix -g --silent)/bin/matterbridge"').toString().trim();
         if (!existsSync(matterbridgePath)) {
             console.error('Matterbridge is not installed globally!');
             console.error('npm install -g matterbridge');
             process.exit(1);
         }
 
+        // Create Matterbridge Plugin and Storage directories
+        const matterbridgePluginPath = resolve(userInfo.homedir, 'Matterbridge');
+        this.#mkdirPath(matterbridgePluginPath, userInfo);
+
+        const matterbridgeStoragePath = resolve(userInfo.homedir, '.matterbridge');
+        this.#mkdirPath(matterbridgeStoragePath, userInfo);
+
+        // Check NPM global modules path permissions and change if necessary
+        const npmGlobalModulesPath = execSync('eval echo "$(npm prefix -g --silent)/lib/node_modules"').toString().trim();
+        try {
+            execSync(`eval test -w "${npmGlobalModulesPath}"`, {
+                uid: userInfo.uid,
+                gid: userInfo.gid
+            });
+        }
+        catch {
+            try {
+                execSync(`chown -R ${userInfo.uid}:${userInfo.gid} "${npmGlobalModulesPath}"`);
+            }
+            catch {
+                console.error('User not able to write to the NPM Global Modules Path!');
+                console.error(`sudo chown -R ${userInfo.uid}:${userInfo.gid} "${npmGlobalModulesPath}"`);
+                process.exit(1);
+            }
+        }
+
+        // Create the launchd plist file
         const plistFileContents = [
             '<?xml version="1.0" encoding="UTF-8"?>',
             '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">',
@@ -55,9 +74,9 @@ export class MacPlatform extends PlatformCommands {
             `        <string>${process.env.PATH}</string>`,
             '    </dict>',
             '    <key>StandardOutPath</key>',
-            `    <string>${storagePath}/matterbridge.log</string>`,
+            `    <string>${matterbridgeStoragePath}/matterbridge.log</string>`,
             '    <key>StandardErrorPath</key>',
-            `    <string>${storagePath}/matterbridge.log</string>`,
+            `    <string>${matterbridgeStoragePath}/matterbridge.log</string>`,
             '</dict>',
             '</plist>'
         ].filter(x => x).join('\n');
@@ -123,8 +142,8 @@ export class MacPlatform extends PlatformCommands {
     }
 
     tail(): void {
-        const storagePath = resolve(this.#getUserInfo().homedir, '.matterbridge');
-        execFileSync('tail', ['-f', '-n', '32', `${storagePath}/matterbridge.log`], { stdio: 'inherit' });
+        const matterbridgeStoragePath = resolve(this.#getUserInfo().homedir, '.matterbridge');
+        execFileSync('tail', ['-f', '-n', '32', `${matterbridgeStoragePath}/matterbridge.log`], { stdio: 'inherit' });
     }
 
     #checkRoot() {
@@ -152,4 +171,9 @@ export class MacPlatform extends PlatformCommands {
     #isInstalled(): boolean {
         return existsSync(this.#plist);
     }
+
+    #mkdirPath(path: string, userInfo: UserInfo<string>): void {
+        mkdirSync(path, { recursive: true });
+        chownSync(path, userInfo.uid, userInfo.gid);
+    }
 }