chore: build dynamix.unraid.net with versioning a-la-slackware

elibosley · elibosley · commit a98ab8e46716 · 2025-05-07T11:53:12.000-04:00
diff --git a/.github/workflows/build-plugin.yml b/.github/workflows/build-plugin.yml
@@ -113,9 +113,8 @@ jobs:
         id: build-plugin
         run: |
           cd ${{ github.workspace }}/plugin
-          ls -al
           pnpm run build:txz
-          pnpm run build:plugin --tag="${{ inputs.TAG }}" --base-url="${{ inputs.BASE_URL }}"
+          pnpm run build:plugin --tag="${{ inputs.TAG }}" --base-url="${{ inputs.BASE_URL }}" --api-version="${{ steps.vars.outputs.API_VERSION }}"
 
       - name: Ensure Plugin Files Exist
         run: |
diff --git a/plugin/.nvmrc b/plugin/.nvmrc
diff --git a/plugin/builder/build-plugin.ts b/plugin/builder/build-plugin.ts
@@ -2,7 +2,7 @@ import { readFile, writeFile, mkdir, rename } from "fs/promises";
 import { $ } from "zx";
 import { escape as escapeHtml } from "html-sloppy-escaper";
 import { dirname, join } from "node:path";
-import { getTxzName, pluginName, startingDir } from "./utils/consts";
+import { getTxzName, pluginName, startingDir, defaultArch, defaultBuild } from "./utils/consts";
 import { getAssetUrl, getPluginUrl } from "./utils/bucket-urls";
 import { getMainTxzUrl } from "./utils/bucket-urls";
 import {
@@ -26,7 +26,7 @@ const checkGit = async () => {
   }
 };
 
