remix-run · kentcdodds · Apr 11, 2022 · Mar 30, 2022 · Mar 29, 2022 · Mar 29, 2022
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,47 +15,116 @@ on:
 
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          # TODO: Fix cross-env issues in Jest before enabling
-          # - windows-latest
+    name: ⚙️ Build
+    runs-on: ubuntu-latest
     steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: prep windows network
-        run: Disable-NetAdapterChecksumOffload -Name * -TcpIPv4 -UdpIPv4 -TcpIPv6 -UdpIPv6
-        if: ${{ matrix.settings.host == 'windows-latest' }}
-      - uses: actions/checkout@v2
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
 
-      - run: echo "::set-output name=version::$(cat .nvmrc)"
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      - name: 🥏 get node in .nvmrc
+        run: echo "::set-output name=version::$(cat .nvmrc)"
+        id: nvmrc
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "${{ steps.nvmrc.outputs.version }}"
+          cache: "yarn"
+
+      - name: 📥 Download deps
+        # even though this is called "npm-install" it does use yarn to install
+        # because we have a yarn.lock and caches efficiently.
+        uses: bahmutov/npm-install@v1
+
+      - name: ⚙️ Build
+        run: yarn build
+
+  lint:
+    name: ⬣ Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
+
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      - name: 🥏 get node in .nvmrc
+        run: echo "::set-output name=version::$(cat .nvmrc)"
         id: nvmrc
 
-      - name: Setup node
+      - name: ⎔ Setup node
         uses: actions/setup-node@v3
         with:
           node-version: "${{ steps.nvmrc.outputs.version }}"
           cache: "yarn"
 
-      - name: Install dependencies
-        run: yarn --frozen-lockfile --network-timeout 1000000
+      - name: 📥 Download deps
+        # even though this is called "npm-install" it does use yarn to install
+        # because we have a yarn.lock and caches efficiently.
+        uses: bahmutov/npm-install@v1
 
-      - name: Lint
+      - name: 🔬 Lint
         run: yarn lint
 
-      - name: Build
-        run: yarn build
+  test:
+    name: 🧪 Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
 
-      - name: Install Playwright
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      - name: 🥏 get node in .nvmrc
+        run: echo "::set-output name=version::$(cat .nvmrc)"
+        id: nvmrc
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "${{ steps.nvmrc.outputs.version }}"
+          cache: "yarn"
+
+      - name: 📥 Download deps
+        # even though this is called "npm-install" it does use yarn to install
+        # because we have a yarn.lock and caches efficiently.
+        uses: bahmutov/npm-install@v1
+
+      - name: 📥 Install Playwright
         run: npx playwright install --with-deps
 
-      - name: Test
-        run: yarn test
+      - name: 🧪 Run Primary Tests
+        run: "yarn test:primary"
+
+  integration:
+    name: 👀 Integration Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛑 Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
 
-      - name: Upload test results
-        if: always()
-        uses: actions/upload-artifact@v2
+      - name: ⬇️ Checkout repo
+        uses: actions/checkout@v3
+
+      - name: 🥏 get node in .nvmrc
+        run: echo "::set-output name=version::$(cat .nvmrc)"
+        id: nvmrc
+
+      - name: ⎔ Setup node
+        uses: actions/setup-node@v3
         with:
-          name: playwright-results
-          path: test-results
+          node-version: "${{ steps.nvmrc.outputs.version }}"
+          cache: "yarn"
+
+      - name: 📥 Download deps
+        # even though this is called "npm-install" it does use yarn to install
+        # because we have a yarn.lock and caches efficiently.
+        uses: bahmutov/npm-install@v1
+
+      - name: 👀 Run Integration Tests
+        run: "yarn test:integration"
diff --git a/docs/pages/contributing.md b/docs/pages/contributing.md
@@ -38,11 +38,12 @@ The following steps will get you setup to contribute changes to this repo:
    git checkout dev
    ```
 
-3. Install dependencies and build. Remix uses [`yarn` (version 1)](https://classic.yarnpkg.com/lang/en/docs/install), so you should too. If you install using `npm`, unnecessary `package-lock.json` files will be generated.
+3. Install dependencies by running `yarn`. Remix uses [`yarn` (version 1)](https://classic.yarnpkg.com/lang/en/docs/install), so you should too. If you install using `npm`, unnecessary `package-lock.json` files will be generated.
+4. Verify you've got everything set up for local development by running `yarn test`
 
 ## Think You Found a Bug?
 
-Please send a PR with a failing test. It's really easy if you follow the instructions in [`integration/bug-report-test.ts`](https://github.com/remix-run/remix/blob/dev/integration/bug-report-test.ts)
+Please send a PR with a failing test. There are instructions in [`integration/bug-report-test.ts`](https://github.com/remix-run/remix/blob/dev/integration/bug-report-test.ts)
 
 ## Proposing New or Changed API?
 
@@ -68,6 +69,23 @@ All commits that fix bugs or add features need a test.
 
 `<blink>`Do not merge code without tests!`</blink>`
 
+We use `jest` for our testing in this project. We have a suite of integration tests in the integration folder and packages have their own jest configuration which are then referenced by the primary jest config in the root of the project.
+
+The integration tests need to be run with `--runInBand` and the primary tests can be run in parallel which is why they each are run by different instances of `jest`. And then we use `npm-run-all` to run those both in parallel to make the tests run as quickly and efficiently as possible. To run these two sets of tests independently you'll need to run the individual script:
+
+- `yarn test:primary`
+- `yarn test:integration`
+
+We also support watch plugins for project, file, and test filtering. To filter things down, you can use a combination of `--testNamePattern`, `--testPathPattern`, and `--selectProjects`. For example:
+
+```
+yarn test:primary --selectProjects react --testPathPattern transition --testNamePattern "initial values"
+```
+
+We also have watch mode plugins for these. So, you can run `yarn test:primary --watch` and hit `w` to see the available watch commands.
+
+Alternatively, you can run a project completely independently by `cd`-ing into that project and running `yarn jest` which will pick up that project's jest config.
+
 ### Docs + Examples
 
 All commits that change or add to the API must be done in a pull request that also updates all relevant examples and docs.

diff --git a/fixtures/gists-app/jest/globalSetup.ts b/fixtures/gists-app/jest/globalSetup.ts
diff --git a/fixtures/gists-app/jest/globalTeardown.ts b/fixtures/gists-app/jest/globalTeardown.ts
diff --git a/fixtures/gists-app/jest/setup.ts b/fixtures/gists-app/jest/setup.ts
diff --git a/fixtures/gists-app/jest/setupAfterEnv.ts b/fixtures/gists-app/jest/setupAfterEnv.ts
diff --git a/fixtures/gists-app/tests/__snapshots__/loader-results-test.ts.snap b/fixtures/gists-app/tests/__snapshots__/loader-results-test.ts.snap