feature/include_plotlyjs uses bundles js version, new cdn-latest option

Author: adehad

packages/python/plotly/plotly/io/_html.py

@@ -6,7 +6,7 @@
 import six
 
 from plotly.io._utils import validate_coerce_fig_to_dict
-from plotly.offline.offline import _get_jconfig, get_plotlyjs
+from plotly.offline.offline import _get_jconfig, get_plotlyjs, get_plotlyjs_version
 from plotly import utils
 
 
@@ -58,10 +58,16 @@ def to_html(
         fully self-contained and can be used offline.
 
         If 'cdn', a script tag that references the plotly.js CDN is included
-        in the output. HTML files generated with this option are about 3MB
-        smaller than those generated with include_plotlyjs=True, but they
-        require an active internet connection in order to load the plotly.js
-        library.
+        in the output. The url used is versioned to match the bundled plotly.js.
+        HTML files generated with this option are about 3MB smaller than those
+        generated with include_plotlyjs=True, but they require an active
+        internet connection in order to load the plotly.js library.
+
+        If 'cdn-latest', a script tag that always references the latest plotly.js
+        CDN is included in the output.
+        HTML files generated with this option are about 3MB smaller than those
+        generated with include_plotlyjs=True, but they require an active
+        internet connection in order to load the plotly.js library.
 
         If 'directory', a script tag is included that references an external
         plotly.min.js bundle that is assumed to reside in the same
@@ -266,12 +272,15 @@ def to_html(
         require_start = 'require(["plotly"], function(Plotly) {'
         require_end = "});"
 
-    elif include_plotlyjs == "cdn":
+    elif include_plotlyjs == "cdn" or include_plotlyjs == "cdn-latest":
+        cdn_ver = get_plotlyjs_version()
+        if include_plotlyjs == "cdn-latest":
+            cdn_ver = "latest"
         load_plotlyjs = """\
         {win_config}
-        <script src="https://cdn.plot.ly/plotly-latest.min.js"></script>\
+        <script src="https://cdn.plot.ly/plotly-{cdn_ver}.min.js"></script>\
     """.format(
-            win_config=_window_plotly_config
+            win_config=_window_plotly_config, cdn_ver=cdn_ver
         )
 
     elif include_plotlyjs == "directory":
@@ -417,10 +426,16 @@ def write_html(
         fully self-contained and can be used offline.
 
         If 'cdn', a script tag that references the plotly.js CDN is included
-        in the output. HTML files generated with this option are about 3MB
-        smaller than those generated with include_plotlyjs=True, but they
-        require an active internet connection in order to load the plotly.js
-        library.
+        in the output. The url used is versioned to match the bundled plotly.js.
+        HTML files generated with this option are about 3MB smaller than those
+        generated with include_plotlyjs=True, but they require an active
+        internet connection in order to load the plotly.js library.
+
+        If 'cdn-latest', a script tag that always references the latest plotly.js
+        CDN is included in the output.
+        HTML files generated with this option are about 3MB smaller than those
+        generated with include_plotlyjs=True, but they require an active
+        internet connection in order to load the plotly.js library.
 
         If 'directory', a script tag is included that references an external
         plotly.min.js bundle that is assumed to reside in the same

packages/python/plotly/plotly/tests/test_html.py

@@ -0,0 +1,52 @@
+import sys
+
+import pytest
+import numpy as np
+
+
+import plotly.graph_objs as go
+import plotly.io as pio
+from plotly.tests.utils import plotly_cdn_url
+
+
+if sys.version_info >= (3, 3):
+    import unittest.mock as mock
+    from unittest.mock import MagicMock
+else:
+    import mock
+    from mock import MagicMock
+
+# fixtures
+# --------
+@pytest.fixture
+def fig1(request):
+    return go.Figure(
+        data=[
+            {
+                "type": "scatter",
+                "y": np.array([2, 1, 3, 2, 4, 2]),
+                "marker": {"color": "green"},
+            }
+        ],
+        layout={"title": {"text": "Figure title"}},
+    )
+
+
+# HTML
+# ----
+def assert_latest_cdn_connected(html):
+    assert plotly_cdn_url(cdn_ver="latest") in html
+
+
+def assert_locked_version_cdn_connected(html):
+    assert plotly_cdn_url() in html
+
+
+def test_latest_cdn_included(fig1):
+    html_str = pio.to_html(fig1, include_plotlyjs="cdn-latest")
+    assert_latest_cdn_connected(html_str)
+
+
+def test_versioned_cdn_included(fig1):
+    html_str = pio.to_html(fig1, include_plotlyjs="cdn")
+    assert_locked_version_cdn_connected(html_str)

packages/python/plotly/plotly/tests/utils.py

@@ -2,6 +2,7 @@
 from numbers import Number as Num
 from unittest import TestCase
 import plotly.io as pio
+from plotly.offline import get_plotlyjs_version
 
 
 class TestCaseNoTemplate(TestCase):
@@ -95,3 +96,10 @@ def is_num_list(item):
     except TypeError:
         return False
     return True
+
+
+def plotly_cdn_url(cdn_ver=get_plotlyjs_version()):
+    """Return plotly CDN url for use in assertions."""
+    return "https://cdn.plot.ly/plotly-{cdn_ver}.min.js".format(
+        cdn_ver=cdn_ver
+    )