oauth2-cli 0.1.6 → 0.2.0

package/CHANGELOG.md

@@ -2,33 +2,39 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
-## [0.1.6](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.5...oauth2-cli/0.1.6) (2025-03-08)
+## [0.2.0](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.6...oauth2-cli/0.2.0) (2025-03-09)
+
+### Features
+
+- **oauth2-cli:** detect and warn about reused localhost ports ([3431d84](https://github.com/battis/oauth2-cli/commit/3431d84d47251dd9fba47b23bbfd3dcf653fc7d3))
+
+### Bug Fixes
 
+- **oauth2-configure:** remove redundant caching ([7294e6a](https://github.com/battis/oauth2-cli/commit/7294e6a7aec373f72abc7c9e7c2ce4c659e3cba5))
+
+## [0.1.6](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.5...oauth2-cli/0.1.6) (2025-03-08)
 
 ### Features
 
-* **oauth2-cli:** export Credentials type for convenience ([f000b56](https://github.com/battis/oauth2-cli/commit/f000b56a587c021d64a294ff33d42fa3966afd38))
+- **oauth2-cli:** export Credentials type for convenience ([f000b56](https://github.com/battis/oauth2-cli/commit/f000b56a587c021d64a294ff33d42fa3966afd38))
 
 ## [0.1.5](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.4...oauth2-cli/0.1.5) (2025-03-07)
 
-
 ### Features
 
-* **oauth2-cli:** attempt to reuse refresh_token if none returned ([8210698](https://github.com/battis/oauth2-cli/commit/82106982e508c1f5f54a16590594daa47f80d57d))
+- **oauth2-cli:** attempt to reuse refresh_token if none returned ([8210698](https://github.com/battis/oauth2-cli/commit/82106982e508c1f5f54a16590594daa47f80d57d))
 
 ## [0.1.4](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.3...oauth2-cli/0.1.4) (2025-03-06)
 
-
 ### Features
 
-* **oauth2-cli:** cache token in memory ([68ac632](https://github.com/battis/oauth2-cli/commit/68ac6323031cbcaa0dd7b444dcd6da62b4f9a48d))
-* **oauth2-cli:** Client.request() and Client.requestJSON() ([50c1198](https://github.com/battis/oauth2-cli/commit/50c11985c0ae8f135932d05bae2bf74ff1cd29df))
-* **oauth2-cli:** deprecate TokenManager (replaced by Client) ([991ac42](https://github.com/battis/oauth2-cli/commit/991ac42eb2cc83b4b31e60856faf192233cd35f3))
-
+- **oauth2-cli:** cache token in memory ([68ac632](https://github.com/battis/oauth2-cli/commit/68ac6323031cbcaa0dd7b444dcd6da62b4f9a48d))
+- **oauth2-cli:** Client.request() and Client.requestJSON() ([50c1198](https://github.com/battis/oauth2-cli/commit/50c11985c0ae8f135932d05bae2bf74ff1cd29df))
+- **oauth2-cli:** deprecate TokenManager (replaced by Client) ([991ac42](https://github.com/battis/oauth2-cli/commit/991ac42eb2cc83b4b31e60856faf192233cd35f3))
 
 ### Bug Fixes
 
-* **oauth2-cli:** improve error window title ([97a4c1c](https://github.com/battis/oauth2-cli/commit/97a4c1c9f98aaacf7ce63fb05a64cfee5f4dd0ce))
+- **oauth2-cli:** improve error window title ([97a4c1c](https://github.com/battis/oauth2-cli/commit/97a4c1c9f98aaacf7ce63fb05a64cfee5f4dd0ce))
 
 ## [0.1.3](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.1.2...oauth2-cli/0.1.3) (2025-03-06)
 

package/dist/Localhost.js

@@ -4,6 +4,8 @@ import fs from 'node:fs';
 import path from 'node:path';
 import open from 'open';
 import * as OpenIDClient from 'openid-client';
+const ejs = await import('ejs');
+const portRegistry = [];
 export async function redirectServer(options) {
     const { authorization_url, redirect_uri, code_verifier, state, headers, resolve, reject, views = '../views' } = options;
     const redirectUrl = new URL(redirect_uri);
@@ -11,10 +13,31 @@ export async function redirectServer(options) {
     const app = express();
     const port = redirectUrl.port !== '' ? redirectUrl.port : 80;
     const server = app.listen(port);
-    const ejs = await import('ejs');
     let view = 'complete.ejs';
     let tokens = undefined;
     let error = undefined;
+    /*
+     * FIXME Multiple clients with `redirect_uri` on the same localhost port
+     *   This seems to be some sort of an issue with Express (or node http?) in
+     *   which, despite a fresh invocation of express() for each redirect
+     *   listener, every listener subsequent to the first _on the same port_
+     *   retains the original routing stack of the first listener on that port.
+     *   I have tried:
+     *     - Setting a manual delay (up to 10 seconds) between the receipt of
+     *       the token and resolving it to allow the server to close.
+     *     - Using a mutex semaphore to ensure that no two instances of
+     *       Localhost are running simultaneously
+     *     - Separating the routing into a separate Router middleware
+     *     - Manually removing the routing stack (which does, at least, break
+     *       the routing of the subsequent instances, supporting the idea that
+     *       the app is getting reused by Express)
+     */
+    if (portRegistry.includes(port)) {
+        throw new Error(`Multiple OAuth clients are attempting to redirect to port ${port}. This will result in failure. Please reconfigure your credentials so that each client is redirecting to a distinct port on http://localhost (e.g. 3000, 3001, 3002)`);
+    }
+    else {
+        portRegistry.push(port);
+    }
     app.get('/authorize', async (req, res) => {
         const viewPath = path.resolve(import.meta.dirname, views, 'authorize');
         if (ejs && fs.existsSync(viewPath)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oauth2-cli",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Acquire API access tokens via OAuth 2.0 within CLI tools",
   "homepage": "https://github.com/battis/oauth2-cli/tree/main/packages/oauth2-cli#readme",
   "repository": {
@@ -20,7 +20,7 @@
     "express": "^4.21.2",
     "open": "^10.1.0",
     "openid-client": "^6.3.3",
-    "@battis/oauth2-configure": "0.1.1"
+    "@battis/oauth2-configure": "0.1.2"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.4",

package/src/Localhost.ts

@@ -5,6 +5,10 @@ import path from 'node:path';
 import open from 'open';
 import * as OpenIDClient from 'openid-client';
 
+const ejs = await import('ejs');
+
+const portRegistry: (number | string)[] = [];
+
 type Options = Configuration.Options & {
   authorization_url: string;
   redirect_uri: string;
@@ -34,11 +38,34 @@ export async function redirectServer(options: Options) {
   const app = express();
   const port = redirectUrl.port !== '' ? redirectUrl.port : 80;
   const server = app.listen(port);
-  const ejs = await import('ejs');
   let view = 'complete.ejs';
   let tokens: OpenIDClient.TokenEndpointResponse | undefined = undefined;
   let error: unknown = undefined;
 
+  /*
+   * FIXME Multiple clients with `redirect_uri` on the same localhost port
+   *   This seems to be some sort of an issue with Express (or node http?) in
+   *   which, despite a fresh invocation of express() for each redirect
+   *   listener, every listener subsequent to the first _on the same port_
+   *   retains the original routing stack of the first listener on that port.
+   *   I have tried:
+   *     - Setting a manual delay (up to 10 seconds) between the receipt of
+   *       the token and resolving it to allow the server to close.
+   *     - Using a mutex semaphore to ensure that no two instances of
+   *       Localhost are running simultaneously
+   *     - Separating the routing into a separate Router middleware
+   *     - Manually removing the routing stack (which does, at least, break
+   *       the routing of the subsequent instances, supporting the idea that
+   *       the app is getting reused by Express)
+   */
+  if (portRegistry.includes(port)) {
+    throw new Error(
+      `Multiple OAuth clients are attempting to redirect to port ${port}. This will result in failure. Please reconfigure your credentials so that each client is redirecting to a distinct port on http://localhost (e.g. 3000, 3001, 3002)`
+    );
+  } else {
+    portRegistry.push(port);
+  }
+
   app.get('/authorize', async (req, res) => {
     const viewPath = path.resolve(import.meta.dirname, views, 'authorize');
     if (ejs && fs.existsSync(viewPath)) {