Merge pull request #5426 from plotly/fixup-compress-attributes

Improve compress_attributes browserify transform and fixup unexpected characters in bundles
plotly · Jan 21, 2021 · 1e8f1b8 · 1e8f1b8
2 parents 59390cb + f68214b
commit 1e8f1b8
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 38 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -166,12 +166,12 @@ jobs:
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.min.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plot-schema.json
-      - run:
-          name: Test certain bundles against function constructors
-          command: npm run no-new-func
       - run:
           name: Test plotly bundles againt unexpected characters
           command: npm run no-bad-char
+      - run:
+          name: Test certain bundles against function constructors
+          command: npm run no-new-func
 
 workflows:
   version: 2

diff --git a/lib/index-basic.js b/lib/index-basic.js
@@ -15,5 +15,4 @@ Plotly.register([
     require('./pie')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-cartesian.js b/lib/index-cartesian.js
@@ -24,5 +24,4 @@ Plotly.register([
     require('./violin')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-finance.js b/lib/index-finance.js
@@ -22,5 +22,4 @@ Plotly.register([
     require('./indicator')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-geo.js b/lib/index-geo.js
@@ -15,5 +15,4 @@ Plotly.register([
     require('./choropleth')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-gl2d.js b/lib/index-gl2d.js
@@ -17,5 +17,4 @@ Plotly.register([
     require('./parcoords')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-gl3d.js b/lib/index-gl3d.js
@@ -20,5 +20,4 @@ Plotly.register([
     require('./streamtube')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-mapbox.js b/lib/index-mapbox.js
@@ -16,5 +16,4 @@ Plotly.register([
     require('./densitymapbox')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index-strict.js b/lib/index-strict.js
@@ -56,5 +56,4 @@ Plotly.register([
     require('./barpolar')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/index.js b/lib/index.js
@@ -71,5 +71,4 @@ Plotly.register([
     require('./barpolar')
 ]);
 
-require('./register_extra')(Plotly);
-module.exports = Plotly;
+module.exports = require('./register_extra')(Plotly);
diff --git a/lib/register_extra.js b/lib/register_extra.js
@@ -30,4 +30,6 @@ module.exports = function registerExtra(Plotly) {
     Plotly.register([
         require('./calendars')
     ]);
+
+    return Plotly;
 };
diff --git a/tasks/compress_attributes.js b/tasks/compress_attributes.js
@@ -8,36 +8,46 @@ var through = require('through2');
 
 // one line string with or without trailing comma
 function makeStringRegex(attr) {
-    return attr + ': \'.*\'' + ',?';
+    return makeRegex(
+        attr + ': \'.*\'' + ',?'
+    );
 }
 
 // joined array of strings with or without trailing comma
 function makeJoinedArrayRegex(attr) {
-    return attr + ': \\[[\\s\\S]*?\\]' + '\\.join\\(.*' + ',?';
+    return makeRegex(
+        attr + ': \\[[\\s\\S]*?\\]' + '\\.join\\(.*' + ',?'
+    );
 }
 
 // array with or without trailing comma
 function makeArrayRegex(attr) {
-    return attr + ': \\[[\\s\\S]*?\\]' + ',?';
+    return makeRegex(
+        attr + ': \\[[\\s\\S]*?\\]' + ',?'
+    );
 }
 
-// ref: http://www.regexr.com/3cmac
-var regexStr = [
-    makeStringRegex('description'),
-    makeJoinedArrayRegex('description'),
-    makeArrayRegex('requiredOpts'),
-    makeArrayRegex('otherOpts'),
-    makeStringRegex('hrName')
-].join('|');
-
-var regex = new RegExp(regexStr, 'g');
+function makeRegex(regexStr) {
+    return (
+        new RegExp(regexStr, 'g')
+    );
+}
 
 module.exports = function() {
-    return through(function(buf, enc, next) {
+    var allChunks = [];
+    return through(function(chunk, enc, next) {
+        allChunks.push(chunk);
+        next();
+    }, function(done) {
+        var str = Buffer.concat(allChunks).toString('utf-8');
         this.push(
-            buf.toString('utf-8')
-               .replace(regex, '')
+            str
+                .replace(makeStringRegex('description'), '')
+                .replace(makeJoinedArrayRegex('description'), '')
+                .replace(makeArrayRegex('requiredOpts'), '')
+                .replace(makeArrayRegex('otherOpts'), '')
+                .replace(makeStringRegex('hrName'), '')
         );
-        next();
+        done();
     });
 };