fix(DEVX-363): remove node 16 support (#877)

.circleci/config.yml

@@ -4,19 +4,6 @@ version: 2.1
 aliases:
   - &working_directory ~/commercetools-sdk-typescript
 
-  # node version 16
-  - &restore_yarn_cache_node_16
-    name: 'Restoring yarn cache'
-    keys:
-      - yarn-cache-node_16-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
-
-  - &save_yarn_cache_node_16
-    name: 'Saving yarn cache'
-    key: yarn-cache-node_16-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
-    paths:
-      - ~/.cache/yarn
-
-
   # node version 18
   - &restore_yarn_cache_node_18
     name: 'Restoring yarn cache'
@@ -44,13 +31,22 @@ aliases:
     paths:
       - ~/.cache/yarn
 
+  # node version 22
+  - &restore_yarn_cache_node_22
+    name: 'Restoring yarn cache'
+    keys:
+      - yarn-cache-node_22-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
+
+  - &save_yarn_cache_node_22
+    name: 'Saving yarn cache'
+    key: yarn-cache-node_22-{{ .Environment.CACHE_VERSION }}-{{ checksum "yarn.lock" }}
+    # Persisting to the workspace is always relative to the root which is our working directory.
+    # https://circleci.com/docs/2.0/configuration-reference/#persist_to_workspace
+    paths:
+      - ~/.cache/yarn
+
 # executors
 executors:
-  node_16:
-    docker:
-      - image: cimg/node:16.20.2
-    working_directory: *working_directory
-
   node_18:
     docker:
       - image: cimg/node:18.20.3
@@ -61,22 +57,27 @@ executors:
       - image: cimg/node:20.14.0
     working_directory: *working_directory
 
+  node_22:
+    docker:
+      - image: cimg/node:22.12.0
+    working_directory: *working_directory
+
 
 # orbs
 orbs:
   codecov: codecov/[email protected]
 
 # jobs
 jobs:
-  install_test_node_16:
-    executor: node_16
+  install_test_node_18:
+    executor: node_18
     steps:
       - checkout
-      - restore_cache: *restore_yarn_cache_node_16
+      - restore_cache: *restore_yarn_cache_node_18
       - run:
           name: Installing dependencies
-          command: yarn install --ignore-engines --frozen-lockfile # temp ignore engine checks [will deprecate node v16 soon]
-      - save_cache: *save_yarn_cache_node_16
+          command: yarn install --frozen-lockfile
+      - save_cache: *save_yarn_cache_node_18
       - run:
           name: Install example dependencies
           command: |
@@ -93,16 +94,22 @@ jobs:
       - run:
           name: Running tests
           command: yarn test --testPathIgnorePatterns='packages/platform-sdk/test/integration-tests'
+      - run:
+          name: Running integration tests
+          command: yarn test packages/platform-sdk/test/integration-tests --coverage
+      - codecov/upload:
+          file: coverage/clover.xml
+          flags: integrationtests
 
-  install_test_node_18:
-    executor: node_18
+  install_test_node_20:
+    executor: node_20
     steps:
       - checkout
-      - restore_cache: *restore_yarn_cache_node_18
+      - restore_cache: *restore_yarn_cache_node_20
       - run:
           name: Installing dependencies
           command: yarn install --frozen-lockfile
-      - save_cache: *save_yarn_cache_node_18
+      - save_cache: *save_yarn_cache_node_20
       - run:
           name: Install example dependencies
           command: |
@@ -119,16 +126,38 @@ jobs:
       - run:
           name: Running tests
           command: yarn test --testPathIgnorePatterns='packages/platform-sdk/test/integration-tests'
+      - run:
+          name: Running integration tests
+          command: yarn test packages/platform-sdk/test/integration-tests --coverage
+      - codecov/upload:
+          file: coverage/clover.xml
+          flags: integrationtests
 
-  install_test_node_20:
-    executor: node_20
+  install_test_node_22:
+    executor: node_22
     steps:
       - checkout
-      - restore_cache: *restore_yarn_cache_node_20
+      - restore_cache: *restore_yarn_cache_node_22
       - run:
           name: Installing dependencies
           command: yarn install --frozen-lockfile
-      - save_cache: *save_yarn_cache_node_20
+      - save_cache: *save_yarn_cache_node_22
+      - run:
+          name: Install example dependencies
+          command: |
+            cd examples
+            yarn install --frozen-lockfile
+      - run:
+          name: Building packages
+          command: yarn build
+      - run:
+          name: Running example tests
+          command: |
+            cd examples
+            yarn test
+      - run:
+          name: Running tests
+          command: yarn test --testPathIgnorePatterns='packages/platform-sdk/test/integration-tests'
       - run:
           name: Running integration tests
           command: yarn test packages/platform-sdk/test/integration-tests --coverage
@@ -141,13 +170,13 @@ workflows:
   version: 2
   build_and_test:
     jobs:
-      - install_test_node_16:
-          context: org-global
       - install_test_node_18:
           context: org-global
-          # requires:
-          #   - install_test_node_16
       - install_test_node_20:
           context: org-global
           requires:
             - install_test_node_18
+      - install_test_node_22:
+          context: org-global
+          requires:
+            - install_test_node_20

BEST_PRACTICES.md

@@ -277,7 +277,6 @@ type HttpErrorType = {
 Proxies can be configured at the http client level in the JS/TS SDK, here we pass the proxy url/ip address
 
 ```ts
-import fetch from 'node-fetch'
 import HttpsProxyAgent from 'https-proxy-agent'
 
 const fetcherProxy = (url, fetchOptions = {}) => {
@@ -341,7 +340,7 @@ client
 
 ## Using HTTP client
 
-The JS/TS SDK uses [node-fetch](https://github.com/bitinn/node-fetch) and its close relatives like [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch), [whatwg-fetch](https://github.com/whatwg/fetch) or [unfetch](https://github.com/developit/unfetch).
+The JS/TS SDK uses [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and its close relatives like [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch), [whatwg-fetch](https://github.com/whatwg/fetch) or [unfetch](https://github.com/developit/unfetch).
 It is important to also note that due to changes in version 3 of `node-fetch`, it is expected that all projects using the v3 of `node-fetch` within the SDK must be in ESM (.mjs) module system. The JS/TS SDK fully supports v2 of `node-fetch` without any restrictions.
 
 ## The `Process` Function

packages/history-sdk/README.md

@@ -38,7 +38,6 @@ const {
   createHttpClient,
 } = require('@commercetools/sdk-client-v2')
 const { createApiBuilderFromCtpClient } = require('@commercetools/history-sdk')
-const fetch = require('node-fetch')
 
 const projectKey = 'mc-project-key'
 const authMiddlewareOptions = {
@@ -115,7 +114,6 @@ import {
   createAuthForClientCredentialsFlow,
 } from '@commercetools/sdk-client-v2'
 import { createApiBuilderFromCtpClient } from '@commercetools/history-sdk'
-import fetch from 'node-fetch'
 
 const projectKey = 'some_project_key'
 

packages/history-sdk/test/helpers/api-helpers.ts

@@ -8,7 +8,6 @@ import {
   createExecutorFromMiddlewares,
   executeRequest,
 } from './../../src'
-import fetch from 'node-fetch'
 import { requireEnvVar } from './test-utils'
 
 const projectKey = requireEnvVar('CTP_PROJECT_KEY')

packages/history-sdk/test/helpers/ctp-api-helper.ts

@@ -8,7 +8,6 @@ import {
   createExecutorFromMiddlewares,
   executeRequest,
 } from '@commercetools/platform-sdk'
-import fetch from 'node-fetch'
 import { requireEnvVar } from './test-utils'
 
 const projectKey = requireEnvVar('CTP_PROJECT_KEY')

packages/importapi-sdk/README.md

@@ -38,7 +38,6 @@ const {
   createHttpClient,
 } = require('@commercetools/sdk-client-v2')
 const { createApiBuilderFromCtpClient } = require('@commercetools/importapi-sdk')
-const fetch = require('node-fetch')
 
 const projectKey = 'mc-project-key'
 const authMiddlewareOptions = {
@@ -98,7 +97,6 @@ import {
   createAuthForClientCredentialsFlow,
 } from '@commercetools/sdk-client-v2'
 import { createApiBuilderFromCtpClient } from '@commercetools/importapi-sdk')
-import fetch from 'node-fetch'
 
 const projectKey = 'some_project_key'
 

packages/importapi-sdk/test/helpers/ctp-api-helper.ts

@@ -3,7 +3,6 @@ import {
   createAuthForClientCredentialsFlow,
   createHttpClient,
 } from '@commercetools/sdk-client-v2'
-import fetch from 'node-fetch'
 import { requireEnvVar } from './test-utils'
 import {
   ApiRoot,

packages/platform-sdk/README.md

@@ -40,7 +40,6 @@ const {
   createHttpClient,
 } = require('@commercetools/sdk-client-v2')
 const { createApiBuilderFromCtpClient } = require('@commercetools/platform-sdk')
-const fetch = require('node-fetch')
 
 const projectKey = 'mc-project-key'
 const authMiddlewareOptions = {
@@ -128,7 +127,6 @@ import {
   createAuthForClientCredentialsFlow,
 } from '@commercetools/sdk-client-v2'
 import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
-import fetch from 'node-fetch'
 
 const projectKey = 'some_project_key'
 

packages/platform-sdk/test/helpers/ctp-api-helper.ts

@@ -3,7 +3,6 @@ import {
   createHttpClient,
   createClient,
 } from '@commercetools/sdk-client-v2'
-import fetch from 'node-fetch'
 import { requireEnvVar } from './test-utils'
 import {
   ApiRoot,

packages/platform-sdk/test/integration-tests/cart/cart.me.test.ts

@@ -8,7 +8,6 @@ import {
 import { requireEnvVar } from '../../helpers/test-utils'
 import { ClientBuilder } from '@commercetools/sdk-client-v2'
 import { ByProjectKeyRequestBuilder } from '../../../src/generated/client/by-project-key-request-builder'
-import fetch from 'node-fetch'
 import { randomUUID } from 'crypto'
 import { apiRoot } from '../test-utils'
 import { createCategory } from '../category/category-fixture'

packages/platform-sdk/test/integration-tests/client/client.test.ts

@@ -6,7 +6,6 @@ import {
   Middleware,
 } from '@commercetools/sdk-client-v2'
 import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
-import fetch from 'node-fetch'
 
 const projectKey = requireEnvVar('CTP_PROJECT_KEY')
 const clientId = requireEnvVar('CTP_CLIENT_ID')

packages/platform-sdk/test/integration-tests/process/process.test.ts

@@ -1,6 +1,5 @@
 import { ClientBuilder } from '@commercetools/sdk-client-v2'
 import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
-import fetch from 'node-fetch'
 
 describe('integration test for process function', () => {
   const projectKey = process.env.CTP_PROJECT_KEY

packages/platform-sdk/test/integration-tests/sdk-v3/error-cases.test.ts

@@ -5,7 +5,6 @@ import {
   projectKey,
 } from '../test-utils'
 import { createApiBuilderFromCtpClient } from '../../../src'
-import fetch from 'node-fetch'
 import { TokenCache } from '@commercetools/ts-client'
 
 describe('testing error cases', () => {

packages/platform-sdk/test/integration-tests/sdk-v3/middlewares.test.ts

@@ -395,7 +395,7 @@ describe('Correlation ID and user agent middlewares', () => {
     )
 
     const response = await apiRootV3.get().execute()
-    expect(response.headers?.['x-correlation-id'][0]).toEqual(correlationId)
+    expect(response.headers?.['x-correlation-id']).toEqual(correlationId)
     expect((response?.originalRequest as any).headers['User-Agent']).toContain(
       'test-app/commercetools-sdk-javascript-v3'
     )

packages/platform-sdk/test/integration-tests/test-utils.ts

@@ -7,7 +7,6 @@ import {
 } from '@commercetools/ts-client'
 import { createApiBuilderFromCtpClient } from '../../src'
 import { requireEnvVar } from '../helpers/test-utils'
-const fetch = require('node-fetch')
 
 export const projectKey = requireEnvVar('CTP_PROJECT_KEY')
 const clientId = requireEnvVar('CTP_CLIENT_ID')

packages/sdk-client-v3/README.md

@@ -26,7 +26,6 @@ import {
   ClientBuilder,
 } from '@commercetools/ts-client'
 import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
-import fetch from 'node-fetch'
 
 const projectKey = 'mc-project-key'
 const authMiddlewareOptions = {

packages/sdk-client-v3/package.json

@@ -33,9 +33,7 @@
     "url": "https://github.com/commercetools/commercetools-sdk-typescript/issues"
   },
   "dependencies": {
-    "abort-controller": "3.0.0",
-    "buffer": "^6.0.3",
-    "node-fetch": "^2.6.1"
+    "buffer": "^6.0.3"
   },
   "files": ["dist", "CHANGELOG.md"],
   "author": "Chukwuemeka Ajima <[email protected]>",
@@ -49,7 +47,7 @@
     "common-tags": "1.8.2",
     "dotenv": "16.4.5",
     "jest": "29.7.0",
-    "nock": "12.0.3",
+    "nock": "^14.0.0-beta.19",
     "organize-imports-cli": "0.10.0"
   },
   "scripts": {

packages/sdk-client-v3/src/client/builder.ts

@@ -1,4 +1,3 @@
-import fetch from 'node-fetch'
 import * as middleware from '../middleware'
 import { constants } from '../utils'
 import { default as createClient } from './client'

packages/sdk-client-v3/src/middleware/auth-middleware/anonymous-session-flow.ts

@@ -1,4 +1,3 @@
-import fetch from 'node-fetch'
 import {
   AuthMiddlewareOptions,
   Middleware,

packages/sdk-client-v3/src/middleware/auth-middleware/client-credentials-flow.ts

@@ -1,4 +1,3 @@
-import fetch from 'node-fetch'
 import {
   AuthMiddlewareOptions,
   Middleware,

packages/sdk-client-v3/src/middleware/auth-middleware/password-flow.ts

@@ -1,4 +1,3 @@
-import fetch from 'node-fetch'
 import {
   Middleware,
   MiddlewareRequest,

packages/sdk-client-v3/src/types/types.d.ts

@@ -1,5 +1,3 @@
-import AbortController, { AbortSignal } from 'abort-controller'
-
 export type Nullable<T> = T | null
 export type Keys = string | number | symbol
 export type JsonObject<T = unknown> = { [key in Keys]: T }

packages/sdk-client-v3/src/utils/executor.ts

@@ -1,4 +1,3 @@
-import AbortController from 'abort-controller'
 import { HttpClientConfig, IResponse, TResponse } from '../types/types'
 import { calculateRetryDelay, sleep, validateRetryCodes } from '../utils'
 
@@ -106,7 +105,13 @@ export default async function executor(request: HttpClientConfig) {
               return { _response, shouldRetry: true }
             }
           } catch (e) {
-            if (e.name.includes('AbortError') && retryWhenAborted) {
+            //  in nodejs v18, the error is AbortError, in nodejs v20, the error is TimeoutError
+            //  https://github.com/nodejs/undici/issues/2590
+            if (
+              (e.name.includes('AbortError') ||
+                e.name.includes('TimeoutError')) &&
+              retryWhenAborted
+            ) {
               return { _response: e, shouldRetry: true }
             } else {
               throw e

packages/sdk-client-v3/src/utils/headers.ts

@@ -28,7 +28,8 @@ export default function getHeaders(
 
   // whatwg-fetch
   const map: JsonObject<string> = {}
-  return headers.forEach(
-    (value: any, name: string | number) => (map[name] = value)
-  )
+  headers.forEach((value: any, name: string | number) => {
+    return (map[name] = value)
+  })
+  return map
 }