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

IGDB sync issues

Author: Lamarcke

server_swagger.json

@@ -6,7 +6,7 @@ export const achievementsEventsData: Achievement[] = [
     {
         id: "awards_2025",
         name: "Awards 2025",
-        description: "Participate in the 2025 Game Awards event",
+        description: "Participate in the 2025 GameNode Awards event",
         expGainAmount: 1000,
         category: AchievementCategory.EVENTS,
         checkEligibility: async (dataSource, targetUserId) => {

src/achievements/data/achievements-events.data.ts

@@ -59,10 +59,6 @@ export class ExternalGameService {
             where: {
                 gameId: In(gameIds),
             },
-            cache: {
-                id: `external-games-ids-${gameIds}`,
-                milliseconds: days(1),
-            },
             relations: this.relations,
         });
     }

src/game/external-game/external-game.service.ts

@@ -20,7 +20,7 @@ import { GameTheme } from "./entities/game-theme.entity";
 import { GamePlayerPerspective } from "./entities/game-player-perspective.entity";
 import { GameEngine } from "./entities/game-engine.entity";
 import { GameEngineLogo } from "./entities/game-engine-logo.entity";
-import { PartialGame } from "./game-repository.types";
+import { IDGBPartialGame } from "./game-repository.types";
 import { StatisticsQueueService } from "../../statistics/statistics-queue/statistics-queue.service";
 import { StatisticsSourceType } from "../../statistics/statistics.constants";
 import { ExternalGameService } from "../external-game/external-game.service";
@@ -100,7 +100,7 @@ export class GameRepositoryCreateService {
         private readonly externalGameService: ExternalGameService,
     ) {}
 
-    async shouldUpdate(game: PartialGame) {
+    async shouldUpdate(game: IDGBPartialGame) {
         if (game.id == null || typeof game.id !== "number") {
             return false;
         } else if (
@@ -121,7 +121,7 @@ export class GameRepositoryCreateService {
      * Bug info: https://github.com/typeorm/typeorm/issues/1754
      * @param game
      */
-    async createOrUpdate(game: PartialGame) {
+    async createOrUpdate(game: IDGBPartialGame) {
         const shouldProcess = await this.shouldUpdate(game);
 
         if (!shouldProcess) {
@@ -141,7 +141,7 @@ export class GameRepositoryCreateService {
     }
 
     private dispatchCreateUpdateEvent(
-        game: PartialGame,
+        game: IDGBPartialGame,
         isUpdateAction: boolean,
     ) {
         if (!isUpdateAction) {
@@ -158,7 +158,7 @@ export class GameRepositoryCreateService {
      * e.g. Relationships where Game is on the ManyToOne side. Do not update ManyToMany models here.
      * @param game
      */
-    async buildParentRelationships(game: PartialGame) {
+    async buildParentRelationships(game: IDGBPartialGame) {
         if (game.collection) {
             // collection.games changes are not cascaded.
             const collection = this.gameCollectionRepository.create(
@@ -175,7 +175,7 @@ export class GameRepositoryCreateService {
      * <strong> We assume the game is already persisted at this point, so we can use it as a parent.</strong>
      * @param game
      */
-    async buildChildRelationships(game: PartialGame) {
+    async buildChildRelationships(game: IDGBPartialGame) {
         if (game.alternativeNames) {
             const alternativeNames = game.alternativeNames.map(
                 (alternativeName) => {
@@ -231,10 +231,17 @@ export class GameRepositoryCreateService {
          */
         if (game.externalGames) {
             for (const externalGame of game.externalGames) {
+                const category =
+                    externalGame.category ?? externalGame.externalGameSource;
+                const media =
+                    externalGame.media ?? externalGame.gameReleaseFormat;
+
                 try {
                     await this.externalGameService.upsert({
                         ...externalGame,
                         gameId: game.id,
+                        category,
+                        media,
                     });
                 } catch (e) {}
             }

src/game/game-repository/game-repository-create.service.ts

@@ -139,7 +139,7 @@ export class GameRepositoryService {
         return games;
     }
 
-    @Cacheable(GameRepositoryService.name, minutes(30))
+    // @Cacheable(GameRepositoryService.name, minutes(30))
     async findGameExternalStores(gameId: number) {
         const externalGames = await this.externalGameService.findAllForGameId([
             gameId,

src/game/game-repository/game-repository.service.ts

@@ -1,7 +1,20 @@
-import { DeepPartial } from "typeorm";
 import { Game } from "./entities/game.entity";
+import { GameExternalGame } from "../external-game/entity/game-external-game.entity";
+import { DeepPartial } from "typeorm";
+
+interface IGDBExternalGame extends GameExternalGame {
+    // Substitute for deprecated field GameExternalGame#category
+    externalGameSource?: number;
+    // Substitute for deprecated field GameExternalGame#media
+    gameReleaseFormat?: number;
+}
 
-export type PartialGame = DeepPartial<Game> & {
+/**
+ * Items are received as pascal_case from IGDB API, and then converted to camelCase.
+ * Assume a camelCase option is available if `IgdbSyncProcessor#normalizeIgdbResults` has run.
+ */
+export type IDGBPartialGame = DeepPartial<Game> & {
     id: number;
+    externalGames: IGDBExternalGame[];
     [key: string]: any;
 };

src/game/game-repository/game-repository.types.ts

@@ -0,0 +1,12 @@
+export class JournalHeatmapItem {
+    /**
+     * Date normalized to the 'day' level. In the 'YYYY-MM-DD' format.
+     * @see https://mantine.dev/charts/heatmap/#data-format
+     */
+    date: string;
+    count: number;
+}
+
+export class GetJournalHeatmapResponseDto {
+    items: JournalHeatmapItem[];
+}

src/journal/dto/get-journal-heatmap.dto.ts

@@ -0,0 +1,57 @@
+import { Injectable } from "@nestjs/common";
+import {
+    GetJournalHeatmapResponseDto,
+    JournalHeatmapItem,
+} from "./dto/get-journal-heatmap.dto";
+import dayjs from "dayjs";
+import { JournalService } from "./journal.service";
+
+@Injectable()
+export class JournalHeatmapService {
+    constructor(private readonly journalService: JournalService) {}
+
+    /**
+     * Build a heatmap from Journal entry items.
+     * @param userId
+     * @param targetUserId
+     */
+    public async buildHeatmap(
+        userId: string | undefined,
+        targetUserId: string,
+    ): Promise<GetJournalHeatmapResponseDto> {
+        const journalOverview = await this.journalService.getOverview(
+            userId,
+            targetUserId,
+        );
+
+        const heatmapItems: JournalHeatmapItem[] = [];
+
+        /**
+         * The good code is the friends we made along the way
+         */
+        for (const yearGroup of journalOverview.years) {
+            const year = yearGroup.year;
+            for (const monthGroup of yearGroup.months) {
+                const month = monthGroup.month;
+                for (const dayGroup of monthGroup.days) {
+                    const day = dayGroup.day;
+                    /**
+                     * @see https://mantine.dev/charts/heatmap/#data-format
+                     */
+                    const formattedDate = dayjs(
+                        `${year}-${month}-${day}`,
+                        // Automatically prefixes the fields with 0 when necessary (e.g. MM -> 08)
+                    ).format("YYYY-MM-DD");
+                    heatmapItems.push({
+                        date: formattedDate,
+                        count: dayGroup.entries.length,
+                    });
+                }
+            }
+        }
+
+        return {
+            items: heatmapItems,
+        };
+    }
+}

src/journal/journal-heatmap.service.ts

@@ -2,3 +2,8 @@ export enum JournalPlaylogItemType {
     COLLECTION_ENTRY_STATUS = "collection_entry_status",
     OBTAINED_ACHIEVEMENT = "obtained_achievement",
 }
+
+export enum JournalHeatmapItemType {
+    ACTIVITY = "activity",
+    PLAYTIME = "playtime",
+}

src/journal/journal.constants.ts

@@ -6,6 +6,7 @@ import { SessionContainer } from "supertokens-node/recipe/session";
 import { JournalService } from "./journal.service";
 import { ApiTags } from "@nestjs/swagger";
 import { JournalPlayLogService } from "./journal-play-log.service";
+import { JournalHeatmapService } from "./journal-heatmap.service";
 
 @Controller("journal")
 @ApiTags("journal")
@@ -14,6 +15,7 @@ export class JournalController {
     constructor(
         private readonly journalService: JournalService,
         private readonly journalPlaylogService: JournalPlayLogService,
+        private readonly journalHeatmapService: JournalHeatmapService,
     ) {}
 
     @Get("overview/:userId")
@@ -33,4 +35,16 @@ export class JournalController {
     ) {
         return this.journalPlaylogService.getPlaylog(userId, gameId);
     }
+
+    @Get("heatmap/:userId")
+    @Public()
+    public async getHeatmap(
+        @Session() session: SessionContainer | undefined,
+        @Param("userId") targetUserId: string,
+    ) {
+        return this.journalHeatmapService.buildHeatmap(
+            session?.getUserId(),
+            targetUserId,
+        );
+    }
 }