@stepzen/fetch 0.23.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, 2022 StepZen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# `@stepzen/fetch`
+
+StepZen wrapper for the [`node-fetch`](https://www.npmjs.com/package/node-fetch) npm package that implements the `fetch()` API for NodeJS.
+
+The main reason to create this wrapper is create a workaround for an issue affecting a small part of StepZen CLI users where some CLI calls would stall due to an incorrectly terminated TCP transmission. See https://github.com/steprz/stepzen-cli/issues/934 for more details.
+
+This package would be obsolete either when the ISP issue with TCP configuration is fixed, or when the CLI can assume it runs on NodeJS 19 or newer. In Node 19 the default http(s) agent config changes to add the `Connection: keep-alive` HTTP header, and that seems to prevent the issue.

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { RequestInfo, RequestInit, Response } from 'node-fetch';
+declare const fetch: (url: RequestInfo, init?: RequestInit) => Promise<Response>;
+export default fetch;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAA;AAe7D,QAAA,MAAM,KAAK,QACJ,WAAW,SACT,WAAW,KACjB,QAAQ,QAAQ,CAclB,CAAA;AAED,eAAe,KAAK,CAAA"}

package/lib/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const http = require("http");
+const https = require("https");
+const node_fetch_1 = require("node-fetch");
+// workaround for https://github.com/steprz/stepzen-cli/issues/934
+const httpAgent = new http.Agent({
+    keepAlive: true,
+    scheduling: 'lifo',
+    timeout: 5000,
+});
+const httpsAgent = new https.Agent({
+    keepAlive: true,
+    scheduling: 'lifo',
+    timeout: 5000,
+});
+const fetch = async (url, init) => {
+    let urlstr;
+    if (typeof url === 'string') {
+        urlstr = url;
+    }
+    else if ('href' in url) {
+        urlstr = url.href;
+    }
+    else {
+        urlstr = url.url;
+    }
+    return (0, node_fetch_1.default)(url, {
+        agent: urlstr.startsWith('https:') ? httpsAgent : httpAgent,
+        ...init,
+    });
+};
+exports.default = fetch;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,6BAA4B;AAC5B,+BAA8B;AAC9B,2CAA+B;AAG/B,kEAAkE;AAClE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC;IAC/B,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,IAAI;CACd,CAAC,CAAA;AAEF,MAAM,UAAU,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC;IACjC,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,IAAI;CACd,CAAC,CAAA;AAEF,MAAM,KAAK,GAAG,KAAK,EACjB,GAAgB,EAChB,IAAkB,EACC,EAAE;IACrB,IAAI,MAAM,CAAA;IACV,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,MAAM,GAAG,GAAG,CAAA;KACb;SAAM,IAAI,MAAM,IAAI,GAAG,EAAE;QACxB,MAAM,GAAG,GAAG,CAAC,IAAI,CAAA;KAClB;SAAM;QACL,MAAM,GAAG,GAAG,CAAC,GAAG,CAAA;KACjB;IAED,OAAO,IAAA,oBAAM,EAAC,GAAG,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;QAC3D,GAAG,IAAI;KACR,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,kBAAe,KAAK,CAAA"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@stepzen/fetch",
+  "description": "StepZen implementation of the fetch() API for NodeJS",
+  "version": "0.23.0-beta.0",
+  "author": "StepZen Ltd",
+  "license": "MIT",
+  "files": [
+    "lib/**/*",
+    "src/**/*"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=14.0.1",
+    "npm": ">=6.14"
+  },
+  "scripts": {
+    "clean": "rm -rf lib tsconfig.tsbuildinfo",
+    "build": "../../node_modules/.bin/tsc -b",
+    "test": "npm run build && nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test:single": "npm run build && mocha",
+    "posttest": "prettier . --check"
+  },
+  "dependencies": {
+    "debug": "^4.3.4",
+    "node-fetch": "^2.6.7"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.7",
+    "@types/mocha": "^9.1.1",
+    "@types/node-fetch": "^2.6.2",
+    "chai": "^4.3.4",
+    "fancy-test": "^1.4.10",
+    "mocha": "^9.0.1",
+    "mock-fs": "^4.13.0",
+    "nyc": "^14.1.1",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.8.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,38 @@
+import * as http from 'http'
+import * as https from 'https'
+import fetch0 from 'node-fetch'
+import {RequestInfo, RequestInit, Response} from 'node-fetch'
+
+// workaround for https://github.com/steprz/stepzen-cli/issues/934
+const httpAgent = new http.Agent({
+  keepAlive: true,
+  scheduling: 'lifo',
+  timeout: 5000,
+})
+
+const httpsAgent = new https.Agent({
+  keepAlive: true,
+  scheduling: 'lifo',
+  timeout: 5000,
+})
+
+const fetch = async (
+  url: RequestInfo,
+  init?: RequestInit,
+): Promise<Response> => {
+  let urlstr
+  if (typeof url === 'string') {
+    urlstr = url
+  } else if ('href' in url) {
+    urlstr = url.href
+  } else {
+    urlstr = url.url
+  }
+
+  return fetch0(url, {
+    agent: urlstr.startsWith('https:') ? httpsAgent : httpAgent,
+    ...init,
+  })
+}
+
+export default fetch