Merge pull request #197 from game-node-app/dev

Dev

Author: Lamarcke

server_swagger.json

@@ -41,6 +41,7 @@ import { addTransactionalDataSource } from "typeorm-transactional";
 import { DataSource } from "typeorm";
 import { AwardsModule } from './awards/awards.module';
 import { UserAccountModule } from './user/user-account/user-account.module';
+import { PreferredPlatformModule } from './preferred-platform/preferred-platform.module';
 
 /**
  * Should only be called after 'ConfigModule' is loaded (e.g. in useFactory)
@@ -198,6 +199,7 @@ function getRedisConfig(target: "cache" | "bullmq" = "cache") {
         JournalModule,
         AwardsModule,
         UserAccountModule,
+        PreferredPlatformModule,
     ],
 })
 export class AppModule implements NestModule {

src/app.module.ts

@@ -4,7 +4,3 @@ export enum CollectionEntryStatus {
     PLANNED = "planned",
     DROPPED = "dropped",
 }
-
-export const COLLECTION_ENTRY_ORDERING_GAP = 1000;
-
-export const COLLECTION_ENTRY_ORDERING_NORMALIZATION_THRESHOLD = 1e-6;

src/collections/collections-entries/collections-entries.constants.ts

@@ -23,16 +23,14 @@ import { LevelIncreaseActivities } from "../../level/level.constants";
 import { CollectionsService } from "../collections.service";
 import { FindCollectionEntriesForCollectionIdDto } from "./dto/find-collection-entries-for-collection-id.dto";
 import { CollectionEntryToCollection } from "./entities/collection-entry-to-collection.entity";
-import {
-    COLLECTION_ENTRY_ORDERING_GAP,
-    CollectionEntryStatus,
-} from "./collections-entries.constants";
+import { CollectionEntryStatus } from "./collections-entries.constants";
 import { match } from "ts-pattern";
 import { buildGameFilterFindOptions } from "../../game/game-repository/utils/build-game-filter-find-options";
 import { Transactional } from "typeorm-transactional";
 import { GameRepositoryService } from "../../game/game-repository/game-repository.service";
 import { FindRelatedCollectionEntriesResponseDto } from "./dto/find-related-collection-entries.dto";
 import { toMap } from "../../utils/toMap";
+import { DEFAULT_ORDERING_GAP } from "../../utils/ordering";
 
 @Injectable()
 export class CollectionsEntriesService {
@@ -432,7 +430,7 @@ export class CollectionsEntriesService {
 
         for (const collectionId of newCollectionIds) {
             const lastOrder = maxOrderMap.get(collectionId) ?? 0;
-            const newOrder = lastOrder + COLLECTION_ENTRY_ORDERING_GAP;
+            const newOrder = lastOrder + DEFAULT_ORDERING_GAP;
 
             await this.collectionEntryToCollectionRepository.insert({
                 collectionEntryId,

src/collections/collections-entries/collections-entries.service.ts

@@ -2,11 +2,11 @@ import { HttpException, HttpStatus, Injectable } from "@nestjs/common";
 import { InjectRepository } from "@nestjs/typeorm";
 import { CollectionEntryToCollection } from "../entities/collection-entry-to-collection.entity";
 import { In, Repository } from "typeorm";
-import {
-    COLLECTION_ENTRY_ORDERING_GAP,
-    COLLECTION_ENTRY_ORDERING_NORMALIZATION_THRESHOLD,
-} from "../collections-entries.constants";
 import { CollectionEntryUpdateOrderingDto } from "../dto/collection-entry-update-ordering.dto";
+import {
+    DEFAULT_ORDERING_GAP,
+    DEFAULT_ORDERING_NORMALIZATION_THRESHOLD,
+} from "../../../utils/ordering";
 
 /**
  * Service responsible for handling collection to collection entry ordering.
@@ -64,10 +64,10 @@ export class CollectionsOrderingService {
             newOrder = (before.order + after.order) / 2;
         } else if (before) {
             // Move to the *end* (after "before")
-            newOrder = before.order + COLLECTION_ENTRY_ORDERING_GAP;
+            newOrder = before.order + DEFAULT_ORDERING_GAP;
         } else if (after) {
             // Move to the *beginning* (before "after")
-            newOrder = after.order - COLLECTION_ENTRY_ORDERING_GAP;
+            newOrder = after.order - DEFAULT_ORDERING_GAP;
         }
 
         await this.collectionEntryToCollectionRepository.update(
@@ -81,8 +81,7 @@ export class CollectionsOrderingService {
         );
 
         if (
-            Math.abs(newOrder) >
-                COLLECTION_ENTRY_ORDERING_NORMALIZATION_THRESHOLD ||
+            Math.abs(newOrder) < DEFAULT_ORDERING_NORMALIZATION_THRESHOLD ||
             !Number.isFinite(newOrder)
         ) {
             await this.normalizeCollectionOrdering(collectionId);
@@ -106,7 +105,7 @@ export class CollectionsOrderingService {
         });
 
         for (let i = 0; i < entries.length; i++) {
-            entries[i].order = i + COLLECTION_ENTRY_ORDERING_GAP;
+            entries[i].order = (i + 1) * DEFAULT_ORDERING_GAP;
         }
 
         await this.collectionEntryToCollectionRepository.save(entries);

src/collections/collections-entries/order/collections-ordering.service.ts

@@ -9,6 +9,7 @@ import { PlaytimeModule } from "../playtime/playtime.module";
 import { PlaytimeWatchModule } from "../playtime/watch/playtime-watch.module";
 import { XboxSyncModule } from "../sync/xbox/xbox-sync.module";
 import { ConnectionSyncModule } from './connection-sync/connection-sync.module';
+import { CollectionsModule } from "../collections/collections.module";
 
 @Module({
     imports: [
@@ -18,6 +19,7 @@ import { ConnectionSyncModule } from './connection-sync/connection-sync.module';
         PlaytimeModule,
         XboxSyncModule,
         forwardRef(() => PlaytimeWatchModule),
+        forwardRef(() => CollectionsModule),
         ConnectionSyncModule,
     ],
     providers: [ConnectionsService],

src/connection/connections.module.ts

@@ -23,6 +23,7 @@ import { UserConnectionDto } from "./dto/user-connection.dto";
 import { HttpStatusCode } from "axios";
 import { PlaytimeWatchService } from "../playtime/watch/playtime-watch.service";
 import { XboxSyncService } from "../sync/xbox/xbox-sync.service";
+import { CollectionsService } from "../collections/collections.service";
 
 const toDto = (userConnection: UserConnection): UserConnectionDto => ({
     ...userConnection,
@@ -47,6 +48,8 @@ export class ConnectionsService {
         private readonly xboxSyncService: XboxSyncService,
         @Inject(forwardRef(() => PlaytimeWatchService))
         private readonly playtimeWatchService: PlaytimeWatchService,
+        @Inject(forwardRef(() => CollectionsService))
+        private readonly collectionsService: CollectionsService,
     ) {}
 
     public findOneById(id: number) {
@@ -123,6 +126,8 @@ export class ConnectionsService {
             userIdentifier,
             isImporterEnabled,
             isPlaytimeImportEnabled,
+            isAutoImportEnabled,
+            autoImportCollectionId,
         } = dto;
 
         const possibleExistingConnection = await this.findOneByUserIdAndType(
@@ -172,6 +177,26 @@ export class ConnectionsService {
         const finalIsPlaytimeImportEnabled = isPlaytimeImporterViable
             ? isPlaytimeImportEnabled
             : false;
+        const finalIsAutoImportEnabled = isImporterViable
+            ? isAutoImportEnabled
+            : false;
+
+        // Validate collection exists and belongs to user if autoImportCollectionId is provided
+        // If auto-import is enabled but no collection specified, games will be imported
+        // to the user's library without being added to a specific collection
+        let validatedAutoImportCollectionId: string | null = null;
+        if (finalIsAutoImportEnabled && autoImportCollectionId) {
+            const collection = await this.collectionsService.findOneById(
+                autoImportCollectionId,
+            );
+            if (!collection || collection.libraryUserId !== userId) {
+                throw new HttpException(
+                    "Collection not found or does not belong to user",
+                    HttpStatus.BAD_REQUEST,
+                );
+            }
+            validatedAutoImportCollectionId = autoImportCollectionId;
+        }
 
         const createdConnection = await this.userConnectionRepository.save({
             ...possibleExistingConnection,
@@ -182,6 +207,8 @@ export class ConnectionsService {
             isImporterViable,
             isImporterEnabled: finalIsImporterEnabled,
             isPlaytimeImportEnabled: finalIsPlaytimeImportEnabled,
+            isAutoImportEnabled: finalIsAutoImportEnabled,
+            autoImportCollectionId: validatedAutoImportCollectionId,
         });
 
         this.onConnectionCreate(createdConnection);

src/connection/connections.service.ts

@@ -5,6 +5,7 @@ import {
     IsNotEmpty,
     IsOptional,
     IsString,
+    IsUUID,
     MinLength,
 } from "class-validator";
 
@@ -25,4 +26,10 @@ export class ConnectionCreateDto {
     @IsBoolean()
     @IsOptional()
     isPlaytimeImportEnabled: boolean = true;
+    @IsBoolean()
+    @IsOptional()
+    isAutoImportEnabled: boolean = false;
+    @IsUUID()
+    @IsOptional()
+    autoImportCollectionId?: string | null;
 }

src/connection/dto/connection-create.dto.ts

@@ -7,6 +7,7 @@ import {
 } from "typeorm";
 import { EConnectionType } from "../connections.constants";
 import { Profile } from "../../profile/entities/profile.entity";
+import { Collection } from "../../collections/entities/collection.entity";
 
 @Entity()
 @Unique(["profile", "type"])
@@ -45,4 +46,20 @@ export class UserConnection {
         default: true,
     })
     isPlaytimeImportEnabled: boolean;
+    @Column({
+        nullable: false,
+        default: false,
+    })
+    isAutoImportEnabled: boolean;
+    @ManyToOne(() => Collection, {
+        nullable: true,
+        onDelete: "SET NULL",
+    })
+    autoImportCollection: Collection | null;
+    @Column({
+        nullable: true,
+        type: "varchar",
+        length: 36,
+    })
+    autoImportCollectionId: string | null;
 }

src/connection/entity/user-connection.entity.ts

@@ -72,6 +72,28 @@ enum EGameStatus {
     Delisted = 8,
 }
 
+/**
+ * Common abbreviations used across the application for game platforms.
+ * This enum is not exaustive. Prefer to query the database for the full list of platforms.
+ * This should only be used to avoid magic strings in the codebase.
+ */
+enum GamePlatformAbbreviations {
+    PC = "PC",
+    // The OG Xbox.
+    Xbox = "XBOX",
+    XboxOne = "XONE",
+    XboxSeriesXS = "Series X|S",
+    Xbox360 = "X360",
+    PSVita = "Vita",
+    PS3 = "PS3",
+    PS4 = "PS4",
+    PS5 = "PS5",
+    Switch = "Switch",
+    Linux = "Linux",
+    Android = "Android",
+    iOS = "iOS",
+}
+
 /**
  * Where the game data is stored in the GameNode system.
  * Helps the clients determine the source of the data.
@@ -99,7 +121,7 @@ const PlatformToIconMap: { [p: string]: string[] } = {
     playstation: ["PSVR", "PSVR2"],
     x360: ["X360"],
     xone: ["XONE"],
-    xseriesx: ["Series X"],
+    xseriesx: ["Series X|S"],
     xbox: ["XBOX"],
     nswitch: ["Switch"],
     n64: ["N64"],
@@ -127,5 +149,6 @@ export {
     EGameExternalGameCategory,
     EGamePlatformCategory,
     EGameStorageSource,
+    GamePlatformAbbreviations,
     PlatformToIconMap,
 };