Release 6.0.0

Develop

.github/workflows/deployment-master.yml

@@ -14,12 +14,6 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-
-      - uses: sonarsource/sonarqube-scan-action@master
-        continue-on-error: true
-        env:
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
 
       - name: Fetch Current Package Version
         id: package-version

CHANGELOG.md

@@ -2,9 +2,32 @@
 
 ## 6.0.0
 
+Recommended Gamevault App Version: `v1.6.0`
+
+### Breaking Changes & Migration
+
+- We've removed the outdated Utility APIs. Instead, please switch to using the more current replacements.
+- We've removed the Tags, Genres, Developers, and Publisher details from entries on the /games API for performace Reasons. To get all details for a game use the /game/:id API
+- Fuzzy Search for Tags, Genres, Developers, and Publishers has been eliminated. (Previously for example, searching for a Publisher like "Rockstar" would return "GTA V") This change was made to improve search performance (18x speed)
+
 ### Changes
 
-- TODO: Removed Deprecated Utility APIs
+- Fixed the default CORS configuration.
+- Significantly enhanced the RAWG Search API, resulting in approximately 5 times faster performance and reduced data consumption. [#187](https://github.com/Phalcode/gamevault-backend/issues/187). Previously, search results inadvertently generated numerous tags, genres, developers, and stores in your databases, as well as images on your filesystem. This is no longer the case. The RAWG Search now provides only essential game information for identification and remapping.
+- Improved Search Performance.
+- Enhanced Error-Handling during image downloads.
+- Transitioned to the Debian `20.6-slim` docker image.
+- Rectified "required/nullable" fields in the API Specification.
+- Resolved the file title extraction issue. [#209](https://github.com/Phalcode/gamevault-app/issues/209).
+- Fixed the Broken Content-Disposition Header for some downloads. [#209](https://github.com/Phalcode/gamevault-app/issues/209).
+- Game Type only gets detected once, or when a game file changes and not on every index. [#200](https://github.com/Phalcode/gamevault-backend/issues/200)
+- Unified global error handler for 4XX and 5XX messages. The Problem is now directly inside the response without the duplicated status.
+- Implemented `(NC)` flag to disable rawg-caching for single games. #194(https://github.com/Phalcode/gamevault-app/issues/194)
+
+### Thanks
+
+- @yodatak
+- @Ben2303
 
 ## 5.0.2
 
@@ -101,7 +124,7 @@ Recommended Gamevault App Version: `v1.5.0`
 
 - @freitagdavid
 - @Kairubyte
-- @yotadak
+- @yodatak
 
 ## 4.0.1
 
@@ -127,13 +150,13 @@ Recommended Gamevault App Version: `v1.5.0`
 - Fixed `SERVER_CORS_ALLOWED_ORIGINS` not working for multiple origins
 - Fixed Vague Password Validation Message
 - Fixed Version "undefined" on Server Startup Log
-- Changed project structure as preparatory work for https://github.com/Phalcode/gamevault-backend/issues/140
+- Changed project structure as preparatory work for [#140](https://github.com/Phalcode/gamevault-backend/issues/140)
 - Implemented Update Game API (currently only supports rawg_id and box_image may come in handy for [#161](https://github.com/Phalcode/gamevault-backend/issues/161) in the future!)
 - [#146](https://github.com/Phalcode/gamevault-backend/issues/146) Fixed OpenAPI Spec again
 
 ### Thanks
 
-- @Yotadak
+- @yodatak
 - @Kairubyte
 
 ## 3.0.0

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20.6 AS base
+FROM node:20.6-slim AS base
 # Default Variables
 ENV PUID=1000
 ENV PGID=1000

nest-cli.json

@@ -3,6 +3,12 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "assets": ["**/static/*"]
+    "assets": [
+      {
+        "include": "../assets",
+        "outDir":"dist/assets",
+        "watchAssets": true
+      }
+    ]
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gamevault-backend",
-  "version": "5.0.2",
+  "version": "6.0.0",
   "description": "the self-hosted gaming platform for drm-free games",
   "author": "Alkan Alper, Schäfer Philip GbR / Phalcode",
   "private": true,
@@ -9,26 +9,27 @@
     "build": "rimraf dist && nest build",
     "format": "prettier --write \"src/**/*.ts\"",
     "start": "rimraf dist && nest start --watch",
-    "start:debug": "nest start --debug --watch",
+    "profile": "rimraf dist && nest start --watch -e 'node --prof'",
+    "start:debug": "rimraf dist &&  nest start --debug --watch",
     "start:prod": "node dist/src/main",
-    "lint": "eslint \"{src,apps,libs}/**/*.ts\" --fix",
-    "migration:gen:sqlite": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:generate -p",
-    "migration:run:sqlite": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:run",
-    "migration:revert:sqlite": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:revert",
-    "migration:gen:postgres": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:generate -p",
-    "migration:run:postgres": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:run",
-    "migration:revert:postgres": "rimraf dist && pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:revert"
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "migration:gen:sqlite": "pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:generate -p",
+    "migration:run:sqlite": "pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:run",
+    "migration:revert:sqlite": "pnpm run build && typeorm -d dist/src/modules/database/migrations/sqlite.migration-config.js migration:revert",
+    "migration:gen:postgres": "pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:generate -p",
+    "migration:run:postgres": "pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:run",
+    "migration:revert:postgres": "pnpm run build && typeorm -d dist/src/modules/database/migrations/postgres.migration-config.js migration:revert"
   },
   "dependencies": {
     "@nestjs/axios": "3.0.0",
-    "@nestjs/common": "10.2.5",
-    "@nestjs/core": "10.2.5",
+    "@nestjs/common": "10.2.6",
+    "@nestjs/core": "10.2.6",
     "@nestjs/passport": "10.0.2",
-    "@nestjs/platform-express": "10.2.5",
-    "@nestjs/schedule": "3.0.3",
-    "@nestjs/swagger": "7.1.11",
+    "@nestjs/platform-express": "10.2.6",
+    "@nestjs/schedule": "3.0.4",
+    "@nestjs/swagger": "7.1.12",
     "@nestjs/typeorm": "10.0.0",
-    "async-g-i-s": "1.5.0",
+    "async-g-i-s": "1.5.1",
     "axios": "1.5.0",
     "bcrypt": "5.1.1",
     "better-sqlite3": "8.6.0",
@@ -38,7 +39,7 @@
     "cookie-parser": "1.4.6",
     "dotenv": "16.3.1",
     "express": "4.18.2",
-    "fastify": "4.23.0",
+    "fastify": "4.23.2",
     "file-type-checker": "^1.0.8",
     "helmet": "7.0.0",
     "mime": "3.0.0",
@@ -52,33 +53,36 @@
     "reflect-metadata": "0.1.13",
     "rimraf": "5.0.1",
     "rxjs": "7.8.1",
-    "sharp": "0.32.5",
+    "sanitize-filename": "^1.6.3",
+    "sharp": "0.32.6",
     "string-similarity-js": "2.1.4",
     "throttle": "^1.0.3",
     "typeorm": "0.3.17",
     "typeorm-naming-strategies": "4.1.0",
+    "unidecode": "^0.1.8",
     "winston": "3.10.0",
     "winston-console-format": "1.0.8",
     "winston-daily-rotate-file": "4.7.1"
   },
   "devDependencies": {
-    "@nestjs/cli": "10.1.17",
+    "@nestjs/cli": "10.1.18",
     "@nestjs/schematics": "10.0.2",
     "@types/bcrypt": "5.0.0",
     "@types/compression": "1.7.3",
     "@types/cookie-parser": "1.4.4",
-    "@types/express": "4.17.17",
+    "@types/express": "4.17.18",
     "@types/mime": "3.0.1",
     "@types/morgan": "1.9.5",
     "@types/multer": "^1.4.7",
-    "@types/node": "20.6.0",
-    "@types/node-7z": "2.1.5",
+    "@types/node": "20.6.5",
+    "@types/node-7z": "2.1.6",
     "@types/passport-http": "0.3.9",
     "@types/string-similarity": "4.0.0",
     "@types/throttle": "^1.0.2",
-    "@typescript-eslint/eslint-plugin": "6.7.0",
-    "@typescript-eslint/parser": "6.7.0",
-    "eslint": "8.49.0",
+    "@types/unidecode": "^0.1.1",
+    "@typescript-eslint/eslint-plugin": "6.7.2",
+    "@typescript-eslint/parser": "6.7.2",
+    "eslint": "8.50.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.28.1",
     "eslint-plugin-prettier": "5.0.0",