Add @ice/store Unit Test

README.md

@@ -10,6 +10,7 @@ English | [简体中文](./README.zh-CN.md)
 [![NPM downloads](http://img.shields.io/npm/dm/@ice/store.svg?style=flat)](https://npmjs.org/package/@ice/store)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@ice/store/badge.svg)](https://snyk.io/test/npm/@ice/store)
 [![David deps](https://img.shields.io/david/ice-lab/icestore.svg?style=flat-square)](https://david-dm.org/ice-lab/icestore)
+[![codecov](https://codecov.io/gh/ice-lab/icestore/branch/master/graph/badge.svg)](https://codecov.io/gh/ice-lab/icestore)
 
 <table>
   <thead>

README.zh-CN.md

@@ -10,6 +10,7 @@
 [![NPM downloads](http://img.shields.io/npm/dm/@ice/store.svg?style=flat)](https://npmjs.org/package/@ice/store)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@ice/store/badge.svg)](https://snyk.io/test/npm/@ice/store)
 [![David deps](https://img.shields.io/david/ice-lab/icestore.svg?style=flat-square)](https://david-dm.org/ice-lab/icestore)
+[![codecov](https://codecov.io/gh/ice-lab/icestore/branch/master/graph/badge.svg)](https://codecov.io/gh/ice-lab/icestore)
 
 <table>
   <thead>

codecov.yml

@@ -1,4 +1,12 @@
-comment: off
+comment:
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false
+  require_base: no
+  require_head: yes
+  branches:
+    - "master"
+
 coverage:
   status:
     project:

examples/todos/src/components/Todos.tsx

@@ -7,16 +7,15 @@ const { useModel, useModelEffectsLoading } = store;
 
 export default function Todos() {
   const todos = useModel('todos');
-  const [ state, dispatchers ] = todos;
+  const [state, dispatchers] = todos;
   const effectsLoading = useModelEffectsLoading('todos');
 
   const { dataSource } = state;
   const { refresh } = dispatchers;
 
   useEffect(() => {
     refresh();
-
-  // eslint-disable-next-line
+    // eslint-disable-next-line
   }, []);
 
   const noTaskView = <div>no task</div>;

examples/todos/src/components/User.tsx

@@ -4,15 +4,14 @@ import store from '../store';
 const { useModel } = store;
 
 export default function UserApp() {
-  const [ state, dispatchers ] = useModel('user');
+  const [state, dispatchers] = useModel('user');
   const { dataSource, auth, todos } = state;
   const { login } = dispatchers;
   const { name } = dataSource;
 
   useEffect(() => {
     login();
-
-  // eslint-disable-next-line
+    // eslint-disable-next-line
   }, []);
 
   console.debug('UserApp rending...');

package.json

@@ -30,23 +30,27 @@
     "prepublishOnly": "npm run lint:nofix && npm run test && npm run build",
     "lint": "npm run lint:nofix -- --fix",
     "lint:nofix": "eslint --cache --ext .ts,.tsx ./",
-    "test": "NODE_ENV=unittest jest",
+    "test": "cross-env NODE_ENV=unittest jest",
+    "test:w": "jest --watch",
     "coverage": "codecov"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.2.0",
     "@commitlint/config-conventional": "^8.2.0",
     "@ice/spec": "^0.1.9",
     "@testing-library/react": "^9.0.0",
-    "@types/jest": "^24.0.12",
+    "@testing-library/react-hooks": "^3.2.1",
+    "@types/jest": "^25.2.1",
     "@types/node": "^12.0.0",
     "codecov": "^3.3.0",
+    "cross-env": "^7.0.2",
     "eslint": "^6.7.2",
     "husky": "^3.0.9",
-    "jest": "^24.7.1",
+    "jest": "^25.2.1",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "ts-jest": "^24.0.2",
+    "react-test-renderer": "^16.13.0",
+    "ts-jest": "^25.2.1",
     "typescript": "^3.7.4"
   },
   "peerDependencies": {
@@ -55,6 +59,10 @@
   "jest": {
     "coverageDirectory": "./coverage/",
     "collectCoverage": true,
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/tests/helpers/",
+      "<rootDir>/node_modules/"
+    ],
     "preset": "ts-jest"
   },
   "dependencies": {
@@ -64,4 +72,4 @@
     "redux": "^4.0.5",
     "redux-thunk": "^2.3.0"
   }
-}
+}

src/types.ts

@@ -276,7 +276,8 @@ export interface ModelEffects<S> {
   [key: string]: (
     this: { [key: string]: (payload?: any, meta?: any) => Action<any, any> },
     payload: any,
-    rootState: S
+    rootState: S,
+    meta: any
   ) => void;
 }
 

tests/helpers/CounterComponent.tsx

@@ -0,0 +1,60 @@
+import React, { PureComponent } from 'react';
+import {
+  ExtractIModelFromModelConfig,
+  ExtractIModelDispatchersFromModelConfig,
+  ExtractIModelEffectsStateFromModelConfig,
+} from '../../src';
+import counterModel from './counter';
+
+interface CounterProps {
+  counter: ExtractIModelFromModelConfig<typeof counterModel>;
+  children: React.ReactNode;
+}
+
+export default class Counter extends PureComponent<CounterProps> {
+  render() {
+    const { counter, children } = this.props;
+    const [state, dispatchers] = counter;
+    const { count } = state;
+    return (
+      <React.Fragment>
+        <div data-testid="count">{count}</div>
+        <div data-testid="setState" onClick={() => dispatchers.setState({ count: 1 })} />
+        <div data-testid="increment" onClick={dispatchers.increment} />
+        <div data-testid="decrement" onClick={dispatchers.decrement} />
+        <div data-testid="decrementAsync" onClick={dispatchers.decrementAsync} />
+        {children}
+      </React.Fragment>
+    );
+  }
+}
+
+interface CounterUseDispathcersProps {
+  counterDispatchers: ExtractIModelDispatchersFromModelConfig<typeof counterModel>;
+};
+export class CounterUseDispathcers extends PureComponent<CounterUseDispathcersProps> {
+  render() {
+    const { counterDispatchers } = this.props;
+    return (
+      <div data-testid="reset" onClick={() => counterDispatchers.reset()} />
+    );
+  }
+};
+
+interface CounterUseEffectsStateProps {
+  counterEffectsState: ExtractIModelEffectsStateFromModelConfig<typeof counterModel>;
+  children: React.ReactChild;
+}
+export class CounterUseEffectsState extends PureComponent<CounterUseEffectsStateProps> {
+  render() {
+    const { counterEffectsState, children } = this.props;
+    return (
+      <React.Fragment>
+        <code data-testid="decrementAsyncEffectsState">
+          {JSON.stringify(counterEffectsState.decrementAsync)}
+        </code>
+        {children}
+      </React.Fragment>
+    );
+  }
+}

tests/helpers/counter.ts

@@ -0,0 +1,64 @@
+import { delay } from './utils';
+
+export interface CounterState {
+  count: number;
+}
+
+const counter = {
+  state: {
+    count: 0,
+  },
+  reducers: {
+    increment: (prevState: CounterState) => prevState.count += 1,
+    decrement: (prevState: CounterState) => prevState.count -= 1,
+    reset: () => ({ count: 0 }),
+  },
+  effects: (dispatch) => ({
+    async decrementAsync(_, rootState) {
+      if (rootState.counter.count <= 0) {
+        throw new Error('count should be greater than or equal to 0');
+      }
+      await delay(1000);
+      this.decrement();
+    },
+  }),
+};
+
+export const counterWithUnsupportEffects = {
+  state: {
+    a: 1,
+  },
+  effects: {
+    incrementA: (state, value) => {
+      return {
+        ...state,
+        a: state.a + value,
+      };
+    },
+  },
+};
+
+export const counterWithUnsupportActions = {
+  state: {
+    a: 1,
+  },
+  actions: {
+    incrementA: (state, value) => {
+      return {
+        ...state,
+        a: state.a + value,
+      };
+    },
+  },
+};
+
+export const counterWithNoImmer = {
+  state: {
+    count: 1,
+  },
+  reducers: {
+    increment: (prevState) => { return prevState.count + 1; },
+  },
+};
+
+export default counter;

tests/helpers/models.ts

@@ -0,0 +1,2 @@
+export { default as todos } from './todos';
+export { default as user } from './user';

tests/helpers/todos.ts

@@ -0,0 +1,45 @@
+import { delay } from './utils';
+
+export interface Todo {
+  name: string;
+  done?: boolean;
+}
+
+export interface TodosState {
+  dataSource: Todo[];
+}
+
+const todos = {
+  state: {
+    dataSource: [
+      {
+        name: 'Init',
+        done: false,
+      },
+    ],
+  },
+
+  reducers: {
+    addTodo(state: TodosState, todo: Todo) {
+      state.dataSource.push(todo);
+    },
+    removeTodo(state: TodosState, index: number) {
+      state.dataSource.splice(index, 1);
+    },
+  },
+
+  effects: (dispatch) => ({
+    add(todo, rootState, { store }) {
+      this.addTodo(todo);
+      dispatch.user.setTodos(store.getModelState('todos').dataSource.length);
+    },
+
+    async delete(index, rootState, { store }) {
+      await delay(1000);
+      this.removeTodo(index);
+      dispatch.user.setTodos(store.getModelState('todos').dataSource.length);
+    },
+  }),
+};
+
+export default todos;

tests/helpers/user.ts

@@ -0,0 +1,21 @@
+interface DataSourceState {
+  name: string;
+}
+class UserStateProps {
+  dataSource: DataSourceState = { name: 'testName' };
+
+  todos: number = 1;
+
+  auth: boolean = false;
+}
+
+const user = {
+  state: new UserStateProps,
+  reducers: {
+    setTodos(state: UserStateProps, todos: number) {
+      state.todos = todos;
+    },
+  },
+};
+
+export default user;

tests/helpers/utils.ts

@@ -0,0 +1 @@
+export const delay = (time) => new Promise((resolve) => setTimeout(() => resolve(), time));