Added multiple file support to attach helper (#204)

- The helper was working well, but only allowed one file at a time
- We have usecases for multiple files, so we'll extend the attach
  helper to support multiple files

Author: ErisDS

packages/express-test/example/app.js

@@ -76,4 +76,11 @@ app.post('/api/upload/', upload.single('image'), async (req, res) => {
     return res.json(req.file);
 });
 
+app.post('/api/upload-multiple/', upload.fields([
+    {name: 'image', maxCount: 1},
+    {name: 'document', maxCount: 1}
+]), async (req, res) => {
+    return res.json(req.files);
+});
+
 module.exports = app;

packages/express-test/lib/Request.js

@@ -22,11 +22,15 @@ class Request {
         this.app = app;
         this.reqOptions = reqOptions instanceof RequestOptions ? reqOptions : new RequestOptions(reqOptions);
         this.cookieJar = cookieJar;
+        this._formData = null; // Track FormData instance for multiple attachments
     }
 
     attach(name, filePath) {
-        const formData = attachFile(name, filePath);
-        return this.body(formData);
+        // Use the utility to create or append to FormData
+        this._formData = attachFile(name, filePath, this._formData);
+
+        // Set the body to the FormData instance
+        return this.body(this._formData);
     }
 
     /**

packages/express-test/lib/utils.js

@@ -21,8 +21,8 @@ module.exports.normalizeURL = function normalizeURL(toNormalize) {
     return normalized;
 };
 
-module.exports.attachFile = function attachFile(name, filePath) {
-    const formData = new FormData();
+module.exports.attachFile = function attachFile(name, filePath, existingFormData = null) {
+    const formData = existingFormData || new FormData();
     const fileContent = fs.readFileSync(filePath);
     const filename = path.basename(filePath);
     const contentType = mime.lookup(filePath) || 'application/octet-stream';

packages/express-test/test/Request.test.js

@@ -339,6 +339,61 @@ describe('Request', function () {
             assert.equal(request.reqOptions.headers.foo, 'bar');
         });
 
+        it('attach() sets body correctly with single file', async function () {
+            const fn = () => {};
+            const jar = {};
+            const opts = new RequestOptions();
+            const request = new Request(fn, jar, opts);
+
+            const path = require('path');
+            const filePath = path.join(__dirname, 'fixtures/ghost-favicon.png');
+
+            request.attach('image', filePath);
+
+            assert.equal(request._formData instanceof FormData, true);
+            assert.equal(request.reqOptions.body, undefined);
+
+            // Verify the FormData contains the file
+            const buffer = request._formData.getBuffer();
+            const content = buffer.toString();
+            assert.match(content, /Content-Disposition: form-data; name="image"/);
+            assert.match(content, /filename="ghost-favicon.png"/);
+        });
+
+        it('attach() sets body correctly with multiple files', async function () {
+            const fn = () => {};
+            const jar = {};
+            const opts = new RequestOptions();
+            const request = new Request(fn, jar, opts);
+
+            const path = require('path');
+            const fs = require('fs');
+            const imagePath = path.join(__dirname, 'fixtures/ghost-favicon.png');
+            const textPath = path.join(__dirname, 'fixtures/test-multi.txt');
+
+            // Create a test text file
+            fs.writeFileSync(textPath, 'test content');
+
+            try {
+                request
+                    .attach('image', imagePath)
+                    .attach('document', textPath);
+
+                assert.equal(request._formData instanceof FormData, true);
+
+                // Verify the FormData contains both files
+                const buffer = request._formData.getBuffer();
+                const content = buffer.toString();
+                assert.match(content, /Content-Disposition: form-data; name="image"/);
+                assert.match(content, /filename="ghost-favicon.png"/);
+                assert.match(content, /Content-Disposition: form-data; name="document"/);
+                assert.match(content, /filename="test-multi.txt"/);
+            } finally {
+                // Clean up
+                fs.unlinkSync(textPath);
+            }
+        });
+
         it('class is thenable [public api]', async function () {
             const fn = (req, res) => {
                 // This is how reqresnext works

packages/express-test/test/example-app.test.js

@@ -1,4 +1,5 @@
 const {assert} = require('./utils');
+const path = require('path');
 
 const Agent = require('../'); // we require the root file
 const app = require('../example/app');
@@ -365,7 +366,7 @@ describe('Example App', function () {
 
             const {body} = await agent
                 .post('/api/upload/')
-                .attach('image', __dirname + '/fixtures/ghost-favicon.png')
+                .attach('image', path.join(__dirname, '/fixtures/ghost-favicon.png'))
                 .expectStatus(200);
 
             assert.equal(body.originalname, 'ghost-favicon.png');
@@ -385,6 +386,41 @@ describe('Example App', function () {
             }
         });
 
+        it('can upload multiple files using multiple attach calls', async function () {
+            // Create a text file for testing
+            const textFilePath = path.join(__dirname, '/fixtures/test-upload.txt');
+            await fs.writeFile(textFilePath, 'test content for multiple files');
+
+            const imageContents = await fs.readFile(__dirname + '/fixtures/ghost-favicon.png');
+            const textContents = await fs.readFile(textFilePath);
+
+            const {body} = await agent
+                .post('/api/upload-multiple/')
+                .attach('image', path.join(__dirname, '/fixtures/ghost-favicon.png'))
+                .attach('document', textFilePath)
+                .expectStatus(200);
+
+            // Verify both files were uploaded
+            assert.equal(body.image[0].originalname, 'ghost-favicon.png');
+            assert.equal(body.image[0].mimetype, 'image/png');
+            assert.equal(body.image[0].size, imageContents.length);
+            assert.equal(body.image[0].fieldname, 'image');
+
+            assert.equal(body.document[0].originalname, 'test-upload.txt');
+            assert.equal(body.document[0].mimetype, 'text/plain');
+            assert.equal(body.document[0].size, textContents.length);
+            assert.equal(body.document[0].fieldname, 'document');
+
+            // Clean up uploaded files
+            try {
+                await fs.unlink(body.image[0].path);
+                await fs.unlink(body.document[0].path);
+                await fs.unlink(textFilePath);
+            } catch (e) {
+                // ignore if this fails
+            }
+        });
+
         it('can stream body', async function () {
             const stat = await fs.stat(__dirname + '/fixtures/long-json-body.json');
             const stream = createReadStream(__dirname + '/fixtures/long-json-body.json');

packages/express-test/test/utils.test.js

@@ -117,5 +117,39 @@ describe('Utils', function () {
             // Check that the form data contains the file content
             assert.match(content, /test content for file upload/);
         });
+
+        it('can append to existing FormData', function () {
+            const filePath1 = path.join(__dirname, 'fixtures/test-file.txt');
+            const filePath2 = path.join(__dirname, 'fixtures/ghost-favicon.png');
+
+            // Create FormData with first file
+            const formData = attachFile('file1', filePath1);
+
+            // Append second file to same FormData
+            const updatedFormData = attachFile('file2', filePath2, formData);
+
+            // Should be the same instance
+            assert.equal(formData, updatedFormData);
+
+            // Verify both files are in the FormData
+            const buffer = formData.getBuffer();
+            const content = buffer.toString();
+
+            assert.match(content, /Content-Disposition: form-data; name="file1"/);
+            assert.match(content, /filename="test-file.txt"/);
+            assert.match(content, /Content-Disposition: form-data; name="file2"/);
+            assert.match(content, /filename="ghost-favicon.png"/);
+        });
+
+        it('creates new FormData when existingFormData is null', function () {
+            const filePath = path.join(__dirname, 'fixtures/test-file.txt');
+            const formData = attachFile('testfile', filePath, null);
+
+            assert.equal(formData instanceof FormData, true);
+
+            const buffer = formData.getBuffer();
+            const content = buffer.toString();
+            assert.match(content, /Content-Disposition: form-data; name="testfile"/);
+        });
     });
 });