Offload browser test transforms to karma runner

Author: ali-ince

gulpfile.babel.js

@@ -48,18 +48,16 @@ var log = require('fancy-log')
 const enableActiveNodeHandlesLogging = false
 
 /** Build all-in-one files for use in the browser */
-gulp.task('build-browser', async function () {
+gulp.task('browser', async function () {
   const browserOutput = 'lib/browser'
   // Our app bundler
   const appBundler = browserify({
     entries: ['src/index.js'],
     cache: {},
     standalone: 'neo4j',
-    packageCache: {}
-  })
-    .transform(babelifyTransform())
-    .transform(browserifyTransformNodeToBrowserRequire())
-    .bundle()
+    packageCache: {},
+    transform: ['babelify', './support/inject-browser-transform']
+  }).bundle()
 
   // Un-minified browser package
   await appBundler
@@ -75,65 +73,21 @@ gulp.task('build-browser', async function () {
     .pipe(gulp.dest(browserOutput))
 })
 
-gulp.task('build-browser-test', async function () {
-  const browserOutput = 'build/browser/'
-  const testFiles = []
-
-  return gulp
-    .src(['./test/**/!(examples).test.js', '!./test/**/node/*.js'])
-    .pipe(
-      through.obj(
-        function (file, enc, cb) {
-          testFiles.push(file.path)
-          cb()
-        },
-        function (cb) {
-          // At end-of-stream, push the list of files to the next step
-          this.push(testFiles)
-          cb()
-        }
-      )
-    )
-    .pipe(
-      through.obj(function (testFiles, enc, cb) {
-        browserify({
-          entries: testFiles,
-          cache: {},
-          debug: true
-        })
-          .transform(babelifyTransform())
-          .transform(browserifyTransformNodeToBrowserRequire())
-          .bundle()
-          .on('error', log.error)
-          .pipe(source('neo4j-web.test.js'))
-          .pipe(gulp.dest(browserOutput))
-          .on('end', cb)
-      })
-    )
-})
-
-var buildNode = function (options) {
-  return gulp
-    .src(options.src)
-    .pipe(babel(babelConfig()))
-    .pipe(gulp.dest(options.dest))
-}
-
 gulp.task('nodejs', function () {
-  return buildNode({
-    src: 'src/**/*.js',
-    dest: 'lib'
-  })
+  return gulp
+    .src('src/**/*.js')
+    .pipe(babel())
+    .pipe(gulp.dest('lib'))
 })
 
 // prepares directory for package.test.js
 gulp.task(
   'install-driver-into-sandbox',
   gulp.series('nodejs', function () {
-    var testDir = path.join('build', 'sandbox')
+    const testDir = path.join('build', 'sandbox')
     fs.emptyDirSync(testDir)
 
-    var packageJsonContent = JSON.stringify({
+    const packageJsonContent = JSON.stringify({
       private: true,
       dependencies: {
         'neo4j-driver': __dirname
@@ -169,14 +123,6 @@ gulp.task('run-browser-test-firefox', function (cb) {
   runKarma('firefox', cb)
 })
 
-gulp.task('run-browser-test-edge', function (cb) {
-  runKarma('edge', cb)
-})
-
-gulp.task('run-browser-test-ie', function (cb) {
-  runKarma('ie', cb)
-})
-
 gulp.task('run-browser-test', gulp.series('run-browser-test-firefox'))
 
 gulp.task('watch', function () {
@@ -198,21 +144,21 @@ gulp.task(
 /** Set the project version, controls package.json and version.js */
 gulp.task('set', function () {
   // Get the --version arg from command line
-  var version = minimist(process.argv.slice(2), { string: 'version' }).version
+  const version = minimist(process.argv.slice(2), { string: 'version' }).version
 
   if (!semver.valid(version)) {
     throw new Error(`Invalid version "${version}"`)
   }
 
   // Change the version in relevant files
-  var versionFile = path.join('src', 'version.js')
+  const versionFile = path.join('src', 'version.js')
   return gulp
     .src([versionFile], { base: './' })
     .pipe(replace('0.0.0-dev', version))
     .pipe(gulp.dest('./'))
 })
 
-var neo4jHome = path.resolve('./build/neo4j')
+const neo4jHome = path.resolve('./build/neo4j')
 
 gulp.task('start-neo4j', function (done) {
   sharedNeo4j.start(neo4jHome, process.env.NEOCTRL_ARGS)
@@ -236,9 +182,7 @@ gulp.task('run-stress-tests', function () {
     .on('end', logActiveNodeHandles)
 })
 
-gulp.task('run-ts-declaration-tests', function () {
-  var failed = false
-
+gulp.task('run-ts-declaration-tests', function (done) {
   return gulp
     .src(['test/types/**/*', 'types/**/*'], { base: '.' })
     .pipe(
@@ -250,25 +194,14 @@ gulp.task('run-ts-declaration-tests', function () {
         strictNullChecks: true
       })
     )
-    .on('error', function () {
-      failed = true
-    })
-    .on('finish', function () {
-      if (failed) {
-        console.log(
-          '[ERROR] TypeScript declarations contain errors. Exiting...'
-        )
-        process.exit(1)
-      }
-    })
     .pipe(gulp.dest('build/test/types'))
+    .on('error', err => done(err))
+    .on('end', () => done())
 })
 
-gulp.task('browser', gulp.series('build-browser-test', 'build-browser'))
-
 gulp.task('all', gulp.series('nodejs', 'browser'))
 
-gulp.task('test-browser', gulp.series('all', 'run-browser-test'))
+gulp.task('test-browser', gulp.series('browser', 'run-browser-test'))
 
 gulp.task(
   'test',
@@ -297,38 +230,6 @@ function newJasmineConsoleReporter () {
   })
 }
 
-function babelifyTransform () {
-  return babelify.configure(babelConfig())
-}
-
-function babelConfig () {
-  return {
-    presets: [['@babel/preset-env']],
-    plugins: ['@babel/plugin-transform-runtime']
-  }
-}
-
-function browserifyTransformNodeToBrowserRequire () {
-  var nodeRequire = '/node'
-  var browserRequire = '/browser'
-
-  return transformTools.makeRequireTransform(
-    'bodeToBrowserRequireTransform',
-    { evaluateArguments: true },
-    function (args, opts, cb) {
-      var requireArg = args[0]
-      var endsWithNodeRequire =
-        requireArg.slice(-nodeRequire.length) === nodeRequire
-      if (endsWithNodeRequire) {
-        var newRequireArg = requireArg.replace(nodeRequire, browserRequire)
-        return cb(null, "require('" + newRequireArg + "')")
-      } else {
-        return cb()
-      }
-    }
-  )
-}
-
 function runKarma (browser, cb) {
   new karma.Server(
     {

package-lock.json

@@ -76,11 +76,13 @@
     "husky": "^2.3.0",
     "jasmine-console-reporter": "^3.1.0",
     "karma": "^4.1.0",
+    "karma-browserify": "^6.0.0",
     "karma-chrome-launcher": "^2.2.0",
     "karma-edge-launcher": "^0.4.2",
     "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
     "karma-jasmine": "^2.0.1",
+    "karma-source-map-support": "^1.4.0",
     "karma-spec-reporter": "^0.0.32",
     "lint-staged": "^8.1.6",
     "lodash": "^4.17.11",
@@ -91,7 +93,6 @@
     "prettier-eslint-cli": "^4.7.1",
     "run-sequence": "^2.2.1",
     "semver": "^6.0.0",
-    "through2": "~3.0.1",
     "tmp": "0.1.0",
     "typescript": "^3.4.5",
     "vinyl-buffer": "^1.0.1",

package.json

@@ -0,0 +1,20 @@
+const transformTools = require('browserify-transform-tools')
+
+const nodeRequire = '/node'
+const browserRequire = '/browser'
+
+module.exports = transformTools.makeRequireTransform(
+  'nodeToBrowserRequireTransform',
+  { evaluateArguments: true },
+  function (args, opts, cb) {
+    const requireArg = args[0]
+    const endsWithNodeRequire =
+      requireArg.slice(-nodeRequire.length) === nodeRequire
+    if (endsWithNodeRequire) {
+      const newRequireArg = requireArg.replace(nodeRequire, browserRequire)
+      return cb(null, "require('" + newRequireArg + "')")
+    } else {
+      return cb()
+    }
+  }
+)

support/inject-browser-transform.js

@@ -18,9 +18,21 @@
  */
 module.exports = function (config) {
   config.set({
-    frameworks: ['jasmine'],
     basePath: '../../',
-    files: ['build/browser/neo4j-web.test.js'],
+    browserify: {
+      debug: true,
+      transform: ['babelify', './support/inject-browser-transform']
+    },
+    files: [
+      'src/**/!(node)/*.js',
+      'test/**/!(node)/*.test.js',
+      'test/!(examples).test.js'
+    ],
+    preprocessors: {
+      'src/**/*.js': ['browserify'],
+      'test/**/*.test.js': ['browserify']
+    },
+    frameworks: ['browserify', 'source-map-support', 'jasmine'],
     reporters: ['spec'],
     port: 9876, // karma web server port
     colors: true,