feat: improve local dev with install path

elibosley · elibosley · commit 236e29ed21fb · 2025-03-13T10:29:07.000-04:00
- also add better watcher support
diff --git a/plugin/.env.example b/plugin/.env.example
@@ -2,5 +2,3 @@
 PR=35
 # Skip validation (default: true for local testing)
 SKIP_VALIDATION=true
-# Local file server URL (optional)
-LOCAL_FILESERVER_URL=http://192.168.1.100:8080
diff --git a/plugin/Dockerfile b/plugin/Dockerfile
@@ -23,8 +23,8 @@ RUN corepack enable && pnpm install
 # Install a simple http server
 RUN npm install -g http-server
 
-# Expose port 8080
-EXPOSE 8080
+# Expose port 5858
+EXPOSE 5858
 
 COPY scripts/entrypoint.sh /start.sh
 RUN chmod +x /start.sh
diff --git a/plugin/builder/build-txz.ts b/plugin/builder/build-txz.ts
@@ -8,22 +8,35 @@ import { cleanupTxzFiles } from "./utils/cleanup";
 
 // Recursively search for manifest files
 const findManifestFiles = async (dir: string): Promise<string[]> => {
-  const entries = await readdir(dir, { withFileTypes: true });
-  const files: string[] = [];
+  try {
+    const entries = await readdir(dir, { withFileTypes: true });
+    const files: string[] = [];
 
-  for (const entry of entries) {
-    const fullPath = join(dir, entry.name);
-    if (entry.isDirectory()) {
-      files.push(...(await findManifestFiles(fullPath)));
-    } else if (
-      entry.isFile() &&
-      (entry.name === "manifest.json" || entry.name === "ui.manifest.json")
-    ) {
-      files.push(entry.name);
+    for (const entry of entries) {
+      const fullPath = join(dir, entry.name);
+      if (entry.isDirectory()) {
+        try {
+          files.push(...(await findManifestFiles(fullPath)));
+        } catch (error) {
+          // Log and continue if a subdirectory can't be read
+          console.warn(`Warning: Could not read directory ${fullPath}: ${error.message}`);
+        }
+      } else if (
+        entry.isFile() &&
+        (entry.name === "manifest.json" || entry.name === "ui.manifest.json")
+      ) {
+        files.push(entry.name);
+      }
     }
-  }
 
-  return files;
+    return files;
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      console.warn(`Directory does not exist: ${dir}`);
+      return [];
+    }
+    throw error; // Re-throw other errors
+  }
 };
 
 const validateSourceDir = async (validatedEnv: TxzEnv) => {
diff --git a/plugin/docker-compose.yml b/plugin/docker-compose.yml
@@ -1,7 +1,7 @@
 services:
   plugin-builder:
     ports:
-      - 8080:8080
+      - 5858:5858
     build: .
     volumes:
       - ./:/app
diff --git a/plugin/package.json b/plugin/package.json
@@ -17,11 +17,11 @@
   "license": "GPL-2.0-only",
   "scripts": {
     "// Build scripts": "",
-    "build": "pnpm run build:txz && pnpm run build:plugin",
+    "build": "pnpm run build:txz && pnpm run build:plugin && ./scripts/output-local-url.sh",
     "build:txz": "tsx builder/build-txz.ts",
     "build:plugin": "tsx builder/build-plugin.ts",
     "build:validate": "npm run env:validate && npm run build",
-    "build:watcher": "nodemon --watch 'source/**/*' --exec 'pnpm run build'",
+    "build:watcher": "nodemon --verbose --watch 'source/**/*' --ext ts,tsx,js --ignore '*.test.ts' --ignore 'node_modules/**' --delay 2000 --exec 'pnpm run build'",
     "// Docker commands": "",
     "build:watch": "./scripts/dc.sh pnpm run build:watcher",
     "docker:build": "docker compose build",
diff --git a/plugin/scripts/dc.sh b/plugin/scripts/dc.sh
@@ -17,4 +17,16 @@ fi
 
 CI=${CI:-false}
 TAG="LOCAL_PLUGIN_BUILD"
-docker compose run --service-ports --rm -e HOST_LAN_IP="$HOST_LAN_IP" -e CI="$CI" -e TAG="$TAG" plugin-builder "$@" 
+
+# Define container name for easier management
+CONTAINER_NAME="plugin-builder"
+
+# Stop any running plugin-builder container first
+echo "Stopping any running plugin-builder containers..."
+docker ps -q --filter "name=${CONTAINER_NAME}" | xargs -r docker stop
+
+# Start the container with the specified environment variables
+echo "Starting plugin-builder container..."
+echo "Install the local plugin using this URL: http://${HOST_LAN_IP}:5858/plugins/dynamix.unraid.net.plg"
+
+docker compose run --remove-orphans --service-ports -e HOST_LAN_IP="$HOST_LAN_IP" -e CI="$CI" -e TAG="$TAG" ${CONTAINER_NAME} "$@"
diff --git a/plugin/scripts/entrypoint.sh b/plugin/scripts/entrypoint.sh
@@ -3,7 +3,7 @@
 mkdir -p /app/deploy/
 # Start http-server with common fileserver settings
 http-server /app/deploy/ \
-    --port 8080 \
+    --port 5858 \
     --host 0.0.0.0 \
     --cors \
     --gzip \
diff --git a/plugin/scripts/output-local-url.sh b/plugin/scripts/output-local-url.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Use ANSI escape codes for color and formatting
+# \e[1m = bold, \e[32m = green, \e[0m = reset formatting
+echo -e "\e[1m\e[32m"
+echo "=============================================================="
+echo "  INSTALL THE LOCAL PLUGIN USING THIS URL:                    "
+echo "  http://${HOST_LAN_IP}:5858/dynamix.unraid.net.plg           "
+echo "=============================================================="
+echo -e "\e[0m"
diff --git a/plugin/source/dynamix.unraid.net/install/doinst.sh b/plugin/source/dynamix.unraid.net/install/doinst.sh
@@ -110,3 +110,105 @@ fi
 ( cd usr/local/unraid-api/node_modules/esbuild/node_modules/.bin ; ln -sf ../../bin/esbuild esbuild )
 ( cd usr/local/unraid-api/node_modules/request/node_modules/.bin ; rm -rf uuid )
 ( cd usr/local/unraid-api/node_modules/request/node_modules/.bin ; ln -sf ../uuid/bin/uuid uuid )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf apollo-pbjs )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../@apollo/protobufjs/bin/pbjs apollo-pbjs )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf apollo-pbts )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../@apollo/protobufjs/bin/pbts apollo-pbts )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf blessed )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../blessed/bin/tput.js blessed )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf esbuild )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../esbuild/bin/esbuild esbuild )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf escodegen )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../escodegen/bin/escodegen.js escodegen )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf esgenerate )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../escodegen/bin/esgenerate.js esgenerate )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf esparse )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../esprima/bin/esparse.js esparse )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf esvalidate )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../esprima/bin/esvalidate.js esvalidate )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf fxparser )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../fast-xml-parser/src/cli/cli.js fxparser )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf glob )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../glob/dist/esm/bin.mjs glob )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf js-yaml )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../js-yaml/bin/js-yaml.js js-yaml )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf jsesc )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../jsesc/bin/jsesc jsesc )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf loose-envify )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../loose-envify/cli.js loose-envify )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf mime )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../mime/cli.js mime )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf mkdirp )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../mkdirp/bin/cmd.js mkdirp )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf mustache )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../mustache/bin/mustache mustache )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf needle )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../needle/bin/needle needle )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf node-which )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../which/bin/node-which node-which )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf opencollective )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../@nuxtjs/opencollective/bin/opencollective.js opencollective )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf parser )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../@babel/parser/bin/babel-parser.js parser )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pino )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pino/bin.js pino )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pino-pretty )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pino-pretty/bin.js pino-pretty )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pm2 )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pm2/bin/pm2 pm2 )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pm2-dev )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pm2/bin/pm2-dev pm2-dev )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pm2-docker )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pm2/bin/pm2-docker pm2-docker )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf pm2-runtime )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../pm2/bin/pm2-runtime pm2-runtime )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf prettier )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../prettier/bin/prettier.cjs prettier )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf relay-compiler )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../@ardatan/relay-compiler/bin/relay-compiler relay-compiler )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf resolve )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../resolve/bin/resolve resolve )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf semver )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../semver/bin/semver.js semver )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf sha.js )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../sha.js/bin.js sha.js )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf sshpk-conv )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../sshpk/bin/sshpk-conv sshpk-conv )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf sshpk-sign )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../sshpk/bin/sshpk-sign sshpk-sign )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf sshpk-verify )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../sshpk/bin/sshpk-verify sshpk-verify )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf systeminformation )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../systeminformation/lib/cli.js systeminformation )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf tsc )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../typescript/bin/tsc tsc )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf tsserver )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../typescript/bin/tsserver tsserver )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf tsx )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../tsx/dist/cli.mjs tsx )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf ua-parser-js )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../ua-parser-js/script/cli.js ua-parser-js )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf uuid )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../uuid/dist/esm/bin/uuid uuid )
