Improve auth provider return type

sourcegraph · Jan 10, 2025 · 68dd847 · 68dd847
1 parent a0ad157
commit 68dd847
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/lib/shared/src/configuration.ts b/lib/shared/src/configuration.ts
@@ -99,7 +99,7 @@ export interface ExternalAuthProvider {
 
 export interface ExternalAuthProviderResult {
     headers: NonSerializableRecord<string, string>
-    expiration: number
+    expiration?: number | null
 }
 
 interface RawClientConfiguration {

diff --git a/lib/shared/src/configuration/resolver.ts b/lib/shared/src/configuration/resolver.ts
@@ -3,7 +3,7 @@ import type {
     AuthCredentials,
     ClientConfiguration,
     ExternalAuthCommand,
-    NonSerializableRecord,
+    ExternalAuthProviderResult,
     TokenSource,
 } from '../configuration'
 import { logError } from '../logger'
@@ -101,10 +101,10 @@ async function executeCommand(cmd: ExternalAuthCommand): Promise<string> {
     return stdout.trim()
 }
 
-async function getExternalProviderAuthHeaders(
+async function getExternalProviderAuthResult(
     serverEndpoint: string,
     clientConfiguration: ClientConfiguration
-): Promise<NonSerializableRecord<string, string> | undefined> {
+): Promise<ExternalAuthProviderResult | undefined> {
     // Check for external auth provider for this endpoint
     const externalProvider = clientConfiguration.authExternalProviders.find(
         provider => normalizeServerEndpointURL(provider.endpoint) === serverEndpoint
@@ -131,11 +131,12 @@ export async function resolveAuth(
         return { credentials: { token: clientConfiguration.overrideAuthToken }, serverEndpoint }
     }
 
-    const authHeaders = await getExternalProviderAuthHeaders(serverEndpoint, clientConfiguration).catch(
-        error => {
+    const authHeaders = await getExternalProviderAuthResult(serverEndpoint, clientConfiguration)
+        .catch(error => {
             throw new Error(`Failed to execute external auth command: ${error}`)
-        }
-    )
+        })
+        .then(result => result?.headers)
+
     if (authHeaders) {
         return { credentials: { headers: authHeaders }, serverEndpoint }
     }