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

Connection Sync and Collection Entry user id migration

Author: Lamarcke

.gitignore

@@ -52,3 +52,4 @@ dist
 /build/
 
 .idea
+

package.json

@@ -38,11 +38,13 @@
     "@nestjs/core": "^11.0.11",
     "@nestjs/mapped-types": "*",
     "@nestjs/platform-express": "^11.0.11",
+    "@nestjs/platform-socket.io": "^11.1.5",
     "@nestjs/schedule": "^5.0.1",
     "@nestjs/swagger": "^11.0.6",
     "@nestjs/terminus": "^11.0.0",
     "@nestjs/throttler": "^6.4.0",
     "@nestjs/typeorm": "^11.0.0",
+    "@nestjs/websockets": "^11.1.5",
     "@types/async-retry": "^1.4.9",
     "@types/bad-words": "^3.0.3",
     "@types/multer": "^1.4.12",
@@ -72,6 +74,7 @@
     "supertokens-node": "^22.0.1",
     "ts-pattern": "^5.6.2",
     "typeorm": "^0.3.21",
+    "typeorm-transactional": "^0.5.0",
     "unique-username-generator": "^1.4.0"
   },
   "devDependencies": {

server_swagger.json

@@ -36,7 +36,9 @@ import { ExternalGameModule } from "./game/external-game/external-game.module";
 import { XboxSyncModule } from "./sync/xbox/xbox-sync.module";
 import { createKeyv } from "@keyv/redis";
 import { GameAchievementModule } from "./game/game-achievement/game-achievement.module";
-import { JournalModule } from './journal/journal.module';
+import { JournalModule } from "./journal/journal.module";
+import { addTransactionalDataSource } from "typeorm-transactional";
+import { DataSource } from "typeorm";
 
 /**
  * Should only be called after 'ConfigModule' is loaded (e.g. in useFactory)
@@ -109,6 +111,12 @@ function getRedisConfig(target: "cache" | "bullmq" = "cache") {
                     },
                 };
             },
+            async dataSourceFactory(options) {
+                if (!options) {
+                    throw new Error("Invalid datasource config");
+                }
+                return addTransactionalDataSource(new DataSource(options));
+            },
         }),
         CacheModule.registerAsync({
             isGlobal: true,

src/app.module.ts

@@ -8,11 +8,10 @@ import * as JsonWebToken from "jsonwebtoken";
 import { JwtHeader } from "jsonwebtoken";
 import jwksClient from "jwks-rsa";
 import * as process from "process";
-import { Reflector } from "@nestjs/core";
+import { Request } from "express";
 
 /**
- * Jwt based auth guard. Checks for valid JWT token which is signed by another service/microservice.
- * Should be used for microservice communication.
+ * Jwt based auth guard. Can be used for microservice-microservice communication, or for websockets.
  */
 @Injectable()
 export class JwtAuthGuard implements CanActivate {
@@ -22,8 +21,6 @@ export class JwtAuthGuard implements CanActivate {
         jwksUri: this.JWKS_URI,
     });
 
-    constructor(private readonly reflector: Reflector) {}
-
     /**
      * @param jwtHeader - JWT header, from the decoded token
      * @private
@@ -39,35 +36,24 @@ export class JwtAuthGuard implements CanActivate {
         }
     }
 
-    /**
-     * This same logic should be applied to all services/microservices.
-     * @param context
-     */
     async canActivate(context: ExecutionContext): Promise<boolean> {
-        const ctx = context.switchToHttp();
-        const ctxType = context.getType<"http" | "rmq">();
+        const ctxType = context.getType<"http" | "ws" | "rpc">();
 
         if (ctxType !== "http") {
-            this.logger.warn(
-                `Warning: JwtAuthGuard can't be used in a non-HTTP context!`,
+            throw new Error(
+                `JwtAuthGuard not configured for context: ${ctxType}`,
             );
-
-            return true;
         }
 
-        const isPublic = this.reflector.get<boolean>(
-            "isPublic",
-            context.getHandler(),
-        );
+        const request: Request = context.switchToHttp().getRequest();
 
-        if (isPublic) {
-            return true;
-        }
+        return this.validateToken(request.headers.authorization);
+    }
+
+    private async validateToken(token: string | undefined) {
+        const bearerToken = token?.split("Bearer ")[1];
 
-        const headers = ctx.getRequest().headers;
-        const authorization = headers.authorization as string;
-        const bearerToken = authorization?.split("Bearer ")[1];
-        if (!authorization || !bearerToken) {
+        if (!token || !bearerToken) {
             return false;
         }
 

src/auth/jwt-auth/jwt-auth.guard.ts

@@ -1,8 +1,8 @@
 import { SetMetadata } from "@nestjs/common";
 
 /**
- * When used with AuthGuard on controllers/methods, makes authentication optional. <br>
- * User session info will still be available if the user is logged in, but will be null if not!
+ * When used with {@link AuthGuard} on controllers/methods, makes authentication optional. <br>
+ * User session info will still be available if the user is logged in, but will be null if not.
  * @see AuthGuard
  * @constructor
  */

src/auth/public.decorator.ts

@@ -1,15 +1,26 @@
 import { createParamDecorator, ExecutionContext } from "@nestjs/common";
+import { Socket } from "socket.io";
 
 /**
  * Retrieves session info for the current logged in user. <br>
- * Needs to be used with AuthGuard. <br>
+ * Needs to be used with {@link AuthGuard} or {@link WsAuthGuard}. <br>
  * If the 'Public' decorator is also used, the 'session' object will be null if the user is not logged in.
  * @see AuthGuard
+ * @see WsAuthGuard
  * @see Public
  */
 export const Session = createParamDecorator(
     (data: unknown, ctx: ExecutionContext) => {
-        const request = ctx.switchToHttp().getRequest();
-        return request.session;
+        const ctxType = ctx.getType();
+        if (ctxType === "http") {
+            const request = ctx.switchToHttp().getRequest();
+            return request.session;
+        }
+
+        if (ctxType === "ws") {
+            const client: Socket = ctx.switchToWs().getClient();
+
+            return client.data.session;
+        }
     },
 );

src/auth/session.decorator.ts

@@ -0,0 +1,37 @@
+import { CanActivate, ExecutionContext, Logger } from "@nestjs/common";
+import { Socket } from "socket.io";
+import { WsException } from "@nestjs/websockets";
+import Session from "supertokens-node/recipe/session";
+
+export class WsAuthGuard implements CanActivate {
+    private logger = new Logger(WsAuthGuard.name);
+
+    async canActivate(context: ExecutionContext): Promise<boolean> {
+        const ctxType = context.getType<"http" | "ws" | "rpc">();
+
+        if (ctxType !== "ws") {
+            throw new WsException(
+                "WsAuthGuard can only be used in Websockets context.",
+            );
+        }
+
+        const client: Socket = context.switchToWs().getClient();
+        const token: string | undefined =
+            client.handshake?.auth?.token || client.handshake?.query?.token;
+
+        if (!token) {
+            throw new WsException("Auth token not provided.");
+        }
+
+        try {
+            // Adds session as a property so that it can be retrieved with @Session later.
+            client.data.session =
+                await Session.getSessionWithoutRequestResponse(token);
+        } catch (err) {
+            this.logger.error(err);
+            throw new WsException(err.message);
+        }
+
+        return true;
+    }
+}

src/auth/ws-auth/WsAuthGuard.ts

@@ -21,7 +21,7 @@ import { CreateUpdateCollectionEntryDto } from "./dto/create-update-collection-e
 import { AuthGuard } from "../../auth/auth.guard";
 import { FindCollectionEntriesDto } from "./dto/find-collection-entries.dto";
 import { CollectionEntry } from "./entities/collection-entry.entity";
-import { CreateFavoriteStatusCollectionEntryDto } from "./dto/create-favorite-status-collection-entry.dto";
+import { CollectionEntryFavoriteStatusDto } from "./dto/collection-entry-favorite-status.dto";
 import { PaginationInterceptor } from "../../interceptor/pagination.interceptor";
 
 import { CollectionEntriesPaginatedResponseDto } from "./dto/collection-entries-paginated-response.dto";
@@ -55,6 +55,14 @@ export class CollectionsEntriesController {
         );
     }
 
+    @Get(":id/related")
+    @Public()
+    async findRelatedEntries(@Param("id") collectionEntryId: string) {
+        return await this.collectionsEntriesService.findRelatedEntries(
+            collectionEntryId,
+        );
+    }
+
     /**
      * Returns a specific collection entry based on game ID
      * @param session
@@ -117,7 +125,7 @@ export class CollectionsEntriesController {
     async changeFavoriteStatus(
         @Session() session: SessionContainer,
         @Param("id") gameId: number,
-        @Body() dto: CreateFavoriteStatusCollectionEntryDto,
+        @Body() dto: CollectionEntryFavoriteStatusDto,
     ) {
         const userId = session.getUserId();
         return await this.collectionsEntriesService.changeFavoriteStatus(

src/collections/collections-entries/collections-entries.controller.ts

@@ -9,6 +9,7 @@ import { AchievementsModule } from "../../achievements/achievements.module";
 import { LevelModule } from "../../level/level.module";
 import { CollectionsModule } from "../collections.module";
 import { CollectionEntryToCollection } from "./entities/collection-entry-to-collection.entity";
+import { GameRepositoryModule } from "../../game/game-repository/game-repository.module";
 
 @Module({
     imports: [
@@ -21,6 +22,7 @@ import { CollectionEntryToCollection } from "./entities/collection-entry-to-coll
         AchievementsModule,
         LevelModule,
         forwardRef(() => CollectionsModule),
+        GameRepositoryModule,
     ],
     controllers: [CollectionsEntriesController],
     providers: [CollectionsEntriesService],