fix: Errors on logout

src/auth/auth.controller.ts

@@ -1,4 +1,12 @@
-import { Controller, UseGuards, Post, Get, Res, Req } from "@nestjs/common";
+import {
+  Controller,
+  UseGuards,
+  Post,
+  Get,
+  Res,
+  Req,
+  HttpCode,
+} from "@nestjs/common";
 import { LocalAuthGuard } from "./guards/local-auth.guard";
 import { AuthService } from "./auth.service";
 import { JwtAuthGuard } from "./guards/jwt-auth.guard";
@@ -107,9 +115,9 @@ export class AuthController {
     status: 200,
     description: "User logged out",
   })
+  @HttpCode(200)
   @Post("logout")
-  async logout(@Req() req: Request, @Res() res: Response) {
-    await this.authService.logout(req, res);
-    res.send({ logout: "successful" });
+  async logout(@Req() req: Request) {
+    return this.authService.logout(req);
   }
 }

src/auth/auth.service.ts

@@ -1,10 +1,10 @@
-import { HttpStatus, Injectable } from "@nestjs/common";
+import { Injectable } from "@nestjs/common";
 import { ConfigService } from "@nestjs/config";
 import { JwtService } from "@nestjs/jwt";
 import { compare } from "bcrypt";
 import { User } from "src/users/schemas/user.schema";
 import { UsersService } from "../users/users.service";
-import { Request, Response } from "express";
+import { Request } from "express";
 import { OidcConfig } from "src/config/configuration";
 import { parseBoolean } from "src/common/utils";
 import { Issuer } from "openid-client";
@@ -52,33 +52,33 @@ export class AuthService {
     };
   }
 
-  async logout(req: Request, res: Response) {
+  async logout(req: Request) {
     const logoutURL = this.configService.get<string>("logoutURL") || "";
     const expressSessionSecret = this.configService.get<string>(
       "expressSessionSecret",
     );
 
     if (expressSessionSecret) {
-      await req.logout(async (err) => {
+      req.logout(async (err) => {
         if (err) {
           // we should provide a message
           console.log("Logout error");
           console.log(err);
           //res.status(HttpStatus.BAD_REQUEST);
         }
-        await this.additionalLogoutTasks(req, res, logoutURL);
+        return await this.additionalLogoutTasks(req, logoutURL);
       });
     } else {
-      await this.additionalLogoutTasks(req, res, logoutURL);
+      return await this.additionalLogoutTasks(req, logoutURL);
     }
     if (logoutURL) {
-      res.redirect(logoutURL);
+      return { logout: "successful", logoutURL: logoutURL };
     }
-    res.status(HttpStatus.OK);
-    return;
+
+    return { logout: "successful" };
   }
 
-  async additionalLogoutTasks(req: Request, res: Response, logoutURL: string) {
+  async additionalLogoutTasks(req: Request, logoutURL: string) {
     const user = req.user as Omit<User, "password">;
     if (user?.authStrategy == "oidc") {
       const oidcConfig = this.configService.get<OidcConfig>("oidc");
@@ -89,10 +89,12 @@ export class AuthService {
         );
         const end_session_endpoint = trustIssuer.metadata.end_session_endpoint;
         if (end_session_endpoint) {
-          res.redirect(
-            end_session_endpoint +
+          return {
+            logout: "successful",
+            logoutURL:
+              end_session_endpoint +
               (logoutURL ? "?post_logout_redirect_uri=" + logoutURL : ""),
-          );
+          };
         }
       }
     }

src/users/users.controller.ts

@@ -9,10 +9,9 @@ import {
   Delete,
   UseInterceptors,
   Put,
-  //UnauthorizedException,
   Body,
-  Res,
   ForbiddenException,
+  HttpCode,
 } from "@nestjs/common";
 import {
   ApiBearerAuth,
@@ -272,10 +271,18 @@ export class UsersController {
   }
 
   @UseGuards(JwtAuthGuard)
+  @ApiOperation({
+    summary: "It logs the current user out.",
+    description: "It logs out the current user.",
+  })
+  @ApiResponse({
+    status: 200,
+    description: "User logged out",
+  })
+  @HttpCode(200)
   @Post("logout")
-  async logout(@Req() req: Request, @Res() res: Response) {
-    await this.authService.logout(req, res);
-    return res.send({ logout: "successful" });
+  async logout(@Req() req: Request) {
+    return this.authService.logout(req);
   }
 
   @UseGuards(PoliciesGuard)