Added tests

src/configure-injection.spec.tsx

@@ -0,0 +1,154 @@
+// tslint:disable:max-classes-per-file
+
+import 'reflect-metadata';
+
+import Enzyme, { shallow } from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+import { Container, injectable } from 'inversify';
+import React, { Component } from 'react';
+import ReactDOM from 'react-dom';
+import { configureInjection } from './configure-injection';
+import { ReactiveService } from './reactive-service';
+
+// Configure enzyme.
+Enzyme.configure({ adapter: new Adapter() });
+
+interface SampleState {
+  sample: string;
+}
+
+@injectable()
+// @ts-ignore
+class SampleService extends ReactiveService<SampleState> {
+  protected state: SampleState = {
+    sample: 'value1',
+  };
+
+  public get sample(): string {
+    return this.state.sample;
+  }
+
+  public setSample(sample: string): void {
+    this.setState({
+      sample,
+    });
+  }
+}
+
+interface SampleProps {
+  normalProp: string;
+  sampleService: SampleService;
+}
+
+const sampleIdent = 'sample-service';
+const injectConfig = {
+  sampleService: sampleIdent,
+};
+
+let container: Container;
+let config: ReturnType<typeof configureInjection>;
+let sampleProps: SampleProps;
+
+class SampleComponent extends Component<SampleProps> {
+  public state = { test: 'testing' };
+
+  public constructor(props: SampleProps) {
+    super(props);
+    sampleProps = props;
+  }
+
+  public render() {
+    return (
+      <>
+        <div className="render">test render</div>
+        <p className="normal">{this.props.normalProp}</p>
+        <p className="sample">{this.props.sampleService.sample}</p>
+      </>
+    );
+  }
+}
+
+function init() {
+  return {
+    div: document.createElement('div'),
+    IP: config.InjectionProvider,
+    InjectedComponent: config.injectComponent(injectConfig)(SampleComponent),
+  };
+}
+
+function renderHtml(shallowRend: Enzyme.ShallowWrapper<any, Readonly<{}>, React.Component<{}, {}, any>>) {
+  return new DOMParser().parseFromString(shallowRend.html(), 'text/html');
+}
+
+function flushPromises() {
+  return new Promise(resolve => setImmediate(resolve));
+}
+
+beforeEach(() => {
+  container = new Container();
+  container.bind(sampleIdent).to(SampleService).inSingletonScope();
+
+  config = configureInjection();
+});
+
+it('initialises', () => {
+  const {
+    div,
+    IP,
+    InjectedComponent,
+  } = init();
+
+  ReactDOM.render(
+    <IP container={container}>
+      <InjectedComponent normalProp="tesing prop" />
+    </IP>,
+    div,
+  );
+  ReactDOM.unmountComponentAtNode(div);
+});
+
+it('support passing the container by props', () => {
+  const {
+    div,
+    InjectedComponent,
+  } = init();
+
+  ReactDOM.render(
+    <InjectedComponent normalProp="tesing prop" container={container} />,
+    div,
+  );
+  ReactDOM.unmountComponentAtNode(div);
+});
+
+it('passes an instance of the injected service to the injected component', () => {
+  const {
+    InjectedComponent,
+  } = init();
+
+  const rend = shallow(<InjectedComponent normalProp="tesing prop" container={container} />);
+  const doc = renderHtml(rend);
+
+  expect(sampleProps.sampleService).toBeInstanceOf(SampleService);
+  expect(doc.querySelector('.sample')!.textContent).toBe('value1');
+});
+
+it('updates the component when the service state changes', async () => {
+  const {
+    div,
+    InjectedComponent,
+  } = init();
+
+  ReactDOM.render(
+    <InjectedComponent normalProp="tesing prop" container={container} />,
+    div,
+  );
+
+  expect(sampleProps.sampleService).toBeInstanceOf(SampleService);
+
+  sampleProps.sampleService.setSample('new value');
+  await flushPromises();
+
+  expect(div.querySelector('.sample')!.textContent).toBe('new value');
+
+  ReactDOM.unmountComponentAtNode(div);
+});

