polendina 1.1.1 → 2.0.0

package/.github/dependabot.yml

@@ -0,0 +1,154 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-async'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-async-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-async-failure'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-async-failure-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-sync'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-sync-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-sync-failure'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/bare-sync-failure-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/mocha'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/mocha-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/mocha-failure'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/mocha-failure-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/tape'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/tape-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/tape-failure'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/tape-failure-esm'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+
+  - package-ecosystem: 'npm'
+    directory: '/test/fixtures/webpack-merge'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [2.0.0](https://github.com/rvagg/polendina/compare/v1.1.1...v2.0.0) (2021-12-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* upgrade to webpack5
+
+### Features
+
+* support both ESM and CJS ([4de7f38](https://github.com/rvagg/polendina/commit/4de7f38ae789463c5907e8e3fcab05052b441730))
+* upgrade to webpack5 ([4e99018](https://github.com/rvagg/polendina/commit/4e99018837d51cc125324804755593a50205a28d))
+
+
+### Trivial Changes
+
+* add dependabot config, also for fixtures ([d074252](https://github.com/rvagg/polendina/commit/d0742522961100022597f9e92512164ade788bee))
+* update deps (those that can be updated without code changes) ([7cca22c](https://github.com/rvagg/polendina/commit/7cca22cbc3847757ca887cfc632cceb99ff6439f))
+
 ### [1.1.1](https://github.com/rvagg/polendina/compare/v1.1.0...v1.1.1) (2021-12-07)
 
 

package/lib/log.js

@@ -1,5 +1,7 @@
-const colors = require('ansi-colors')
-const stripAnsi = require('strip-ansi')
+import process from 'process'
+import colors from 'ansi-colors'
+import stripAnsi from 'strip-ansi'
+
 const tty = process.stdout.isTTY && process.stderr.isTTY
 
 function brand (error) {
@@ -7,27 +9,25 @@ function brand (error) {
   return tty ? `${colors[error ? 'red' : 'green'](brand)}` : brand
 }
 
-function log (msg) {
+export function log (msg) {
   if (msg === undefined) {
     return console.log()
   }
   console.log(`  ${brand()}   ${tty ? colors.gray.italic(msg) : msg}`)
 }
 
-function error (msg) {
+export function error (msg) {
   console.log(`  ${brand(true)}   ${tty ? colors.gray.italic(msg) : msg}`)
 }
 
-function logRaw (type, args) {
+export function logRaw (type, args) {
   if (!tty) {
     args = args.map((a) => typeof a === 'string' ? stripAnsi(a) : a)
   }
   console[type === 'info' ? 'log' : type].apply(null, args)
 }
 
-function logWrite (args) {
+export function logWrite (args) {
   args = Array.isArray(args) ? args : [args]
   process.stdout.write.apply(process.stdout, args)
 }
-
-module.exports = { log, error, logRaw, logWrite }

package/lib/puppeteer.js

@@ -1,13 +1,13 @@
-const puppeteer = require('puppeteer')
+import puppeteer from 'puppeteer'
 // TODO
 // const pti = require('puppeteer-to-istanbul')
 // const { copyFile } = require('fs').promises
-const { log, error, logRaw, logWrite } = require('./log')
+import { log, error, logRaw, logWrite } from './log.js'
 
 // wrap our convoluted _run() function in a pure Promise that can handle
 // both standard throws and the callback that ends it. _run() needs to handle
 // ends in a few different ways, hence the hack.
-function run (outputDir, port, timeout, mode, runner, coverage) {
+export function run (outputDir, port, timeout, mode, runner, coverage) {
   return new Promise((resolve, reject) => {
     _run(outputDir, port, timeout, mode, runner, coverage, (err, errors) => {
       if (err) {
@@ -112,5 +112,3 @@ async function _run (outputDir, port, timeout, mode, runner, coverage, callback)
     browser.close().then(cb).catch(cb)
   }, timeout * 1000).unref()
 }
-
-module.exports = run

package/lib/webpack.config.js

@@ -1,7 +1,10 @@
-const path = require('path')
-const glob = require('glob')
+import path from 'path'
+import glob from 'glob'
+import { fileURLToPath } from 'url'
 
-module.exports = function (env, options, runner) {
+const __dirname = fileURLToPath(path.dirname(import.meta.url))
+
+export function webpackConfig (env, options, runner) {
   const bundleRun = path.normalize(path.resolve(options.outputDir, runner))
   const testFiles = options._.reduce((p, c) => {
     return p.concat(glob.sync(c, { absolute: true }))
@@ -38,21 +41,14 @@ module.exports = function (env, options, runner) {
         path.join(__dirname, '../node_modules')
       ]
     },
-    node: {
-      dgram: 'empty',
-      fs: 'empty',
-      net: 'empty',
-      tls: 'empty',
-      dns: 'empty',
-      child_process: 'empty'
-    },
     module: {
       rules: [
         {
           test: testFiles,
           exclude: [/node_modules/, bundleRun],
+          type: 'javascript/auto', // needed so the wrap-loader can get a sync require() in
           use: [{
-            loader: require.resolve('./wrap-loader.js'),
+            loader: path.resolve(__dirname, 'wrap-loader.cjs'),
             options: options
           }]
         }

package/lib/{wrap-loader.js → wrap-loader.cjs}

@@ -5,11 +5,11 @@
 
 const path = require('path')
 
-function loader (src) {
+function wrapLoader (src) {
   return src
 }
 
-loader.pitch = function pitch (remainingRequest) {
+wrapLoader.pitch = function pitch (remainingRequest) {
   const argv = this.query
 
   // probably redundant
@@ -17,15 +17,18 @@ loader.pitch = function pitch (remainingRequest) {
     return
   }
 
-  // wrap the test in a function that is only called when we want it called
+  // wrap the test in a function that is only called when we want it called, using CJS here because
+  // we get synchronous require() out of it, this needs the tests to be loaded with javascript/auto
+  // so webpack can auto-detect
   return `
-    const registry = require(${JSON.stringify(`!!${path.normalize(path.resolve(argv.outputDir, 'test-registry.js'))}`)})
+    const { registry } = require(${JSON.stringify(`!!${path.normalize(path.resolve(argv.outputDir, 'test-registry.js'))}`)})
     registry.argv = JSON.parse(${JSON.stringify(JSON.stringify(argv))})
     registry.tests.push({
-      name: JSON.parse('${JSON.stringify(path.normalize(path.relative(process.cwd(), remainingRequest)))}'),
+      name: JSON.parse('${JSON.stringify(path.normalize(path.relative(process.cwd(), remainingRequest))).replace(/\\/g, '/')}'),
       load: () => { return require(${JSON.stringify(`!!${remainingRequest}`)}) }
     })
+    module.exports = {}
   `
 }
 
-module.exports = loader
+module.exports = wrapLoader

package/package.json

@@ -1,29 +1,33 @@
 {
   "name": "polendina",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Non-UI browser testing for JavaScript libraries from the command-line",
   "main": "polendina.js",
+  "type": "module",
   "dependencies": {
     "ansi-colors": "^4.1.1",
-    "glob": "^7.1.6",
-    "puppeteer": "^5.2.1",
-    "raw-loader": "^4.0.0",
-    "readable-stream": "^2.3.7",
-    "rimraf": "^3.0.0",
-    "st": "^2.0.0",
-    "strip-ansi": "^6.0.0",
-    "webpack": "^4.41.5",
-    "webpack-merge": "^4.2.2",
-    "yargs": "^15.1.0"
+    "glob": "^7.2.0",
+    "path-browserify": "^1.0.1",
+    "process": "^0.11.10",
+    "puppeteer": "~12.0.1",
+    "raw-loader": "~4.0.2",
+    "readable-stream": "^3.6.0",
+    "rimraf": "^3.0.2",
+    "st": "^3.0.0",
+    "stream-browserify": "^3.0.0",
+    "strip-ansi": "^6.0.1",
+    "webpack": "~5.65.0",
+    "webpack-merge": "~5.8.0",
+    "yargs": "^17.3.0"
   },
   "bin": {
     "polendina": "./polendina-cli.js",
     "polendina-node": "./polendina-node-cli.js"
   },
   "scripts": {
-    "lint": "npx standard",
+    "lint": "npm_config_yes=true npx standard",
     "test:install": "for f in $(cd test/fixtures/; ls); do (cd test/fixtures/$f && grep devDependencies package.json > /dev/null && npm i --no-audit --no-fund --no-package-lock) || true; done",
-    "test:run": "npx mocha test/test-*.js",
+    "test:run": "npm_config_yes=true npx mocha test/test-*.js",
     "test": "npm run lint && npm run test:install && npm run test:run"
   },
   "repository": {

package/polendina-cli.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 
-const start = Date.now()
-
-const path = require('path')
-const { log } = require('./lib/log')
-const Polendina = require('./polendina')
+import path from 'path'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { log } from './lib/log.js'
+import { Polendina } from './polendina.js'
 
-const argv = require('yargs')
+const start = Date.now()
+const argv = yargs(hideBin(process.argv))
   .usage('$0 testfile.js [testfile2.js [tests/**/test*.js ...] ]')
   .option('runner', {
     alias: 'r',

package/polendina-node-cli.js

@@ -1,12 +1,16 @@
 #!/usr/bin/env node
 
+import process from 'process'
+import path from 'path'
+import glob from 'glob'
+import stripAnsi from 'strip-ansi'
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import { BareRunner } from './resources/bare.js'
+
 const start = Date.now()
-const glob = require('glob')
-const path = require('path')
-const stripAnsi = require('strip-ansi')
 const tty = process.stdout.isTTY && process.stderr.isTTY
-const BareRunner = require('./resources/bare')
-const argv = require('yargs')
+const argv = yargs(hideBin(process.argv))
   .command('bare-sync <test files..>', 'Run synchronous tests using a plain require(file)')
   .command('bare-async <test files..>', 'Run tests by executing exported functions from files as async')
   .demandCommand()
@@ -42,7 +46,7 @@ async function run () {
   const tests = testFiles.map((f) => {
     return {
       name: path.relative(process.cwd(), f),
-      load: () => require(path.resolve(process.cwd(), f))
+      load: () => import(new URL(`file://${path.resolve(process.cwd(), f)}`))
     }
   })
   const log = {

package/polendina.js

@@ -1,14 +1,21 @@
-const { promisify } = require('util')
-const path = require('path')
-const fs = require('fs').promises
-const http = require('http')
-const st = require('st')
-const rimraf = promisify(require('rimraf'))
-const webpack = promisify(require('webpack'))
-const merge = require('webpack-merge')
-const puppeteer = require('./lib/puppeteer')
-
-class Polendina {
+import { promisify } from 'util'
+import path from 'path'
+import fs from 'fs'
+import http from 'http'
+import { fileURLToPath } from 'url'
+import st from 'st'
+import _rimraf from 'rimraf'
+import _webpack from 'webpack'
+import { merge } from 'webpack-merge'
+import { run as puppeteer } from './lib/puppeteer.js'
+import { webpackConfig } from './lib/webpack.config.js'
+
+const rimraf = promisify(_rimraf)
+const webpack = promisify(_webpack)
+
+const __dirname = fileURLToPath(path.dirname(import.meta.url))
+
+export class Polendina {
   constructor (options) {
     this._options = options
 
@@ -32,23 +39,40 @@ class Polendina {
   }
 
   async build () {
-    let webpackConfig = require('./lib/webpack.config')(process.env, this._options, this._runnerModule)
+    let config = webpackConfig(process.env, this._options, this._runnerModule)
+
+    if (this._options.runner === 'tape') {
+      config = merge(config, {
+        resolve: {
+          fallback: {
+            stream: path.join(__dirname, 'node_modules', 'stream-browserify'),
+            path: path.join(__dirname, 'node_modules', 'path-browserify'),
+            fs: false
+          }
+        },
+        plugins: [
+          new webpack.ProvidePlugin({
+            process: 'process/browser'
+          })
+        ]
+      })
+    }
 
     if (this._options.webpackConfig) {
-      const userConfig = require(path.join(process.cwd(), this._options.webpackConfig))
-      webpackConfig = merge.smart(webpackConfig, userConfig)
+      const userConfig = (await import(`file://${path.join(process.cwd(), this._options.webpackConfig)}`)).default
+      config = merge(config, userConfig)
     }
 
-    await fs.mkdir(this.outputDir, { recursive: true })
+    await fs.promises.mkdir(this.outputDir, { recursive: true })
     const copyFiles = ['index.html', 'test-registry.js', 'page-run.js', 'common-run.js', this._runnerModule]
     if (this._options.runner.startsWith('bare-')) {
       copyFiles.push('bare.js')
     }
     await Promise.all(copyFiles.map((file) => {
-      return fs.copyFile(path.join(__dirname, 'resources', file), path.join(this.outputDir, file))
+      return fs.promises.copyFile(path.join(__dirname, 'resources', file), path.join(this.outputDir, file))
     }))
 
-    const stats = await webpack(webpackConfig)
+    const stats = await webpack(config)
     const info = stats.toJson()
 
     if (stats.hasErrors()) {
@@ -65,8 +89,8 @@ class Polendina {
     this.bundleFile = info.assetsByChunkName.main[0]
 
     if (this._options.stats) {
-      this.statsFile = path.join(webpackConfig.output.path, 'webpack-stats.json')
-      await fs.writeFile(this.statsFile, JSON.stringify(info), 'utf8')
+      this.statsFile = path.join(config.output.path, 'webpack-stats.json')
+      await fs.promises.writeFile(this.statsFile, JSON.stringify(info), 'utf8')
     }
   }
 
@@ -119,5 +143,3 @@ class Polendina {
     })
   }
 }
-
-module.exports = Polendina

package/resources/bare-run.js

@@ -1,10 +1,10 @@
 // in-browser test runner for bare-sync and bare-async, at end of bundle
 
-const { registry, executionQueue, log, setup } = require('./common-run')
-const BareRunner = require('./bare')
+import { registry, executionQueue, log, setup } from './common-run.js'
+import { BareRunner } from './bare.js'
 
 setup().then(async () => {
   const runner = new BareRunner(log, registry.tests)
   const errors = await runner[registry.argv.runner === 'bare-sync' ? 'runBareSync' : 'runBareAsync']()
-  executionQueue(() => global.polendinaEnd(errors ? 1 : 0))
+  executionQueue(() => globalThis.polendinaEnd(errors ? 1 : 0))
 })

package/resources/bare.js

@@ -1,4 +1,4 @@
-class BareRunner {
+export class BareRunner {
   constructor (log, tests) {
     this.log = log
     this.tests = tests
@@ -36,13 +36,17 @@ class BareRunner {
 
   async runBareAsync () {
     return this.runBare(async (mod) => {
-      const exp = mod.load()
+      const exp = await mod.load()
       if (typeof exp === 'function') {
         return this.execBare(mod.name, exp)
       }
+      const expn = Object.keys(exp)
+      if (expn.length === 1 && expn[0] === 'default' && typeof exp.default === 'function') {
+        return this.execBare(mod.name, exp.default)
+      }
       await this.log.info(`  ${mod.name}`)
       let found = false
-      for (const name in exp) {
+      for (const name of expn) {
         const fn = exp[name]
         if (typeof fn === 'function') {
           found = true
@@ -55,5 +59,3 @@ class BareRunner {
     })
   }
 }
-
-module.exports = BareRunner