feat: full ESM config support using Jiti (build #1041) (#1048)

* feat: full ESM config support using Jiti

* fix(ci): set fail-fast to false for the test matrix to see all results

* fix: contains -> includes, contains is deprecated

* chore: minor wording change

* fix: run jest with --experimental-vm-modules, needed on Windows

* fix: make sure we always disable ts-node if enabled

* ci: temporarily disable windows testing until jest/jiti compat is worked out

---------

Co-authored-by: Henrik Steen <henrist@henrist.net>

Author: sorccu

.github/workflows/test.yml

@@ -22,8 +22,9 @@ jobs:
       - run: npm run lint
   test:
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest]
     name: test - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     steps:

examples/advanced-project/package.json

@@ -11,7 +11,6 @@
   "license": "ISC",
   "devDependencies": {
     "checkly": "latest",
-    "ts-node": "10.9.1",
-    "typescript": "4.9.5"
+    "jiti": "^2"
   }
 }

examples/boilerplate-project/package.json

@@ -11,7 +11,6 @@
   "license": "ISC",
   "devDependencies": {
     "checkly": "latest",
-    "ts-node": "10.9.1",
-    "typescript": "4.9.5"
+    "jiti": "^2"
   }
 }

package-lock.json

@@ -15,8 +15,8 @@
     "clean": "rimraf ./dist",
     "prepack": "npx oclif manifest",
     "prepare": "npm run clean && tsc --build",
-    "test": "jest --selectProjects unit",
-    "test:e2e": "npm run prepare && cross-env NODE_CONFIG_DIR=./e2e/config jest --selectProjects E2E",
+    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --selectProjects unit",
+    "test:e2e": "npm run prepare && cross-env NODE_OPTIONS=\"--experimental-vm-modules\" NODE_CONFIG_DIR=./e2e/config jest --selectProjects E2E",
     "test:e2e:local": "cross-env CHECKLY_BASE_URL=http://localhost:3000  CHECKLY_ENV=local npm run test:e2e",
     "watch": "tsc --watch"
   },
@@ -112,6 +112,7 @@
     "config": "^3.3.12",
     "cross-env": "^7.0.3",
     "jest": "^29.7.0",
+    "jiti": "^2.4.2",
     "nanoid": "^3.3.11",
     "oclif": "^4.17.44",
     "rimraf": "^5.0.10",
@@ -120,6 +121,14 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
   },
