feat: add deleteUserAccount endpoint (#38)

Aam-Digital · Aug 16, 2024 · 4c7b8c8 · 4c7b8c8
1 parent ba375f7
commit 4c7b8c8
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 11 deletions.
diff --git a/src/account/account.controller.spec.ts b/src/account/account.controller.spec.ts
@@ -2,20 +2,17 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { AccountController } from './account.controller';
 import { HttpService } from '@nestjs/axios';
 import { User } from '../auth/user.dto';
-import { of } from 'rxjs';
+import { of, throwError } from "rxjs";
 import { NotFoundException } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
 import { KeycloakService } from './keycloak.service';
 import { KeycloakUser } from './keycloak-user.dto';
 
 describe('AccountController', () => {
   let controller: AccountController;
-  const mockHttp = {
-    put: jest.fn().mockReturnValue(of({ data: undefined })),
-    get: jest.fn().mockReturnValue(of({ data: undefined })),
-    post: jest.fn().mockReturnValue(of({ date: undefined })),
-    delete: jest.fn().mockReturnValue(of({ date: undefined })),
-  };
+
+  let mockHttp;
+
   const user: User = {
     sub: 'user-id',
     realm: 'ndb-dev',
@@ -24,6 +21,15 @@ describe('AccountController', () => {
   };
 
   beforeEach(async () => {
+    mockHttp = {
+      put: jest.fn().mockReturnValue(of({ data: undefined })),
+      get: jest.fn().mockReturnValue(of({ data: undefined })),
+      post: jest.fn().mockReturnValue(of({ date: undefined })),
+      delete: jest.fn().mockReturnValue(of({ date: undefined })),
+    }
+
+    jest.clearAllMocks();
+
     const module: TestingModule = await Test.createTestingModule({
       imports: [ConfigModule],
       controllers: [AccountController],
@@ -34,7 +40,6 @@ describe('AccountController', () => {
     }).compile();
 
     controller = module.get<AccountController>(AccountController);
-    jest.clearAllMocks();
   });
 
   it('should be defined', () => {
@@ -70,6 +75,43 @@ describe('AccountController', () => {
       });
   });
 
+  it('should delete return 200 with bodyDeleted true', (done) => {
+    mockHttp.delete.mockReturnValue(of(""));
+    const id = 'my-id';
+
+    controller
+      .deleteAccount({ user }, id )
+      .subscribe({
+        next: (value) => {
+          expect(value.userDeleted).toBeTruthy()
+          // delete user
+          expect(mockHttp.delete).toHaveBeenCalledWith(
+            expect.stringContaining("/ndb-dev/users/my-id"),
+          );
+          done()
+        }
+      });
+  });
+
+  it('should delete return 200 with bodyDeleted false', (done) => {
+    mockHttp.delete.mockReturnValue(throwError(() => new Error()));
+    const id = 'my-id';
+
+    controller
+      .deleteAccount({ user }, id )
+      .subscribe({
+        next: (value) => {
+          expect(value.userDeleted).toBeFalsy()
+          // delete user
+          expect(mockHttp.delete).toHaveBeenCalledWith(
+            expect.stringContaining("/ndb-dev/users/my-id"),
+          );
+          done()
+        }
+      })
+    ;
+  });
+
   it('should return a user with the assigned roles', async () => {
     const requestedUser: KeycloakUser = { username: 'my-user', id: 'user-id' };
     const roles = ['user-role-1', 'user-role-2'];

diff --git a/src/account/account.controller.ts b/src/account/account.controller.ts
@@ -1,6 +1,7 @@
 import {
   Body,
   Controller,
+  Delete,
   Get,
   Headers,
   Param,
@@ -12,13 +13,16 @@ import {
 import { BearerGuard } from '../auth/bearer/bearer.guard';
 import { ApiBearerAuth, ApiHeader, ApiOperation } from '@nestjs/swagger';
 import {
+  catchError,
   concatMap,
   concatWith,
   firstValueFrom,
   last,
   Observable,
-  tap,
-} from 'rxjs';
+  of,
+  switchMap,
+  tap
+} from "rxjs";
 import { ForgotEmailReq } from './forgot-email-req.dto';
 import { SetEmailReq } from './set-email-req.dto';
 import { User } from '../auth/user.dto';
@@ -149,6 +153,39 @@ export class AccountController {
     );
   }
 
+  @ApiOperation({
+    summary: 'delete an user account',
+    description:
+      'Looks if an account with given id exist in realm and deletes it',
+  })
+  @ApiBearerAuth()
+  @ApiHeader({ name: 'Accept-Language', required: false })
+  @UseGuards(BearerGuard, RolesGuard)
+  @Roles(AccountController.ACCOUNT_MANAGEMENT_ROLE)
+  @Delete('/:userId')
+  deleteAccount(
+    @Req() req,
+    @Param('userId') userId: string,
+  ) {
+    const user = req.user as User;
+
+    return this.keycloak.deleteUser(
+      user.realm,
+      userId
+    ).pipe(
+      switchMap(() => {
+        return of({
+          userDeleted: true
+        });
+      }),
+      catchError(() => {
+        return of({
+          userDeleted: false
+        });
+      }),
+    )
+  }
+
   @ApiOperation({
     summary: 'get account details',
     description:

diff --git a/src/account/keycloak.service.ts b/src/account/keycloak.service.ts
@@ -2,7 +2,7 @@ import { Injectable, NotFoundException } from '@nestjs/common';
 import { HttpService } from '@nestjs/axios';
 import { ConfigService } from '@nestjs/config';
 import { KeycloakUser } from './keycloak-user.dto';
-import { map, Observable } from 'rxjs';
+import { catchError, map, Observable, of } from 'rxjs';
 
 /**
  * This service provides endpoints for interacting with Keycloak.
@@ -17,6 +17,7 @@ export class KeycloakService {
   ];
 
   private readonly keycloakUrl: string;
+
   constructor(private http: HttpService, configService: ConfigService) {
     this.keycloakUrl = configService.get('KEYCLOAK_URL');
   }
@@ -35,6 +36,18 @@ export class KeycloakService {
     );
   }
 
+  /**
+   * Delete a user in the realm with the given id
+   * @param realm
+   * @param id
+   */
+  deleteUser(realm: string, id: string) {
+    return this.perform(
+      this.http.delete,
+      `${realm}/users/${id}`,
+    )
+  }
+
   /**
    * Update the user with the given id in the realm.
    * @param realm