@heroku/heroku-fetch 0.1.1-beta.0 → 0.1.2

package/dist/client/http-request-hooks.js

@@ -7,6 +7,30 @@
 import { debugAuth, debugRequest, debugResponse } from '../debug-loggers.js';
 import { handleErrorResponse } from './http-error-handler.js';
 import { handle2FAChallenge, is2FAError } from './two-factor-authentication-handler.js';
+/**
+ * Headers whose values must never appear in debug output. Compared
+ * case-insensitively. Mirrors the redaction in http-call so tokens
+ * aren't leaked when `debug` is enabled.
+ */
+const SENSITIVE_HEADERS = new Set([
+    'authorization',
+    'cookie',
+    'heroku-two-factor-code',
+    'proxy-authorization',
+    'x-addon-sso',
+]);
+/**
+ * Build a plain object of a request's headers with sensitive values
+ * replaced by `[REDACTED]`, safe for debug logging.
+ */
+function redactHeaders(headers) {
+    const result = {};
+    // eslint-disable-next-line unicorn/no-array-for-each
+    headers.forEach((value, key) => {
+        result[key] = SENSITIVE_HEADERS.has(key.toLowerCase()) ? '[REDACTED]' : value;
+    });
+    return result;
+}
 /**
  * Create a beforeRequest hook that adds authentication and custom headers
  */
@@ -24,7 +48,16 @@ export function createBeforeRequestHook(getToken, defaultAccept, customHeaders,
                 request.headers.set(key, value);
             }
         }
-        // Add authorization header
+        // Add authorization header.
+        //
+        // We deliberately don't strip this on cross-origin redirects: the
+        // underlying fetch implementation does it for us. Per the WHATWG
+        // Fetch spec, `Authorization` (along with `Cookie`,
+        // `Proxy-Authorization`, and `Host`) is dropped before following a
+        // redirect to a different origin. Note this only covers those
+        // spec'd headers — if we ever add a custom sensitive header (e.g.
+        // `x-addon-sso`), fetch will NOT strip it and we'd need to handle
+        // that ourselves.
         const token = await getToken();
         if (token) {
             request.headers.set('Authorization', `Bearer ${token}`);
@@ -32,12 +65,7 @@ export function createBeforeRequestHook(getToken, defaultAccept, customHeaders,
         }
         debugRequest('%s %s', request.method, request.url);
         if (debug) {
-            const headers = {};
-            // eslint-disable-next-line unicorn/no-array-for-each
-            request.headers.forEach((value, key) => {
-                headers[key] = value;
-            });
-            debugRequest('Headers: %O', headers);
+            debugRequest('Headers: %O', redactHeaders(request.headers));
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/heroku-fetch",
-  "version": "0.1.1-beta.0",
+  "version": "0.1.2",
   "description": "A JavaScript/TypeScript API client for Heroku APIs",
   "type": "module",
   "main": "dist/index.js",
@@ -42,6 +42,14 @@
   ],
   "author": "Heroku",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/heroku/heroku-fetch.git"
+  },
+  "bugs": {
+    "url": "https://github.com/heroku/heroku-fetch/issues"
+  },
+  "homepage": "https://github.com/heroku/heroku-fetch#readme",
   "dependencies": {
     "debug": "^4.3.4",
     "ky": "^2.0.2",