prevent resource mutation when using addResourceBundle fixes #2081

i18next · Feb 17, 2024 · d2d7608 · d2d7608
1 parent 4ce76ae
commit d2d7608
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 23.8.3
+
+- prevent resource mutation when using `addResourceBundle` [2081](https://github.com/i18next/i18next/issues/2081)
+
 ## 23.8.2
 
 - optimize `addResources` to address [2130](https://github.com/i18next/i18next/issues/2130)

diff --git a/i18next.js b/i18next.js
@@ -403,7 +403,8 @@
     }
     addResourceBundle(lng, ns, resources, deep, overwrite) {
       let options = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : {
-        silent: false
+        silent: false,
+        skipCopy: false
       };
       let path = [lng, ns];
       if (lng.indexOf('.') > -1) {
@@ -414,6 +415,7 @@
       }
       this.addNamespaces(ns);
       let pack = getPath(this.data, path) || {};
+      if (!options.skipCopy) resources = JSON.parse(JSON.stringify(resources));
       if (deep) {
         deepExtend(pack, resources, overwrite);
       } else {
@@ -1653,7 +1655,9 @@
       const ns = s[1];
       if (err) this.emit('failedLoading', lng, ns, err);
       if (data) {
-        this.store.addResourceBundle(lng, ns, data);
+        this.store.addResourceBundle(lng, ns, data, undefined, undefined, {
+          skipCopy: true
+        });
       }
       this.state[name] = err ? -1 : 2;
       const loaded = {};

diff --git a/i18next.min.js b/i18next.min.js
diff --git a/src/BackendConnector.js b/src/BackendConnector.js
@@ -94,7 +94,7 @@ class Connector extends EventEmitter {
     if (err) this.emit('failedLoading', lng, ns, err);
 
     if (data) {
-      this.store.addResourceBundle(lng, ns, data);
+      this.store.addResourceBundle(lng, ns, data, undefined, undefined, { skipCopy: true });
     }
 
     // set loaded

diff --git a/src/ResourceStore.js b/src/ResourceStore.js
@@ -96,7 +96,14 @@ class ResourceStore extends EventEmitter {
     if (!options.silent) this.emit('added', lng, ns, resources);
   }
 
-  addResourceBundle(lng, ns, resources, deep, overwrite, options = { silent: false }) {
+  addResourceBundle(
+    lng,
+    ns,
+    resources,
+    deep,
+    overwrite,
+    options = { silent: false, skipCopy: false },
+  ) {
     let path = [lng, ns];
     if (lng.indexOf('.') > -1) {
       path = lng.split('.');
@@ -109,6 +116,8 @@ class ResourceStore extends EventEmitter {
 
     let pack = utils.getPath(this.data, path) || {};
 
+    if (!options.skipCopy) resources = JSON.parse(JSON.stringify(resources)); // make a copy to fix #2081
+
     if (deep) {
       utils.deepExtend(pack, resources, overwrite);
     } else {

diff --git a/test/runtime/i18next.test.js b/test/runtime/i18next.test.js
@@ -191,6 +191,19 @@ describe('i18next', () => {
         });
       });
 
+      it('it adds resources by addResourceBundle without mutating the input resources', () => {
+        const base = { k1: { k2: 'v' } };
+        i18next.addResourceBundle('en', 'ns1', base);
+        expect(base.k1.k2).to.eql('v');
+        i18next.addResourceBundle('en', 'ns1', { k1: { k2: 'v for ns1' } }, true, true);
+        expect(base.k1.k2).to.eql('v');
+        i18next.addResourceBundle('en', 'ns2', base);
+        expect(base.k1.k2).to.eql('v');
+        i18next.addResourceBundle('en', 'ns2', { k1: { k2: 'v for ns2' } }, true, true);
+        expect(base.k1.k2).to.eql('v');
+        expect(i18next.t('ns1:k1.k2')).to.eql('v for ns1');
+      });
+
       describe('can remove resources bundle', () => {
         it('it removes resources by removeResourceBundle', () => {
           i18next.removeResourceBundle('en', 'translation');