Class OAuthFlowManager

Manages OAuth authentication flows adapted for VS Code.

Unlike browser-based OAuth flows, VS Code requires:

Opening system browser instead of popup window
Custom URI handler for OAuth callbacks
State-based CSRF protection
Timeout handling for abandoned flows

Hierarchy (View Summary)

BaseService
- OAuthFlowManager

Index

Constructors

Properties

Accessors

callbackUri state

Methods

assertReady dispose getPendingFlowCount initialize onDispose onInitialize startOAuthFlow

Constructors

constructor

new OAuthFlowManager(
context: ExtensionContext,
logger: ILogger,
): OAuthFlowManager
Parameters
- context: ExtensionContext
- logger: ILogger
Returns OAuthFlowManager
Overrides BaseService.constructor
- Defined in src/services/core/oauthFlowManager.ts:105

Properties

`Protected` `Readonly`logger

logger: ILogger

Logger instance for this service.

`Protected` `Readonly`name

name: string

Service name for logging.

Accessors

callbackUri

get callbackUri(): string
Callback URI for OAuth flows, using the host editor's URI scheme.

Returns string
Callback URI (e.g. vscode://extensionId/auth or windsurf://extensionId/auth).
- Defined in src/services/core/oauthFlowManager.ts:101

state

get state(): ServiceState
Gets the current service state.

Returns ServiceState
Inherited from BaseService.state
- Defined in src/services/core/baseService.ts:73

Methods

`Protected`assertReady

assertReady(): void
Asserts that the service is ready for use. Throws an error if the service is not in the Ready state.

Returns void
Throws
Error if service is not ready.
Inherited from BaseService.assertReady
- Defined in src/services/core/baseService.ts:133

dispose

dispose(): Promise<void>
Disposes the service and cleans up resources. Ensures disposal only happens once.

Returns Promise<void>
Inherited from BaseService.dispose
- Defined in src/services/core/baseService.ts:108

getPendingFlowCount

getPendingFlowCount(): number
Get count of pending OAuth flows (for testing/debugging).

Returns number
Number of currently pending OAuth flows.
- Defined in src/services/core/oauthFlowManager.ts:592

initialize

initialize(): Promise<void>
Initializes the service. Ensures initialization only happens once and tracks state.

Returns Promise<void>
Inherited from BaseService.initialize
- Defined in src/services/core/baseService.ts:81

`Protected`onDispose

onDispose(): Promise<void>
Clean up OAuth flow manager.

Returns Promise<void>
Overrides BaseService.onDispose
- Defined in src/services/core/oauthFlowManager.ts:157

`Protected`onInitialize

onInitialize(): Promise<void>
Initialize OAuth flow manager and register URI handler.

Returns Promise<void>
Overrides BaseService.onInitialize
- Defined in src/services/core/oauthFlowManager.ts:116

startOAuthFlow

startOAuthFlow(provider: OAuthProvider): Promise<OAuthResult>
Starts an OAuth authentication flow by generating a state parameter, opening the browser to the authorization URL, waiting for the callback, and returning the authentication token.
Parameters
- provider: OAuthProvider
  OAuth provider (github, google, or linkedin).
Returns Promise<OAuthResult>
Promise that resolves with authentication token.

Throws
Error if flow times out, is cancelled, or fails.
- Defined in src/services/core/oauthFlowManager.ts:185