Add workaround for orca segmentation fault (#1140)

jonmmease · web-flow · commit f6bbdaec178a · 2018-08-30T07:46:43.000-04:00
* Workaround for plotly/orca#124 Unset the NODE_OPTIONS environment variable before calling orca to avoid an orca segmentation fault * Constrain ipykernel version. Build was breaking on Python 2.7 with ipykernel 4.9 * Reconnect stream write on 502 errors Example test failure: ``` ====================================================================== ERROR: test_stream_single_points (plotly.tests.test_plot_ly.test_stream.test_stream.TestStreaming) ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/circleci/project/plotly/tests/test_plot_ly/test_stream/test_stream.py", line 52, in test_stream_single_points my_stream.write(Scatter(x=[1], y=[10])) File "/home/circleci/project/plotly/plotly/plotly.py", line 704, in write self._stream.write(jdata, reconnect_on=reconnect_on) File "/home/circleci/project/plotly/plotly/chunked_requests/chunked_request.py", line 61, in write msg=response.read())) Exception: Server responded with status code: 502 and message: <html><body><h1>502 Bad Gateway</h1> The server returned an invalid or incomplete response. </body></html> ```
diff --git a/plotly/io/_orca.py b/plotly/io/_orca.py
@@ -911,6 +911,13 @@ def validate_executable():
             formatted_path=formatted_path,
             instructions=install_location_instructions))
 
+    # Clear NODE_OPTIONS environment variable
+    # ---------------------------------------
+    # When this variable is set, orca <v1.2 will have a segmentation fault
+    # due to an electron bug.
+    # See: https://github.com/electron/electron/issues/12695
+    os.environ.pop('NODE_OPTIONS', None)
+
     # Run executable with --help and see if it's our orca
     # ---------------------------------------------------
     invalid_executable_msg = """
diff --git a/plotly/plotly/chunked_requests/chunked_request.py b/plotly/plotly/chunked_requests/chunked_request.py
@@ -25,7 +25,7 @@ def __init__(self, server, port=80, headers={}, url='/', ssl_enabled=False,
         self._ssl_verification_enabled = ssl_verification_enabled
         self._connect()
 
-    def write(self, data, reconnect_on=('', 200, )):
+    def write(self, data, reconnect_on=('', 200, 502)):
         ''' Send `data` to the server in chunk-encoded form.
         Check the connection before writing and reconnect
         if disconnected and if the response status code is in `reconnect_on`.
diff --git a/tox.ini b/tox.ini
@@ -61,6 +61,7 @@ deps=
     pytest==3.5.1
     optional: numpy==1.11.3
     optional: ipython[all]==5.1.0
+    optional: ipykernel==4.8.2
     optional: jupyter==1.0.0
     optional: pandas==0.19.2
     optional: scipy==0.18.1
