Support cjs/mjs config files (#203)

* make internal pw config explicitly cjs

* Convert base config to esm

* Use fully qualified, platform specific absolute path for import

* More succinctly

* Run basic-ts and config-merging in testing workflow

* Make the basic-ts test explicitly ESM

* move test specific gitignore to test dir root

* cleanup

* cleanup unused files

* fix gitignore

* powershell-ify

* setup github token for saucectl action

* make config source mjs

* rename file

Author: mhan83

.github/workflows/test.yml

@@ -44,7 +44,9 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup saucectl
-        uses: saucelabs/saucectl-run-action@v2
+        uses: saucelabs/saucectl-run-action@v3
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
         with:
           skip-run: true
 
@@ -80,10 +82,29 @@ jobs:
           npx playwright install
           npx playwright install-deps
 
-      - run: node . --suiteName basic-js --runCfgPath ./tests/fixtures/local/basic-js/sauce-runner.json
+      - name: Run basic-js
+        run: |
+          node . `
+            --suiteName basic-js `
+            --runCfgPath ./tests/fixtures/local/basic-js/sauce-runner.json
+        env:
+          SAUCE_VM: true
+
+      - name: Run basic-ts
+        run: |
+          node . `
+            --suiteName basic-ts `
+            --runCfgPath ./tests/fixtures/local/basic-ts/sauce-runner.json
+        env:
+          SAUCE_VM: true
+
+      - name: Run config-merging
+        run: |
+          node . `
+            --suiteName config-merging `
+            --runCfgPath ./tests/fixtures/local/config-merging/sauce-runner.json
         env:
           SAUCE_VM: true
-        name: Run test locally
 
   cucumber-build-and-test-local:
     runs-on: windows-latest

src/playwright-runner.js

@@ -374,8 +374,8 @@ async function runPlaywright(nodeBin, runCfg) {
 
   // Copy our runner's playwright config to a custom location in order to
   // preserve the customer's config which we may want to load in the future
-  const configFile = path.join(runCfg.projectPath, 'sauce.config.js');
-  fs.copyFileSync(path.join(__dirname, 'sauce.config.js'), configFile);
+  const configFile = path.join(runCfg.projectPath, 'sauce.config.mjs');
+  fs.copyFileSync(path.join(__dirname, 'sauce.config.mjs'), configFile);
 
   const defaultArgs = {
     output: runCfg.playwrightOutputFolder,

src/sauce.config.js renamed to src/sauce.config.mjs

@@ -1,6 +1,7 @@
-const process = require('process');
-const _ = require('lodash');
-const fs = require('fs');
+import * as fs from 'node:fs';
+import * as process from 'node:process';
+import { pathToFileURL } from 'node:url';
+import _ from 'lodash';
 
 let userConfig = {};
 
@@ -12,7 +13,7 @@ const configFiles = process.env.PLAYWRIGHT_CFG_FILE ?
 for (const file of configFiles) {
   if (fs.existsSync(file)) {
     try {
-      userConfig = require(file);
+      userConfig = await import(pathToFileURL(file));
       // it should put config just under root level to get it work with playwright.config.ts
       // there is no such issue with playwright.config.js
       if (userConfig.default) {
@@ -80,4 +81,4 @@ function arrMerger(objValue, srcValue) {
   }
 }
 
-module.exports = _.mergeWith(userConfig, overrides, arrMerger);
+export default _.mergeWith(userConfig, overrides, arrMerger);

tests/fixtures/local/.gitignore

@@ -0,0 +1 @@
+sauce.config.*js

tests/fixtures/local/basic-js/sauce.config.js

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

tests/fixtures/local/basic-ts/package.json

@@ -0,0 +1,8 @@
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: {
+    headless: true,
+    video: 'on',
+  },
+});

tests/fixtures/local/basic-ts/playwright.config.ts

@@ -7,10 +7,9 @@
             "name": "basic-ts",
             "param": {
               "browserName": "chromium",
-              "headful": true,
-              "slowMo": 10000
+              "headless": true
             },
             "testMatch": ".*.spec.ts"
         }
     ]
-}
+}

tests/fixtures/local/basic-ts/sauce-runner.json

@@ -2,10 +2,9 @@
 module.exports = {
   use: {
     headless: true,
-    video: false,
+    video: 'off',
     timezoneId: 'Asia/Seoul',
     locale: 'ko-KR',
     reporter: [['dot']],
   },
 };
-

tests/fixtures/local/config-merging/.gitignore

@@ -14,14 +14,7 @@
         {
             "name": "config-merging",
             "param": {
-              "browserName": "chromium",
-              "globalTimeout": 900000,
-              "grep": ".*",
-              "repeatEach": 1,
-              "retries": 0,
-              "shard": "1/2",
-              "timeout": 30000,
-              "maxFailures": 2
+              "browserName": "chromium"
             },
             "testMatch": ".*.js"
         }