Housekeeping, remove PhantomJS + use headless chrome (#125)

Author: silesky

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/node:8-browsers
+      - image: circleci/node:14-browsers
     steps:
       - checkout
       - run: npm config set "//registry.npmjs.org/:_authToken" $NPM_AUTH
@@ -14,28 +14,32 @@ jobs:
       NPM_CONFIG_PROGRESS: false
       NPM_CONFIG_SPIN: false
       TEST_REPORTS_DIR: $CIRCLE_TEST_REPORTS
-  publish:
-    docker:
-      - image: circleci/node:8-browsers
-    steps:
-      - checkout
-      - run: make build
-      - run: npm config set "//registry.npmjs.org/:_authToken" $NPM_AUTH
-      - run: npm publish .
 
-workflows:
-  version: 2
-  test_and_publish:
-    jobs:
-      - build:
-          filters:
-            tags:
-              only: /.*/
-      - publish:
-          requires:
-            - build
-          filters:
-            tags:
-              only: /[0-9]+(\.[0-9]+)*(-.+)?/
-            branches:
-              ignore: /.*/
+
+  # Disabling because people seem to be publishing manually for the last few years.
+  # We are no longer using CircleCI as a company (and I think we'd need a to set a new npm automation token).
+
+  # publish:
+  #   docker:
+  #     - image: circleci/node:14-browsers
+  #   steps:
+  #     - checkout
+  #     - run: make build
+  #     - run: npm config set "//registry.npmjs.org/:_authToken" $NPM_AUTH
+  #     - run: npm publish .
+# workflows:
+#   version: 2
+#   test_and_publish:
+#     jobs:
+#       - build:
+#           filters:
+#             tags:
+#               only: /.*/
+#       - publish:
+#           requires:
+#             - build
+#           filters:
+#             tags:
+#               only: /[0-9]+(\.[0-9]+)*(-.+)?/
+#             branches:
+#               ignore: /.*/

Makefile

@@ -3,7 +3,6 @@
 ##
 
 ESLINT := node_modules/.bin/eslint
-ISTANBUL := node_modules/.bin/istanbul
 KARMA := node_modules/.bin/karma
 MATCHA := node_modules/.bin/matcha
 MOCHA := node_modules/.bin/mocha
@@ -47,20 +46,13 @@ MOCHA_FLAGS := \
 	--reporter "$(MOCHA_REPORTER)" \
 	--ui bdd
 
-# Istanbul flags.
-COVERAGE_DIR ?= coverage
-ISTANBUL_FLAGS := \
-	--root "./lib" \
-	--include-all-sources true \
-	--dir "$(COVERAGE_DIR)/Node $(shell node -v)"
-
 ##
 # Tasks
 ##
 
 # Install node modules.
 node_modules: package.json $(wildcard node_modules/*/package.json)
-	@npm install
+	@npm ci
 	@touch $@
 
 # Install dependencies.
@@ -96,7 +88,7 @@ bench: install build
 
 # Run unit tests in node.
 test-node: install build
-	@NODE_ENV=test $(ISTANBUL) cover $(ISTANBUL_FLAGS) $(_MOCHA) -- $(MOCHA_FLAGS) test/render.test.js
+	@NODE_ENV=test  $(_MOCHA) -- $(MOCHA_FLAGS) test/render.test.js
 .PHONY: test-node
 
 # Run browser unit tests in a browser.
@@ -105,6 +97,6 @@ test-browser: install build
 .PHONY: test-browser
 
 # Default test target.
-test: lint bench test-node test-browser
+test: bench test-node test-browser
 .PHONY: test
 .DEFAULT_GOAL = test

README.md

@@ -51,3 +51,22 @@ Returns the maxified version of the analytics.js snippet given a set of `options
 ### snippet.min(options)
 
 Returns the minified version of the snippet.
+
+
+## Development
+
+### Installation + Running Tests
+```
+nvm use
+make install 
+make test
+```
+
+## Publishing to `npm`
+```
+git co master
+make build
+npm version <patch|minor|major>
+git push --follow-tags
+npm publish
+```

karma.conf.ci.js

@@ -58,7 +58,7 @@ module.exports = function(config) {
 
     reporters: ['progress', 'junit', 'coverage'],
 
-    browsers: ['PhantomJS'].concat(Object.keys(customLaunchers)),
+    browsers: Object.keys(customLaunchers),
 
     customLaunchers: customLaunchers,
 

karma.conf.js

@@ -1,24 +1,28 @@
 /* eslint-env node */
 'use strict';
+const { chromium } = require('playwright-chromium')
+
+process.env.CHROME_BIN = chromium.executablePath()
 
 module.exports = function(config) {
   config.set({
+    autoWatch: false,
+    singleRun: true,
     files: [
       // https://app.segment.com/segment-libraries/sources/snippet/settings/keys
       'https://cdn.segment.com/analytics.js/v1/zCueSsEKipbrRgqbJarlTG8UJsAZWpkm/analytics.js',
       'test/**/*.test.js'
     ],
 
-    browsers: ['PhantomJS'],
+    browsers: ['ChromeHeadless'],
 
     frameworks: ['browserify', 'mocha'],
 
-    reporters: ['spec', 'coverage'],
-
+    reporters: ['spec'],
+    
     preprocessors: {
-      'test/**/*.js': 'browserify'
+      'test/**/*.js': ['browserify']
     },
-
     client: {
       mocha: {
         grep: process.env.GREP,
@@ -27,28 +31,6 @@ module.exports = function(config) {
       }
     },
 
-    browserify: {
-      debug: true,
-      transform: [
-        [
-          'browserify-istanbul',
-          {
-            instrumenterConfig: {
-              embedSource: true
-            }
-          }
-        ]
-      ]
-    },
-
-    coverageReporter: {
-      reporters: [
-        { type: 'text' },
-        { type: 'html' },
-        { type: 'json' }
-      ]
-    },
-
     plugins: [
       'karma-*'
     ]