Merge pull request #35 from tkrotoff/remove-old-browsers-support

Remove old browsers support

Author: tkrotoff

.github/workflows/node.js.yml

@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [18.x]
 
     steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.16.0 (2023/03/03)
+
+- Breaking change: drop old browsers support (#28)
+- Remove node-fetch from Node.js example (#36)
+- Update npm packages
+- Remove Node.js 14 & 16 from CI
+
 ## 0.15.0 (2022/12/01)
 
 - Breaking change: createHttpError & createJSONHttpError params are no longer optional

README.md

@@ -88,20 +88,17 @@ Or copy-paste [Http.ts](src/Http.ts) into your source code.
 
 ## JavaScript runtimes support
 
-@tkrotoff/fetch supports Node.js, all modern browsers + IE 11
+@tkrotoff/fetch supports Node.js and modern browsers
 
-### With Node.js you need:
+### Node.js
 
-- Nothing if Node.js >= 18
-- [node-fetch](https://github.com/node-fetch/node-fetch) if Node.js < 18
+- Nothing is needed if Node.js >= 18.0
+- Use [`--experimental-fetch`](https://nodejs.org/docs/latest-v16.x/api/cli.html#--experimental-fetch) if Node.js >= 16.15 < 18.0
+- [node-fetch](https://github.com/node-fetch/node-fetch) if Node.js < 16.15
 
 Check [examples/node](examples/node)
 
-### With IE 11 you need:
-
-- [whatwg-fetch](https://github.com/github/fetch) polyfill
-- [core-js](https://github.com/zloirock/core-js) for other modern JS features like async/await
-- to transpile @tkrotoff/fetch code to ES5
+### Browsers
 
 Check [examples/web](examples/web)
 

examples/node/getErrorMessage.test.ts

@@ -0,0 +1,124 @@
+/* eslint-disable no-throw-literal, jest/no-conditional-expect */
+
+import { getErrorMessage } from './getErrorMessage';
+
+test('throw new Error()', () => {
+  try {
+    throw new Error('message');
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('message');
+  }
+});
+
+test('throw without new Error()', () => {
+  try {
+    throw 'message';
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('"message"');
+  }
+
+  try {
+    throw 666;
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('666');
+  }
+
+  try {
+    throw { error: 'message' };
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('{"error":"message"}');
+  }
+
+  try {
+    throw [1, 2, 3];
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('[1,2,3]');
+  }
+
+  try {
+    throw undefined;
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('');
+  }
+
+  try {
+    // eslint-disable-next-line unicorn/no-null
+    throw null;
+  } catch (e) {
+    expect(getErrorMessage(e)).toEqual('null');
+  }
+});
+
+test('circular reference', () => {
+  {
+    const circular = {
+      error: 'message'
+    };
+    // @ts-ignore
+    circular.myself = circular;
+
+    try {
+      JSON.stringify(circular);
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual(
+        'Converting circular structure to JSON\n' +
+          "    --> starting at object with constructor 'Object'\n" +
+          "    --- property 'myself' closes the circle"
+      );
+    }
+
+    try {
+      throw circular;
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual('[object Object]');
+    }
+  }
+
+  {
+    const circular = [1, 2, 3];
+    // @ts-ignore
+    circular[0] = circular;
+
+    try {
+      JSON.stringify(circular);
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual(
+        'Converting circular structure to JSON\n' +
+          "    --> starting at object with constructor 'Array'\n" +
+          '    --- index 0 closes the circle'
+      );
+    }
+
+    try {
+      throw circular;
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual(',2,3');
+    }
+  }
+
+  {
+    class Circular {
+      error = 'message';
+
+      myself = this;
+    }
+
+    const circular = new Circular();
+
+    try {
+      JSON.stringify(circular);
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual(
+        'Converting circular structure to JSON\n' +
+          "    --> starting at object with constructor 'Circular'\n" +
+          "    --- property 'myself' closes the circle"
+      );
+    }
+
+    try {
+      throw circular;
+    } catch (e) {
+      expect(getErrorMessage(e)).toEqual('[object Object]');
+    }
+  }
+});

examples/node/getErrorMessage.ts

@@ -0,0 +1,30 @@
+// https://kentcdodds.com/blog/get-a-catch-block-error-message-with-typescript
+
+type ErrorWithMessage = {
+  message: string;
+};
+
+function isErrorWithMessage(error: unknown): error is ErrorWithMessage {
+  return (
+    typeof error === 'object' &&
+    error !== null &&
+    'message' in error &&
+    typeof (error as Record<string, unknown>).message === 'string'
+  );
+}
+
+function toErrorWithMessage(maybeError: unknown): ErrorWithMessage {
+  if (isErrorWithMessage(maybeError)) return maybeError;
+
+  try {
+    return new Error(JSON.stringify(maybeError));
+  } catch {
+    // Fallback in case there's an error stringifying the maybeError
+    // like with circular references for example
+    return new Error(String(maybeError));
+  }
+}
+
+export function getErrorMessage(error: unknown) {
+  return toErrorWithMessage(error).message;
+}

examples/node/index.ts

@@ -1,26 +1,19 @@
-import { AbortController, AbortSignal } from 'abort-controller';
-import * as nodeFetch from 'node-fetch';
-
 import {
   abortRequestExample,
   del200OKExample,
   get200OKExample,
   get404NotFoundExample,
   get500InternalServerErrorExample,
   postJSON201CreatedExample
-} from './requests.js';
-
-globalThis.fetch = nodeFetch.default as any;
-globalThis.Headers = nodeFetch.Headers as any;
-globalThis.Response = nodeFetch.Response as any;
-
-// FIXME Remove when support for Node.js < 15.0.0 is dropped, https://nodejs.org/en/blog/release/v15.0.0/
-globalThis.AbortController = AbortController as any;
-globalThis.AbortSignal = AbortSignal as any;
+} from './requests';
 
-await get200OKExample();
-await postJSON201CreatedExample();
-await del200OKExample();
-await get404NotFoundExample();
-await get500InternalServerErrorExample();
-await abortRequestExample();
+// FIXME Remove when ESM is enabled
+// eslint-disable-next-line func-names, unicorn/prefer-top-level-await
+(async function () {
+  await get200OKExample();
+  await postJSON201CreatedExample();
+  await del200OKExample();
+  await get404NotFoundExample();
+  await get500InternalServerErrorExample();
+  await abortRequestExample();
+})();

examples/node/jest.config.js

@@ -1,8 +1,5 @@
 // @ts-check
 
-// [How to set transformIgnorePatterns to fix "Jest encountered an unexpected token"](https://github.com/nrwl/nx/issues/812)
-const esModules = ['node-fetch', 'data-uri-to-buffer', 'fetch-blob', 'formdata-polyfill'];
-
 /** @type import('@jest/types').Config.InitialOptions */
 const config = {
   testEnvironment: 'node',
@@ -14,8 +11,6 @@ const config = {
   // Let's be strict and use *.test.js only
   testRegex: '\\.test\\.ts$',
 
-  transformIgnorePatterns: [`/node_modules/(?!${esModules.join('|')})`],
-
   coverageThreshold: {
     global: {
       statements: 100,
@@ -32,4 +27,4 @@ const config = {
   // restoreMocks: true
 };
 
-export default config;
+module.exports = config;

examples/node/jest.setup.ts

@@ -1,18 +1,9 @@
-import { AbortController, AbortSignal } from 'abort-controller';
 import assert from 'node:assert';
-import * as nodeFetch from 'node-fetch';
 
 // [console.assert not throwing with v22.4.0](https://github.com/facebook/jest/issues/5634)
 // eslint-disable-next-line no-console
 console.assert = assert;
 
-globalThis.Headers = nodeFetch.Headers as any;
-globalThis.Response = nodeFetch.Response as any;
-
-// FIXME Remove when support for Node.js < 15.0.0 is dropped, https://nodejs.org/en/blog/release/v15.0.0/
-globalThis.AbortController = AbortController as any;
-globalThis.AbortSignal = AbortSignal as any;
-
 (globalThis.fetch as any) = () => {
   throw new Error('You should mock fetch()');
 };

examples/node/package.json

@@ -3,26 +3,23 @@
   "version": "1.0.0",
   "private": true,
   "description": "@tkrotoff/fetch Node.js example",
-  "type": "module",
   "scripts": {
     "clean": "rm -rf build coverage",
     "clean:all": "npm run clean && rm -rf node_modules package-lock.json",
-    "start": "node --loader ts-node/esm index.ts",
+    "start": "ts-node index.ts",
     "test": "jest --verbose",
     "test:coverage": "jest --coverage",
     "tsc": "tsc",
     "npm:update": "npm run clean:all && npx npm-check-updates --upgrade && npm install"
   },
   "dependencies": {
     "@tkrotoff/fetch": "file:../..",
-    "abort-controller": "^3.0.0",
-    "node-fetch": "^3.3.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.5"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
-    "jest": "^29.3.1"
+    "@babel/preset-typescript": "^7.21.0",
+    "jest": "^29.4.3"
   }
 }

examples/node/requests.test.ts

@@ -96,10 +96,7 @@ test('getCorsBlockedExample()', async () => {
 });
 
 test('abortRequestExample()', async () => {
-  // DOMException does not exist with node-fetch
-  //const abortError = new DOMException('The operation was aborted.', 'AbortError')
-  const abortError = new Error('The operation was aborted.');
-  abortError.name = 'AbortError';
+  const abortError = new DOMException('This operation was aborted', 'AbortError');
 
   const mock = jest.spyOn(Http, 'get').mockImplementation((_input, init) => {
     // Mock aborted request