Release v3.5.0

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = test/*

.editorconfig

@@ -15,5 +15,5 @@ indent_size = 4
 [*.md]
 trim_trailing_whitespace = false
 
-[*.{js,yaml}]
+[*.{js,yaml,yml}]
 indent_size = 2

.flake8

@@ -21,5 +21,7 @@ extend-exclude =
     scratch*,
     # Ignore dirs and files that have not been ported yet
     */jukebox/NvManager.py
-    # ignore GitHub Codespaces
+    # ignore Python venv's
     .venv/*
+    # ignore node modules
+    */node_modules/*

.github/workflows/bundle_webapp_and_release_v3.yml

@@ -0,0 +1,183 @@
+name: Bundle Webapp and Release
+
+on:
+  push:
+    branches:
+      - 'future3/main'
+      - 'future3/develop'
+
+jobs:
+
+  check:
+    if: ${{ github.repository_owner == 'MiczFlor' }}
+    runs-on: ubuntu-latest
+
+    outputs:
+      tag_name: ${{ steps.vars.outputs.tag_name }}
+      release_type: ${{ steps.vars.outputs.release_type }}
+      check_abort: ${{ steps.vars.outputs.check_abort }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set Output vars
+        id: vars
+        env:
+          BRANCH_NAME: ${{ github.ref_name }}
+        run: |
+          # Official SemVer Regex definition
+          # https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+          # Needed changes to the regex:
+          # - '?:' capture command needed to be removed as it wasn't working in shell
+          # - '\d' had to be replaced with [0-9]
+          #
+          # Release versions like 1.0.0, 3.5.0, 100.4.50000+metadata
+          REGEX_VERSION_RELEASE="^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$"
+          #
+          # Prerelease versions like 1.0.0-alpha, 3.5.0-whatsoever.12, 100.4.50000-identifier.12+metadata
+          REGEX_VERSION_PRERELEASE="^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$"
+
+
+          # Get the version and calculate release type
+          VERSION=$(python ./src/jukebox/jukebox/version.py)
+          if echo "$VERSION" | grep -qoE "$REGEX_VERSION_RELEASE" ; then
+            RELEASE_TYPE=release
+          elif echo "$VERSION" | grep -qoE "$REGEX_VERSION_PRERELEASE" ; then
+            RELEASE_TYPE=prerelease
+          else
+            RELEASE_TYPE=none
+          fi
+
+          if [ "$BRANCH_NAME" == 'future3/main' -a "$RELEASE_TYPE" == 'release' ] || [ "$BRANCH_NAME" == 'future3/develop' -a "$RELEASE_TYPE" == 'prerelease' ] ; then
+            CHECK_ABORT=false
+          else
+            echo "::notice title=Abort due to not matching ${RELEASE_TYPE} version for branch!::'${VERSION}' on '${BRANCH_NAME}'"
+            CHECK_ABORT=true
+          fi
+
+          echo "::group::Output values"
+          echo "Version: ${VERSION}"
+          echo "RELEASE_TYPE: ${RELEASE_TYPE}"
+          echo "BRANCH_NAME: ${BRANCH_NAME}"
+          echo "CHECK_ABORT: ${CHECK_ABORT}"
+
+          echo "tag_name=v${VERSION}" >> $GITHUB_OUTPUT
+          echo "release_type=${RELEASE_TYPE}" >> $GITHUB_OUTPUT
+          echo "branch_name=${BRANCH_NAME}" >> $GITHUB_OUTPUT
+          echo "check_abort=${CHECK_ABORT}" >> $GITHUB_OUTPUT
+          echo "::endgroup::"
+
+  build:
+    needs: [check]
+    if: ${{ needs.check.outputs.check_abort == 'false' }}
+    runs-on: ubuntu-latest
+
+    env:
+      WEBAPP_ROOT_PATH: ./src/webapp
+
+    outputs:
+      tag_name: ${{ needs.check.outputs.tag_name }}
+      release_type: ${{ needs.check.outputs.release_type }}
+      commit_sha: ${{ steps.vars.outputs.commit_sha }}
+      webapp_bundle_name: ${{ steps.vars.outputs.webapp_bundle_name }}
+      webapp_bundle_name_latest: ${{ steps.vars.outputs.webapp_bundle_name_latest }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set Output vars
+        id: vars
+        env:
+          COMMIT_SHA: ${{ github.sha }}
+        run: |
+          echo "commit_sha=${COMMIT_SHA}" >> $GITHUB_OUTPUT
+          echo "webapp_bundle_name=webapp-build-${COMMIT_SHA:0:10}.tar.gz" >> $GITHUB_OUTPUT
+          echo "webapp_bundle_name_latest=webapp-build-latest.tar.gz" >> $GITHUB_OUTPUT
+
+      - name: Setup Node.js 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+      - name: npm install
+        working-directory: ${{ env.WEBAPP_ROOT_PATH }}
+        run: npm install
+      - name: npm build
+        working-directory: ${{ env.WEBAPP_ROOT_PATH }}
+        env:
+          CI: false
+        run: npm run build
+
+      - name: Create Bundle
+        working-directory: ${{ env.WEBAPP_ROOT_PATH }}
+        run: |
+          tar -czvf ${{ steps.vars.outputs.webapp_bundle_name }} build
+
+      - name: Artifact Upload
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ steps.vars.outputs.webapp_bundle_name }}
+          path: ${{ env.WEBAPP_ROOT_PATH }}/${{ steps.vars.outputs.webapp_bundle_name }}
+          retention-days: 5
+
+  release:
+    needs: [build]
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: ${{ needs.build.outputs.tag_name }}
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Artifact Download
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ needs.build.outputs.webapp_bundle_name }}
+
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        with:
+          commit: ${{ needs.build.outputs.commit_sha }}
+          tag: ${{ needs.build.outputs.tag_name }}
+          body: "Automated Release for ${{ needs.build.outputs.tag_name }}"
+          makeLatest: 'false'
+          prerelease: ${{ needs.build.outputs.release_type == 'prerelease' }}
+          generateReleaseNotes: ${{ needs.build.outputs.release_type == 'release' }}
+          skipIfReleaseExists: false
+          allowUpdates: true
+          removeArtifacts: false
+          replacesArtifacts: false
+          omitBodyDuringUpdate: true
+          omitNameDuringUpdate: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get Release by tag
+        id: get_release
+        uses: joutvhu/get-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ needs.build.outputs.tag_name }}
+
+      - name: Upload Release Asset
+        uses: shogo82148/actions-upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.get_release.outputs.upload_url }}
+          asset_name: ${{ needs.build.outputs.webapp_bundle_name }}
+          asset_path: ${{ needs.build.outputs.webapp_bundle_name }}
+          asset_content_type: application/gzip
+          overwrite: true
+
+      - name: Upload Release Asset as Latest
+        uses: shogo82148/actions-upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.get_release.outputs.upload_url }}
+          asset_name: ${{ needs.build.outputs.webapp_bundle_name_latest }}
+          asset_path: ${{ needs.build.outputs.webapp_bundle_name }}
+          asset_content_type: application/gzip
+          overwrite: true

.github/workflows/codeql-analysis.yml → .github/workflows/codeql-analysis_v3.yml

@@ -9,14 +9,14 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: "CodeQL v3"
 
 on:
   push:
-    branches: [ develop ]
+    branches: [ future3/develop ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ develop ]
+    branches: [ future3/develop ]
   schedule:
     - cron: '16 18 * * 0'
 
@@ -35,22 +35,37 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+          python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        # Install necessary packages
+        sudo apt-get install libasound2-dev pulseaudio
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        # Set the `CODEQL-PYTHON` environment variable to the Python executable
+        # that includes the dependencies
+        echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
+        setup-python-dependencies: false
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +79,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/pythonpackage_future3.yml

@@ -39,9 +39,9 @@ jobs:
         pip3 install -r src/jukebox/components/rfid/hardware/pn532_i2c_py532/requirements.txt
         pip3 install -r src/jukebox/components/rfid/hardware/rdm6300_serial/requirements.txt
         pip3 install -r src/jukebox/components/rfid/hardware/rc522_spi/requirements.txt
-    - name: Run pytest
+    - name: Run pytest with coverage
       run: |
-        ./run_pytest.sh --cov --cov-report xml
+        ./run_pytest.sh --cov --cov-report xml --cov-config=.coveragerc
     - name: Report to Coveralls (parallel)
       uses: coverallsapp/github-action@v2
       with:

.github/workflows/test_docker_debian_v3.yml

@@ -5,9 +5,29 @@ on:
     # run at 17:00 every sunday
     - cron: '0 17 * * 0'
   push:
+    branches:
+        - 'future3/**'
+    paths:
+        - '.github/workflows/test_docker_debian*.yml'
+        - 'installation/**'
+        - 'ci/**'
+        - 'resources/**'
+        - 'src/jukebox/jukebox/version.py'
+        - 'packages*.txt'
+        - 'requirements*.txt'
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ future3/develop ]
+    branches:
+        - future3/develop
+        - future3/main
+    paths:
+        - '.github/workflows/test_docker_debian*.yml'
+        - 'installation/**'
+        - 'ci/**'
+        - 'resources/**'
+        - 'src/jukebox/jukebox/version.py'
+        - 'packages*.txt'
+        - 'requirements*.txt'
 
 # let only one instance run the test so cache is not corrupted.
 # cancel already running instances as only the last run will be relevant

.gitignore

@@ -6,6 +6,7 @@
 /shared/logs/*.log*
 /shared/*.*
 /shared/*
+/src/webapp/public/cover-cache/*.*
 
 # Application
 /src/cli_client/pbc

ci/installation/run_install_common.sh

@@ -24,8 +24,8 @@ export ENABLE_WEBAPP_PROD_DOWNLOAD=true
 # n - setup rfid reader
 # y - setup samba
 # y - setup webapp
-# n - setup kiosk mode
 # - - install node (forced WebApp Download)
+# n - setup kiosk mode
 # n - reboot
 
 "${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y

ci/installation/run_install_faststartup.sh

@@ -22,8 +22,8 @@ LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
 # n - setup rfid reader
 # n - setup samba
 # n - setup webapp
-# - - setup kiosk mode (only with webapp = y)
 # - - install node (only with webapp = y)
+# - - setup kiosk mode (only with webapp = y)
 # n - reboot
 
 "${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y

ci/installation/run_install_libzmq_local.sh

@@ -23,8 +23,8 @@ export BUILD_LIBZMQ_WITH_DRAFTS_ON_DEVICE=true
 # n - setup rfid reader
 # n - setup samba
 # n - setup webapp
-# - - setup kiosk mode (only with webapp = y)
 # - - install node (only with webapp = y)
+# - - setup kiosk mode (only with webapp = y)
 # n - reboot
 
 "${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y

ci/installation/run_install_webapp_download.sh

@@ -11,7 +11,6 @@ SCRIPT_DIR="$(dirname "$SOURCE")"
 LOCAL_INSTALL_SCRIPT_PATH="${INSTALL_SCRIPT_PATH:-${SCRIPT_DIR}/../../installation}"
 LOCAL_INSTALL_SCRIPT_PATH="${LOCAL_INSTALL_SCRIPT_PATH%/}"
 
-export ENABLE_WEBAPP_PROD_DOWNLOAD=true
 # Run installation (in interactive mode)
 # y - start setup
 # n - use static ip
@@ -23,8 +22,8 @@ export ENABLE_WEBAPP_PROD_DOWNLOAD=true
 # n - setup rfid reader
 # n - setup samba
 # y - setup webapp
+# n - install node
 # y - setup kiosk mode
-# - - install node (forced webapp download)
 # n - reboot
 
 "${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y
@@ -36,6 +35,7 @@ n
 n
 n
 y
+n
 y
 n
 '

ci/installation/run_install_webapp_local.sh

@@ -23,8 +23,8 @@ export ENABLE_WEBAPP_PROD_DOWNLOAD=false
 # n - setup rfid reader
 # n - setup samba
 # y - setup webapp
-# y - setup kiosk mode
 # y - install node
+# y - setup kiosk mode
 # n - reboot
 
 "${LOCAL_INSTALL_SCRIPT_PATH}/install-jukebox.sh" <<< 'y

docker/docker-compose.yml

@@ -41,6 +41,7 @@ services:
     tty: true
     volumes:
       - ../src/jukebox:/root/RPi-Jukebox-RFID/src/jukebox
+      - ../src/webapp/public/cover-cache:/root/RPi-Jukebox-RFID/src/webapp/build/cover-cache
       - ../shared:/root/RPi-Jukebox-RFID/shared
       - ./config/docker.pulse.mpd.conf:/root/.config/mpd/mpd.conf
     command: python run_jukebox.py