-const moveTxzFile = async (txzPath: string, pluginVersion: string) => {
+const moveTxzFile = async ({txzPath, pluginVersion}: Pick<PluginEnv, "txzPath" | "pluginVersion">) => {
   const txzName = getTxzName(pluginVersion);
   await rename(txzPath, join(deployDir, txzName));
 };
@@ -50,14 +50,20 @@ const buildPlugin = async ({
   tag,
   txzSha256,
   releaseNotes,
+  apiVersion,
 }: PluginEnv) => {
+  console.log(`API version: ${apiVersion}`);
+  
   // Update plg file
   let plgContent = await readFile(getRootPluginPath({ startingDir }), "utf8");
 
   // Update entity values
   const entities: Record<string, string> = {
     name: pluginName,
     version: pluginVersion,
+    api_version: apiVersion,
+    arch: defaultArch,
+    build: defaultBuild,
     pluginURL: getPluginUrl({ baseUrl, tag }),
     MAIN_TXZ: getMainTxzUrl({ baseUrl, pluginVersion, tag }),
     TXZ_SHA256: txzSha256,
@@ -107,7 +113,7 @@ const main = async () => {
     await cleanupPluginFiles();
 
     await buildPlugin(validatedEnv);
-    await moveTxzFile(validatedEnv.txzPath, validatedEnv.pluginVersion);
+    await moveTxzFile(validatedEnv);
     await bundleVendorStore();
   } catch (error) {
     console.error(error);
diff --git a/plugin/builder/build-txz.ts b/plugin/builder/build-txz.ts
@@ -91,6 +91,7 @@ const validateSourceDir = async (validatedEnv: TxzEnv) => {
 
 const buildTxz = async (validatedEnv: TxzEnv) => {
   await validateSourceDir(validatedEnv);
+  console.log(`Package name: ${getTxzName()}`);
   const txzPath = join(validatedEnv.txzOutputDir, getTxzName());
   await ensureNodeJs();
 
@@ -99,6 +100,7 @@ const buildTxz = async (validatedEnv: TxzEnv) => {
   await cd(join(startingDir, "source", pluginName));
   $.verbose = true;
 
+  // Create the package using the default package name
   await $`${join(startingDir, "scripts/makepkg")} --chown y --compress -${
     validatedEnv.compress
   } --linkadd y ${txzPath}`;
diff --git a/plugin/builder/cli/setup-plugin-environment.ts b/plugin/builder/cli/setup-plugin-environment.ts
@@ -9,6 +9,7 @@ const safeParseEnvSchema = z.object({
   ci: z.boolean().optional(),
   baseUrl: z.string().url(),
   tag: z.string().optional().default(''),
+  apiVersion: z.string().optional(),
 
   txzPath: z.string().refine((val) => val.endsWith(".txz"), {
     message: "TXZ Path must end with .txz",
@@ -24,6 +25,7 @@ const pluginEnvSchema = safeParseEnvSchema.extend({
   txzSha256: z.string().refine((val) => val.length === 64, {
     message: "TXZ SHA256 must be 64 characters long",
   }),
+  apiVersion: z.string().nonempty("API version is required"),
 });
 
 export type PluginEnv = z.infer<typeof pluginEnvSchema>;
@@ -105,6 +107,11 @@ export const setupPluginEnv = async (argv: string[]): Promise<PluginEnv> => {
       "Plugin Version in the format YYYY.MM.DD.HHMM",
       getPluginVersion()
     )
+    .requiredOption(
+      "--api-version <version>",
+      "API Version (e.g. 1.0.0)",
+      process.env.API_VERSION
+    )
     .option("--tag <tag>", "Tag (used for PR and staging builds)", process.env.TAG)
     .option("--release-notes-path <path>", "Path to release notes file")
     .option("--ci", "CI mode", process.env.CI === "true")
diff --git a/plugin/builder/utils/bucket-urls.ts b/plugin/builder/utils/bucket-urls.ts
@@ -1,4 +1,4 @@
-import { getTxzName, LOCAL_BUILD_TAG, pluginNameWithExt } from "./consts";
+import { getTxzName, LOCAL_BUILD_TAG, pluginNameWithExt, defaultArch, defaultBuild } from "./consts";
 
 // Define a common interface for URL parameters
 interface UrlParams {
@@ -44,7 +44,7 @@ export const getPluginUrl = (params: UrlParams): string =>
 
 /**
  * Get the URL for the main TXZ file
- * ex. returns = BASE_URL/TAG/dynamix.unraid.net-4.1.3.txz
+ * ex. returns = BASE_URL/TAG/dynamix.unraid.net-4.1.3-x86_64-1.txz
  */
 export const getMainTxzUrl = (params: TxzUrlParams): string =>
-  getAssetUrl(params, getTxzName(params.pluginVersion));
+  getAssetUrl(params, getTxzName(params.pluginVersion, defaultArch, defaultBuild));
diff --git a/plugin/builder/utils/consts.ts b/plugin/builder/utils/consts.ts
@@ -1,8 +1,13 @@
 export const pluginName = "dynamix.unraid.net" as const;
 export const pluginNameWithExt = `${pluginName}.plg` as const;
 
-export const getTxzName = (version?: string) =>
-  version ? `${pluginName}-${version}.txz` : `${pluginName}.txz`;
+// Default architecture and build number for Slackware package
+export const defaultArch = "x86_64" as const;
+export const defaultBuild = "1" as const;
+
+// Get the txz name following Slackware naming convention: name-version-arch-build.txz
+export const getTxzName = (version?: string, arch: string = defaultArch, build: string = defaultBuild) =>
+  version ? `${pluginName}-${version}-${arch}-${build}.txz` : `${pluginName}.txz`;
 export const startingDir = process.cwd();
 
 export const BASE_URLS = {
diff --git a/plugin/builder/utils/nodejs-helper.ts b/plugin/builder/utils/nodejs-helper.ts
@@ -5,8 +5,21 @@ import { get } from "https";
 import { $ } from "zx";
 import { startingDir } from "./consts";
 
+const findNvmrc = () => {
+  const nvmrcPaths = [
+    join(startingDir, "..", ".nvmrc"),
+    join(startingDir, ".nvmrc"),
+  ];
+  for (const nvmrcPath of nvmrcPaths) {
+    if (existsSync(nvmrcPath)) {
+      return nvmrcPath;
+    }
+  }
+  throw new Error("NVMRC file not found");
+}
 // Read Node.js version from .nvmrc
-const NVMRC_PATH = join(startingDir, "..", ".nvmrc");
+const NVMRC_PATH = findNvmrc();
+console.log(`NVMRC_PATH: ${NVMRC_PATH}`);
 const NODE_VERSION = readFileSync(NVMRC_PATH, "utf8").trim();
 
 const NODE_FILENAME = `node-v${NODE_VERSION}-linux-x64.tar.xz`;
diff --git a/plugin/docker-compose.yml b/plugin/docker-compose.yml
@@ -7,6 +7,7 @@ services:
       - ./:/app
       - /app/node_modules
       - ../.git:/app/.git
+      - ../.nvmrc:/app/.nvmrc
       - ./source:/app/source
       - ./scripts:/app/scripts
       - ../unraid-ui/dist-wc:/app/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components/uui
@@ -19,3 +20,4 @@ services:
       - HOST_LAN_IP=${HOST_LAN_IP}
       - CI=${CI:-false}
       - TAG=${TAG}
+      - API_VERSION=${API_VERSION}
diff --git a/plugin/docs/migration/progress.md b/plugin/docs/migration/progress.md
@@ -1,176 +1,43 @@
-# Plugin Migration to Slackware Package: Progress Report
-
-## Overview
-This document tracks our progress in migrating the Unraid plugin to a native Slackware package.
+# Migration Progress: Plugin to Slackware Package
 
 ## Completed Tasks
 
-### Package Structure and Slackware Integration
-- Created standard Slackware package description file (`slack-desc`) for the dynamix.unraid.net package
-- Implemented proper Slackware init system integration:
-  - Modified `rc.unraid-api` script to include standard start/stop/restart/status functions
-  - Updated approach to use native Slackware init system rather than System V directories
-  - Added boot-time node modules dependency restoration to the `start()` function
-  - Moved environment setup from setup_api.sh to rc.unraid-api to ensure it's available at boot
-  - The service will now properly start on boot if pre-installed in the OS
-
-### Installation Scripts
-- Added `doinst.sh` script to handle post-installation tasks like creating symlinks and starting services
-- Implemented support for both install and remove operations in doinst.sh using Slackware's installation mode parameter
-- Modularized the installation logic into separate scripts for better maintainability:
-  - `setup_api.sh`: Handles API setup, symlinks, and service startup
-  - `file_patches.sh`: Manages file patches and system configurations
-  - `cleanup.sh`: Performs uninstallation and cleanup operations
-- Improved doinst.sh script maintainability:
-  - Added SCRIPTS_DIR variable to centralize script paths
-  - Replaced all hardcoded script paths with the variable reference
-
-### Cleanup and Removal Operations
-- File restoration scripts have been successfully migrated from the plugin's inline code to the modular cleanup.sh script
-- Enhanced cleanup.sh to handle both installation and removal scenarios with a mode parameter ('restore' or 'cleanup')
-- Updated doinst.sh to call cleanup.sh with the appropriate mode for both installation and removal operations
-- Simplified the plugin XML file by removing all cleanup code, as these operations are now entirely handled by the Slackware package system
-- Updated the removal script to rely on the Slackware package system instead of manually running cleanup operations
-- Consolidated all cleanup scripts into a single robust shell script:
-  - Merged functionality from the PHP `cleanup_operations.php` script into the shell-based `cleanup.sh`
-  - Removed dependency on PHP for cleanup operations, making it more compatible with native Slackware tooling
-  - Created a unified script that handles both file restoration (during installation) and full cleanup (during removal)
-
-### Node.js and Dependencies Management
-- Removed Node.js symlinking from both the doinst.sh script and plugin file as this will be handled by the build-txz script
-- Implemented vendor archive handling in the rc.unraid-api script:
-  - Proper path definitions for the vendor archive
-  - Comprehensive dependency restoration function that checks file existence and disk space
-  - Archive creation function for backing up node_modules
-  - Command-line interface for both restoration and archiving operations
-  - Automatic restoration during service startup if node_modules are missing
-
-### Script Consolidation
-- Eliminated duplicate cleanup scripts by standardizing on the version at usr/local/share/dynamix.unraid.net/install/scripts/cleanup.sh
-- Eliminated duplicate setup_api.sh scripts by standardizing on the version at usr/local/share/dynamix.unraid.net/install/scripts/setup_api.sh
+### 2024-05-XX
 
-### POSIX Compatibility
-- Ensured POSIX shell compatibility by replacing Bash-specific array syntax with POSIX-compliant for loops
-- Fixed POSIX shell compatibility in verify_install.sh:
-  - Replaced Bash-specific array syntax with POSIX-compliant string lists
-  - Maintained identical functionality while ensuring /bin/sh compatibility
-  - Eliminated SC3030 shellcheck warnings about undefined arrays in POSIX sh
-  - Removed unused check_file() function to fix SC2317 unreachable command warning
+- Modified `setup_api.sh` to only use the Slackware package version
+  - Removed all fallback logic for bundle detection
+  - Now exclusively uses version from dynamix.unraid.net Slackware package
+  - Exit with error if package not found instead of falling back to defaults
+  - Simplified logic for finding and using the correct bundle archives
+  - Fixed ShellCheck SC2010 violations by replacing `ls | grep` with proper glob pattern matching
 
-### Verification and TAG Handling
-- Created post-installation verification script:
-  - Checks for existence of critical files and directories
-  - Verifies executable permissions on important scripts
-  - Validates startup and shutdown configurations in rc.M, rc.local, rc.0, and rc.6 files
-  - Provides color-coded output for easy readability
-  - Integrated with doinst.sh to run automatically after installation
-- Added TAG handling from plugin XML file to the Slackware package
+## Pending Tasks
 
-### Slackware-Native Init System Changes
-- Completely rewrote the startup/shutdown system to use Slackware's native approach:
-  - Removed all code trying to create or use System V-style rc*.d directories
-  - Implemented direct modification of rc.M and rc.local for service startup
-  - Implemented direct modification of rc.0 and rc.6 for service shutdown
-  - Created a generic `configure_script()` function to handle both startup and shutdown scripts
-  - Updated verification script to check for the proper Slackware initialization entries
-  - The setup_api.sh script now properly modifies rc.M, rc.local, rc.0, and rc.6 files
+- Update installation process to use native Slackware packaging
+- Modify build scripts to create proper Slackware packages
+- Update boot scripts to conform with Slackware standards
+- Test package installation/upgrade flows
+- Implement proper package dependencies
+- Ensure all scripts use proper Slackware paths and conventions
 
-## Recent Decisions
-- Kept version compatibility check in the plugin file rather than the Slackware package:
-  - Recognized that doinst.sh runs after files are already installed
-  - Version checking needs to happen before installation to be effective
-  - The PHP check in the plugin file is the best place for this validation
-- Removed TAG handling from doinst.sh and reverted to plugin file approach:
-  - Discovered TAG isn't properly set in the Unraid environment within doinst.sh context
-  - Reverted to using the plugin file for TAG handling to ensure proper functionality
-- Identified issue with runlevel directory creation approach:
-  - Discovered that in Slackware, the rc.0 and rc.6 files are actual files, not directories
-  - Completely redesigned the approach to use Slackware's native init system
-  - Now directly modifying rc.M and rc.local for startup, rc.0 and rc.6 for shutdown
+## In Progress
 
-## Removed Components
-- Removed redundant build-slackware-package.sh script:
-  - Eliminated duplicate functionality as we now use build-txz.ts for package creation
-  - Simplified build tooling to use a single TypeScript-based build process
-- Removed makepkg-usage.md documentation:
-  - Determined that direct makepkg usage documentation is unnecessary
-  - Package creation is now fully handled by the build-txz.ts script
-- Removed System V-style init system code:
-  - Eliminated all code related to rc*.d directories that don't exist in Slackware
-  - Replaced with native Slackware init system modification approach
+1. Refactoring `build-plugin.ts` to better support Slackware package format.
+2. Implementing standard Slackware package scripts (doinst.sh, etc.)
 
 ## Next Steps
-- Document complete migration process with testing results
-- Review and ensure all file permissions are set correctly
-- Test package installation and removal
-- Verify that all services start correctly after installation
-
-## Implementation Notes
-- Disk space verification checks are not needed in the native package since it will be pre-installed in Unraid
-- Gzip availability checks are unnecessary for the native package
-- DNS resolution checks are unnecessary and should be removed from the plugin file
-- Plugin staging conflict check is outdated and no longer needed
-- Full SlackBuild script is not necessary since we're not compiling code; direct use of `makepkg` is simpler
-- Version compatibility checks should remain in the plugin file since they need to run before installation 
-
-## Recent Improvements
-- Enhanced Firefox configuration in file_patches.sh:
-  - Replaced hardcoded Firefox profile path with dynamic profile detection
-  - Added fallback handling when Firefox profile cannot be found
-  - Improved user feedback with status messages about configuration changes
-  - Made the script more resilient to Firefox profile directory changes in future Unraid versions
-- Improved POSIX and shellcheck compliance in cleanup.sh:
-  - Fixed SC2046 warning in process termination code by properly handling pidof with no results
-  - Improved ps/grep/kill pattern to safely handle cases with no matching processes
-  - Prevented non-zero exit codes during cleanup process to ensure smooth uninstallation
-  - Enhanced reliability of the script in edge cases like when no processes are running
-  - Fixed base64 encoding to prevent line wrapping in HTTP POST data by piping through tr -d '\n' 
-- Enhanced POSIX compatibility in shell scripts:
-  - Replaced echo statements with escape sequences (\n) with printf commands
-  - Fixed issue where /bin/sh implementations (like dash) print literal \n instead of interpreting them
-  - Improved formatting of status messages in cleanup.sh with proper newlines
-  - Ensured better cross-platform compatibility across different shell implementations
-- Created advanced init script configuration:
-  - Implemented a unified script function that handles both startup and shutdown script modifications
-  - Added intelligent handling of script placement (end of file for startup, beginning for shutdown)
-  - Made the verification script more robust to check both potential startup locations (rc.M and rc.local)
-  - Added conditional checks to only setup flash_backup if it exists
 
-## Bug Fixes
-- Fixed malformed sed pattern in cleanup.sh:
-  - Changed `sed -i '#robots.txt any origin/d'` to use standard slash delimiters
-  - Replaced with `sed -i '/#robots.txt any origin/d'` to correctly match and delete the pattern
-  - This ensures the robots.txt origin line is properly removed from rc.nginx during cleanup 
-- Fixed issue in rc6.d and rc0.d directory creation:
-  - Previously attempted to create and use rc0.d/rc6.d directories that don't exist in Slackware
-  - Completely rewrote the approach to directly modify rc.0 and rc.6 files
-  - Now correctly configures shutdown using Slackware's native approach
+1. Create standard Slackware package structure
+   - Create install directory with doinst.sh script
+   - Setup proper Slackware package metadata
 
-## Changes Implemented
+2. Utilize native Slackware tooling for:
+   - Package installation
+   - Service management
+   - Version tracking
 
-### rc.unraid-api Script
-- Added functionality to start flash backup service during API service startup
-- This ensures that flash backup is running whenever the API service is started
+3. Update vendor storage mechanism to align with Slackware standards
 
-### setup_api.sh Script
-- Completely redesigned to use Slackware's native initialization system
-- Now properly configures both startup (in rc.M and rc.local) and shutdown (in rc.0 and rc.6)
-- Created a unified `configure_script()` function that handles all script modifications
-- Made startup/shutdown script handling more intelligent and robust
+## References
 
-## API Setup Script Validation
-- Identified issue with `setup_api.sh` not executing properly during package installation:
-  - Despite being called correctly from `doinst.sh`, the script fails to create necessary symlinks
-  - Manual execution of the script after installation was required to properly set up API
-  - Key symptoms include missing symlinks that should have been created during installation
-  - Further troubleshooting needed to determine why the script doesn't function when called by doinst.sh
-  - Potential issues:
-    - Path resolution differences when called from doinst.sh vs manual execution
-    - Permission issues during package installation process
-    - Environment variable differences between package install context and manual execution
-  - Action item: Add logging to doinst.sh and setup_api.sh to debug execution flow during installation
-
-## Pending Tasks
-- Continue migrating plugin components to follow Slackware package standards
-- Review and ensure all necessary init scripts are properly configured
-- Test the startup and shutdown sequences for all services 
+- The setup_api.sh script (at plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/) already implements some Slackware-style package detection for getting API version. 
diff --git a/plugin/package.json b/plugin/package.json
@@ -12,7 +12,7 @@
     "tsx": "^4.19.2",
     "zod": "^3.24.1",
     "zx": "^8.3.2"
-  },
+},
   "type": "module",
   "license": "GPL-2.0-or-later",
   "scripts": {
diff --git a/plugin/plugins/dynamix.unraid.net.plg b/plugin/plugins/dynamix.unraid.net.plg
diff --git a/plugin/scripts/dc.sh b/plugin/scripts/dc.sh
diff --git a/plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid-api b/plugin/source/dynamix.unraid.net/etc/rc.d/rc.unraid-api
diff --git a/plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/setup_api.sh b/plugin/source/dynamix.unraid.net/usr/local/share/dynamix.unraid.net/install/scripts/setup_api.sh
