Merge pull request #779 from arabcoders/dev

General improvements to underlying codebase

Author: arabcoders

.github/workflows/build.yml

@@ -54,7 +54,7 @@ jobs:
   validate-build-config:
     name: Validate Build Configuration
     runs-on: ubuntu-latest
-    permissions: { }
+    permissions: {}
     steps:
       - name: Ensure at least one architecture is enabled
         run: |
@@ -70,13 +70,13 @@ jobs:
   test:
     name: Tests & Frontend Build
     runs-on: ubuntu-latest
-    needs: [ validate-build-config ]
+    needs: [validate-build-config]
     permissions:
       contents: read
     strategy:
       fail-fast: true
       matrix:
-        php: [ 8.4 ]
+        php: [8.4]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -113,6 +113,12 @@ jobs:
       - name: Install PHP dependencies
         run: composer install --prefer-dist --no-interaction --no-progress
 
+      - name: Run PHP formatter check
+        run: composer run format:ci
+
+      - name: Run PHP linter
+        run: composer run lint
+
       - name: Run PHP tests
         run: composer run test
 
@@ -130,10 +136,22 @@ jobs:
 
       - name: Install frontend dependencies
         working-directory: frontend
-        env:
-          NODE_ENV: production
         run: pnpm install --frozen-lockfile --prefer-offline
 
+      - name: Run nuxt prepare
+        working-directory: frontend
+        env:
+          NODE_ENV: development
+        run: pnpm run prepare:test
+
+      - name: Run frontend linter
+        working-directory: frontend
+        run: pnpm run lint
+
+      - name: Run frontend typecheck
+        working-directory: frontend
+        run: pnpm run lint:tsc
+
       - name: Build frontend
         working-directory: frontend
         env:
@@ -166,8 +184,8 @@ jobs:
   docker-build-amd64:
     name: Build Container (amd64)
     runs-on: ubuntu-latest
-    needs: [ test, validate-build-config ]
-    if: (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && github.event.inputs.build == 'true')) && vars.BUILD_AMD64 != 'false'
+    needs: [test, validate-build-config]
+    if: (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && github.event.inputs.build)) && vars.BUILD_AMD64 != 'false'
     permissions:
       packages: write
       contents: write
@@ -257,15 +275,15 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=gha,scope=${{ github.workflow }}-${{ env.ARCH }}
-          cache-to: type=gha,mode=max,scope=${{ github.workflow }}-${{ env.ARCH }}
+          cache-from: type=gha,scope=${{ github.workflow_ref }}-${{ env.ARCH }}
+          cache-to: type=gha,mode=max,scope=${{ github.workflow_ref }}-${{ env.ARCH }}
           provenance: true
 
   docker-build-arm64:
     name: Build Container (arm64)
     runs-on: ubuntu-latest
-    needs: [ test, validate-build-config ]
-    if: (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && github.event.inputs.build == 'true')) && vars.BUILD_ARM64 != 'false'
+    needs: [test, validate-build-config]
+    if: (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && github.event.inputs.build)) && vars.BUILD_ARM64 != 'false'
     permissions:
       packages: write
       contents: write
@@ -362,7 +380,7 @@ jobs:
   docker-publish-manifest:
     name: Publish multi-arch manifest
     runs-on: ubuntu-latest
-    needs: [ docker-build-amd64, docker-build-arm64 ]
+    needs: [docker-build-amd64, docker-build-arm64]
     if: |
       !cancelled() && github.event_name != 'pull_request' &&
       (needs.docker-build-amd64.result == 'success' || needs.docker-build-arm64.result == 'success')

.gitignore

@@ -6,3 +6,5 @@
 /frontend/exported/
 .phpactor.json
 **.php-cs-fixer.cache
+src/Backends/Plex/PlexJWT.php
+tests/Backends/Plex/PlexJWTTest.php

FAQ.md

@@ -309,7 +309,7 @@ to see list of loaded environment variables, click on `Env` page.
 > the `compose.yaml` file.
 
 | Key           | Type    | Description                        | Default |
-|---------------|---------|------------------------------------|---------|
+| ------------- | ------- | ---------------------------------- | ------- |
 | DISABLE_CRON  | integer | Disable included `Task Scheduler`. | `0`     |
 | DISABLE_CACHE | integer | Disable included `Cache Server`.   | `0`     |
 
@@ -417,9 +417,23 @@ Sadly, this is due to bug in jellyfin, where it marks the item as played without
 such, watchstate doesn't really know the item has changed since last sync. Unfortunately, there is no way to fix this
 issue from our side for the `state:import` task as it working as intended.
 
+### Workarounds.
+
+There are two possible workarounds:
+
+### (1) Webhooks (Recommended)
+
 However, we managed implemented a workaround for this issue using the webhooks as workaround, until jellyfin devs fixes
 the issue. Please enable webhooks for your jellyfin backend to avoid this issue.
 
+### (1) by special handling
+
+We have added an experimental workaround for this issue in the `state:import` command, to enable it, add the env `WS_CLIENTS_JELLYFIN_FIX_PLAYED` via the `Env` page. It's turned off by default as it may cause some issues as it's untested in production, so please use it with caution and report any issues you find.
+
+## CODE: DM001 - Marking the item as tainted and re-processing.
+
+This warning appears when there is a mismatch between the local database and a backend regarding the item. This error mostly occurs in some edge cases. which can be fixed by forced state export to the backend.
+
 ---
 
 # How does the file integrity feature works?

composer.json

@@ -10,15 +10,28 @@
         "optimize-autoloader": true,
         "preferred-install": {
             "*": "dist"
+        },
+        "allow-plugins": {
+            "carthage-software/mago": true
         }
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
         "tests": "vendor/bin/phpunit",
-        "ui_update": "pnpm up --dir ./frontend --latest",
-        "ui_gen": "pnpm run --dir ./frontend generate",
-        "ui_dev": "pnpm run --dir ./frontend dev",
-        "ui_tc": "pnpm run --dir ./frontend typecheck"
+        "format": "vendor/bin/mago format",
+        "format:ci": "vendor/bin/mago format --check",
+        "test:all": "php -d display_errors=1 -d display_startup_errors=1 -d error_reporting=E_ALL vendor/bin/phpunit",
+        "test:coverage": [
+            "mkdir -p var/coverage",
+            "php -d zend_extension=xdebug -d xdebug.mode=coverage -d xdebug.start_with_request=no vendor/bin/phpunit --coverage-filter src/ --coverage-clover var/coverage/clover.xml --coverage-xml var/coverage/xml --coverage-text",
+            "echo 'Coverage reports generated in ./var/coverage/'"
+        ],
+        "lint": "vendor/bin/mago lint",
+        "frontend:update": "pnpm up --dir ./frontend --latest",
+        "frontend:gen": "pnpm run --dir ./frontend generate",
+        "frontend:dev": "pnpm run --dir ./frontend dev",
+        "frontend:tc": "pnpm run --dir ./frontend typecheck",
+        "frontend:prepare": "pnpm run --dir ./frontend prepare --envName=development"
     },
     "require": {
         "php": "^8.4",
@@ -62,8 +75,7 @@
         "roave/security-advisories": "dev-latest",
         "symfony/var-dumper": "^7.2",
         "phpunit/phpunit": "^11.5.2",
-        "phpstan/phpstan": "^2.0",
-        "psalm/phar": "^5.26"
+        "carthage-software/mago": "^1.3.0"
     },
     "autoload-dev": {
         "psr-4": {