Feat/local-plugin (#1125)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


• New Features  
 - Enhanced the login experience with improved session management and
two-factor authentication.
 - Introduced a comprehensive README for the Unraid Plugin Builder,
detailing development workflows and commands.

• Chores  
 - Streamlined build, packaging, and deployment processes with updated
dependency and environment configurations.
 - Updated Docker configurations to support pnpm as the package manager.
 - Added new environment variables for better configuration management.
 - Introduced new scripts for improved build and packaging processes.  

• Tests  
 - Removed outdated test cases and simplified test setups.  

• Refactor  
 - Modernized internal code structure and asynchronous handling for
improved overall performance.
 - Transitioned imports from lodash to lodash-es for better module
handling.
 - Updated environment variable management and configuration settings.  
 - Enhanced the build script for improved deployment processes.  
 - Updated the notification handling structure to improve efficiency.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: elibosley

.github/workflows/main.yml

@@ -34,66 +34,106 @@ jobs:
       - name: Validate branch and tag
         run: exit 0
 
-  build-test-api:
+  test-api:
+    defaults:
+      run:
+        working-directory: api
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "api/.nvmrc"
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 8
+          run_install: false
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('api/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: PNPM Install
+        run: pnpm install
+
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Test
+        run: pnpm run coverage
+
+  build-api:
     name: Build and Test API
     runs-on: ubuntu-latest
     defaults:
       run:
         working-directory: api
-    outputs:
-      API_VERSION: ${{ steps.vars.outputs.API_VERSION }}
-      API_MD5: ${{ steps.set-hashes.outputs.API_MD5 }}
-      API_SHA256: ${{ steps.set-hashes.outputs.API_SHA256 }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Build with Buildx
-        uses: docker/setup-buildx-action@v3
+
+      - name: Install Node
+        uses: actions/setup-node@v4
         with:
-          install: true
-          platforms: linux/amd64
-      - name: Build Builder
-        uses: docker/build-push-action@v6
+          node-version-file: "api/.nvmrc"
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
         with:
-          context: ./api
-          push: false
-          tags: builder:latest
-          cache-from: type=gha,ref=builder:latest
-          cache-to: type=gha,mode=max,ref=builder:latest
-          load: true
-      - name: Lint inside of the docker container
-        continue-on-error: false
-        run: |
-          docker run --rm builder npm run lint
+          version: 8
+          run_install: false
 
-      - name: Test inside of the docker container
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
         run: |
-          git fetch --depth=2 origin main
-          if git diff --name-only --relative=api origin/main HEAD | grep -q '.'; then
-            docker run --rm builder npm run coverage
-          else
-            echo "No changes in /api folder, skipping coverage."
-          fi
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('api/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Cache APT Packages
+        uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+        with:
+          packages: bash procps python3 libvirt-dev jq zstd git build-essential
+          version: 1.0
+
+      - name: PNPM Install
+        run: pnpm install
+
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Build
+        run: pnpm run build
+
       - name: Get Git Short Sha and API version
         id: vars
         run: |
           GIT_SHA=$(git rev-parse --short HEAD)
           IS_TAGGED=$(git describe --tags --abbrev=0 --exact-match || echo '')
-          PACKAGE_LOCK_VERSION=$(jq -r '.version' package-lock.json)
-          echo "GIT_SHA=$GIT_SHA" >> $GITHUB_OUTPUT
-          echo "IS_TAGGED=$IS_TAGGED" >> $GITHUB_OUTPUT
-          echo "PACKAGE_LOCK_VERSION=$PACKAGE_LOCK_VERSION" >> $GITHUB_OUTPUT
-          echo "API_VERSION=$([[ -n "$IS_TAGGED" ]] && echo "$PACKAGE_LOCK_VERSION" || echo "${PACKAGE_LOCK_VERSION}+${GIT_SHA}")" >> $GITHUB_OUTPUT
-      - name: Build inside of the docker container
-        id: build-pack-binary
-        run: |
-          docker run --rm -v ${{ github.workspace }}/api/deploy/release:/app/deploy/release -e API_VERSION=${{ steps.vars.outputs.API_VERSION }} builder npm run build-and-pack
-
-      - name: Set Hashes
-        id: set-hashes
-        run: |
-          echo "API_MD5=$(md5sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')" >> $GITHUB_OUTPUT
-          echo "API_SHA256=$(sha256sum ${{ github.workspace }}/api/deploy/release/*.tgz | awk '{ print $1 }')" >> $GITHUB_OUTPUT
+          PACKAGE_LOCK_VERSION=$(jq -r '.version' package.json)
+          API_VERSION=$([[ -n "$IS_TAGGED" ]] && echo "$PACKAGE_LOCK_VERSION" || echo "${PACKAGE_LOCK_VERSION}+${GIT_SHA}")
+          export API_VERSION
+          
+      - name: Build
+        run: pnpm run build-and-pack
 
       - name: Upload tgz to Github artifacts
         uses: actions/upload-artifact@v4
@@ -187,7 +227,7 @@ jobs:
           path: web/.nuxt/nuxt-custom-elements/dist/unraid-components
 
   build-plugin:
-    needs: [build-test-api, build-web, build-unraid-ui-webcomponents]
+    needs: [build-api, build-web, build-unraid-ui-webcomponents]
     defaults:
       run:
         working-directory: plugin
@@ -201,38 +241,42 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Build with Buildx
-        uses: docker/setup-buildx-action@v3
-        with:
-          install: true
-          platforms: linux/amd64
-      - name: Build Builder
-        uses: docker/build-push-action@v6
+      - name: Install node
+        uses: actions/setup-node@v4
         with:
-          context: ./plugin
-          push: false
-          tags: plugin-builder:latest
-          cache-from: type=gha,ref=plugin-builder:latest
-          cache-to: type=gha,mode=max,ref=plugin-builder:latest
-          load: true
+          cache: "npm"
+          cache-dependency-path: |
+            plugin/package-lock.json
+          node-version-file: ".nvmrc"
+      - name: Install dependencies
+        run: npm ci
       - name: Download Unraid Web Components
         uses: actions/download-artifact@v4
         with:
           pattern: unraid-wc-*
           path: ./plugin/source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components
           merge-multiple: true
-      - name: Build Plugin
+      - name: Download Unraid API
+        uses: actions/download-artifact@v4
+        with:
+          name: unraid-api
+          path: /tmp/unraid-api/
+      - name: Extract Unraid API and Build Plugin
         run: |
-          echo "API_VERSION=${{needs.build-test-api.outputs.API_VERSION}}" > .env
-          echo "API_SHA256=${{needs.build-test-api.outputs.API_SHA256}}" >> .env
-          echo "PR=${{ github.event.pull_request.number }}" >> .env
-          npm run start
+          tar -xzf /tmp/unraid-api/unraid-api.tgz -C ${{ github.workspace }}/plugin/source/dynamix.unraid.net/usr/local/unraid-api
+          cd ${{ github.workspace }}/plugin
+
+          if [ -n "${{ github.event.pull_request.number }}" ]; then
+            export TAG=PR${{ github.event.pull_request.number }}
+          fi
+
+          npm run build
       - name: Upload binary txz and plg to Github artifacts
         uses: actions/upload-artifact@v4
         with:
           name: connect-files
           path: |
-            plugin/deploy/release/plugins/*.plg
+            plugin/deploy/release/plugins/
             plugin/deploy/release/archive/*.txz
           retention-days: 5
           if-no-files-found: error
@@ -241,20 +285,14 @@ jobs:
     if: |
       github.event_name == 'pull_request'
     runs-on: ubuntu-latest
-    needs: [build-plugin]
+    needs: [test-api, build-plugin]
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Make PR Release Folder
         run: mkdir pr-release/
 
-      - name: Download unraid-api binary tgz
-        uses: actions/download-artifact@v4
-        with:
-          name: unraid-api
-          path: pr-release
-
       - name: Download plugin binary tgz
         uses: actions/download-artifact@v4
         with:
@@ -263,7 +301,7 @@ jobs:
       - name: Copy other release files to pr-release
         run: |
           cp archive/*.txz pr-release/
-          cp plugins/dynamix.unraid.net.pr.plg pr-release/dynamix.unraid.net.plg
+          cp plugins/pr/dynamix.unraid.net.plg pr-release/dynamix.unraid.net.plg
 
       - name: Upload to Cloudflare
         uses: jakejarvis/s3-sync-action@v0.5.1
@@ -293,7 +331,7 @@ jobs:
     # Only release if this is a push to the main branch
     if: startsWith(github.ref, 'refs/heads/main')
     runs-on: ubuntu-latest
-    needs: [build-plugin]
+    needs: [test-api, build-plugin]
 
     steps:
       - name: Checkout repo
@@ -302,12 +340,6 @@ jobs:
       - name: Make Staging Release Folder
         run: mkdir staging-release/
 
-      - name: Download unraid-api binary tgz
-        uses: actions/download-artifact@v4
-        with:
-          name: unraid-api
-          path: staging-release
-
       - name: Download plugin binary tgz
         uses: actions/download-artifact@v4
         with:
@@ -316,7 +348,7 @@ jobs:
       - name: Copy Files for Staging Release
         run: |
           cp archive/*.txz staging-release/
-          cp plugins/dynamix.unraid.net.staging.plg staging-release/dynamix.unraid.net.plg
+          cp plugins/staging/dynamix.unraid.net.plg staging-release/dynamix.unraid.net.plg
           ls -al staging-release
 
       - name: Upload Staging Plugin to Cloudflare Bucket
@@ -335,17 +367,11 @@ jobs:
     if: |
       startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
-    needs: [build-plugin]
-
+    needs: [test-api, build-plugin]
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
-      - name: Download unraid-api binary tgz
-        uses: actions/download-artifact@v4
-        with:
-          name: unraid-api
-
       - name: Download plugin binary tgz
         uses: actions/download-artifact@v4
         with:
@@ -355,7 +381,7 @@ jobs:
         run: |
           mkdir -p release/
           mv unraid-api-*.tgz release/
-          mv plugins/dynamix.unraid.net.plg release/
+          mv plugins/production/dynamix.unraid.net.plg release/
           mv archive/* release/
 
       - name: Create Github release

.gitignore

@@ -92,3 +92,6 @@ deploy/*
 !.env.example
 
 fb_keepalive
+
+# pnpm store
+.pnpm-store

api/.env.test

@@ -1,11 +1,13 @@
-VERSION="THIS_WILL_BE_REPLACED_WHEN_BUILT"
-
 PATHS_UNRAID_DATA=./dev/data # Where we store plugin data (e.g. permissions.json)
 PATHS_STATES=./dev/states # Where .ini files live (e.g. vars.ini)
+PATHS_AUTH_SESSIONS=./dev/sessions # Where user sessions live
+PATHS_AUTH_KEY=./dev/keys # Auth key directory
 PATHS_DYNAMIX_BASE=./dev/dynamix # Dynamix's data directory
+PATHS_DYNAMIX_CONFIG_DEFAULT=./dev/dynamix/default.cfg # Dynamix's default config file, which ships with unraid
 PATHS_DYNAMIX_CONFIG=./dev/dynamix/dynamix.cfg # Dynamix's config file
 PATHS_MY_SERVERS_CONFIG=./dev/Unraid.net/myservers.cfg # My servers config file
 PATHS_MY_SERVERS_FB=./dev/Unraid.net/fb_keepalive # My servers flashbackup timekeeper file
 PATHS_KEYFILE_BASE=./dev/Unraid.net # Keyfile location
+PATHS_MACHINE_ID=./dev/data/machine-id
 PORT=5000
-NODE_ENV=test
+NODE_ENV="test"

api/.gitignore

@@ -80,3 +80,5 @@ deploy/*
 
 # IDE Settings Files
 .idea
+
+!**/*.login.*

api/.npmrc

@@ -0,0 +1,2 @@
+node-linker=hoisted
+shamefully-hoist=true

api/Dockerfile

@@ -19,15 +19,18 @@ WORKDIR /app
 
 # Set app env
 ENV NODE_ENV=development
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
 
-COPY tsconfig.json .eslintrc.ts .prettierrc.cjs .npmrc .env.production .env.staging ./
+# Install pnpm
+RUN corepack enable && corepack prepare pnpm@8.15.4 --activate && npm i -g npm@latest
 
-COPY package.json package-lock.json ./
+COPY tsconfig.json .eslintrc.ts .prettierrc.cjs .npmrc .env.production .env.staging package.json pnpm-lock.yaml .npmrc ./
 
 # Install deps
-RUN npm i
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install
 
-EXPOSE 4000
+EXPOSE 3001
 
 ###########################################################
 # Builder Image
@@ -39,4 +42,4 @@ ENV NODE_ENV=production
 
 COPY . .
 
-CMD ["npm", "run", "build-and-pack"]
+CMD ["pnpm", "run", "build-and-pack"]