ci: migrate to github actions (#901)

* ci: migrate to github actions

* test: support skipping browser setup

Author: pmmmwh

.circleci/config.yml

@@ -0,0 +1,89 @@
+name: CI
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  lint-and-format:
+    name: Lint and Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: 22
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+      - name: Check Linting
+        run: yarn lint
+      - name: Check Formatting
+        run: yarn format:check
+
+  test:
+    name: Tests (Node ${{ matrix.node-version }} - WDS ${{ matrix.wds-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - '18'
+          - '20'
+          - '22'
+        wds-version:
+          - '4'
+          - '5'
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: ${{ matrix.node-version }}
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+      - name: Run Tests
+        run: yarn test --testPathIgnorePatterns conformance
+        env:
+          BROWSER: false
+          WDS_VERSION: ${{ matrix.wds-version }}
+
+  conformance:
+    name: Conformance (Node ${{ matrix.node-version }} - WDS ${{ matrix.wds-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - '18'
+          - '20'
+          - '22'
+        wds-version:
+          - '4'
+          - '5'
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: ${{ matrix.node-version }}
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+      - name: Disable AppArmor
+        run: echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns
+      - name: Run Conformance Tests
+        run: yarn test conformance
+        env:
+          WDS_VERSION: ${{ matrix.wds-version }}

.github/workflows/ci.yml

@@ -13,9 +13,6 @@ const yn = require('yn');
 let argv = process.argv.slice(2);
 
 if (yn(process.env.CI)) {
-  // Force headless mode in CI environments
-  process.env.HEADLESS = 'true';
-
   // Use CI mode
   argv.push('--ci');
   // Parallelized puppeteer tests have high memory overhead in CI environments.

scripts/test.js

@@ -1,3 +1,7 @@
+/**
+ * @jest-environment <rootDir>/conformance/environment
+ */
+
 const getSandbox = require('../helpers/sandbox');
 
 // https://github.com/facebook/metro/blob/c083da2a9465ef53f10ded04bb7c0b748c8b90cb/packages/metro/src/lib/polyfills/__tests__/require-test.js#L1028-L1087

test/conformance/ReactRefreshRequire.test.js

@@ -0,0 +1,27 @@
+const puppeteer = require('puppeteer');
+const TestEnvironment = require('../jest-environment');
+
+class SandboxEnvironment extends TestEnvironment {
+  async setup() {
+    await super.setup();
+
+    const wsEndpoint = process.env.PUPPETEER_WS_ENDPOINT;
+    if (!wsEndpoint) {
+      throw new Error('Puppeteer wsEndpoint not found!');
+    }
+
+    this.global.browser = await puppeteer.connect({
+      browserWSEndpoint: wsEndpoint,
+    });
+  }
+
+  async teardown() {
+    await super.teardown();
+
+    if (this.global.browser) {
+      await this.global.browser.disconnect();
+    }
+  }
+}
+
+module.exports = SandboxEnvironment;

test/conformance/environment.js

@@ -1,9 +1,8 @@
-const { TestEnvironment } = require('jest-environment-node');
-const puppeteer = require('puppeteer');
+const { TestEnvironment: NodeEnvironment } = require('jest-environment-node');
 const semver = require('semver');
 const yn = require('yn');
 
-class SandboxEnvironment extends TestEnvironment {
+class TestEnvironment extends NodeEnvironment {
   async setup() {
     await super.setup();
 
@@ -15,24 +14,7 @@ class SandboxEnvironment extends TestEnvironment {
         : semver.major(process.version) < 18 || this.global.WEBPACK_VERSION === 4
           ? 4
           : 5;
-
-    const wsEndpoint = process.env.PUPPETEER_WS_ENDPOINT;
-    if (!wsEndpoint) {
-      throw new Error('Puppeteer wsEndpoint not found!');
-    }
-
-    this.global.browser = await puppeteer.connect({
-      browserWSEndpoint: wsEndpoint,
-    });
-  }
-
-  async teardown() {
-    await super.teardown();
-
-    if (this.global.browser) {
-      await this.global.browser.disconnect();
-    }
   }
 }
 
-module.exports = SandboxEnvironment;
+module.exports = TestEnvironment;

test/jest-environment.js

@@ -2,14 +2,19 @@ const puppeteer = require('puppeteer');
 const yn = require('yn');
 
 async function setup() {
-  const browser = await puppeteer.launch({
-    devtools: yn(process.env.DEBUG, { default: false }),
-    headless: yn(process.env.HEADLESS, { default: false }),
-  });
+  if (yn(process.env.BROWSER, { default: true })) {
+    const browser = await puppeteer.launch({
+      devtools: yn(process.env.DEBUG, { default: false }),
+      headless: yn(process.env.HEADLESS, {
+        // Force headless mode in CI environments
+        default: yn(process.env.CI, { default: false }),
+      }),
+    });
 
-  global.__BROWSER_INSTANCE__ = browser;
+    global.__BROWSER_INSTANCE__ = browser;
 
-  process.env.PUPPETEER_WS_ENDPOINT = browser.wsEndpoint();
+    process.env.PUPPETEER_WS_ENDPOINT = browser.wsEndpoint();
+  }
 }
 
 module.exports = setup;