added tests for PR #406

Author: Alfagun74

CHANGELOG.md

@@ -11,6 +11,11 @@
 ### Changes
 
 - Updated automatic Web UI version selection: if no compatible stable release is found, the backend now falls back to the nearest newer stable release before falling back to `unstable`.
+- Added regex-based indexing exclusion filters: `GAMES_SEARCH_EXCLUDE_FILE_REGEX` and `GAMES_SEARCH_EXCLUDE_DIR_REGEX`.
+
+### Thanks
+
+- @AlmostEasyGoing
 
 ## 16.3.0
 
@@ -37,6 +42,18 @@
 - Migrated backend configuration to NestJS Config (`@nestjs/config`) as the global config source.
 - Added YAML-based configuration support via `config.yaml` / `config.yml` in the config volume (`VOLUMES_CONFIG`) with precedence: `*_FILE` > env > YAML > defaults.
 
+### Thanks
+
+- @AlmostEasyGoing
+- @brokenglasszero
+- @Toylerrr
+- @Z0y6h0kS9X
+- @dandroid213
+- @spaceboy1234
+- @binarygeek119
+- @KawaKode
+- @ShadowPeo
+
 ## 16.2.0
 
 ### Changes

src/modules/games/files.service.spec.ts

@@ -51,6 +51,12 @@ jest.mock("fs-extra", () => ({
 
 describe("FilesService", () => {
   let service: FilesService;
+  let configuration: {
+    GAMES: {
+      SEARCH_EXCLUDE_FILE_REGEX?: RegExp;
+      SEARCH_EXCLUDE_DIR_REGEX?: RegExp;
+    };
+  };
   let gamesService: jest.Mocked<GamesService>;
   let metadataService: jest.Mocked<MetadataService>;
   let schedulerRegistry: jest.Mocked<SchedulerRegistry>;
@@ -69,6 +75,9 @@ describe("FilesService", () => {
 
   beforeEach(() => {
     fsExtra = jest.requireMock("fs-extra");
+    configuration = jest.requireMock("../../configuration").default;
+    configuration.GAMES.SEARCH_EXCLUDE_FILE_REGEX = undefined;
+    configuration.GAMES.SEARCH_EXCLUDE_DIR_REGEX = undefined;
 
     gamesService = {
       findOneByGameIdOrFail: jest.fn(),
@@ -403,4 +412,30 @@ describe("FilesService", () => {
       jest.useRealTimers();
     });
   });
+
+  describe("search exclude regex filters", () => {
+    it("should exclude files matching GAMES_SEARCH_EXCLUDE_FILE_REGEX", () => {
+      configuration.GAMES.SEARCH_EXCLUDE_FILE_REGEX = /sample/i;
+
+      expect((service as any).shouldIncludeFile("My Sample Game.zip")).toBe(
+        false,
+      );
+      expect((service as any).shouldIncludeFile("My Real Game.zip")).toBe(true);
+    });
+
+    it("should exclude directories matching GAMES_SEARCH_EXCLUDE_DIR_REGEX", () => {
+      configuration.GAMES.SEARCH_EXCLUDE_DIR_REGEX = /^ignored$/i;
+
+      expect((service as any).shouldIncludeDirectory("ignored")).toBe(false);
+      expect((service as any).shouldIncludeDirectory("games")).toBe(true);
+    });
+
+    it("should still apply normal filename validation after regex checks", () => {
+      configuration.GAMES.SEARCH_EXCLUDE_FILE_REGEX = /^ignore-/i;
+
+      expect((service as any).shouldIncludeFile("ignore-demo.zip")).toBe(false);
+      expect((service as any).shouldIncludeFile("valid-title.zip")).toBe(true);
+      expect((service as any).shouldIncludeFile("valid-title.txt")).toBe(false);
+    });
+  });
 });

src/modules/games/game-versions.controller.ts

@@ -16,6 +16,7 @@ import {
   ApiNoContentResponse,
   ApiOkResponse,
   ApiOperation,
+  ApiParam,
   ApiSecurity,
   ApiTags,
 } from "@nestjs/swagger";
@@ -42,6 +43,18 @@ export class GameVersionsController {
   ) {}
 
   @Delete(":game_id/versions/:version_id")
+  @ApiParam({
+    name: "game_id",
+    type: Number,
+    description: "numeric id of the game",
+    example: 42,
+  })
+  @ApiParam({
+    name: "version_id",
+    type: Number,
+    description: "numeric id of the game version",
+    example: 7,
+  })
   @ApiOperation({
     summary: "deletes a specific game version file from disk",
     description:
@@ -61,6 +74,18 @@ export class GameVersionsController {
   }
 
   @Get(":game_id/versions/:version_id")
+  @ApiParam({
+    name: "game_id",
+    type: Number,
+    description: "numeric id of the game",
+    example: 42,
+  })
+  @ApiParam({
+    name: "version_id",
+    type: Number,
+    description: "numeric id of the game version",
+    example: 7,
+  })
   @ApiHeader({
     name: "X-Download-Speed-Limit",
     required: false,