chore: typescript CI matrix (#68) (#118)

### CI/CD - Added matrices to test Zimic's compatibility with Node.js 18 and 20 and TypeScript 4.7 to 5.4. Closes #68;
zimicjs · Mar 29, 2024 · 67757dc · 67757dc
1 parent b3acf7a
commit 67757dc
Show file tree

Hide file tree

Showing 9 changed files with 140 additions and 46 deletions.
diff --git a/.github/actions/zimic-setup/action.yaml b/.github/actions/zimic-setup/action.yaml
@@ -69,8 +69,6 @@ runs:
       id: install-dependencies
       shell: bash
       run: |
-        workspaceRootInstallFlag='--filter zimic-root'
-
         function composeFilterOptions() {
           filterEntries=${*}
           filterOptions=()
@@ -82,13 +80,25 @@ runs:
           echo "${filterOptions[@]}"
         }
 
-        partialInstallFlag="$(composeFilterOptions ${{ inputs.install }})"
-        installFlag="$workspaceRootInstallFlag $partialInstallFlag"
-        echo "install-filters=$installFlag" >> $GITHUB_OUTPUT
+        if [[ '${{ inputs.install }}' == '' ]]; then
+          workspaceRootInstallFlag=''
+          partialInstallFlag=''
+          installFlag=''
+        else
+          workspaceRootInstallFlag='--filter zimic-root'
+          partialInstallFlag="$(composeFilterOptions ${{ inputs.install }})"
+          installFlag="$workspaceRootInstallFlag $partialInstallFlag"
+        fi
 
+        echo "install-filters=$installFlag" >> $GITHUB_OUTPUT
         pnpm install --prefer-offline --frozen-lockfile --ignore-scripts $installFlag
 
-        buildFlag="$(composeFilterOptions ${{ inputs.build }})"
+        if [[ '${{ inputs.build }}' == '' ]]; then
+          buildFlag=''
+        else
+          buildFlag="$(composeFilterOptions ${{ inputs.build }})"
+        fi
+
         echo "build-filters=$buildFlag" >> $GITHUB_OUTPUT
         NODE_ENV='${{ inputs.build-node-env }}' pnpm turbo build $buildFlag
 

diff --git a/.github/workflows/cache.yaml b/.github/workflows/cache.yaml
@@ -27,6 +27,9 @@ jobs:
           - 18
           - 20
 
+    env:
+      NODE_VERSION: ${{ matrix.node-version }}
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -14,6 +14,8 @@ concurrency:
 
 env:
   CI: true
+  IS_PULL_REQUEST_TO_MAIN:
+    ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main' && 'true' || 'false' }}
   TURBO_LOG_ORDER: stream
   TURBO_TOKEN:
     ${{ !(github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') &&
@@ -28,20 +30,13 @@ env:
     "{./packages/*}[HEAD^1]..."' || './packages/*' }}
 
 jobs:
-  ci:
-    name: CI
+  ci-general:
+    name: CI General
     runs-on: ubuntu-latest
-    timeout-minutes: 12
-
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version:
-          - 18
-          - 20
+    timeout-minutes: 10
 
     env:
-      NODE_VERSION: ${{ matrix.node-version }}
+      NODE_VERSION: 20
 
     steps:
       - name: Checkout code
@@ -53,33 +48,123 @@ jobs:
         id: zimic-setup
         uses: ./.github/actions/zimic-setup
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ env.NODE_VERSION }}
           turbo-token: ${{ env.TURBO_TOKEN }}
           turbo-team: ${{ env.TURBO_TEAM }}
           install: ${{ env.INSTALL_OPTIONS }}
           build: ${{ env.BUILD_OPTIONS }}
-          build-node-env:
-            ${{ !(github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') && 'development'
-            || 'production' }}
+          build-node-env: ${{ env.IS_PULL_REQUEST_TO_MAIN == 'false' && 'development' || 'production' }}
           install-playwright-browsers: true
 
       - name: Check formatting style
         uses: ./.github/actions/zimic-style-check
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ env.NODE_VERSION }}
 
       - name: Lint code and check types
         run: |
           pnpm turbo \
             types:check lint:turbo \
             --continue \
             --concurrency 100% \
-            ${{ !(github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') && steps.zimic-setup.outputs.install-filters || '' }}
+            ${{ steps.zimic-setup.outputs.install-filters }}
+
+  ci-node:
+    name: CI Node.js
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 18
+          - 20
+
+    env:
+      NODE_VERSION: ${{ matrix.node-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Setup Zimic
+        id: zimic-setup
+        uses: ./.github/actions/zimic-setup
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          turbo-token: ${{ env.TURBO_TOKEN }}
+          turbo-team: ${{ env.TURBO_TEAM }}
+          install: ${{ env.INSTALL_OPTIONS }}
+          build: ${{ env.BUILD_OPTIONS }}
+          build-node-env: ${{ env.IS_PULL_REQUEST_TO_MAIN == 'false' && 'development' || 'production' }}
+          install-playwright-browsers: true
 
       - name: Run tests
         run: |
           pnpm turbo \
             test:turbo \
             --continue \
             --concurrency 100% \
-            ${{ !(github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') && steps.zimic-setup.outputs.install-filters || '' }}
+            ${{ steps.zimic-setup.outputs.install-filters }}
+
+  ci-typescript:
+    name: CI TypeScript
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+      matrix:
+        typescript-version:
+          - 4.7
+          - 4.8
+          - 4.9
+          - 5.0
+          - 5.1
+          - 5.2
+          - 5.3
+          - 5.4
+
+    env:
+      NODE_VERSION: 20
+      TYPESCRIPT_VERSION: ${{ matrix.typescript-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Setup Zimic
+        id: zimic-setup
+        uses: ./.github/actions/zimic-setup
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          turbo-token: ${{ env.TURBO_TOKEN }}
+          turbo-team: ${{ env.TURBO_TEAM }}
+          install: ${{ env.INSTALL_OPTIONS }}
+          build: ${{ env.BUILD_OPTIONS }}
+          build-node-env: ${{ env.IS_PULL_REQUEST_TO_MAIN == 'false' && 'development' || 'production' }}
+          install-playwright-browsers: false
+
+      - name: Set TypeScript version
+        run: |
+          pnpm update \
+            typescript@${{ matrix.typescript-version }} \
+            --recursive \
+            ${{ steps.zimic-setup.outputs.install-filters }} \
+            --filter !zimic \
+            --filter !@zimic/*
+
+      - name: Check types
+        run: |
+          pnpm turbo \
+            types:check \
+            --continue \
+            --concurrency 100% \
+            ${{ steps.zimic-setup.outputs.install-filters }} \
+            --filter !zimic \
+            --filter !@zimic/*
diff --git a/apps/zimic-test-client/tests/v0/interceptor/thirdParty/superagent/utils.ts b/apps/zimic-test-client/tests/v0/interceptor/thirdParty/superagent/utils.ts
@@ -22,7 +22,7 @@ export async function superagentAsFetch(request: Request): Promise<Response> {
       throw error;
     }
 
-    const superagentResponse = error.response as SuperagentResponse;
+    const { response: superagentResponse } = error as Error & { response: SuperagentResponse };
 
     return new Response(superagentResponse.text, {
       status: superagentResponse.status,

diff --git a/examples/package.json b/examples/package.json
@@ -15,7 +15,6 @@
   "devDependencies": {
     "@zimic/eslint-config-node": "workspace:*",
     "@zimic/lint-staged-config": "workspace:*",
-    "@zimic/tsconfig": "workspace:*",
-    "typescript": "^5.4.3"
+    "@zimic/tsconfig": "workspace:*"
   }
 }
diff --git a/examples/with-jest-node/package.json b/examples/with-jest-node/package.json
@@ -8,7 +8,7 @@
     "types:check": "tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^4.26.1",
+    "fastify": "4.23.2",
     "zimic": "latest",
     "zod": "^3.22.4"
   },

diff --git a/examples/with-vitest-node/package.json b/examples/with-vitest-node/package.json
@@ -8,7 +8,7 @@
     "types:check": "tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^4.26.1",
+    "fastify": "4.23.2",
     "zimic": "latest",
     "zod": "^3.22.4"
   },

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/turbo.json b/turbo.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://turbo.build/schema.json",
-  "globalEnv": ["NODE_ENV", "NODE_VERSION"],
+  "globalEnv": ["NODE_ENV", "NODE_VERSION", "TYPESCRIPT_VERSION"],
   "pipeline": {
     "dev": {
       "cache": false,