Add Tests w/ 100% Code Coverage

.gitignore

@@ -4,6 +4,7 @@ dist/
 .rts2_cache_cjs
 .rts2_cache_esm
 .rts2_cache_umd
+coverage/
 
 ### Node ###
 

.travis.yml

@@ -1,3 +1,9 @@
 language: node_js
 # default is the very old 0.10.48; match local version instead
-node_js: '8.9'
+node_js: '10.16.0'
+
+script: npm test -- --coverage
+after_script:
+  # upload coverage reports to CodeCov
+  - bash <(curl -s https://codecov.io/bash)
+  - npm run test:pub

README.md

@@ -12,6 +12,7 @@
 <br><!-- status / activity -->
 [![typings](https://img.shields.io/npm/types/mst-persist.svg)](https://github.com/agilgur5/mst-persist/blob/master/src/index.ts)
 [![build status](https://img.shields.io/travis/agilgur5/mst-persist/master.svg)](https://travis-ci.org/agilgur5/mst-persist)
+[![code coverage](https://img.shields.io/codecov/c/gh/agilgur5/mst-persist/master.svg)](https://codecov.io/gh/agilgur5/mst-persist)
 <br>
 [![NPM](https://nodei.co/npm/mst-persist.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/mst-persist)
 

package.json

@@ -29,7 +29,8 @@
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
-    "test": "npm run build && npm pack",
+    "test": "tsdx test",
+    "test:pub": "npm run build && npm pack",
     "pub": "npm run build && npm publish",
     "changelog": "changelog-maker"
   },
@@ -39,9 +40,10 @@
   "dependencies": {},
   "devDependencies": {
     "@agilgur5/changelog-maker": "^3.0.0",
+    "@types/jest": "^24.0.23",
     "mobx": "^5.11.0",
     "mobx-state-tree": "^3.14.0",
-    "tsdx": "^0.7.2",
+    "tsdx": "^0.11.0",
     "typescript": "^3.5.2"
   }
 }

src/asyncLocalStorage.ts

@@ -1,3 +1,5 @@
+// using istanbul ignore on portions of code that are not currently used internally
+
 interface IAsyncLocalStorage {
   clear(): Promise<void>
   getItem(key: string): Promise<string>
@@ -7,13 +9,13 @@ interface IAsyncLocalStorage {
 
 export const AsyncLocalStorage: IAsyncLocalStorage = {
   // must use wrapper functions when passing localStorage functions (https://github.com/agilgur5/mst-persist/issues/18)
-  clear () {
+  clear /* istanbul ignore next */ () {
     return callWithPromise(() => window.localStorage.clear())
   },
   getItem (key) {
     return callWithPromise(() => window.localStorage.getItem(key))
   },
-  removeItem (key) {
+  removeItem /* istanbul ignore next */ (key) {
     return callWithPromise(() => window.localStorage.removeItem(key))
   },
   setItem (key, value) {
@@ -25,6 +27,7 @@ function callWithPromise (func: Function, ...args: any[]): Promise<any> {
   try {
     return Promise.resolve(func(...args))
   } catch (err) {
+    /* istanbul ignore next */
     return Promise.reject(err)
   }
 }

src/index.ts

@@ -34,6 +34,7 @@ export const persist: IArgs = (name, store, options = {}) => {
   const blacklistDict = arrToDict(blacklist)
 
   onSnapshot(store, (_snapshot: StrToAnyMap) => {
+    // need to shallow clone as otherwise properties are non-configurable (https://github.com/agilgur5/mst-persist/pull/21#discussion_r348105595)
     const snapshot = { ..._snapshot }
     Object.keys(snapshot).forEach((key) => {
       if (whitelist && !whitelistDict[key]) {

test/fixtures.ts

@@ -0,0 +1,15 @@
+import { types } from 'mobx-state-tree'
+
+export const UserStoreF = types.model('UserStore', {
+  name: 'John Doe',
+  age: 32
+}).actions((self) => ({
+  changeName(name: string) {
+    self.name = name
+  }
+}))
+
+export const persistedDataF = {
+  name: 'Persisted Name',
+  age: 35
+}

test/index.node.spec.ts

@@ -0,0 +1,16 @@
+/**
+ * @jest-environment node
+ */
+// add tests in this file that are specific to node (vs. jsdom)
+
+/// <reference types="@types/jest" />
+
+import { persist } from '../src/index'
+import { UserStoreF } from './fixtures'
+
+describe('node usage', () => {
+  it('should error on default localStorage usage', async () => {
+    const user = UserStoreF.create()
+    await expect(persist('user', user)).rejects.toMatch(/^localStorage.+$/)
+  })
+})

test/index.spec.ts

@@ -0,0 +1,76 @@
+/// <reference types="@types/jest" />
+import { getSnapshot } from 'mobx-state-tree'
+
+import { persist } from '../src/index'
+import { UserStoreF, persistedDataF } from './fixtures'
+
+function getItem(key: string) {
+  const item = window.localStorage.getItem(key)
+  return item ? JSON.parse(item) : null // can only parse strings
+}
+
+describe('basic persist functionality', () => {
+  beforeEach(() => window.localStorage.clear())
+
+  it('should persist nothing if no actions are used', async () => {
+    const user = UserStoreF.create()
+    await persist('user', user)
+
+    expect(getItem('user')).toBe(null)
+  })
+
+  it('should persist snapshot when action used', async () => {
+    const user = UserStoreF.create()
+    await persist('user', user)
+
+    user.changeName('Joe') // fire action to trigger onSnapshot
+    expect(getItem('user')).toStrictEqual(getSnapshot(user))
+  })
+
+  it('should load persisted data', async () => {
+    window.localStorage.setItem('user', JSON.stringify(persistedDataF))
+
+    const user = UserStoreF.create()
+    await persist('user', user)
+    expect(getSnapshot(user)).toStrictEqual(persistedDataF)
+  })
+})
+
+describe('persist options', () => {
+  beforeEach(() => window.localStorage.clear())
+
+  it('shouldn\'t jsonify', async () => {
+    const user = UserStoreF.create()
+    await persist('user', user, {
+      jsonify: false
+    })
+
+    user.changeName('Joe') // fire action to trigger onSnapshot
+    // if not jsonified, localStorage will store as '[object Object]'
+    expect(window.localStorage.getItem('user')).toBe('[object Object]')
+  })
+
+  it('should whitelist', async () => {
+    const user = UserStoreF.create()
+    await persist('user', user, {
+      whitelist: ['name']
+    })
+
+    user.changeName('Joe') // fire action to trigger onSnapshot
+    const snapshot = { ...getSnapshot(user) } // need to shallow clone as otherwise properties are non-configurable (https://github.com/agilgur5/mst-persist/pull/21#discussion_r348105595)
+    delete snapshot['age']
+    expect(getItem('user')).toStrictEqual(snapshot)
+  })
+
+  it('should blacklist', async () => {
+    const user = UserStoreF.create()
+    await persist('user', user, {
+      blacklist: ['age']
+    })
+
+    user.changeName('Joe') // fire action to trigger onSnapshot
+    const snapshot = { ...getSnapshot(user) } // need to shallow clone as otherwise properties are non-configurable (https://github.com/agilgur5/mst-persist/pull/21#discussion_r348105595)
+    delete snapshot['age']
+    expect(getItem('user')).toStrictEqual(snapshot)
+  })
+})