Merge pull request #56 from mmcardle/master

Make pool job propagate progress event

Author: andywer

CHANGELOG.md

@@ -1,5 +1,11 @@
 # threads.js - Changelog
 
+## Next release
+
+- Job class now emits 'progress' events
+[#56](https://github.com/andywer/threads.js/pull/56)
+- Credits to https://github.com/mmcardle
+
 ## 0.7.3
 
 - Trigger worker error event on unhandled promise rejection in worker [#49](https://github.com/andywer/threads.js/issues/49)

src/job.js

@@ -34,9 +34,20 @@ export default class Job extends EventEmitter {
   }
 
   executeOn(thread) {
+    const onProgress = (...args) => this.emit('progress', ...args);
+    const onMessage = (...args) => {
+      this.emit('done', ...args);
+      thread.removeListener('progress', onProgress);
+    };
+    const onError = (...args) => {
+      this.emit('error', ...args);
+      thread.removeListener('progress', onProgress);
+    };
+    
     thread
-      .once('message', this.emit.bind(this, 'done'))
-      .once('error', this.emit.bind(this, 'error'))
+      .on('progress', onProgress)
+      .once('message', onMessage)
+      .once('error', onError)
       .run(...this.runArgs)
       .send(...this.sendArgs);
 

test/spec/job.spec.js

@@ -24,6 +24,11 @@ function createFakeThread(response) {
     thread.send = function() {
       thread.emit('error', response.error);
     };
+  } else if (response.progress) {
+    thread.send = function() {
+      // Emit multiple progress events
+      response.progress.forEach((p) => {thread.emit('progress', p)});
+    };
   } else {
     thread.send = function() {
       thread.emit('message', ...response.response);
@@ -80,7 +85,8 @@ describe('Job', () => {
     const thread = {
       once : noop,
       run  : noop,
-      send : noop
+      send : noop,
+      on   : noop
     };
     const mock = sinon.mock(thread);
 
@@ -92,6 +98,7 @@ describe('Job', () => {
 
     mock.expects('run').once().withArgs(runnable, importScripts).returnsThis();
     mock.expects('send').once().withArgs(param, transferables).returnsThis();
+    mock.expects('on').once().withArgs('progress').returnsThis();
 
     job
       .run(runnable, importScripts)
@@ -101,6 +108,25 @@ describe('Job', () => {
     mock.verify();
   });
 
+  it('triggers multiple progress events', () => {
+    const progress1 = { progress: 'progress1' };
+    const progress2 = { progress: 'progress2' };
+    const thread = createFakeThread({
+      progress : [ progress1, progress2 ]
+    });
+
+    const job = new Job(pool);
+    sinon.spy(job, 'emit');
+
+    job
+      .run(noop)
+      .send()
+      .executeOn(thread);
+
+    sinon.assert.calledWith(job.emit, 'progress', progress1);
+    sinon.assert.calledWith(job.emit, 'progress', progress2);
+  });
+
   it('triggers done event', () => {
     const thread = createFakeThread({
       response : [ { foo: 'bar' }, 'more data' ]