+( cd usr/local/unraid-api/node_modules/.bin ; rm -rf xss )
+( cd usr/local/unraid-api/node_modules/.bin ; ln -sf ../xss/bin/xss xss )
+( cd usr/local/unraid-api/node_modules/@apollo/protobufjs/node_modules/.bin ; rm -rf apollo-pbjs )
+( cd usr/local/unraid-api/node_modules/@apollo/protobufjs/node_modules/.bin ; ln -sf ../../bin/pbjs apollo-pbjs )
+( cd usr/local/unraid-api/node_modules/@apollo/protobufjs/node_modules/.bin ; rm -rf apollo-pbts )
+( cd usr/local/unraid-api/node_modules/@apollo/protobufjs/node_modules/.bin ; ln -sf ../../bin/pbts apollo-pbts )
+( cd usr/local/unraid-api/node_modules/@apollo/server/node_modules/.bin ; rm -rf uuid )
+( cd usr/local/unraid-api/node_modules/@apollo/server/node_modules/.bin ; ln -sf ../uuid/dist/bin/uuid uuid )
+( cd usr/local/unraid-api/node_modules/@nestjs/core/node_modules/.bin ; rm -rf opencollective )
+( cd usr/local/unraid-api/node_modules/@nestjs/core/node_modules/.bin ; ln -sf ../../../../@nuxtjs/opencollective/bin/opencollective.js opencollective )
+( cd usr/local/unraid-api/node_modules/@nestjs/graphql/node_modules/.bin ; rm -rf uuid )
+( cd usr/local/unraid-api/node_modules/@nestjs/graphql/node_modules/.bin ; ln -sf ../uuid/dist/esm/bin/uuid uuid )
+( cd usr/local/unraid-api/node_modules/@pm2/agent/node_modules/.bin ; rm -rf semver )
+( cd usr/local/unraid-api/node_modules/@pm2/agent/node_modules/.bin ; ln -sf ../semver/bin/semver.js semver )
+( cd usr/local/unraid-api/node_modules/@pm2/io/node_modules/.bin ; rm -rf semver )
+( cd usr/local/unraid-api/node_modules/@pm2/io/node_modules/.bin ; ln -sf ../semver/bin/semver.js semver )
+( cd usr/local/unraid-api/node_modules/esbuild/node_modules/.bin ; rm -rf esbuild )
+( cd usr/local/unraid-api/node_modules/esbuild/node_modules/.bin ; ln -sf ../../bin/esbuild esbuild )
+( cd usr/local/unraid-api/node_modules/nestjs-pino/node_modules/.bin ; rm -rf pino )
+( cd usr/local/unraid-api/node_modules/nestjs-pino/node_modules/.bin ; ln -sf ../../../pino/bin.js pino )
+( cd usr/local/unraid-api/node_modules/request/node_modules/.bin ; rm -rf uuid )
+( cd usr/local/unraid-api/node_modules/request/node_modules/.bin ; ln -sf ../uuid/bin/uuid uuid )
