[updates] More unit tests (jest), CI (circle), etc (dollarshaveclub#61)

* [bug] fixes spelling

* [update] adds more tests; config updates

* [init] adds initial circle setup

* [update] adds tests: messageId/log fn

* [update] init sanitize tests

Author: yowainwright

.circleci/config.yml

@@ -0,0 +1,30 @@
+defaults: &defaults
+  working_directory: ~/code
+  docker:
+    - image: circleci/node:8
+      environment:
+        NPM_CONFIG_LOGLEVEL: error # make npm commands less noisy
+        JOBS: max # https://gist.github.com/ralphtheninja/f7c45bdee00784b41fed
+
+restore_cache: &restore_cache
+  keys:
+    - code-{{ .Branch }}-{{ checksum ".nvmrc" }}-{{ checksum "package.json" }}
+    - code-master-{{ checksum ".nvmrc" }}-{{ checksum "package.json" }}
+
+save_cache: &save_cache
+  key: code-{{ .Branch }}-{{ checksum ".nvmrc" }}-{{ checksum "package.json" }}
+  paths:
+    - node_modules
+
+version: 2
+jobs:
+  build:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache: *restore_cache
+      - run: npm install
+      - run: npm run eslint:ci
+      - run: npm test
+      - run: npx codecov
+      - save_cache: *save_cache

jsconfig.json

@@ -0,0 +1 @@
+{"compilerOptions":{"target":"es6","experimentalDecorators":true},"exclude":["node_modules","bower_components","tmp","vendor",".git","dist"]}

package.json

@@ -39,11 +39,12 @@
     "vinyl-source-stream": "^2.0.0"
   },
   "scripts": {
-    "eslint": "eslint . --fix .",
+    "eslint": "eslint . --fix",
+    "eslint:ci": "eslint .",
     "test": "npm run test:unit && npm run test:acceptance && npm run test:es-check",
     "test:es-check": "es-check es5 build/postmate.min.js",
-    "test:unit": "nyc jest --coverage",
-    "test:acceptance": "gulp test --coverage",
+    "test:unit": "jest --coverage",
+    "test:acceptance": "gulp test",
     "build": "npm run build:dist && npm run build:readme",
     "build:readme": "node ./scripts/update-readme.js",
     "build:dist": "rollup --config configs/rollup.config.js",

src/postmate.js

@@ -3,7 +3,7 @@
  * The type of messages our frames our sending
  * @type {String}
  */
-export const messsageType = 'application/x-postmate-v1+json'
+export const messageType = 'application/x-postmate-v1+json'
 
 /**
  * hasOwnProperty()
@@ -22,13 +22,13 @@ export const maxHandshakeRequests = 5
  * A unique message ID that is used to ensure responses are sent to the correct requests
  * @type {Number}
  */
-let _messageId = 0
+const _messageId = 0
 
 /**
  * Increments and returns a message ID
  * @return {Number} A unique ID for a message
  */
-export const messageId = () => ++_messageId
+export const messageId = () => _messageId + 1
 
 /**
  * Postmate logging function that enables/disables via config
@@ -231,14 +231,12 @@ export class ChildAPI {
  * @type {Class}
  */
 class Postmate {
-  static debug = false // eslint-disable-line no-undef
-
   // Internet Explorer craps itself
   static Promise = (() => {
     try {
       return window ? window.Promise : Promise
     } catch (e) {
-      return null
+      return log('Promise: error', e)
     }
   })()
 

test/unit/test.postmate.js

@@ -3,16 +3,37 @@ import {
   log,
   maxHandshakeRequests,
   messageId,
-  message_type,
+  messageType,
   ParentAPI,
   Postmate,
   resolveOrigin,
   resolveValue,
   sanitize,
 } from '../../src/postmate'
 
-// Jest works
-test('Jest is working', () => expect(1).toBe(1))
+test('Message Type', () => expect(messageType).toBe('application/x-postmate-v1+json'))
+
+test('messageId', () => expect(!isNaN(messageId())).toBe(true))
+
+test('messageId adds 1', () => {
+  const result = messageId()
+  expect(result).toBe(1)
+})
+
+test('postmate logs args', () => {
+  Postmate.debug = true
+  console.log = jest.fn()
+  log('a', 'b', 'c')
+  expect(typeof log !== 'undefined')
+  expect(typeof log).toBe('function')
+  expect(console.log.mock.calls[0][0]).toBe('a')
+  expect(console.log.mock.calls[0][1]).toBe('b')
+  expect(console.log.mock.calls[0][2]).toBe('c')
+})
+
+test('Sanitize', () => {
+  expect(typeof sanitize !== 'undefined')
+})
 
 // test API
 // the tests below test the API generally
@@ -31,11 +52,6 @@ test('ChildAPI class is ready to rock', () => {
   expect(typeof ChildAPI.emit !== 'undefined')
 })
 
-test('log func is ready to rock', () => {
-  expect(typeof log !== 'undefined')
-  expect(typeof log).toBe('function')
-})
-
 test('maxHandshakeRequests class is ready to rock', () => {
   expect(maxHandshakeRequests === 5)
 })
@@ -55,6 +71,9 @@ test('ParentAPI class is ready to rock', () => {
 
 test('resolveOrigin class is ready to rock', () => {
   expect(typeof resolveOrigin !== 'undefined')
+  const result = 'https://sometest.com'
+  const a = resolveOrigin(result)
+  expect(a).toEqual(result)
 })
 
 test('resolveValue class is ready to rock', () => {