Clone SVGO opts object before mutating it (#250)

Author: cpmsmith

packages/react-svg-core/package.json

@@ -25,6 +25,7 @@
     "@babel/plugin-syntax-jsx": "^7.2.0",
     "@babel/preset-react": "^7.0.0",
     "babel-plugin-react-svg": "^2.1.0",
+    "lodash.clonedeep": "^4.5.0",
     "lodash.isplainobject": "^4.0.6",
     "svgo": "^1.2.2"
   },

packages/react-svg-core/src/index.js

@@ -8,7 +8,7 @@ import { validateAndFix } from "./svgo";
 
 // SVGO Optimize
 export function optimize(opts: any = {}): string => Promise<string> {
-  validateAndFix(opts);
+  opts = validateAndFix(opts);
   const svgo = new Svgo(opts);
 
   return (content: string) => svgo.optimize(content).then(data => data.data);

packages/react-svg-core/src/svgo.js

@@ -5,6 +5,7 @@
 // for the babylon JSX parser to work
 
 import isPlainObject from "lodash.isplainobject";
+import cloneDeep from "lodash.clonedeep";
 
 const essentialPlugins = [
   "removeDoctype",
@@ -16,13 +17,15 @@ export function validateAndFix(opts: any = {}) {
   if (!isPlainObject(opts))
     throw new Error("Expected options.svgo to be Object.");
 
-  if (opts.plugins === void 0) opts.plugins = [];
+  let cleanOpts = cloneDeep(opts);
 
-  if (!Array.isArray(opts.plugins))
+  if (cleanOpts.plugins === void 0) cleanOpts.plugins = [];
+
+  if (!Array.isArray(cleanOpts.plugins))
     throw new Error("Expected options.svgo.plugins to be an array");
 
-  if (opts.plugins.length === 0) {
-    opts.plugins = [...essentialPlugins].map(p => ({ [p]: true }));
+  if (cleanOpts.plugins.length === 0) {
+    cleanOpts.plugins = [...essentialPlugins].map(p => ({ [p]: true }));
   }
 
   const state = new Map();
@@ -32,7 +35,7 @@ export function validateAndFix(opts: any = {}) {
   }
 
   // parse through input plugins and mark enabled ones
-  for (const plugin of opts.plugins) {
+  for (const plugin of cleanOpts.plugins) {
     if (isPlainObject(plugin)) {
       for (const pluginName of Object.keys(plugin)) {
         if (essentialPlugins.indexOf(pluginName) > -1) {
@@ -55,14 +58,16 @@ export function validateAndFix(opts: any = {}) {
   // add missing plugins
   for (const p of essentialPlugins) {
     if (!state.get(p)) {
-      opts.plugins.push(p);
+      cleanOpts.plugins.push(p);
     }
   }
 
   // convert strings to objects to match the form svgo accepts
-  for (let i = 0; i < opts.plugins.length; i++) {
-    if (typeof opts.plugins[i] === "string") {
-      opts.plugins[i] = { [opts.plugins[i]]: true };
+  for (let i = 0; i < cleanOpts.plugins.length; i++) {
+    if (typeof cleanOpts.plugins[i] === "string") {
+      cleanOpts.plugins[i] = { [cleanOpts.plugins[i]]: true };
     }
   }
+
+  return cleanOpts;
 }

packages/react-svg-core/test/svgo.js

@@ -3,7 +3,7 @@ import test from "tape";
 
 test("fills essential plugins when empty", function(t) {
   let opts = {};
-  validateAndFix(opts);
+  opts = validateAndFix(opts);
   t.equal(opts.plugins.length, 3);
   t.end();
 });
@@ -13,7 +13,7 @@ test("enable disabled essential plugins", function(t) {
     full: true,
     plugins: ["removeDoctype", { removeComments: false }]
   };
-  validateAndFix(opts);
+  opts = validateAndFix(opts);
   t.equal(opts.plugins.length, 3);
   t.equal(opts.plugins[1].removeComments, true);
   t.end();

yarn.lock

@@ -2426,15 +2426,6 @@ cmd-shim@^2.0.2:
     graceful-fs "^4.1.2"
     mkdirp "~0.5.0"
 
-coa@^2.0.2:
-  version "2.0.2"
-  resolved "https://registry.yarnpkg.com/coa/-/coa-2.0.2.tgz#43f6c21151b4ef2bf57187db0d73de229e3e7ec3"
-  integrity sha512-q5/jG+YQnSy4nRTV4F7lPepBJZ8qBNJJDBuJdoejDyLXgmL7IEo+Le2JDZudFTFt7mrCqIRaSjws4ygRCTCAXA==
-  dependencies:
-    "@types/q" "^1.5.1"
-    chalk "^2.4.1"
-    q "^1.1.2"
-
 coa@~1.0.1:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/coa/-/coa-1.0.4.tgz#a9ef153660d6a86a8bdec0289a5c684d217432fd"
@@ -2758,6 +2749,14 @@ csso@~2.3.1:
     clap "^1.0.9"
     source-map "^0.5.3"
 
+csso@~2.3.1:
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/csso/-/csso-2.3.2.tgz#ddd52c587033f49e94b71fc55569f252e8ff5f85"
+  integrity sha1-3dUsWHAz9J6Utx/FVWnyUuj/X4U=
+  dependencies:
+    clap "^1.0.9"
+    source-map "^0.5.3"
+
 currently-unhandled@^0.4.1:
   version "0.4.1"
   resolved "https://registry.yarnpkg.com/currently-unhandled/-/currently-unhandled-0.4.1.tgz#988df33feab191ef799a61369dd76c17adf957ea"
@@ -4857,14 +4856,6 @@ js-yaml@^3.12.0, js-yaml@^3.9.0:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
-js-yaml@^3.13.1:
-  version "3.13.1"
-  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.13.1.tgz#aff151b30bfdfa8e49e05da22e7415e9dfa37847"
-  integrity sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==
-  dependencies:
-    argparse "^1.0.7"
-    esprima "^4.0.0"
-
 js-yaml@~3.7.0:
   version "3.7.0"
   resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.7.0.tgz#5c967ddd837a9bfdca5f2de84253abe8a1c03b80"