+  "peerDependencies": {
+    "jiti": ">=2"
+  },
+  "peerDependenciesMeta": {
+    "jiti": {
+      "optional": true
+    }
+  },
   "jest": {
     "testTimeout": 30000,
     "projects": [

packages/cli/package.json

@@ -1,19 +1,23 @@
-import path from 'path'
-import { loadFile } from '../services/checkly-config-loader'
 import fs from 'fs'
+import path from 'path'
+import { loadFile } from '../services/util'
 
 export async function loadPlaywrightConfig () {
-  let config
-  const filenames = ['playwright.config.ts', 'playwright.config.js']
+  const filenames = [
+    'playwright.config.ts',
+    'playwright.config.mts',
+    'playwright.config.cts',
+    'playwright.config.js',
+    'playwright.config.mjs',
+    'playwright.config.cjs',
+  ]
   for (const configFile of filenames) {
-    if (!fs.existsSync(path.resolve(path.dirname(configFile)))) {
+    const configPath = path.resolve(configFile)
+    if (!fs.existsSync(configPath)) {
       continue
     }
-    const dir = path.resolve(path.dirname(configFile))
-    config = await loadFile(path.join(dir, configFile))
-    if (config) {
-      break
-    }
+    const result = await loadFile(configPath)
+    return result
   }
-  return config
+  return undefined
 }

packages/cli/src/playwright/playwright-config-loader.ts

@@ -23,7 +23,7 @@ describe('loadChecklyConfig()', () => {
       await loadChecklyConfig(configDir)
     } catch (e: any) {
       expect(e.message).toContain(`Unable to locate a config at ${configDir} with ${
-        ['checkly.config.ts', 'checkly.config.js', 'checkly.config.mjs'].join(', ')}.`)
+        ['checkly.config.ts', 'checkly.config.mts', 'checkly.config.cts', 'checkly.config.js', 'checkly.config.mjs', 'checkly.config.cjs'].join(', ')}.`)
     }
   })
   it('config TS file should export an object', async () => {

packages/cli/src/services/__tests__/checkly-config-loader.spec.ts

@@ -1,6 +1,6 @@
 import * as path from 'path'
 import { existsSync } from 'fs'
-import { loadJsFile, loadTsFile } from './util'
+import { loadFile } from './util'
 import { CheckProps } from '../constructs/check'
 import { Session } from '../constructs'
 import { Construct } from '../constructs/construct'
@@ -73,35 +73,19 @@ export type ChecklyConfig = {
   }
 }
 
-// eslint-disable-next-line no-restricted-syntax
-enum Extension {
-  JS = '.js',
-  MJS = '.mjs',
-  TS = '.ts',
-}
-
-export function loadFile (file: string) {
-  if (!existsSync(file)) {
-    return Promise.resolve(null)
-  }
-  switch (path.extname(file)) {
-    case Extension.JS:
-      return loadJsFile(file)
-    case Extension.MJS:
-      return loadJsFile(file)
-    case Extension.TS:
-      return loadTsFile(file)
-    default:
-      throw new Error(`Unsupported file extension ${file} for the config file`)
-  }
-}
-
 function isString (obj: any) {
   return (Object.prototype.toString.call(obj) === '[object String]')
 }
 
 export function getChecklyConfigFile (): {checklyConfig: string, fileName: string} | undefined {
-  const filenames: string[] = ['checkly.config.ts', 'checkly.config.js', 'checkly.config.mjs']
+  const filenames = [
+    'checkly.config.ts',
+    'checkly.config.mts',
+    'checkly.config.cts',
+    'checkly.config.js',
+    'checkly.config.mjs',
+    'checkly.config.cjs',
+  ]
   let config
   for (const configFile of filenames) {
     const dir = path.resolve(path.dirname(configFile))
@@ -120,13 +104,14 @@ export function getChecklyConfigFile (): {checklyConfig: string, fileName: strin
   return config
 }
 
-export async function loadChecklyConfig (dir: string, filenames = ['checkly.config.ts', 'checkly.config.js', 'checkly.config.mjs']): Promise<{ config: ChecklyConfig, constructs: Construct[] }> {
+export async function loadChecklyConfig (dir: string, filenames = ['checkly.config.ts', 'checkly.config.mts', 'checkly.config.cts', 'checkly.config.js', 'checkly.config.mjs', 'checkly.config.cjs']): Promise<{ config: ChecklyConfig, constructs: Construct[] }> {
   let config
   Session.loadingChecklyConfigFile = true
   Session.checklyConfigFileConstructs = []
   for (const filename of filenames) {
-    config = await loadFile(path.join(dir, filename))
-    if (config) {
+    const filePath = path.join(dir, filename)
+    if (existsSync(filePath)) {
+      config = await loadFile(filePath)
       break
     }
   }

packages/cli/src/services/checkly-config-loader.ts

@@ -1,5 +1,5 @@
 import * as path from 'path'
-import { findFilesWithPattern, loadJsFile, loadTsFile, pathToPosix } from './util'
+import { findFilesWithPattern, loadFile, pathToPosix } from './util'
 import {
   Check, BrowserCheck, CheckGroup, Project, Session,
   PrivateLocation, PrivateLocationCheckAssignment, PrivateLocationGroupAssignment, MultiStepCheck,
@@ -84,15 +84,11 @@ async function loadAllCheckFiles (
     // setting the checkFilePath is used for filtering by file name on the command line
     Session.checkFileAbsolutePath = checkFile
     Session.checkFilePath = pathToPosix(path.relative(directory, checkFile))
-    if (checkFile.endsWith('.js')) {
-      await loadJsFile(checkFile)
-    } else if (checkFile.endsWith('.mjs')) {
-      await loadJsFile(checkFile)
-    } else if (checkFile.endsWith('.ts')) {
-      await loadTsFile(checkFile)
+    if (/\.[mc]?(js|ts)$/.test(checkFile)) {
+      await loadFile(checkFile)
     } else {
       throw new Error('Unable to load check configuration file with unsupported extension. ' +
-      `Please use a .js, .msj  or .ts file instead.\n${checkFile}`)
+      `Please use a .js, .mjs, .cjs, .ts, .mts or .cts file instead.\n${checkFile}`)
     }
     Session.checkFilePath = undefined
     Session.checkFileAbsolutePath = undefined