fix: 🐛 fix the issue 2667, do not mutate object given to options … (#2668)

gnekich · web-flow · commit 8a9f25968a08 · 2025-10-29T10:12:34.000-04:00
* fix: 🐛 fix the issue 2667, do not mutate object given to options argument in file download method

* test: 🧪 add the test for issue 2667, and fix another faulty test

* style: 🎨 fix the lint error in test
diff --git a/src/file.ts b/src/file.ts
@@ -2309,7 +2309,7 @@ class File extends ServiceObject<File, FileMetadata> {
       cb = optionsOrCallback as DownloadCallback;
       options = {};
     } else {
-      options = optionsOrCallback as DownloadOptions;
+      options = Object.assign({}, optionsOrCallback);
     }
 
     let called = false;
diff --git a/test/file.ts b/test/file.ts
@@ -2596,11 +2596,26 @@ describe('File', () => {
       file.download({}, assert.ifError);
     });
 
+    it('should not mutate options object after use', done => {
+      const optionsObject = {destination: './unknown.jpg'};
+      fileReadStream._read = () => {
+        assert.strictEqual(optionsObject.destination, './unknown.jpg');
+        assert.deepStrictEqual(optionsObject, {destination: './unknown.jpg'});
+        done();
+      };
+      file.download(optionsObject, assert.ifError);
+    });
+
     it('should pass the provided options to createReadStream', done => {
-      const readOptions = {start: 100, end: 200};
+      const readOptions = {start: 100, end: 200, destination: './unknown.jpg'};
 
       file.createReadStream = (options: {}) => {
-        assert.deepStrictEqual(options, readOptions);
+        assert.deepStrictEqual(options, {start: 100, end: 200});
+        assert.deepStrictEqual(readOptions, {
+          start: 100,
+          end: 200,
+          destination: './unknown.jpg',
+        });
         done();
         return fileReadStream;
       };

Original file line number	Diff line number	Diff line change
`@@ -2309,7 +2309,7 @@ class File extends ServiceObject<File, FileMetadata> {`
`2309`	`2309`	`cb = optionsOrCallback as DownloadCallback;`
`2310`	`2310`	`options = {};`
`2311`	`2311`	`} else {`
`2312`		`- options = optionsOrCallback as DownloadOptions;`
	`2312`	`+ options = Object.assign({}, optionsOrCallback);`
`2313`	`2313`	`}`
`2314`	`2314`
`2315`	`2315`	`let called = false;`