refactor project structure

Author: solkimicreb

.circleci/config.yml

@@ -18,3 +18,4 @@ jobs:
       - run: npm install
       - run: npm run lint
       - run: npm test
+      - run: npm run coveralls

.gitignore

@@ -35,6 +35,7 @@ build/Release
 # Dependency directories
 node_modules/
 jspm_packages/
+package-lock.json
 
 # Typescript v1 declaration files
 typings/
@@ -56,4 +57,3 @@ typings/
 
 # dotenv environment variables file
 .env
-

karma.conf.js

@@ -1,17 +1,54 @@
+const resolve = require('rollup-plugin-node-resolve')
+const commonjs = require('rollup-plugin-commonjs')
+const coverage = require('rollup-plugin-coverage')
+const alias = require('rollup-plugin-alias')
+
+const bundleType = process.env.BUNDLE_TYPE
+const bundlePath = bundleType ? `dist/${bundleType}.js` : 'src/index.js'
+
 module.exports = function (config) {
   config.set({
-    frameworks: ['mocha', 'chai'],
-    files: ['*.test.js'],
-    reporters: ['progress'],
+    frameworks: ['mocha', 'chai', 'source-map-support'],
+    files: ['tests/**/*.test.js'],
+    reporters: ['progress', 'coverage'],
     preprocessors: {
-      '*.test.js': ['webpack']
+      'tests/**/*.test.js': ['rollup']
     },
-    port: 9876,  // karma web server port
+    rollupPreprocessor: {
+      plugins: [
+        resolve(),
+        commonjs({
+          namedExports: {
+            'node_modules/chai/index.js': ['expect']
+          }
+        }),
+        coverage({
+          include: ['src/**/*.js']
+        })
+      ],
+      format: 'iife',
+      name: 'historyThrottler',
+      sourcemap: 'inline'
+    },
+    coverageReporter: {
+      dir: 'coverage',
+      reporters: [
+        { type: 'lcov', subdir: '.' },
+        { type: 'text-summary' }
+      ]
+    },
+    port: 9876,
     colors: true,
     logLevel: config.LOG_INFO,
-    browsers: ['ChromeHeadless'],
     autoWatch: false,
-    // singleRun: false, // Karma captures browsers, runs the tests and exits
-    concurrency: Infinity
+    concurrency: Infinity,
+    singleRun: true,
+    browsers: ['ChromeHeadlessNoSandbox'],
+    customLaunchers: {
+      ChromeHeadlessNoSandbox: {
+        base: 'ChromeHeadless',
+        flags: ['--no-sandbox']
+      }
+    }
   })
 }

package.json

@@ -2,11 +2,12 @@
   "name": "history-throttler",
   "version": "1.0.0",
   "description": "A simple fix for unwanted duplicate history entries on the frontend",
-  "main": "throttleHistory.js",
+  "main": "src/throttleHistory.js",
   "scripts": {
-    "test": "karma start --single-run --browsers ChromeHeadless karma.conf.js",
+    "test": "karma start karma.conf.js",
     "lint": "standard",
-    "lint:fix": "standard --fix"
+    "lint:fix": "standard --fix",
+    "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
   },
   "author": {
     "name": "Miklos Bertalan",
@@ -35,11 +36,18 @@
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^2.2.0",
     "karma-mocha": "^1.3.0",
-    "karma-webpack": "^2.0.4",
+    "karma-coverage": "^1.1.1",
+    "karma-rollup-preprocessor": "^5.0.1",
+    "karma-source-map-support": "^1.2.0",
+    "rollup": "^0.49.0",
+    "rollup-plugin-commonjs": "^8.2.0",
+    "rollup-plugin-coverage": "^0.1.4",
+    "rollup-plugin-node-resolve": "^3.0.0",
     "mocha": "^3.5.0",
+    "nyc": "11.1.0",
     "pre-push": "^0.1.1",
     "standard": "^10.0.3",
-    "webpack": "^3.5.4"
+    "coveralls": "^2.13.1"
   },
   "standard": {
     "env": [

throttleHistory.js renamed to src/throttleHistory.js

@@ -2,7 +2,7 @@ const originalPushState = history.pushState
 let statePushedInCurrentTick = false
 
 export default function pushState () {
-  if (!statePushedInCurrentTick && document.readyState === 'completed') {
+  if (!statePushedInCurrentTick && document.readyState === 'complete') {
     // allow pushState if it is the first one since the last paint and the document is loaded
     originalPushState.apply(history, arguments)
     flagOn()

tests/throttleHistory.test.js

@@ -0,0 +1,39 @@
+import { expect } from 'chai'
+import pushState from '../src/throttleHistory'
+import { pageLoad, nextRender } from './utils'
+
+describe('do not allow push state before the load event', () => {
+  // 'it' blocks run after the page load, so this must remain here
+  const startLength = history.length
+  pushState(undefined, '', '')
+  expect(history.length).to.equal(startLength)
+})
+
+describe('throttle history', () => {
+  before(async () => {
+    await pageLoad()
+  })
+
+  it('should allow the first pushState call after a repaint', () => {
+    const startLength = history.length
+    pushState(undefined, '', '')
+    expect(history.length).to.equal(startLength + 1)
+  })
+
+  it('should throttle later pushStates by replacing them by replaceState', () => {
+    const startLength = history.length
+    pushState(undefined, '', '')
+    pushState(undefined, '', '')
+    expect(history.length).to.equal(startLength)
+  })
+
+  it('should allow a new pushState after a repaint', async () => {
+    const startLength = history.length
+    pushState(undefined, '', '')
+    expect(history.length).to.equal(startLength)
+
+    await nextRender()
+    pushState(undefined, '', '')
+    expect(history.length).to.equal(startLength + 1)
+  })
+})

tests/utils.js

@@ -0,0 +1,10 @@
+export function nextRender () {
+  return new Promise(requestAnimationFrame)
+}
+
+export function pageLoad () {
+  if (document.readyState === 'complete') {
+    return Promise.resolve()
+  }
+  return new Promise(resolve => window.addEventListener('load', resolve))
+}