From 0f848209959cd981c0e98c434d5cf3bc139d056f Mon Sep 17 00:00:00 2001
From: Johan Haals <johan.haals@gmail.com>
Date: Wed, 20 Nov 2024 14:06:18 +0100
Subject: [PATCH] Make return type an object. Improve naming

Signed-off-by: Johan Haals <johan.haals@gmail.com>
---
 .../backend-defaults/report-httpAuth.api.md   |  5 ++--
 .../httpAuth/DefaultHttpAuthService.test.ts   | 18 +++++--------
 .../httpAuth/httpAuthServiceFactory.ts        | 27 +++++++++----------
 3 files changed, 23 insertions(+), 27 deletions(-)

diff --git a/packages/backend-defaults/report-httpAuth.api.md b/packages/backend-defaults/report-httpAuth.api.md
index 4aa492bac3..b3843beb3d 100644
--- a/packages/backend-defaults/report-httpAuth.api.md
+++ b/packages/backend-defaults/report-httpAuth.api.md
@@ -41,8 +41,9 @@ export interface DefaultHttpAuthServiceOptions {
   auth: AuthService;
   // (undocumented)
   discovery: DiscoveryService;
-  // (undocumented)
-  extractTokenFromRequest?: (req: Request_2) => string | undefined;
+  getTokenFromRequest?: (req: Request_2) => {
+    token?: string;
+  };
   // (undocumented)
   pluginId: string;
 }
diff --git a/packages/backend-defaults/src/entrypoints/httpAuth/DefaultHttpAuthService.test.ts b/packages/backend-defaults/src/entrypoints/httpAuth/DefaultHttpAuthService.test.ts
index bbcd77795e..e314564b59 100644
--- a/packages/backend-defaults/src/entrypoints/httpAuth/DefaultHttpAuthService.test.ts
+++ b/packages/backend-defaults/src/entrypoints/httpAuth/DefaultHttpAuthService.test.ts
@@ -25,21 +25,17 @@ describe('DefaultHttpAuthService', () => {
       discovery: mockServices.discovery(),
       auth,
       pluginId: 'test',
-      extractTokenFromRequest: req => {
-        const authHeader = req.headers.test;
-        if (typeof authHeader === 'string') {
-          const matches = authHeader.match(/^Bearer[ ]+(\S+)$/i);
-          const token = matches?.[1];
-          if (token) {
-            return token;
-          }
+      getTokenFromRequest: req => {
+        let token: string | undefined;
+        const header = req.headers.test;
+        if (typeof header === 'string') {
+          token = header;
         }
-
-        return undefined;
+        return { token };
       },
     });
     await httpAuthService.credentials(
-      createRequest({ headers: { test: 'Bearer mock-user-token' } }),
+      createRequest({ headers: { test: 'mock-user-token' } }),
     );
     expect(auth.authenticate).toHaveBeenCalledWith('mock-user-token');
   });
diff --git a/packages/backend-defaults/src/entrypoints/httpAuth/httpAuthServiceFactory.ts b/packages/backend-defaults/src/entrypoints/httpAuth/httpAuthServiceFactory.ts
index 4259a604c4..4bc6b3b1fc 100644
--- a/packages/backend-defaults/src/entrypoints/httpAuth/httpAuthServiceFactory.ts
+++ b/packages/backend-defaults/src/entrypoints/httpAuth/httpAuthServiceFactory.ts
@@ -33,16 +33,14 @@ const FIVE_MINUTES_MS = 5 * 60 * 1000;
 const BACKSTAGE_AUTH_COOKIE = 'backstage-auth';
 
 function getTokenFromRequest(req: Request) {
+  let token: string | undefined;
   const authHeader = req.headers.authorization;
   if (typeof authHeader === 'string') {
     const matches = authHeader.match(/^Bearer[ ]+(\S+)$/i);
-    const token = matches?.[1];
-    if (token) {
-      return token;
-    }
+    token = matches?.[1];
   }
 
-  return undefined;
+  return { token };
 }
 
 function getCookieFromRequest(req: Request) {
@@ -78,8 +76,10 @@ export interface DefaultHttpAuthServiceOptions {
   auth: AuthService;
   discovery: DiscoveryService;
   pluginId: string;
-  // Optionally override the default token extraction logic
-  extractTokenFromRequest?: (req: Request) => string | undefined;
+  /**
+   * Optionally override logic for extracting the token from the request.
+   */
+  getTokenFromRequest?: (req: Request) => { token?: string };
 }
 
 /**
@@ -90,19 +90,18 @@ export class DefaultHttpAuthService implements HttpAuthService {
   readonly #auth: AuthService;
   readonly #discovery: DiscoveryService;
   readonly #pluginId: string;
-  readonly #extractTokenFromRequest: (req: Request) => string | undefined;
+  readonly #getToken: (req: Request) => { token?: string };
 
   private constructor(
     auth: AuthService,
     discovery: DiscoveryService,
     pluginId: string,
-    extractTokenFromRequest?: (req: Request) => string | undefined,
+    getToken?: (req: Request) => { token?: string },
   ) {
     this.#auth = auth;
     this.#discovery = discovery;
     this.#pluginId = pluginId;
-    this.#extractTokenFromRequest =
-      extractTokenFromRequest ?? getTokenFromRequest;
+    this.#getToken = getToken ?? getTokenFromRequest;
   }
 
   static create(
@@ -112,12 +111,12 @@ export class DefaultHttpAuthService implements HttpAuthService {
       options.auth,
       options.discovery,
       options.pluginId,
-      options.extractTokenFromRequest,
+      options.getTokenFromRequest,
     );
   }
 
   async #extractCredentialsFromRequest(req: Request) {
-    const token = this.#extractTokenFromRequest(req);
+    const { token } = this.#getToken(req);
     if (!token) {
       return await this.#auth.getNoneCredentials();
     }
@@ -126,7 +125,7 @@ export class DefaultHttpAuthService implements HttpAuthService {
   }
 
   async #extractLimitedCredentialsFromRequest(req: Request) {
-    const token = this.#extractTokenFromRequest(req);
+    const { token } = this.#getToken(req);
     if (token) {
       return await this.#auth.authenticate(token, {
         allowLimitedAccess: true,