[backend] Add API GET /room/:id/bans (#188)

[backend] * Add test for GET /room/:id/bans * Add API GET /room/:id/bans --------- Co-authored-by: Shun Usami <[email protected]>
usatie · Jan 4, 2024 · 55875da · 55875da
1 parent b3b2643
commit 55875da
Show file tree

Hide file tree

Showing 6 changed files with 214 additions and 3 deletions.
diff --git a/backend/src/app.module.ts b/backend/src/app.module.ts
@@ -11,12 +11,14 @@ import { HistoryModule } from './history/history.module';
 import { PrismaModule } from './prisma/prisma.module';
 import { RoomModule } from './room/room.module';
 import { UserModule } from './user/user.module';
+import { BanModule } from './room/ban/ban.module';
 
 @Module({
   imports: [
     UserModule,
     PrismaModule,
     AuthModule,
+    BanModule,
     RoomModule,
     EventsModule,
     ChatModule,

diff --git a/backend/src/room/ban/ban.controller.ts b/backend/src/room/ban/ban.controller.ts
@@ -1,5 +1,6 @@
 import {
   Controller,
+  Get,
   Delete,
   Param,
   ParseIntPipe,
@@ -17,6 +18,12 @@ import { BanService } from './ban.service';
 export class BanController {
   constructor(private readonly banService: BanService) {}
 
+  @Get()
+  @UseGuards(AdminGuard)
+  findAll(@Param('roomId', ParseIntPipe) roomId: number) {
+    return this.banService.findAll(roomId);
+  }
+
   @Put(':userId')
   @UseGuards(AdminGuard)
   create(

diff --git a/backend/src/room/ban/ban.service.ts b/backend/src/room/ban/ban.service.ts
@@ -52,6 +52,25 @@ export class BanService {
     return { message: 'Ban user successfully' };
   }
 
+  async findAll(roomId: number) {
+    const tmp = await this.prisma.banUserOnRoom.findMany({
+      where: {
+        roomId: roomId,
+      },
+      include: {
+        user: {
+          select: {
+            id: true,
+            name: true,
+            avatarURL: true,
+          },
+        },
+      },
+    });
+    const users = tmp.map((item) => item.user);
+    return users;
+  }
+
   async remove(roomId: number, userId: number) {
     await this.prisma.$transaction(async (prisma) => {
       const user = await prisma.banUserOnRoom.findUnique({

diff --git a/backend/src/room/room.module.ts b/backend/src/room/room.module.ts
@@ -1,12 +1,11 @@
 import { Module } from '@nestjs/common';
 import { PrismaModule } from 'src/prisma/prisma.module';
-import { BanModule } from './ban/ban.module';
 import { RoomController } from './room.controller';
 import { RoomService } from './room.service';
 
 @Module({
   controllers: [RoomController],
   providers: [RoomService],
-  imports: [PrismaModule, BanModule],
+  imports: [PrismaModule],
 })
 export class RoomModule {}
diff --git a/backend/test/room.e2e-spec.ts b/backend/test/room.e2e-spec.ts
@@ -6,7 +6,7 @@ import supertest from 'supertest';
 import { constants } from './constants';
 import { TestApp, UserEntityWithAccessToken } from './utils/app';
 import { initializeApp } from './utils/initialize';
-import { expectRoom } from './utils/matcher';
+import { expectPublicUser, expectRoom } from './utils/matcher';
 
 describe('RoomController (e2e)', () => {
   let app: TestApp;
@@ -1678,6 +1678,185 @@ describe('RoomController (e2e)', () => {
     });
   });
 
+  describe('GET /room/:id/bans (Get banned users)', () => {
+    describe('Owner', () => {
+      let _publicRoom: RoomEntity;
+      let bannedUser: UserEntityWithAccessToken;
+      beforeAll(async () => {
+        bannedUser = await app.createAndLoginUser({
+          name: 'BANNED USER',
+          email: '[email protected]',
+          password: '12345678',
+        });
+        _publicRoom = await setupRoom(constants.room.publicRoom);
+        // await app.banUser(_publicRoom.id, bannedUser.id, owner.accessToken);
+      });
+      afterAll(async () => {
+        await app.deleteRoom(_publicRoom.id, owner.accessToken).expect(204);
+        await app.deleteUser(bannedUser.id, bannedUser.accessToken).expect(204);
+      });
+      describe('No banned users in the room', () => {
+        it('should get empty array (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, owner.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          expect(res.body).toHaveLength(0);
+        });
+      });
+      it('Ban user', async () => {
+        await app
+          .banUser(_publicRoom.id, bannedUser.id, owner.accessToken)
+          .expect(200);
+      });
+      describe('Banned users in the room', () => {
+        it('should get banned users (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, owner.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          res.body.forEach(expectPublicUser);
+          const {
+            /* eslint-disable */
+            email,
+            twoFactorEnabled,
+            accessToken,
+            /* eslint-enable */
+            ...bannedUserWithoutAccessToken
+          } = bannedUser;
+
+          expect(res.body).toContainEqual(bannedUserWithoutAccessToken);
+        });
+      });
+    });
+    describe('Admin', () => {
+      let _publicRoom: RoomEntity;
+      let bannedUser: UserEntityWithAccessToken;
+      beforeAll(async () => {
+        bannedUser = await app.createAndLoginUser({
+          name: 'BANNED USER',
+          email: '[email protected]',
+          password: '12345678',
+        });
+        _publicRoom = await setupRoom(constants.room.publicRoom);
+        // await app.banUser(_publicRoom.id, bannedUser.id, owner.accessToken);
+      });
+      afterAll(async () => {
+        await app.deleteRoom(_publicRoom.id, owner.accessToken).expect(204);
+        await app.deleteUser(bannedUser.id, bannedUser.accessToken).expect(204);
+      });
+      describe('No banned users in the room', () => {
+        it('should get empty array (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, admin.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          expect(res.body).toHaveLength(0);
+        });
+      });
+      it('Ban user', async () => {
+        await app
+          .banUser(_publicRoom.id, bannedUser.id, owner.accessToken)
+          .expect(200);
+      });
+      describe('Banned users in the room', () => {
+        it('should get banned users (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, admin.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          res.body.forEach(expectPublicUser);
+          const {
+            /* eslint-disable */
+            email,
+            twoFactorEnabled,
+            accessToken,
+            /* eslint-enable */
+            ...bannedUserWithoutAccessToken
+          } = bannedUser;
+
+          expect(res.body).toContainEqual(bannedUserWithoutAccessToken);
+        });
+      });
+    });
+    describe('Member', () => {
+      let _publicRoom: RoomEntity;
+      let bannedUser: UserEntityWithAccessToken;
+      beforeAll(async () => {
+        bannedUser = await app.createAndLoginUser({
+          name: 'BANNED USER',
+          email: '[email protected]',
+          password: '12345678',
+        });
+        _publicRoom = await setupRoom(constants.room.publicRoom);
+        // await app.banUser(_publicRoom.id, bannedUser.id, owner.accessToken);
+      });
+      afterAll(async () => {
+        await app.deleteRoom(_publicRoom.id, owner.accessToken).expect(204);
+        await app.deleteUser(bannedUser.id, bannedUser.accessToken).expect(204);
+      });
+      describe('No banned users in the room', () => {
+        it('should get empty array (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, admin.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          expect(res.body).toHaveLength(0);
+        });
+      });
+      it('Ban user', async () => {
+        await app
+          .banUser(_publicRoom.id, bannedUser.id, owner.accessToken)
+          .expect(200);
+      });
+      describe('Banned users in the room', () => {
+        it('should not get banned users (403 Forbidden)', async () => {
+          await app
+            .getBannedUsers(publicRoom.id, member.accessToken)
+            .expect(403);
+        });
+      });
+    });
+    describe('notMember', () => {
+      let _publicRoom: RoomEntity;
+      let bannedUser: UserEntityWithAccessToken;
+      beforeAll(async () => {
+        bannedUser = await app.createAndLoginUser({
+          name: 'BANNED USER',
+          email: '[email protected]',
+          password: '12345678',
+        });
+        _publicRoom = await setupRoom(constants.room.publicRoom);
+        // await app.banUser(_publicRoom.id, bannedUser.id, owner.accessToken);
+      });
+      afterAll(async () => {
+        await app.deleteRoom(_publicRoom.id, owner.accessToken).expect(204);
+        await app.deleteUser(bannedUser.id, bannedUser.accessToken).expect(204);
+      });
+      describe('No banned users in the room', () => {
+        it('should get empty array (200 OK)', async () => {
+          const res = await app
+            .getBannedUsers(_publicRoom.id, admin.accessToken)
+            .expect(200);
+          expect(res.body).toBeInstanceOf(Array);
+          expect(res.body).toHaveLength(0);
+        });
+      });
+      it('Ban user', async () => {
+        await app
+          .banUser(_publicRoom.id, bannedUser.id, owner.accessToken)
+          .expect(200);
+      });
+      describe('Banned users in the room', () => {
+        it('should not get banned users (403 Forbidden)', async () => {
+          await app
+            .getBannedUsers(publicRoom.id, notMember.accessToken)
+            .expect(403);
+        });
+      });
+    });
+  });
+
   describe('DELETE /room/:id/bans/:userId (Unban user)', () => {
     describe('Owner', () => {
       let _publicRoom: RoomEntity;

diff --git a/backend/test/utils/app.ts b/backend/test/utils/app.ts
@@ -131,6 +131,11 @@ export class TestApp {
       .delete(`/room/${roomId}/bans/${userId}`)
       .set('Authorization', `Bearer ${accessToken}`);
 
+  getBannedUsers = (roomId: number, accessToken: string) =>
+    request(this.app.getHttpServer())
+      .get(`/room/${roomId}/bans`)
+      .set('Authorization', `Bearer ${accessToken}`);
+
   muteUser = (
     roomId: number,
     userId: number,