feat: Implement waitFor

.codesandbox/ci.json

@@ -0,0 +1,5 @@
+{
+  "installCommand": "install:csb",
+  "sandboxes": ["new", "github/kentcdodds/react-testing-library-examples"],
+  "node": "18"
+}

.github/workflows/validate.yml

@@ -11,27 +11,27 @@ on:
       - 'beta'
       - 'alpha'
       - '!all-contributors/**'
-  pull_request: {}
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 permissions: {}
 
 jobs:
   main:
     permissions:
-      actions: write #  to cancel/stop running workflows (styfle/cancel-workflow-action)
       contents: read #  to fetch code (actions/checkout)
     # ignore all-contributors PRs
     if: ${{ !contains(github.head_ref, 'all-contributors') }}
     strategy:
       # Otherwise we would not know if the problem is tied to the Node.js version
       fail-fast: false
       matrix:
-        node: [14, 16, 18]
+        node: [14, 16, 18, 20]
     runs-on: ubuntu-latest
     steps:
-      - name: 🛑 Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.9.0
-
       - name: ⬇️ Checkout repo
         uses: actions/checkout@v3
         with:
@@ -43,6 +43,10 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
 
+      # Ideally done by actions/setup-node: https://github.com/actions/setup-node/issues/213
+      - name: Setup package manager
+        run: npm install -g npm@9.2.0
+
       - name: 📥 Download deps
         uses: bahmutov/npm-install@v1
         with:
@@ -63,18 +67,15 @@ jobs:
 
   release:
     permissions:
-      actions: write #  to cancel/stop running workflows (styfle/cancel-workflow-action)
       contents: write #  to create release tags (cycjimmy/semantic-release-action)
+      issues: write # to post release that resolves an issue
 
     needs: main
     runs-on: ubuntu-latest
     if:
       ${{ github.repository == 'testing-library/web-testing-library' &&
       github.event_name == 'push' }}
     steps:
-      - name: 🛑 Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.9.0
-
       - name: ⬇️ Checkout repo
         uses: actions/checkout@v3
 
@@ -83,6 +84,10 @@ jobs:
         with:
           node-version: 14
 
+      # Ideally done by actions/setup-node: https://github.com/actions/setup-node/issues/213
+      - name: Setup package manager
+        run: npm install -g npm@9.2.0
+
       - name: 📥 Download deps
         uses: bahmutov/npm-install@v1
         with:

jest.config.js

@@ -7,18 +7,24 @@ const {
 
 module.exports = {
   collectCoverageFrom,
-  coveragePathIgnorePatterns: [
-    ...coveragePathIgnorePatterns,
-    '/__tests__/',
-    '/__node_tests__/',
-  ],
-  coverageThreshold,
+  coveragePathIgnorePatterns: [...coveragePathIgnorePatterns, '/__tests__/'],
+  coverageThreshold: {
+    ...coverageThreshold,
+    // full coverage across the build matrix (Node.js versions) but not in a single job
+    // minimum coverage of jobs using different Node.js version
+    './src/waitFor.ts': {
+      branches: 96.77,
+      functions: 100,
+      lines: 97.95,
+      statements: 98,
+    },
+  },
   watchPlugins: [
     ...watchPlugins,
     require.resolve('jest-watch-select-projects'),
   ],
   projects: [
-    require.resolve('./tests/jest.config.dom.js'),
-    require.resolve('./tests/jest.config.node.js'),
+    // No idea why I need to specify a project instead of having a single config
+    require.resolve('./tests/jest.config.js'),
   ],
 }

package.json

@@ -68,8 +68,13 @@
     "jest-watch-select-projects": "^2.0.0",
     "jsdom": "^16.4.0",
     "kcd-scripts": "^11.0.0",
+    "pretty-format": "^29.3.1",
     "typescript": "^4.1.2"
   },
+  "overrides": {
+    "browserslist": "4.21.8",
+    "caniuse-lite": "1.0.30001502"
+  },
   "eslintConfig": {
     "extends": [
       "./node_modules/kcd-scripts/eslint.js",

src/__tests__/__snapshots__/waitFor.test.js.snap

@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`waitFor DOM reference implementation using fake legacy timers timeout 1`] = `Not done`;
+
+exports[`waitFor DOM reference implementation using fake modern timers timeout 1`] = `Not done`;
+
+exports[`waitFor DOM reference implementation using real timers timeout 1`] = `Not done`;

src/__tests__/__snapshots__/waitForDOM.test.js.snap

@@ -0,0 +1,67 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`waitFor DOM reference implementation using fake legacy timers timeout 1`] = `
+Not done
+
+Document {
+  "location": Location {
+    "assign": [Function assign],
+    "hash": "",
+    "host": "localhost",
+    "hostname": "localhost",
+    "href": "http://localhost/",
+    "origin": "http://localhost",
+    "pathname": "/",
+    "port": "",
+    "protocol": "http:",
+    "reload": [Function reload],
+    "replace": [Function replace],
+    "search": "",
+    "toString": [Function toString],
+  },
+}
+`;
+
+exports[`waitFor DOM reference implementation using fake modern timers timeout 1`] = `
+Not done
+
+Document {
+  "location": Location {
+    "assign": [Function assign],
+    "hash": "",
+    "host": "localhost",
+    "hostname": "localhost",
+    "href": "http://localhost/",
+    "origin": "http://localhost",
+    "pathname": "/",
+    "port": "",
+    "protocol": "http:",
+    "reload": [Function reload],
+    "replace": [Function replace],
+    "search": "",
+    "toString": [Function toString],
+  },
+}
+`;
+
+exports[`waitFor DOM reference implementation using real timers timeout 1`] = `
+Not done
+
+Document {
+  "location": Location {
+    "assign": [Function assign],
+    "hash": "",
+    "host": "localhost",
+    "hostname": "localhost",
+    "href": "http://localhost/",
+    "origin": "http://localhost",
+    "pathname": "/",
+    "port": "",
+    "protocol": "http:",
+    "reload": [Function reload],
+    "replace": [Function replace],
+    "search": "",
+    "toString": [Function toString],
+  },
+}
+`;