Merge pull request #399 from stumpapp/release/v0.0.5

🔖 Release v0.0.5
stumpapp · Aug 15, 2024 · f8f0d3d · f8f0d3d
2 parents c0c4267 + c828e42
commit f8f0d3d
Show file tree

Hide file tree

Showing 179 changed files with 6,478 additions and 1,454 deletions.
diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
@@ -1,7 +1,49 @@
 # Changelog
 
-<a name="next"></a>
-## next
+<a name="0.0.5"></a>
+## 0.0.5 (2024-08-14)
+
+### Added
+
+- 👷‍♂️ Remote duplicate rust cache action in CI ([#396](https://github.com/stumpapp/stump/issues/396)) [[dddb298](https://github.com/stumpapp/stump/commit/dddb298bb794f0c6048e281af02c2a2c73f679d2)]
+- ✅ Add tests to improve coverage ([#394](https://github.com/stumpapp/stump/issues/394)) [[7d6c289](https://github.com/stumpapp/stump/commit/7d6c289220a2ad9cbd49605b2af81950e39e6ec5)]
+- 👷‍♂️ Fix codecov upload conditions in CI ([#395](https://github.com/stumpapp/stump/issues/395)) [[4b4dcb1](https://github.com/stumpapp/stump/commit/4b4dcb14ed420ab4adc25706b672cafff1d1e34b)]
+- ✨ Add &#x60;OpenDyslexic&#x60; font and pave way to support other fonts ([#386](https://github.com/stumpapp/stump/issues/386)) [[1a0b76d](https://github.com/stumpapp/stump/commit/1a0b76d8090084f98f904c1d51cd5c404e8c38bc)]
+- 👷‍♂️ Add &#x60;macOS&#x60; platform to binary release workflow ([#374](https://github.com/stumpapp/stump/issues/374)) [[7fc059f](https://github.com/stumpapp/stump/commit/7fc059fd3857015e3eded2bf8451520dd57e5c11)]
+- ✅ Add core tests to improve coverage ([#370](https://github.com/stumpapp/stump/issues/370)) [[c73dd31](https://github.com/stumpapp/stump/commit/c73dd31e39e968df394a4ecdf297696215b93c47)]
+- ✨ Page dimensions analysis task ([#349](https://github.com/stumpapp/stump/issues/349)) [[3f447d5](https://github.com/stumpapp/stump/commit/3f447d56a83a7652bdc2a9c602f80c227577dde2)]
+- ✨ Historical read progress tracking ([#340](https://github.com/stumpapp/stump/issues/340)) [[e355932](https://github.com/stumpapp/stump/commit/e355932d021670cc01b4a19de3e370326ad370c3)]
+
+### Fixed
+
+- 🐛 Fix 422 error relating to invalid user permission ([#389](https://github.com/stumpapp/stump/issues/389)) [[7c44eb9](https://github.com/stumpapp/stump/commit/7c44eb904bab1778481f67327d700c5c717a2c2f)]
+- 🐛 Fix missing scrollbar in table component ([#382](https://github.com/stumpapp/stump/issues/382)) [[1b5cc1b](https://github.com/stumpapp/stump/commit/1b5cc1bce975f8e1fbdc748987c1d5af528d997d)]
+- 🐛 Fix various thumbnail generation issues ([#381](https://github.com/stumpapp/stump/issues/381)) [[7f09503](https://github.com/stumpapp/stump/commit/7f0950390259478c23ffe015ba61e4018586a420)]
+- ✏️ Fix infered typo ([#379](https://github.com/stumpapp/stump/issues/379)) [[6f2b3d9](https://github.com/stumpapp/stump/commit/6f2b3d9516893acabd6db68167cc0cd020afa47f)]
+- 🐛 Fix bug in &#x60;WebpProcessor::generate&#x60; ([#380](https://github.com/stumpapp/stump/issues/380)) [[d59d547](https://github.com/stumpapp/stump/commit/d59d547d9bc87fe111c53c335f5cb9f6cc0d72ab)]
+- 🐛 Fix basic auth password parsing breaking on : character ([#375](https://github.com/stumpapp/stump/issues/375)) [[2f8d53a](https://github.com/stumpapp/stump/commit/2f8d53a9cfa76b0b3aa8fdbec0962926c1a144ab)]
+
+### Miscellaneous
+
+-  👷 Make codecov run on pushes to develop as well ([#392](https://github.com/stumpapp/stump/issues/392)) [[6161b49](https://github.com/stumpapp/stump/commit/6161b4970b4cbf6a08520bb63bb3ca20304c8262)]
+- 🌐 Update translations ([#390](https://github.com/stumpapp/stump/issues/390)) [[4b375bf](https://github.com/stumpapp/stump/commit/4b375bf341aa747a9db839fa7c8d11b06f1dc5d6)]
+- 🩹 Fix path filter on push ([#388](https://github.com/stumpapp/stump/issues/388)) [[cb837c5](https://github.com/stumpapp/stump/commit/cb837c55729228c9cc164de338f482328a1c0a8b)]
+- 🔨 Fix cargo watch tooling ([#387](https://github.com/stumpapp/stump/issues/387)) [[b7e5771](https://github.com/stumpapp/stump/commit/b7e5771fdf189ad77823ddc5f889d1a4ae2daec4)]
+- 🔨 Update docker-compose example to remove version ([#373](https://github.com/stumpapp/stump/issues/373)) [[6bba9f9](https://github.com/stumpapp/stump/commit/6bba9f92170f16fe735611edc5a2377612d7e25c)]
+-  👷 Release server binary ([#369](https://github.com/stumpapp/stump/issues/369)) [[ac0d723](https://github.com/stumpapp/stump/commit/ac0d723e4b519aa5680e36535877905521db78dd)]
+- 🌐 New translations ([#368](https://github.com/stumpapp/stump/issues/368)) [[d71fc24](https://github.com/stumpapp/stump/commit/d71fc240fd8d6e7a8823da15c26f824bf390c4a5)]
+-  👷 Add code coverage tracking ([#366](https://github.com/stumpapp/stump/issues/366)) [[5fa2695](https://github.com/stumpapp/stump/commit/5fa2695bc5f22e60a0a853c718c3ba90beca39ec)]
+-  Merge remote-tracking branch &#x27;origin/main&#x27; into develop [[f63a213](https://github.com/stumpapp/stump/commit/f63a21310766d05e732269f101833dd391be1d54)]
+-  Merge pull request [#360](https://github.com/stumpapp/stump/issues/360) from stumpapp/experimental [[f38ce38](https://github.com/stumpapp/stump/commit/f38ce385a3adfbcd31cbbd5daa240b0c516d3848)]
+-  Merge branch &#x27;develop&#x27; into experimental [[861eab6](https://github.com/stumpapp/stump/commit/861eab607d48efc7138f4b95343ae7f9415fdc09)]
+- 🌐 New Translations ([#363](https://github.com/stumpapp/stump/issues/363)) [[c29d18f](https://github.com/stumpapp/stump/commit/c29d18f7b54436c6dcc24af625057e969cca4317)]
+- 🍒 Port DB error fix during media analysis [[0177f06](https://github.com/stumpapp/stump/commit/0177f06b0cc1561faaa708a725118b28ad4f6ae2)]
+-  Merge remote-tracking branch &#x27;origin/develop&#x27; into experimental [[4fdc5d3](https://github.com/stumpapp/stump/commit/4fdc5d3e7cc27bb59004a7f61b20b2c8dcae63f9)]
+-  Merge remote-tracking branch &#x27;origin/develop&#x27; into experimental [[0bf0ec9](https://github.com/stumpapp/stump/commit/0bf0ec94f057462805d1e15ab1ab2b727f494e84)]
+
+
+<a name="0.0.4"></a>
+## 0.0.4 (2024-07-11)
 
 ### Added
 
@@ -27,6 +69,7 @@
 
 ### Miscellaneous
 
+-  Merge pull request [#365](https://github.com/stumpapp/stump/issues/365) from stumpapp/release/v0.0.4 [[c0c4267](https://github.com/stumpapp/stump/commit/c0c4267c987045b16ad16a49e355565463b22339)]
 - 🌐 Update translations ([#352](https://github.com/stumpapp/stump/issues/352)) [[09cae5b](https://github.com/stumpapp/stump/commit/09cae5b875a00ce00d64354dcae04c0e093100de)]
 - 🌐 Update translations ([#345](https://github.com/stumpapp/stump/issues/345)) [[755403e](https://github.com/stumpapp/stump/commit/755403e01113c54a09aee9a9b514d7261d31eec8)]
 -  Merge pull request [#342](https://github.com/stumpapp/stump/issues/342) from stumpapp/experimental [[2d5fac5](https://github.com/stumpapp/stump/commit/2d5fac55be4d82fe56d1ea99c98471d9b98771c4)]

diff --git a/.github/actions/build-server/action.yml b/.github/actions/build-server/action.yml
@@ -1,10 +1,5 @@
-name: 'Build Stump server'
-description: 'Compile the Stump Rust server'
-
-inputs:
-  platform:
-    description: 'The plaform of the runner'
-    required: true
+name: Build Stump server
+description: Compile the Stump Rust server
 
 runs:
   using: composite
@@ -15,12 +10,19 @@ runs:
     - name: Setup rust
       uses: ./.github/actions/setup-rust
 
-    - name: Copy bundled web app
-      uses: actions/download-artifact@v3
-      with:
-        name: webapp
-        path: ./apps/server/dist
-
-    - name: Compile server
+    # This action can be called to build in a Linux, macOS, or Windows runner
+    # This step only runs when using Linux
+    - name: Compile server (Linux)
+      if: runner.os == 'Linux'
       shell: bash
       run: cargo build --package stump_server --release
+    - name: Compile server (macOS)
+      # Alternatively, when running macOS
+      if: runner.os == 'macOS'
+      shell: bash
+      run: cargo build --package stump_server --release
+    - name: Compile server (Windows)
+      # Alternatively, when running Windows
+      if: runner.os == 'Windows'
+      shell: powershell
+      run: cargo build --package stump_server --release
diff --git a/.github/actions/build-web/action.yml b/.github/actions/build-web/action.yml
@@ -1,5 +1,5 @@
-name: 'Compile Web Application'
-description: 'Compile stump web'
+name: Compile Web Application
+description: Compile stump web
 
 runs:
   using: composite

diff --git a/.github/actions/setup-rust/action.yml b/.github/actions/setup-rust/action.yml
@@ -1,13 +1,13 @@
-name: 'Setup system dependencies'
-description: 'Install system dependencies and setup cache'
+name: Setup system dependencies
+description: Install system dependencies and setup cache
 
 runs:
-  using: 'composite'
+  using: composite
   steps:
     - name: Install Rust
       uses: actions-rs/toolchain@v1
       with:
-        toolchain: 1.77.2
+        toolchain: 1.79.0
         profile: minimal
         override: true
         components: rustfmt, clippy

diff --git a/.github/actions/upload-artifact/action.yml b/.github/actions/upload-artifact/action.yml
@@ -1,16 +1,16 @@
-name: 'Upload Local'
-description: 'Upload artifact to local action'
+name: Upload Local
+description: Upload artifact to local action
 
 inputs:
   upload-name:
     required: true
-    description: 'Name of the upload'
+    description: Name of the upload
   upload-path:
     required: true
-    description: 'Path to the upload data'
+    description: Path to the upload data
 
 runs:
-  using: 'composite'
+  using: composite
   steps:
     # https://github.com/actions/upload-artifact/issues/337
     - name: Normalize
@@ -22,7 +22,7 @@ runs:
         echo "normalized_path=$UPLOAD_PATH" >> $GITHUB_OUTPUT
 
     - name: Upload
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       with:
         name: ${{ inputs.upload-name }}
         path: ${{ env.normalized_path || inputs.upload-path }}

diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -0,0 +1,13 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 10%
+    patch:
+      default:
+        target: 0%
+ignore:
+  - 'crates/cli'
+  - 'crates/codegen'
+  - 'crates/prisma-cli'
+  - 'apps/desktop'
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,16 +1,35 @@
 name: 'Stump Checks CI'
-
 on:
   pull_request:
   push:
     branches:
       - main
+      - develop
 
 jobs:
+  code-changes-check:
+    runs-on: [ubuntu-22.04]
+    outputs:
+      changes: ${{steps.filter.outputs.changes}}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          filters: |
+            apps: ./apps/**
+            crates: ./crates/**
+            docker: ./docker/**
+            packages: ./packages/**
+
   check-rust:
-    if: "!contains(github.event.pull_request.head.ref, 'release/v')"
+    needs: code-changes-check
+    if: "!contains(github.event.pull_request.head.ref, 'release/v') && needs.code-changes-check.outputs.changes != '[]'"
     name: Rust checks
     runs-on: [ubuntu-22.04]
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, windows-latest]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -22,28 +41,48 @@ jobs:
         run: |
           cargo fmt --all -- --check
           cargo clippy -- -D warnings
-      # TODO: fix the tests, then uncomment this
-      # - name: Run tests
-      #   run: |
-      #     cargo integration-tests
+
+      - name: Run tests
+        run: cargo test
+
+      # TODO: move coverage to a separate job instead of conditionally running it
+      # on the ubuntu-22.04 runner as a workaround for only running it once
+      - name: Install cargo-llvm-cov
+        if: matrix.os == 'ubuntu-22.04'
+        run: cargo install cargo-llvm-cov
+
+      - name: Generate code coverage data
+        if: matrix.os == 'ubuntu-22.04'
+        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
+
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-22.04'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: lcov.info
+          fail_ci_if_error: true
 
   check-typescript:
-    if: "!contains(github.event.pull_request.head.ref, 'release/v')"
+    needs: code-changes-check
+    if: "!contains(github.event.pull_request.head.ref, 'release/v') && needs.code-changes-check.outputs.changes != '[]'"
     name: TypeScript checks
     runs-on: [ubuntu-22.04]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
         with:
           node-version: '20.0.0'
 
       - name: Install yarn
         shell: bash
         run: npm install -g yarn
 
-      - uses: actions/setup-node@v4
+      - name: Setup node (yarn cache)
+        uses: actions/setup-node@v4
         with:
           node-version: '20.0.0'
           cache: 'yarn'

diff --git a/.github/workflows/experimental.yml b/.github/workflows/experimental.yml
@@ -17,9 +17,27 @@ env:
   DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
 
 jobs:
+  code-changes-check:
+    runs-on: [ubuntu-22.04]
+    outputs:
+      changes: ${{steps.filter.outputs.changes}}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          base: 'experimental'
+          filters: |
+            apps: ./apps/**
+            crates: ./crates/**
+            docker: ./docker/**
+            packages: ./packages/**
+
   nightly-docker-build:
+    needs: code-changes-check
     name: Build docker image
     runs-on: [ubuntu-22.04]
+    if: ${{ needs.code-changes-check.outputs.changes != '[]' }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3

diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -17,8 +17,25 @@ env:
   DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
 
 jobs:
+  code-changes-check:
+    runs-on: [ubuntu-22.04]
+    outputs:
+      changes: ${{steps.filter.outputs.changes}}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          base: 'develop'
+          filters: |
+            apps: ./apps/**
+            crates: ./crates/**
+            docker: ./docker/**
+            packages: ./packages/**
+
   nightly-docker-build:
-    if: "!contains(github.event.pull_request.head.ref, 'release/v')"
+    needs: code-changes-check
+    if: "!contains(github.event.pull_request.head.ref, 'release/v') && needs.code-changes-check.outputs.changes != '[]'"
     name: Build docker image
     runs-on: [ubuntu-22.04]
     steps:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-name: 'Release CI'
+name: Release CI
 
 # This workflow triggers when a PR is merged into `main`, but jobs have conditions to only run when:
 # - A PR is closed, merged into `main`, from a branch that matches the pattern `release/v*.*.*`
@@ -86,65 +86,3 @@ jobs:
           push: ${{ needs.push-or-load.outputs.push }}
           platforms: ${{ needs.push-or-load.outputs.platforms }}
           discord-webhook: ${{ secrets.DISCORD_WEBHOOK }}
-
-  # build-web-app:
-  #   name: Build web app
-  #   runs-on: [self-hosted]
-  #   if: false # TODO: Enable this once 0.1.0 is ready
-  #   steps:
-  #     - name: Checkout repository
-  #       uses: actions/checkout@v3
-
-  #     - name: Build the app
-  #       uses: ./.github/actions/build-web
-
-  #     - name: Upload the build
-  #       uses: ./.github/actions/upload-artifact
-  #       with:
-  #         upload-name: webapp
-  #         upload-path: apps/web/dist
-
-  # build-server:
-  #   strategy:
-  #     fail-fast: true
-  #     matrix:
-  #       platform: [macos, windows]
-  #   name: Build server app
-  #   needs: build-web
-  #   runs-on: ${{ matrix.platform }}
-  #   if: false # TODO: Enable this once 0.1.0 is ready
-  #   steps:
-  #     - name: Checkout repository
-  #       uses: actions/checkout@v3
-
-  #     - name: Build the server
-  #       uses: ./.github/actions/build-server
-  #       with:
-  #         platform: ${{ matrix.platform }}
-
-  #     - name: Upload the server binary
-  #       uses: ./.github/actions/upload-artifact
-  #       with:
-  #         upload-name: stump_server-${{ matrix.platform }}
-  #         upload-path: target/release/stump_server
-
-  # # TODO: Investigate if I can just merge this with the above
-  # build-linux-server:
-  #   name: Build server app (self-hosted runner)
-  #   needs: build-web
-  #   runs-on: [self-hosted]
-  #   if: false # TODO: Enable this once 0.1.0 is ready
-  #   steps:
-  #     - name: Checkout repository
-  #       uses: actions/checkout@v3
-
-  #     - name: Build the server
-  #       uses: ./.github/actions/build-server
-  #       with:
-  #         platform: 'linux'
-
-  #     - name: Upload the server binary
-  #       uses: ./.github/actions/upload-artifact
-  #       with:
-  #         upload-name: stump_server-linux
-  #         upload-path: target/release/stump_server