feat: update to Node18, remove cross-fetch, and run tests on node+jsdom (#386)

Co-authored-by: Nathanael DEMACON <[email protected]>

Author: Vinzius

.github/workflows/check-pull-request.yml

@@ -1,19 +1,19 @@
 name: Check Pull Request
 on:
   pull_request:
-    types: ['opened', 'edited', 'reopened', 'synchronize']
+    types: ["opened", "edited", "reopened", "synchronize"]
 
 jobs:
   check-title:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/[email protected]
-    - uses: pnpm/[email protected]
-    - name: Use Node.js
-      uses: actions/[email protected]
-      with:
-        node-version: 17
-        check-latest: true
-        cache: 'pnpm'
-    - run: pnpm install
-    - run: echo '${{ github.event.pull_request.title }}' | pnpm commitlint
+      - uses: actions/[email protected]
+      - uses: pnpm/[email protected]
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 18
+          check-latest: true
+          cache: "pnpm"
+      - run: pnpm install
+      - run: echo '${{ github.event.pull_request.title }}' | pnpm commitlint

.github/workflows/deploy-doc.yml

@@ -4,7 +4,7 @@ on:
   # Runs on tags
   push:
     tags:
-      - '**'
+      - "**"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -39,9 +39,9 @@ jobs:
       - name: Setup Node
         uses: actions/[email protected]
         with:
-          node-version: 17
+          node-version: 18
           check-latest: true
-          cache: 'pnpm'
+          cache: "pnpm"
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v2

.github/workflows/deploy-package.yml

@@ -10,30 +10,30 @@ jobs:
     runs-on: ubuntu-20.04
     if: github.ref == 'refs/heads/main'
     steps:
-    - uses: actions/[email protected]
-      with:
-        fetch-depth: "0"
-        persist-credentials: false
-    - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-    - name: Git Identity
-      run: |
-        git config --global user.name 'scaleway-bot'
-        git config --global user.email '[email protected]'
-        git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/$GITHUB_REPOSITORY
-      env:
-        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-    - uses: pnpm/[email protected]
-    - name: Use Node.js
-      uses: actions/[email protected]
-      with:
-        node-version: 17
-        check-latest: true
-    - run: pnpm install
-    - run: pnpm run build
-    - run: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc
-      env:
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    - run: pnpm lerna publish -y --create-release github
-      env:
-        HUSKY: 0
-        GH_TOKEN: ${{ secrets.GH_TOKEN }}
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: "0"
+          persist-credentials: false
+      - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
+      - name: Git Identity
+        run: |
+          git config --global user.name 'scaleway-bot'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/$GITHUB_REPOSITORY
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - uses: pnpm/[email protected]
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 18
+          check-latest: true
+      - run: pnpm install
+      - run: pnpm run build
+      - run: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: pnpm lerna publish -y --create-release github
+        env:
+          HUSKY: 0
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/run-tests.yml

@@ -10,47 +10,51 @@ jobs:
   typecheck:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/[email protected]
-    - uses: pnpm/[email protected]
-    - name: Use Node.js
-      uses: actions/[email protected]
-      with:
-        node-version: 17
-        check-latest: true
-        cache: 'pnpm'
-    - run: pnpm install
-    - run: pnpm run build
-    - run: pnpm tsc --noEmit
+      - uses: actions/[email protected]
+      - uses: pnpm/[email protected]
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 17
+          check-latest: true
+          cache: "pnpm"
+      - run: pnpm install
+      - run: pnpm run build
+      - run: pnpm tsc --noEmit
   lint:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/[email protected]
-    - uses: pnpm/[email protected]
-    - name: Use Node.js
-      uses: actions/[email protected]
-      with:
-        node-version: 17
-        check-latest: true
-        cache: 'pnpm'
-    - run: pnpm install
-    - run: pnpm run build
-    - run: pnpm run lint
+      - uses: actions/[email protected]
+      - uses: pnpm/[email protected]
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 18
+          check-latest: true
+          cache: "pnpm"
+      - run: pnpm install
+      - run: pnpm run build
+      - run: pnpm run lint
   test:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        node: [ '14', '16', '17' ]
+        test-environment:
+          - node
+          - jsdom
+        node:
+          - "18"
+          - "19"
     steps:
-    - uses: actions/[email protected]
-    - uses: pnpm/[email protected]
-    - name: Use Node.js
-      uses: actions/[email protected]
-      with:
-        node-version: ${{ matrix.node }}
-        check-latest: true
-        cache: 'pnpm'
-    - run: pnpm install
-    - run: pnpm run build
-    - run: pnpm run test:coverage
-    - uses: codecov/[email protected]
- 
+      - uses: actions/[email protected]
+      - uses: pnpm/[email protected]
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: ${{ matrix.node }}
+          check-latest: true
+          cache: "pnpm"
+      - run: pnpm install
+      - run: pnpm run build
+      - run: pnpm run test:coverage --testEnvironment ${{ matrix.test-environment }}
+      - uses: codecov/[email protected]

README.md

@@ -45,7 +45,7 @@ const client = createClient(profile)
 
 **For more advanced needs**, please check the examples.
 
-## Pagination
+### Pagination
 
 We included some pagination helpers for the methods supporting the feature. Let's take `listNamespaces()` (Registry product) as an example:
 
@@ -67,42 +67,21 @@ for await (const page of api.listNamespaces()) {
 }
 ```
 
-## Types
+### Types
 
 The project is coded with Typescript, so don't hesitate to take advantage of it.
 
 1. All **types of a product** are stored in the `Product.version` namespace. For instance, the `Image` interface of Registry v1 can be accessed with `Registry.v1.Image`.
 
 2. We export **errors** in the namespace `Errors`, allowing you to differentiate the cases (e.g. `Errors.PermissionsDeniedError`).
 
-## Dependencies
+## Notes
 
-This SDK is based on the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API and uses `Request`, `Response` & `Headers` interfaces. Those interfaces are native in modern browsers, node >=18 & [deno](https://deno.land/) environments.
-
-For `node` < 18 & `React Native` environments, the commonJS build requires [cross-fetch](https://www.npmjs.com/package/cross-fetch) package, it is listed in `dependencies` but not used in esm build.
-
-**Troubleshooting**
-
-In node environment, the commonJS module defined in `dist/index.cjs` entry file is used by default, thanks to the "main" `package.json` field.
-
-If you want to use the ES module from `dist/index.js` with node < 18 & `React Native` environments, we recommend you to explicitly import [cross-fetch](https://www.npmjs.com/package/cross-fetch) polyfill:
-
-```ts
-import 'cross-fetch/polyfill'
-import {...} from '@scaleway/sdk'
-```
-
-or
-
-```bash
-node -r cross-fetch/polyfill ./script-using-sdk.mjs
-```
-
-## Development
+### Contributing Guidelines
 
 This repository is at its early stage and is still in active development.
 If you are looking for a way to contribute please read [CONTRIBUTING.md](./CONTRIBUTING.md).
 
-## Reach us
+### Reach us
 
 We love feedback. Feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), we are waiting for you on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource).

setupTests.ts renamed to env-setup.ts

@@ -12,7 +12,7 @@
     "@scaleway/sdk": "^0.1.0-beta"
   },
   "devDependencies": {
-    "@types/node": "^17.0.45",
+    "@types/node": "^18.11.18",
     "typescript": "^4.9.4"
   }
 }

examples/nodejs-minimal/package.json

@@ -5,7 +5,7 @@
     "packages/*"
   ],
   "engines": {
-    "node": ">=14.13",
+    "node": ">=18.0",
     "pnpm": ">=7.25.1"
   },
   "type": "module",
@@ -37,6 +37,9 @@
     ]
   },
   "jest": {
+    "setupFiles": [
+      "./env-setup.ts"
+    ],
     "collectCoverageFrom": [
       "packages/*/src/**/*.{ts,tsx}"
     ],
@@ -61,9 +64,6 @@
     ],
     "transformIgnorePatterns": [
       "node_modules/(?!(.*(@scaleway)))"
-    ],
-    "setupFiles": [
-      "./setupTests.ts"
     ]
   },
   "devDependencies": {
@@ -76,7 +76,6 @@
     "@jest/globals": "^29.3.1",
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^24.0.1",
-    "@rollup/plugin-inject": "^5.0.3",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@scaleway/eslint-config-react": "^3.14.1",
     "@types/jest": "^29.2.6",
@@ -88,6 +87,7 @@
     "eslint-plugin-tsdoc": "^0.2.17",
     "husky": "^8.0.3",
     "jest": "^29.3.1",
+    "jest-environment-jsdom": "^29.4.0",
     "jest-junit": "^15.0.0",
     "lerna": "^6.4.1",
     "lint-staged": "^13.1.0",

package.json

@@ -30,8 +30,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@scaleway/random-name": "^4.0.1",
-    "cross-fetch": "^3.1.5"
+    "@scaleway/random-name": "^4.0.1"
   },
   "bundledDependencies": [
     "@scaleway/random-name"