1
>
/*---------------------------------------------------------------------------------------------
loopbackProxyServer.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import type * as http from 'http';
7
>
import { AddressInfo } from 'net';
8
>
import { IDisposable } from '../../../../base/common/lifecycle.js';
9
>
import { ILogService } from '../../../log/common/log.js';
10
>
11
>
// #region Public types
12
>
13
>
/**
14
>
* Per-request bookkeeping shared by every loopback proxy. `clientGone`
15
>
* distinguishes a client-driven disconnect (socket already closed — write
16
>
* nothing) from a service-driven `dispose()` (socket still open —
17
>
* `res.destroy()` to unblock the client) when the abort signal fires.
18
>
*/
19
>
export interface IProxyInFlight {
20
>
readonly ac: AbortController;
21
>
readonly res: http.ServerResponse;
22
>
clientGone: boolean;
23
>
}
24
>
25
>
/**
26
>
* The shared, refcounted runtime exposed to subclasses while servicing
27
>
* requests and minting handles. `state` is the subclass-owned mutable
28
>
* payload (e.g. the current GitHub token) created once per bind by
29
>
* {@link LoopbackProxyServer.createState} from the seed supplied to the
30
>
* `acquire()` call that triggered the bind.
31
>
*/
32
>
export interface ILoopbackProxyRuntime<TState> {
33
>
/** e.g. `http://127.0.0.1:54321` — no trailing slash. */
34
>
readonly baseUrl: string;
35
>
/** 256-bit hex string minted for this bind. */
36
>
readonly nonce: string;
37
>
/** In-flight requests; aborted on teardown. */
38
>
readonly inFlight: Set<IProxyInFlight>;
39
>
/** Subclass-owned mutable per-bind state. */
40
>
readonly state: TState;
41
>
}
42
>
43
>
/**
44
>
* Minimal handle every loopback proxy hands back from `start()`. Subclasses
45
>
* are free to widen this with extra members (e.g. `setToken`,
46
>
* `providerBaseUrl`).
47
>
*
48
>
* **Subprocess ownership invariant.** Callers that hand `baseUrl` / `nonce`
49
>
* to a subprocess MUST kill that subprocess before calling `dispose()` —
50
>
* after the last handle is disposed the proxy may rebind on a different port
51
>
* and the subprocess would silently lose its endpoint.
52
>
*/
53
>
export interface ILoopbackProxyHandle extends IDisposable {
54
>
/** e.g. `http://127.0.0.1:54321` — no trailing slash. */
55
>
readonly baseUrl: string;
56
>
/** 256-bit hex string. */
57
>
readonly nonce: string;
58
>
}
59
>
60
>
// #endregion
61
>
62
>
// #region Internal state
63
>
64
>
interface IInternalRuntime<TState> extends ILoopbackProxyRuntime<TState> {
65
>
readonly server: http.Server;
66
>
refcount: number;
67
>
}
68
>
69
>
/**
70
>
* Build the 256-bit hex nonce embedded in the proxy Bearer token. Web Crypto
71
>
* is available in Node 18+.
72
>
*/
73
function generateNonce(): string {
74
const bytes = new Uint8Array(32);