Add support for custom Worker instances. Remove deprecated property.

Author: ghengeveld

README.md

@@ -81,6 +81,7 @@ const MyComponent = () => (
 
 - `url` {string} (required) Public url to the Web Worker file (or path relative to the root of your domain)
 - `options` {Object} Options passed to the Worker constructor
+- `worker` {Worker} An existing Worker instance to use instead of creating a new one (ignoring `url` and `options`)
 - `parser` {Function} Transforms incoming message data (not errors)
 - `serializer` {Function} Transforms `postMessage` payload before sending
 - `onMessage` {Function} Callback function invoked when a message is received, passing message data as argument

src/index.js

@@ -44,10 +44,8 @@ class WebWorker extends React.Component {
   }
 
   componentDidMount() {
-    if (this.props.path && console) {
-      console.warn("`path` is deprecated and will be removed in the next major release. Use `url` instead.")
-    }
-    this.worker = new window.Worker(this.props.url || this.props.path, this.props.options)
+    const { url, options, worker } = this.props
+    this.worker = worker || new window.Worker(url, options)
     this.worker.onmessage = this.onMessage
     this.worker.onerror = this.onError
     this.mounted = true
@@ -56,7 +54,7 @@ class WebWorker extends React.Component {
 
   componentWillUnmount() {
     this.mounted = false
-    this.worker.terminate()
+    this.props.worker || this.worker.terminate()
   }
 
   render() {

src/spec.js

@@ -121,6 +121,28 @@ test("parser will deserialize messages received from the worker", async () => {
   await waitForElement(() => getByText("bar"))
 })
 
+test("supports passing a custom Worker instance", () => {
+  const onMessage = jest.fn()
+  const customWorker = { postMessage: jest.fn() }
+  const { getByText } = render(
+    <WebWorker worker={customWorker} onMessage={onMessage}>
+      {({ postMessage }) => <button onClick={() => postMessage("hello")}>go</button>}
+    </WebWorker>
+  )
+  customWorker.onmessage({ data: "foo" })
+  expect(onMessage).toHaveBeenCalledWith("foo")
+  expect(customWorker.postMessage).not.toHaveBeenCalled()
+  fireEvent.click(getByText("go"))
+  expect(customWorker.postMessage).toHaveBeenCalledWith("hello")
+})
+
+test("custom workers don't terminate on unmount", async () => {
+  const customWorker = { terminate: jest.fn() }
+  const { unmount } = render(<WebWorker worker={customWorker} />)
+  unmount()
+  expect(customWorker.terminate).not.toHaveBeenCalled()
+})
+
 test("WebWorker.Data renders with last message data only when a message has been received", async () => {
   const { getByText, queryByText } = render(
     <WebWorker>