@fluidframework/tool-utils 2.90.0 → 2.91.0

package/src/odspTokenManager.ts

@@ -11,7 +11,6 @@ import type {
 } from "@fluidframework/odsp-doclib-utils/internal";
 import {
 	fetchTokens,
-	getLoginPageUrl,
 	getOdspScope,
 	pushScope,
 	refreshTokens,
@@ -21,11 +20,6 @@ import { Mutex } from "async-mutex";
 import { debug } from "./debug.js";
 import type { IAsyncCache, IResources } from "./fluidToolRc.js";
 import { loadRC, lockRC, saveRC } from "./fluidToolRc.js";
-import { endResponse, serverListenAndHandle } from "./httpHelpers.js";
-
-const odspAuthRedirectPort = 7000;
-const odspAuthRedirectOrigin = `http://localhost:${odspAuthRedirectPort}`;
-const odspAuthRedirectUri = new URL("/auth/callback", odspAuthRedirectOrigin).href;
 
 // TODO: Add documentation
 // eslint-disable-next-line jsdoc/require-description
@@ -45,16 +39,16 @@ export const getMicrosoftConfiguration = (): IPublicClientConfig => ({
 /**
  * @internal
  */
-export type OdspTokenConfig =
+export type LoginCredentials =
 	| {
 			type: "password";
 			username: string;
 			password: string;
 	  }
 	| {
-			type: "browserLogin";
-			navigator: (url: string) => void;
-			redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>;
+			type: "fic";
+			username: string;
+			fetchToken(scopeEndpoint: "push" | "storage"): Promise<string>;
 	  };
 
 /**
@@ -62,7 +56,7 @@ export type OdspTokenConfig =
  */
 export interface IOdspTokenManagerCacheKey {
 	readonly isPush: boolean;
-	readonly userOrServer: string;
+	readonly user: string;
 }
 
 const isValidAndNotExpiredToken = (tokens: IOdspTokens): boolean => {
@@ -82,7 +76,7 @@ const isValidAndNotExpiredToken = (tokens: IOdspTokens): boolean => {
 };
 
 const cacheKeyToString = (key: IOdspTokenManagerCacheKey): string => {
-	return `${key.userOrServer}${key.isPush ? "[Push]" : ""}`;
+	return `${key.user}${key.isPush ? "[Push]" : ""}`;
 };
 
 /**
@@ -111,37 +105,37 @@ export class OdspTokenManager {
 	): Promise<void> {
 		debug(`${cacheKeyToString(key)}: Saving tokens`);
 		const memoryCache = key.isPush ? this.pushCache : this.storageCache;
-		memoryCache.set(key.userOrServer, value);
+		memoryCache.set(key.user, value);
 		await this.tokenCache?.save(key, value);
 	}
 
 	public async getOdspTokens(
 		server: string,
 		clientConfig: IPublicClientConfig,
-		tokenConfig: OdspTokenConfig,
+		credentials: LoginCredentials,
 		forceRefresh = false,
 		forceReauth = false,
 	): Promise<IOdspTokens> {
 		debug("Getting odsp tokens");
-		return this.getTokens(false, server, clientConfig, tokenConfig, forceRefresh, forceReauth);
+		return this.getTokens(false, server, clientConfig, credentials, forceRefresh, forceReauth);
 	}
 
 	public async getPushTokens(
 		server: string,
 		clientConfig: IPublicClientConfig,
-		tokenConfig: OdspTokenConfig,
+		credentials: LoginCredentials,
 		forceRefresh = false,
 		forceReauth = false,
 	): Promise<IOdspTokens> {
 		debug("Getting push tokens");
-		return this.getTokens(true, server, clientConfig, tokenConfig, forceRefresh, forceReauth);
+		return this.getTokens(true, server, clientConfig, credentials, forceRefresh, forceReauth);
 	}
 
 	private async getTokenFromCache(
 		cacheKey: IOdspTokenManagerCacheKey,
 	): Promise<IOdspTokens | undefined> {
 		const memoryCache = cacheKey.isPush ? this.pushCache : this.storageCache;
-		const memoryToken = memoryCache.get(cacheKey.userOrServer);
+		const memoryToken = memoryCache.get(cacheKey.user);
 		if (memoryToken) {
 			debug(`${cacheKeyToString(cacheKey)}: Token found in memory `);
 			return memoryToken;
@@ -149,20 +143,18 @@ export class OdspTokenManager {
 		const fileToken = await this.tokenCache?.get(cacheKey);
 		if (fileToken) {
 			debug(`${cacheKeyToString(cacheKey)}: Token found in file`);
-			memoryCache.set(cacheKey.userOrServer, fileToken);
+			memoryCache.set(cacheKey.user, fileToken);
 			return fileToken;
 		}
 	}
 
 	private static getCacheKey(
 		isPush: boolean,
-		tokenConfig: OdspTokenConfig,
-		server: string,
+		credentials: LoginCredentials,
 	): IOdspTokenManagerCacheKey {
-		// If we are using password, we should cache the token per user instead of per server
 		return {
 			isPush,
-			userOrServer: tokenConfig.type === "password" ? tokenConfig.username : server,
+			user: credentials.username,
 		};
 	}
 
@@ -170,7 +162,7 @@ export class OdspTokenManager {
 		isPush: boolean,
 		server: string,
 		clientConfig: IPublicClientConfig,
-		tokenConfig: OdspTokenConfig,
+		credentials: LoginCredentials,
 		forceRefresh: boolean,
 		forceReauth: boolean,
 	): Promise<IOdspTokens> {
@@ -182,7 +174,7 @@ export class OdspTokenManager {
 					isPush,
 					server,
 					clientConfig,
-					tokenConfig,
+					credentials,
 					forceRefresh,
 					forceReauth,
 				);
@@ -190,12 +182,11 @@ export class OdspTokenManager {
 		};
 		if (!forceReauth && !forceRefresh) {
 			// check and return if it exists without lock
-			const cacheKey = OdspTokenManager.getCacheKey(isPush, tokenConfig, server);
+			const cacheKey = OdspTokenManager.getCacheKey(isPush, credentials);
 			const tokensFromCache = await this.getTokenFromCache(cacheKey);
 			if (tokensFromCache) {
 				if (isValidAndNotExpiredToken(tokensFromCache)) {
 					debug(`${cacheKeyToString(cacheKey)}: Token reused from cache `);
-					await this.onTokenRetrievalFromCache(tokenConfig, tokensFromCache);
 					return tokensFromCache;
 				}
 				debug(`${cacheKeyToString(cacheKey)}: Token expired from cache `);
@@ -212,12 +203,12 @@ export class OdspTokenManager {
 		isPush: boolean,
 		server: string,
 		clientConfig: IPublicClientConfig,
-		tokenConfig: OdspTokenConfig,
+		credentials: LoginCredentials,
 		forceRefresh: boolean,
 		forceReauth: boolean,
 	): Promise<IOdspTokens> {
 		const scope = isPush ? pushScope : getOdspScope(server);
-		const cacheKey = OdspTokenManager.getCacheKey(isPush, tokenConfig, server);
+		const cacheKey = OdspTokenManager.getCacheKey(isPush, credentials);
 		let tokens: IOdspTokens | undefined;
 		if (!forceReauth) {
 			// check the cache again under the lock (if it is there)
@@ -225,8 +216,16 @@ export class OdspTokenManager {
 			if (tokensFromCache) {
 				if (forceRefresh || !isValidAndNotExpiredToken(tokensFromCache)) {
 					try {
-						// This updates the tokens in tokensFromCache
-						tokens = await refreshTokens(server, scope, clientConfig, tokensFromCache);
+						if (credentials.type === "fic") {
+							const scopeEndpoint = isPush ? "push" : "storage";
+							const newTokenData = await credentials.fetchToken(scopeEndpoint);
+							tokens = this.ficTokenToIOdspTokens(newTokenData, isPush);
+						} else if (credentials.type === "password") {
+							// For OAuth flows, use refresh token
+							tokens = await refreshTokens(server, scope, clientConfig, tokensFromCache);
+						} else {
+							unreachableCase(credentials);
+						}
 						await this.updateTokensCacheWithoutLock(cacheKey, tokens);
 					} catch (error) {
 						debug(`${cacheKeyToString(cacheKey)}: Error in refreshing token. ${error}`);
@@ -236,37 +235,29 @@ export class OdspTokenManager {
 					debug(`${cacheKeyToString(cacheKey)}: Token reused from locked cache `);
 				}
 			}
+			if (tokens) {
+				return tokens;
+			}
 		}
 
-		if (tokens) {
-			await this.onTokenRetrievalFromCache(tokenConfig, tokens);
-			return tokens;
-		}
-
-		switch (tokenConfig.type) {
+		switch (credentials.type) {
 			case "password": {
 				tokens = await this.acquireTokensWithPassword(
 					server,
 					scope,
 					clientConfig,
-					tokenConfig.username,
-					tokenConfig.password,
+					credentials.username,
+					credentials.password,
 				);
 				break;
 			}
-			case "browserLogin": {
-				tokens = await this.acquireTokensViaBrowserLogin(
-					getLoginPageUrl(server, clientConfig, scope, odspAuthRedirectUri),
-					server,
-					clientConfig,
-					scope,
-					tokenConfig.navigator,
-					tokenConfig.redirectUriCallback,
-				);
+			case "fic": {
+				const tokenData = await credentials.fetchToken(isPush ? "push" : "storage");
+				tokens = this.ficTokenToIOdspTokens(tokenData, isPush);
 				break;
 			}
 			default: {
-				unreachableCase(tokenConfig);
+				unreachableCase(credentials);
 			}
 		}
 
@@ -296,64 +287,50 @@ export class OdspTokenManager {
 		return fetchTokens(server, scope, clientConfig, credentials);
 	}
 
-	private async acquireTokensViaBrowserLogin(
-		loginPageUrl: string,
-		server: string,
-		clientConfig: IPublicClientConfig,
-		scope: string,
-		navigator: (url: string) => void,
-		redirectUriCallback?: (tokens: IOdspTokens) => Promise<string>,
-	): Promise<IOdspTokens> {
-		// Start up a local auth redirect handler service to receive the tokens after login
-		const tokenGetter = await serverListenAndHandle(odspAuthRedirectPort, async (req, res) => {
-			// extract code from request URL and fetch the tokens
-			const credentials: TokenRequestCredentials = {
-				grant_type: "authorization_code",
-				code: this.extractAuthorizationCode(req.url),
-				redirect_uri: odspAuthRedirectUri,
+	private ficTokenToIOdspTokens(token: string, isPush: boolean): IOdspTokens {
+		// eslint-disable-next-line unicorn/prefer-ternary -- using if statement for clarity
+		if (isPush) {
+			// Push tokens are not standard JWTs. With direct token exchange, the second leg includes information about expiry.
+			// This is not available in the FIC flow, but in direct token exchange we request tokens with 1 hour expiry so default to that.
+			// At worst this should result in some higher latency when a token is returned from the cache when it should really be
+			// refreshed immediately (as attempting to use such a token will trigger a token refresh flow indirectly).
+			return {
+				accessToken: token,
+				receivedAt: Math.floor(Date.now() / 1000),
+				expiresIn: 3600,
 			};
-			const tokens = await fetchTokens(server, scope, clientConfig, credentials);
-
-			// redirect now that the browser is done with auth
-			if (redirectUriCallback) {
-				res.writeHead(301, { Location: await redirectUriCallback(tokens) });
-				await endResponse(res);
-			} else {
-				res.write("Please close the window");
-				await endResponse(res);
-			}
-
-			return tokens;
-		});
-
-		// Now that our local redirect handler is up, navigate the browser to the login page
-		navigator(loginPageUrl);
-
-		// Receive and extract the tokens
-		const odspTokens = await tokenGetter();
-
-		return odspTokens;
-	}
-
-	private async onTokenRetrievalFromCache(
-		config: OdspTokenConfig,
-		tokens: IOdspTokens,
-	): Promise<void> {
-		if (config.type === "browserLogin" && config.redirectUriCallback) {
-			config.navigator(await config.redirectUriCallback(tokens));
+		} else {
+			return this.jwtToIOdspTokens(token);
 		}
 	}
 
-	private extractAuthorizationCode(relativeUrl: string | undefined): string {
-		if (relativeUrl === undefined) {
-			throw new Error("Failed to get authorization");
+	private jwtToIOdspTokens(token: string): IOdspTokens {
+		let receivedAt: number;
+		let expiresIn: number;
+		const payloadSegment = token.split(".")[1];
+		if (payloadSegment === undefined) {
+			throw new Error("Invalid JWT format");
+		}
+		const payload = JSON.parse(Buffer.from(payloadSegment, "base64url").toString("utf8")) as {
+			iat?: number;
+			exp?: number;
+		};
+		if (typeof payload.iat === "number") {
+			receivedAt = payload.iat;
+		} else {
+			throw new TypeError("JWT payload lacks valid iat claim.");
 		}
-		const parsedUrl = new URL(relativeUrl, odspAuthRedirectOrigin);
-		const code = parsedUrl.searchParams.get("code");
-		if (code === null || code === undefined) {
-			throw new Error("Failed to get authorization");
+		if (typeof payload.exp === "number" && typeof payload.iat === "number") {
+			expiresIn = payload.exp - payload.iat;
+		} else {
+			throw new TypeError("JWT payload lacks valid exp claim.");
 		}
-		return code;
+
+		return {
+			accessToken: token,
+			receivedAt,
+			expiresIn,
+		};
 	}
 }
 
@@ -374,7 +351,7 @@ async function loadAndPatchRC(): Promise<IResources> {
 export const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens> = {
 	async get(key: IOdspTokenManagerCacheKey): Promise<IOdspTokens | undefined> {
 		const rc = await loadAndPatchRC();
-		return rc.tokens?.data[key.userOrServer]?.[key.isPush ? "push" : "storage"];
+		return rc.tokens?.data[key.user]?.[key.isPush ? "push" : "storage"];
 	},
 	async save(key: IOdspTokenManagerCacheKey, tokens: IOdspTokens): Promise<void> {
 		const rc = await loadAndPatchRC();
@@ -385,10 +362,10 @@ export const odspTokensCache: IAsyncCache<IOdspTokenManagerCacheKey, IOdspTokens
 				data: {},
 			};
 		}
-		let prevTokens = rc.tokens.data[key.userOrServer];
+		let prevTokens = rc.tokens.data[key.user];
 		if (!prevTokens) {
 			prevTokens = {};
-			rc.tokens.data[key.userOrServer] = prevTokens;
+			rc.tokens.data[key.user] = prevTokens;
 		}
 		prevTokens[key.isPush ? "push" : "storage"] = tokens;
 		return saveRC(rc);

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tool-utils";
-export const pkgVersion = "2.90.0";
+export const pkgVersion = "2.91.0";

package/dist/httpHelpers.d.ts

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/// <reference types="node" />
-/// <reference types="node" />
-import http from "node:http";
-import type { Socket } from "node:net";
-export interface ITrackedHttpServer {
-    readonly server: http.Server;
-    readonly sockets: Set<Socket>;
-    fullyClose(): void;
-}
-export declare function createTrackedServer(port: number, requestListener: http.RequestListener): ITrackedHttpServer;
-export type OnceListenerHandler<T> = (req: http.IncomingMessage, res: http.ServerResponse) => Promise<T>;
-export type OnceListenerResult<T> = Promise<() => Promise<T>>;
-export declare const serverListenAndHandle: <T>(port: number, handler: OnceListenerHandler<T>) => OnceListenerResult<T>;
-export declare const endResponse: (response: http.ServerResponse) => Promise<void>;
-//# sourceMappingURL=httpHelpers.d.ts.map

package/dist/httpHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"httpHelpers.d.ts","sourceRoot":"","sources":["../src/httpHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAIvC,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,UAAU,IAAI,IAAI,CAAC;CACnB;AAID,wBAAgB,mBAAmB,CAClC,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,IAAI,CAAC,eAAe,GACnC,kBAAkB,CAmBpB;AAID,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CACpC,GAAG,EAAE,IAAI,CAAC,eAAe,EACzB,GAAG,EAAE,IAAI,CAAC,cAAc,KACpB,OAAO,CAAC,CAAC,CAAC,CAAC;AAIhB,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAI9D,eAAO,MAAM,qBAAqB,YAC3B,MAAM,WACH,oBAAoB,CAAC,CAAC,KAC7B,mBAAmB,CAAC,CAqBpB,CAAC;AAIJ,eAAO,MAAM,WAAW,aAAoB,KAAK,cAAc,KAAG,QAAQ,IAAI,CAQ3E,CAAC"}

package/dist/httpHelpers.js

@@ -1,68 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.endResponse = exports.serverListenAndHandle = exports.createTrackedServer = void 0;
-const node_http_1 = __importDefault(require("node:http"));
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-function createTrackedServer(port, requestListener) {
-    const server = node_http_1.default.createServer(requestListener).listen(port);
-    const sockets = new Set();
-    server.on("connection", (socket) => {
-        sockets.add(socket);
-        socket.on("close", () => sockets.delete(socket));
-    });
-    return {
-        server,
-        sockets,
-        fullyClose() {
-            server.close();
-            for (const socket of sockets) {
-                socket.destroy();
-            }
-        },
-    };
-}
-exports.createTrackedServer = createTrackedServer;
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-const serverListenAndHandle = async (port, handler) => 
-// eslint-disable-next-line promise/param-names
-new Promise((outerResolve, outerReject) => {
-    const innerP = new Promise((innerResolve, innerReject) => {
-        const httpServer = createTrackedServer(port, (req, res) => {
-            // ignore favicon
-            if (req.url === "/favicon.ico") {
-                res.writeHead(200, { "Content-Type": "image/x-icon" });
-                res.end();
-                return;
-            }
-            handler(req, res)
-                .finally(() => httpServer.fullyClose())
-                .then((result) => innerResolve(result), 
-            // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-            (error) => innerReject(error));
-        });
-        outerResolve(async () => innerP);
-    });
-});
-exports.serverListenAndHandle = serverListenAndHandle;
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-const endResponse = async (response) => new Promise((resolve, reject) => {
-    try {
-        response.end(resolve);
-    }
-    catch (error) {
-        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-        reject(error);
-    }
-});
-exports.endResponse = endResponse;
-//# sourceMappingURL=httpHelpers.js.map

package/dist/httpHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"httpHelpers.js","sourceRoot":"","sources":["../src/httpHelpers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,0DAA6B;AAW7B,0BAA0B;AAC1B,+CAA+C;AAC/C,SAAgB,mBAAmB,CAClC,IAAY,EACZ,eAAqC;IAErC,MAAM,MAAM,GAAG,mBAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAClC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,OAAO;QACN,MAAM;QACN,OAAO;QACP,UAAU;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC9B,MAAM,CAAC,OAAO,EAAE,CAAC;YAClB,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAtBD,kDAsBC;AAaD,0BAA0B;AAC1B,+CAA+C;AACxC,MAAM,qBAAqB,GAAG,KAAK,EACzC,IAAY,EACZ,OAA+B,EACP,EAAE;AAC1B,+CAA+C;AAC/C,IAAI,OAAO,CAAC,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;IACzC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAI,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;QAC3D,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACzD,iBAAiB;YACjB,IAAI,GAAG,CAAC,GAAG,KAAK,cAAc,EAAE,CAAC;gBAChC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC;gBACvD,GAAG,CAAC,GAAG,EAAE,CAAC;gBACV,OAAO;YACR,CAAC;YACD,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;iBACf,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;iBACtC,IAAI,CACJ,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC;YAChC,2EAA2E;YAC3E,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAC7B,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAxBS,QAAA,qBAAqB,yBAwB9B;AAEJ,0BAA0B;AAC1B,+CAA+C;AACxC,MAAM,WAAW,GAAG,KAAK,EAAE,QAA6B,EAAiB,EAAE,CACjF,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC/B,IAAI,CAAC;QACJ,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,2EAA2E;QAC3E,MAAM,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;AACF,CAAC,CAAC,CAAC;AARS,QAAA,WAAW,eAQpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport http from \"node:http\";\nimport type { Socket } from \"node:net\";\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport interface ITrackedHttpServer {\n\treadonly server: http.Server;\n\treadonly sockets: Set<Socket>;\n\tfullyClose(): void;\n}\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function createTrackedServer(\n\tport: number,\n\trequestListener: http.RequestListener,\n): ITrackedHttpServer {\n\tconst server = http.createServer(requestListener).listen(port);\n\tconst sockets = new Set<Socket>();\n\n\tserver.on(\"connection\", (socket) => {\n\t\tsockets.add(socket);\n\t\tsocket.on(\"close\", () => sockets.delete(socket));\n\t});\n\n\treturn {\n\t\tserver,\n\t\tsockets,\n\t\tfullyClose(): void {\n\t\t\tserver.close();\n\t\t\tfor (const socket of sockets) {\n\t\t\t\tsocket.destroy();\n\t\t\t}\n\t\t},\n\t};\n}\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport type OnceListenerHandler<T> = (\n\treq: http.IncomingMessage,\n\tres: http.ServerResponse,\n) => Promise<T>;\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport type OnceListenerResult<T> = Promise<() => Promise<T>>;\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport const serverListenAndHandle = async <T>(\n\tport: number,\n\thandler: OnceListenerHandler<T>,\n): OnceListenerResult<T> =>\n\t// eslint-disable-next-line promise/param-names\n\tnew Promise((outerResolve, outerReject) => {\n\t\tconst innerP = new Promise<T>((innerResolve, innerReject) => {\n\t\t\tconst httpServer = createTrackedServer(port, (req, res) => {\n\t\t\t\t// ignore favicon\n\t\t\t\tif (req.url === \"/favicon.ico\") {\n\t\t\t\t\tres.writeHead(200, { \"Content-Type\": \"image/x-icon\" });\n\t\t\t\t\tres.end();\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\thandler(req, res)\n\t\t\t\t\t.finally(() => httpServer.fullyClose())\n\t\t\t\t\t.then(\n\t\t\t\t\t\t(result) => innerResolve(result),\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors\n\t\t\t\t\t\t(error) => innerReject(error),\n\t\t\t\t\t);\n\t\t\t});\n\t\t\touterResolve(async () => innerP);\n\t\t});\n\t});\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport const endResponse = async (response: http.ServerResponse): Promise<void> =>\n\tnew Promise((resolve, reject) => {\n\t\ttry {\n\t\t\tresponse.end(resolve);\n\t\t} catch (error) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors\n\t\t\treject(error);\n\t\t}\n\t});\n"]}

package/lib/httpHelpers.d.ts

@@ -1,19 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import http from "node:http";
-import type { Socket } from "node:net";
-export interface ITrackedHttpServer {
-    readonly server: http.Server;
-    readonly sockets: Set<Socket>;
-    fullyClose(): void;
-}
-export declare function createTrackedServer(port: number, requestListener: http.RequestListener): ITrackedHttpServer;
-export type OnceListenerHandler<T> = (req: http.IncomingMessage, res: http.ServerResponse) => Promise<T>;
-export type OnceListenerResult<T> = Promise<() => Promise<T>>;
-export declare const serverListenAndHandle: <T>(port: number, handler: OnceListenerHandler<T>) => OnceListenerResult<T>;
-export declare const endResponse: (response: http.ServerResponse) => Promise<void>;
-//# sourceMappingURL=httpHelpers.d.ts.map

package/lib/httpHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"httpHelpers.d.ts","sourceRoot":"","sources":["../src/httpHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAIvC,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,UAAU,IAAI,IAAI,CAAC;CACnB;AAID,wBAAgB,mBAAmB,CAClC,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,IAAI,CAAC,eAAe,GACnC,kBAAkB,CAmBpB;AAID,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CACpC,GAAG,EAAE,IAAI,CAAC,eAAe,EACzB,GAAG,EAAE,IAAI,CAAC,cAAc,KACpB,OAAO,CAAC,CAAC,CAAC,CAAC;AAIhB,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAI9D,eAAO,MAAM,qBAAqB,YAC3B,MAAM,WACH,oBAAoB,CAAC,CAAC,KAC7B,mBAAmB,CAAC,CAqBpB,CAAC;AAIJ,eAAO,MAAM,WAAW,aAAoB,KAAK,cAAc,KAAG,QAAQ,IAAI,CAQ3E,CAAC"}

package/lib/httpHelpers.js

@@ -1,59 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import http from "node:http";
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export function createTrackedServer(port, requestListener) {
-    const server = http.createServer(requestListener).listen(port);
-    const sockets = new Set();
-    server.on("connection", (socket) => {
-        sockets.add(socket);
-        socket.on("close", () => sockets.delete(socket));
-    });
-    return {
-        server,
-        sockets,
-        fullyClose() {
-            server.close();
-            for (const socket of sockets) {
-                socket.destroy();
-            }
-        },
-    };
-}
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export const serverListenAndHandle = async (port, handler) => 
-// eslint-disable-next-line promise/param-names
-new Promise((outerResolve, outerReject) => {
-    const innerP = new Promise((innerResolve, innerReject) => {
-        const httpServer = createTrackedServer(port, (req, res) => {
-            // ignore favicon
-            if (req.url === "/favicon.ico") {
-                res.writeHead(200, { "Content-Type": "image/x-icon" });
-                res.end();
-                return;
-            }
-            handler(req, res)
-                .finally(() => httpServer.fullyClose())
-                .then((result) => innerResolve(result), 
-            // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-            (error) => innerReject(error));
-        });
-        outerResolve(async () => innerP);
-    });
-});
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export const endResponse = async (response) => new Promise((resolve, reject) => {
-    try {
-        response.end(resolve);
-    }
-    catch (error) {
-        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-        reject(error);
-    }
-});
-//# sourceMappingURL=httpHelpers.js.map

package/lib/httpHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"httpHelpers.js","sourceRoot":"","sources":["../src/httpHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAW7B,0BAA0B;AAC1B,+CAA+C;AAC/C,MAAM,UAAU,mBAAmB,CAClC,IAAY,EACZ,eAAqC;IAErC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAClC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,OAAO;QACN,MAAM;QACN,OAAO;QACP,UAAU;YACT,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC9B,MAAM,CAAC,OAAO,EAAE,CAAC;YAClB,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAaD,0BAA0B;AAC1B,+CAA+C;AAC/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EACzC,IAAY,EACZ,OAA+B,EACP,EAAE;AAC1B,+CAA+C;AAC/C,IAAI,OAAO,CAAC,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;IACzC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAI,CAAC,YAAY,EAAE,WAAW,EAAE,EAAE;QAC3D,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACzD,iBAAiB;YACjB,IAAI,GAAG,CAAC,GAAG,KAAK,cAAc,EAAE,CAAC;gBAChC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC;gBACvD,GAAG,CAAC,GAAG,EAAE,CAAC;gBACV,OAAO;YACR,CAAC;YACD,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;iBACf,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;iBACtC,IAAI,CACJ,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC;YAChC,2EAA2E;YAC3E,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAC7B,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,0BAA0B;AAC1B,+CAA+C;AAC/C,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,QAA6B,EAAiB,EAAE,CACjF,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC/B,IAAI,CAAC;QACJ,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,2EAA2E;QAC3E,MAAM,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;AACF,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport http from \"node:http\";\nimport type { Socket } from \"node:net\";\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport interface ITrackedHttpServer {\n\treadonly server: http.Server;\n\treadonly sockets: Set<Socket>;\n\tfullyClose(): void;\n}\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function createTrackedServer(\n\tport: number,\n\trequestListener: http.RequestListener,\n): ITrackedHttpServer {\n\tconst server = http.createServer(requestListener).listen(port);\n\tconst sockets = new Set<Socket>();\n\n\tserver.on(\"connection\", (socket) => {\n\t\tsockets.add(socket);\n\t\tsocket.on(\"close\", () => sockets.delete(socket));\n\t});\n\n\treturn {\n\t\tserver,\n\t\tsockets,\n\t\tfullyClose(): void {\n\t\t\tserver.close();\n\t\t\tfor (const socket of sockets) {\n\t\t\t\tsocket.destroy();\n\t\t\t}\n\t\t},\n\t};\n}\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport type OnceListenerHandler<T> = (\n\treq: http.IncomingMessage,\n\tres: http.ServerResponse,\n) => Promise<T>;\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport type OnceListenerResult<T> = Promise<() => Promise<T>>;\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport const serverListenAndHandle = async <T>(\n\tport: number,\n\thandler: OnceListenerHandler<T>,\n): OnceListenerResult<T> =>\n\t// eslint-disable-next-line promise/param-names\n\tnew Promise((outerResolve, outerReject) => {\n\t\tconst innerP = new Promise<T>((innerResolve, innerReject) => {\n\t\t\tconst httpServer = createTrackedServer(port, (req, res) => {\n\t\t\t\t// ignore favicon\n\t\t\t\tif (req.url === \"/favicon.ico\") {\n\t\t\t\t\tres.writeHead(200, { \"Content-Type\": \"image/x-icon\" });\n\t\t\t\t\tres.end();\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\thandler(req, res)\n\t\t\t\t\t.finally(() => httpServer.fullyClose())\n\t\t\t\t\t.then(\n\t\t\t\t\t\t(result) => innerResolve(result),\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors\n\t\t\t\t\t\t(error) => innerReject(error),\n\t\t\t\t\t);\n\t\t\t});\n\t\t\touterResolve(async () => innerP);\n\t\t});\n\t});\n\n// TODO: Add documentation\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport const endResponse = async (response: http.ServerResponse): Promise<void> =>\n\tnew Promise((resolve, reject) => {\n\t\ttry {\n\t\t\tresponse.end(resolve);\n\t\t} catch (error) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors\n\t\t\treject(error);\n\t\t}\n\t});\n"]}

package/src/httpHelpers.ts

@@ -1,92 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import http from "node:http";
-import type { Socket } from "node:net";
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export interface ITrackedHttpServer {
-	readonly server: http.Server;
-	readonly sockets: Set<Socket>;
-	fullyClose(): void;
-}
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export function createTrackedServer(
-	port: number,
-	requestListener: http.RequestListener,
-): ITrackedHttpServer {
-	const server = http.createServer(requestListener).listen(port);
-	const sockets = new Set<Socket>();
-
-	server.on("connection", (socket) => {
-		sockets.add(socket);
-		socket.on("close", () => sockets.delete(socket));
-	});
-
-	return {
-		server,
-		sockets,
-		fullyClose(): void {
-			server.close();
-			for (const socket of sockets) {
-				socket.destroy();
-			}
-		},
-	};
-}
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type OnceListenerHandler<T> = (
-	req: http.IncomingMessage,
-	res: http.ServerResponse,
-) => Promise<T>;
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type OnceListenerResult<T> = Promise<() => Promise<T>>;
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export const serverListenAndHandle = async <T>(
-	port: number,
-	handler: OnceListenerHandler<T>,
-): OnceListenerResult<T> =>
-	// eslint-disable-next-line promise/param-names
-	new Promise((outerResolve, outerReject) => {
-		const innerP = new Promise<T>((innerResolve, innerReject) => {
-			const httpServer = createTrackedServer(port, (req, res) => {
-				// ignore favicon
-				if (req.url === "/favicon.ico") {
-					res.writeHead(200, { "Content-Type": "image/x-icon" });
-					res.end();
-					return;
-				}
-				handler(req, res)
-					.finally(() => httpServer.fullyClose())
-					.then(
-						(result) => innerResolve(result),
-						// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-						(error) => innerReject(error),
-					);
-			});
-			outerResolve(async () => innerP);
-		});
-	});
-
-// TODO: Add documentation
-// eslint-disable-next-line jsdoc/require-jsdoc
-export const endResponse = async (response: http.ServerResponse): Promise<void> =>
-	new Promise((resolve, reject) => {
-		try {
-			response.end(resolve);
-		} catch (error) {
-			// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
-			reject(error);
-		}
-	});