feat(mobile_team_logo): retrive team logo from backend and display them if exist (#1259)

Author: LaurentMag

yaki_backend/src/__test__/team-repository.test.ts

@@ -33,7 +33,7 @@ describe("TeamRepository", () => {
     ];
     pgClient.query.mockResolvedValue({rows: mockRows});
 
-    const result = await teamRepository.getTeamLogoByTeamsId(teamIds);
+    const result = await teamRepository.getTeamsLogoByTeamsId(teamIds);
 
     expect(pgClient.connect).toHaveBeenCalled();
     expect(pgClient.query).toHaveBeenCalledWith(expect.stringContaining("1,2,3"));
@@ -47,7 +47,7 @@ describe("TeamRepository", () => {
     const teamIds = [1, 2, 3];
     pgClient.query.mockResolvedValue({rows: []});
 
-    const result = await teamRepository.getTeamLogoByTeamsId(teamIds);
+    const result = await teamRepository.getTeamsLogoByTeamsId(teamIds);
 
     expect(pgClient.connect).toHaveBeenCalled();
     expect(pgClient.query).toHaveBeenCalledWith(expect.stringContaining("1,2,3"));

yaki_backend/src/__test__/team-service.test.ts

@@ -8,7 +8,7 @@ jest.mock("../features/team/team.repository", () => {
     TeamRepository: jest.fn().mockImplementation(() => {
       return {
         getTeamByTeammateId: jest.fn(),
-        getTeamLogoByTeamsId: jest.fn(),
+        getTeamsLogoByTeamsId: jest.fn(),
       };
     }),
   };
@@ -48,7 +48,7 @@ describe("TeamService", () => {
     });
   });
 
-  describe("getTeamLogoByTeamsId", () => {
+  describe("getTeamsLogoByTeamsId", () => {
     it("should return a teams logo list if it exists", async () => {
       const buffer1 = Buffer.from("mock buffer data 1");
       const buffer2 = Buffer.from("mock buffer data 2");
@@ -57,23 +57,23 @@ describe("TeamService", () => {
         {teamLogoTeamId: 1, teamLogoBlob: buffer1},
         {teamLogoTeamId: 2, teamLogoBlob: buffer2},
       ];
-      mockTeamRepository.getTeamLogoByTeamsId.mockResolvedValueOnce(teamLogo);
+      mockTeamRepository.getTeamsLogoByTeamsId.mockResolvedValueOnce(teamLogo);
 
-      const result = await service.getTeamLogoByTeamsId([1, 2]);
+      const result = await service.getTeamsLogoByTeamsId([1, 2]);
       expect(result).toEqual(teamLogo);
-      expect(mockTeamRepository.getTeamLogoByTeamsId).toHaveBeenCalledWith([1, 2]);
-      expect(mockTeamRepository.getTeamLogoByTeamsId).toHaveBeenCalledTimes(1);
+      expect(mockTeamRepository.getTeamsLogoByTeamsId).toHaveBeenCalledWith([1, 2]);
+      expect(mockTeamRepository.getTeamsLogoByTeamsId).toHaveBeenCalledTimes(1);
     });
 
     it("should return an empty array if the team does not exist", async () => {
       const teamLogo: TeamLogoDto[] = [];
 
-      mockTeamRepository.getTeamLogoByTeamsId.mockResolvedValueOnce(teamLogo);
+      mockTeamRepository.getTeamsLogoByTeamsId.mockResolvedValueOnce(teamLogo);
 
-      const result = await service.getTeamLogoByTeamsId([1, 2]);
+      const result = await service.getTeamsLogoByTeamsId([1, 2]);
       expect(result).toEqual(teamLogo);
-      expect(mockTeamRepository.getTeamLogoByTeamsId).toHaveBeenCalledWith([1, 2]);
-      expect(mockTeamRepository.getTeamLogoByTeamsId).toHaveBeenCalledTimes(1);
+      expect(mockTeamRepository.getTeamsLogoByTeamsId).toHaveBeenCalledWith([1, 2]);
+      expect(mockTeamRepository.getTeamsLogoByTeamsId).toHaveBeenCalledTimes(1);
     });
   });
 

yaki_backend/src/features/team/team.controller.ts

@@ -1,4 +1,5 @@
 import {TeamService} from "./team.service";
+import {TeamLogoDto} from "./teamLogo.dto";
 
 export class TeamController {
   private teamService: TeamService;
@@ -30,6 +31,26 @@ export class TeamController {
     }
   };
 
+  /**
+   * Verify if the query param is either teamIds or userId.
+   * If the query param is teamIds, it will call the getTeamsLogoByTeamsId function.
+   * If the query param is userId, it will call the getTeamsLogoByUserId function.
+   * If the query param is neither teamIds or userId, it will return a 400 error.
+   * @param req
+   * @param res
+   */
+  getTeamsLogo = async (req: any, res: any) => {
+    const queryParams = Object.keys(req.query)[0];
+
+    if (queryParams === "teamIds") {
+      this.getTeamsLogoByTeamsId(req, res);
+    } else if (queryParams === "userId") {
+      this.getTeamsLogoByUserId(req, res);
+    } else {
+      res.status(400).json({message: "invalid query param"});
+    }
+  };
+
   /**
    * Retrive a list of team logo given a list of team id.
    * If a team id does not have a logo, it will not be returned.
@@ -38,13 +59,12 @@ export class TeamController {
    * @param req
    * @param res
    */
-  getTeamImageByTeamsId = async (req: any, res: any) => {
+  getTeamsLogoByTeamsId = async (req: any, res: any) => {
     const teamIds = req.query.teamIds;
-
     const idsArray = this.teamsIdsValidation(teamIds);
 
     try {
-      const teamsLogo = await this.teamService.getTeamLogoByTeamsId(idsArray);
+      const teamsLogo = await this.teamService.getTeamsLogoByTeamsId(idsArray);
 
       if (teamsLogo.length === 0) {
         console.log("404 no team logo was found");
@@ -82,4 +102,37 @@ export class TeamController {
 
     return idsArray;
   };
+
+  /**
+   * Retrive a list of team logo given a user id, meaning its all teams the user is into.
+   * If a team id does not have a logo, it will not be returned.
+   * User query param, ex : ?userId=1
+   * @param req
+   * @param res
+   */
+  getTeamsLogoByUserId = async (req: any, res: any) => {
+    const userId = Number(req.query.userId);
+
+    if (isNaN(userId)) {
+      throw new Error("invalid user id provided");
+    }
+
+    try {
+      const teamsLogo = await this.teamService.getTeamsLogoByUserId(userId);
+
+      if (teamsLogo.length === 0) {
+        console.log("404 no team logo was found");
+        res.status(404).json({message: "No team logo was found"});
+      } else {
+        console.log(
+          "200 team logo was found for the teams :",
+          teamsLogo.map((team: TeamLogoDto) => team.teamLogoTeamId)
+        );
+        res.status(200).json(teamsLogo);
+      }
+    } catch (error: any) {
+      // catch server errors
+      res.status(500).json({message: error.message});
+    }
+  };
 }

yaki_backend/src/features/team/team.repository.ts

@@ -49,7 +49,7 @@ export class TeamRepository {
    * @param teamIds list of team id
    * @returns promise of list of TeamLogoDto
    */
-  getTeamLogoByTeamsId = async (teamIds: number[]): Promise<TeamLogoDto[]> => {
+  getTeamsLogoByTeamsId = async (teamIds: number[]): Promise<TeamLogoDto[]> => {
     let teamIdListString = teamIds.join(",");
 
     const client = new Client({
@@ -87,6 +87,46 @@ export class TeamRepository {
     }
   };
 
+  /**
+   * Retrive the list of team logo given a user id, meaning its all teams the user is into.
+   * @param userId
+   * @returns promise of list of TeamLogoDto
+   */
+  getTeamsLogoByUserId = async (userId: number): Promise<TeamLogoDto[]> => {
+    const client = new Client({
+      host: process.env.DB_HOST,
+      user: process.env.DB_USER,
+      password: process.env.DB_PASSWORD,
+      database: process.env.DB_DATABASE,
+      port: Number(process.env.DB_PORT),
+    });
+
+    const query = `
+      SELECT 
+      tl.team_logo_team_id, 
+      tl.team_logo_blob 
+      FROM public.team_logo tl
+      JOIN public.teammate tm on tm.teammate_team_id = tl.team_logo_team_id
+      WHERE tm.teammate_user_id= $1
+    `;
+
+    await client.connect();
+    try {
+      const result = await client.query(query, [userId]);
+
+      if (result.rows.length === 0) {
+        return [];
+      }
+      const teamLogoList: TeamLogoDto[] = result.rows.map(
+        (teamImageRow) =>
+          new TeamLogoDto(teamImageRow.team_logo_team_id, teamImageRow.team_logo_blob)
+      );
+      return teamLogoList;
+    } catch (error: any) {
+      throw new DataError("Error during users avatar fetching: " + error.message);
+    }
+  };
+
   // DEPRECIATED - TO BE REMOVED WHEN 1.10 isnt used anymore
   //========================================================
   /**

yaki_backend/src/features/team/team.service.ts

@@ -28,9 +28,9 @@ export class TeamService {
    * @param teamIds list of team id
    * @returns promise of list of TeamLogoDto
    */
-  getTeamLogoByTeamsId = async (teamIds: number[]): Promise<TeamLogoDto[]> => {
+  getTeamsLogoByTeamsId = async (teamIds: number[]): Promise<TeamLogoDto[]> => {
     try {
-      const teamsLogo = await this.teamRepository.getTeamLogoByTeamsId(teamIds);
+      const teamsLogo = await this.teamRepository.getTeamsLogoByTeamsId(teamIds);
 
       return teamsLogo;
     } catch (error: any) {
@@ -39,6 +39,22 @@ export class TeamService {
     }
   };
 
+  /**
+   * Team service method, Retrive a list of team logo given a User id.
+   * If a team id does not have a logo, it will not be returned.
+   * @param teamId
+   * @returns promise of list of TeamLogoDto
+   */
+  getTeamsLogoByUserId = async (teamId: number): Promise<TeamLogoDto[]> => {
+    try {
+      const teamLogo = await this.teamRepository.getTeamsLogoByUserId(teamId);
+      return teamLogo;
+    } catch (error: any) {
+      console.error("Error get team logo : ", error.message);
+      throw error;
+    }
+  };
+
   // DEPRECIATED - TO BE REMOVED WHEN 1.10 isnt used anymore
   //========================================================
   /**

yaki_backend/src/team.router.ts

@@ -27,7 +27,7 @@ teamRouter.get(
 teamRouter.get(
   "/teams-logo",
   (req, res, next) => authService.verifyToken(req, res, next),
-  (req, res) => teamController.getTeamImageByTeamsId(req, res)
+  (req, res) => teamController.getTeamsLogo(req, res)
 );
 
 export default teamRouter;

yaki_mobile/lib/data/models/team_logo_model.dart

@@ -0,0 +1,43 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'team_logo_model.g.dart';
+
+@JsonSerializable()
+class TeamLogoModel {
+  int teamLogoTeamId;
+  TeamLogoBlob teamLogoBlob;
+
+  TeamLogoModel({
+    required this.teamLogoTeamId,
+    required this.teamLogoBlob,
+  });
+
+  factory TeamLogoModel.fromJson(Map<String, dynamic> json) =>
+      _$TeamLogoModelFromJson(json);
+  Map<String, dynamic> toJson() => _$TeamLogoModelToJson(this);
+
+  @override
+  String toString() {
+    return 'TeamLogoModel{teamLogoTeamId: $teamLogoTeamId, teamLogoBlob: $teamLogoBlob}';
+  }
+}
+
+@JsonSerializable()
+class TeamLogoBlob {
+  String type;
+  List<int> data;
+
+  TeamLogoBlob({
+    required this.type,
+    required this.data,
+  });
+
+  factory TeamLogoBlob.fromJson(Map<String, dynamic> json) =>
+      _$TeamLogoBlobFromJson(json);
+  Map<String, dynamic> toJson() => _$TeamLogoBlobToJson(this);
+
+  @override
+  String toString() {
+    return 'TeamLogoBlob{type: $type, data: $data}';
+  }
+}