src/configure-injection.tsx

@@ -56,13 +56,13 @@ export function configureInjection(defaultContainer?: Container) {
     injectComponent<TInject extends InjectConfig>(
       inject: TInject,
     ) {
-      type TActualProps<TBase> = Omit<TBase, keyof Shared<TInject, TBase>> & { container?: Container };
+      type RemoveInjectedProps<TBase> = Omit<TBase, keyof Shared<TInject, TBase>> & { container?: Container };
 
       // Return an full-bodied function to prevent syntax errors due to JSX conflicts.
       return function <TBaseProps>(
         Component: ComponentType<TBaseProps>,
-      ): ComponentType<TActualProps<TBaseProps>> {
-        const injector = class extends React.Component<TActualProps<TBaseProps>> {
+      ): ComponentType<RemoveInjectedProps<TBaseProps>> {
+        const injector = class extends React.Component<RemoveInjectedProps<TBaseProps>> {
           private services: Record<string, any> = {};
 
           public componentDidMount() {
@@ -92,6 +92,7 @@ export function configureInjection(defaultContainer?: Container) {
                   }
 
                   // Get the necessary services that we need to inject.
+                  // Unbind handlers first to prevent memory leaks.
                   this.unbindHandlers();
                   this.services = {};
                   for (const key of Object.keys(inject)) {

src/state-tracker.ts

@@ -17,7 +17,7 @@ export class StateTracker<TState, TService extends IStatefulService<TState>> {
   public handlers = new Set<HandlerFn>();
 
   private changes: Array<StateChange<TState>> = [];
-  private intervalTracker?: number;
+  private scheduledUpdate = false;
 
   public constructor(
     private service: TService,
@@ -26,8 +26,9 @@ export class StateTracker<TState, TService extends IStatefulService<TState>> {
   public enqueueUpdate(update: StateChange<TState>): void {
     this.changes.push(update);
 
-    if (!this.intervalTracker) {
-      this.intervalTracker = setTimeout(() => this.handleUpdate());
+    if (!this.scheduledUpdate) {
+      Promise.resolve().then(() => this.handleUpdate());
+      this.scheduledUpdate = true;
     }
   }
 
@@ -61,8 +62,19 @@ export class StateTracker<TState, TService extends IStatefulService<TState>> {
       }
     }
 
+    this.scheduledUpdate = false;
     if (performedChange) {
+      // Copy all of the handlers to a separate list.
+      // This is because when each handler is fired, there's a chance
+      // that the component it's from will unbind & rebind, causing the next
+      // item in the set to be the same handler.
+      const handlers: HandlerFn[] = [];
       for (const handler of this.handlers) {
+        handlers.push(handler);
+      }
+
+      // Fire all the handlers.
+      for (const handler of handlers) {
         handler();
       }
 

testing/project/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

testing/project/README.md

@@ -0,0 +1,48 @@
+# Test Project
+You have to remove the 'isolatedModules' flag from the react-scripts config for this project to work properly.
+
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.<br>
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br>
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br>
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br>
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br>
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

testing/project/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "test-project",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@types/jest": "23.3.9",
+    "@types/node": "10.12.9",
+    "@types/react": "16.7.6",
+    "@types/react-dom": "16.0.9",
+    "inversify": "^5.0.1",
+    "react": "^16.6.3",
+    "react-dom": "^16.6.3",
+    "react-scripts": "2.1.1",
+    "reflect-metadata": "^0.1.12",
+    "typescript": "3.1.6"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": "react-app"
+  },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not ie <= 11",
+    "not op_mini all"
+  ]
+}

testing/project/public/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <!--
+      manifest.json provides metadata used when your web app is added to the
+      homescreen on Android. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json">
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>
+      You need to enable JavaScript to run this app.
+    </noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

testing/project/public/manifest.json

@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}