richardgirges / express-fileupload / 312

pending completion

Build # 312

Build Type

Pull #253

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/richardgirges/express-fileupload/commit/<a class=hub.com/richardgirges/express-fileupload/commit/<a class="double-link" href="https://git"><a class=hub.com/richardgirges/express-fileupload/commit/<a class="double-link" href="https://git"><a class=hub.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5bc48">15821aec2<a href="https://github.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5bc48">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/richardgirges/express-fileupload/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/richardgirges/express-fileupload/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5bc48&quot;&gt;15821aec2&lt;/a&gt;&lt;a href=&quot;https://github.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5bc48&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93&lt;/a&gt;fbc5bc48&quot;&gt;&amp;quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/richardgirges/express-fileupload/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/richardgirges/express-fileupload/commit/<a class="double-link" href="https://github.com/richardgirges/express-fileupload/commit/58ca33724d0ace9febaa48b9464a8889863cc22f">58ca33724</a><a href="https://github.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5bc48">&amp;quot;&amp;gt;58ca33724&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;58ca33724&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/richardgirges/express-fileupload/commit/15821aec2945015fdda500df91d9ac93fbc5b&lt;/a&gt;c48&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/richardgirges/express-fileupload/commit/<a class="double-link" href="https://github.com/richardgirges/express-fileupload/commit/1216f4f06">1216f4f06">1216f4f06</a>

Pull Request Pull Request #253: Add `numFilesLimitHandler` option so user can provide handler for busboy's `filesLimit` event

Run Details

125 of 138 branches covered (90.58%)

5 of 5 new or added lines in 1 file covered. (100.0%)

276 of 294 relevant lines covered (93.88%)

2862.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.0

/lib/processMultipart.js

const Busboy = require('busboy');
const UploadTimer = require('./uploadtimer');
const fileFactory = require('./fileFactory');
const memHandler = require('./memHandler');
const tempFileHandler = require('./tempFileHandler');
const processNested = require('./processNested');
const {
  isFunc,
  debugLog,
  buildFields,
  buildOptions,
  parseFileName
} = require('./utilities');

const waitFlushProperty = Symbol('wait flush property symbol');

/**
 * Processes multipart request
 * Builds a req.body object for fields
 * Builds a req.files object for files
 * @param  {Object}   options expressFileupload and Busboy options
 * @param  {Object}   req     Express request object
 * @param  {Object}   res     Express response object
 * @param  {Function} next    Express next method
 * @return {void}
 */
module.exports = (options, req, res, next) => {
  req.files = null;

  // Build busboy options and init busboy instance.
  const busboyOptions = buildOptions(options, { headers: req.headers });
  const busboy = new Busboy(busboyOptions);

  // Close connection with specified reason and http code, default: 400 Bad Request.
  const closeConnection = (code, reason) => {
    req.unpipe(busboy);
    res.writeHead(code || 400, { Connection: 'close' });
    res.end(reason || 'Bad Request');
  };

  // Build multipart req.body fields
  busboy.on('field', (field, val) => req.body = buildFields(req.body, field, val));

  // Build req.files fields
  busboy.on('file', (field, file, name, encoding, mime) => {
    // Parse file name(cutting huge names, decoding, etc..).
    const filename = parseFileName(options, name);
    // Define methods and handlers for upload process.
    const {
      dataHandler,
      getFilePath,
      getFileSize,
      getHash,
      complete,
      cleanup,
      getWritePromise
    } = options.useTempFiles
      ? tempFileHandler(options, field, filename) // Upload into temporary file.
      : memHandler(options, field, filename);     // Upload into RAM.
    // Define upload timer.
    const uploadTimer = new UploadTimer(options.uploadTimeout, () => {
      file.removeAllListeners('data');
      file.resume();
      // After destroy an error event will be emitted and file clean up will be done.
      file.destroy(new Error(`Upload timeout ${field}->${filename}, bytes:${getFileSize()}`));
    });

    file.on('limit', () => {
      debugLog(options, `Size limit reached for ${field}->${filename}, bytes:${getFileSize()}`);
      // Reset upload timer in case of file limit reached.
      uploadTimer.clear();
      // Run a user defined limit handler if it has been set.
      if (isFunc(options.limitHandler)) return options.limitHandler(req, res, next);
      // Close connection with 413 code and do cleanup if abortOnLimit set(default: false).
      if (options.abortOnLimit) {
        debugLog(options, `Aborting upload because of size limit ${field}->${filename}.`);
        closeConnection(413, options.responseOnLimit);
        cleanup();
      }
    });

    file.on('data', (data) => {
      uploadTimer.set(); // Refresh upload timer each time new data chunk came.
      dataHandler(data); // Handle new piece of data.
    });

    file.on('end', () => {
      const size = getFileSize();
      // Debug logging for file upload ending.
      debugLog(options, `Upload finished ${field}->${filename}, bytes:${size}`);
      // Reset upload timer in case of end event.
      uploadTimer.clear();
      // See https://github.com/richardgirges/express-fileupload/issues/191
      // Do not add file instance to the req.files if original name and size are empty.
      // Empty name and zero size indicates empty file field in the posted form.
      if (!name && size === 0) {
        if (options.useTempFiles) {
          cleanup();
          debugLog(options, `Removing the empty file ${field}->${filename}`);
        }
        return debugLog(options, `Don't add file instance if original name and size are empty`);
      }
      req.files = buildFields(req.files, field, fileFactory({
        buffer: complete(),
        name: filename,
        tempFilePath: getFilePath(),
        hash: getHash(),
        size,
        encoding,
        truncated: file.truncated,
        mimetype: mime
      }, options));

      if (!req[waitFlushProperty]) {
        req[waitFlushProperty] = [];
      }
      req[waitFlushProperty].push(getWritePromise());
    });

    file.on('error', (err) => {
      uploadTimer.clear(); // Reset upload timer in case of errors.
      debugLog(options, err);
      cleanup();
      next();
    });

    // Debug logging for a new file upload.
    debugLog(options, `New upload started ${field}->${filename}, bytes:${getFileSize()}`);
    // Set new upload timeout for a new file.
    uploadTimer.set();
  });

  busboy.on('filesLimit', () => {
    debugLog(options, `Number of files limit reached for ${field}`);
    // Reset upload timer in case of file limit reached.
    uploadTimer.clear();
    // Run a user defined limit handler if it has been set.
    if (isFunc(options.numFilesLimitHandler)){
      return options.numFilesLimitHandler(req, res, next);
    }
  });

  busboy.on('finish', () => {
    debugLog(options, `Busboy finished parsing request.`);
    if (options.parseNested) {
      req.body = processNested(req.body);
      req.files = processNested(req.files);
    }

    if (!req[waitFlushProperty]) return next();
    Promise.all(req[waitFlushProperty])
      .then(() => {
        delete req[waitFlushProperty];
        next();
      }).catch(err => {
        delete req[waitFlushProperty];
        debugLog(options, `Error while waiting files flush: ${err}`);
        next(err);
      });
  });

  busboy.on('error', (err) => {
    debugLog(options, `Busboy error`);
    next(err);
  });

  req.pipe(busboy);
};

1	const Busboy = require('busboy');	3✔
2	const UploadTimer = require('./uploadtimer');	3✔
3	const fileFactory = require('./fileFactory');	3✔
4	const memHandler = require('./memHandler');	3✔
5	const tempFileHandler = require('./tempFileHandler');	3✔
6	const processNested = require('./processNested');	3✔
7	const {	3✔
8	isFunc,
9	debugLog,
10	buildFields,
11	buildOptions,
12	parseFileName
13	} = require('./utilities');
14
15	const waitFlushProperty = Symbol('wait flush property symbol');	3✔
16
17	/**
18	* Processes multipart request
19	* Builds a req.body object for fields
20	* Builds a req.files object for files
21	* @param {Object} options expressFileupload and Busboy options
22	* @param {Object} req Express request object
23	* @param {Object} res Express response object
24	* @param {Function} next Express next method
25	* @return {void}
26	*/
27	module.exports = (options, req, res, next) => {	3✔
28	req.files = null;	264✔
29
30	// Build busboy options and init busboy instance.
31	const busboyOptions = buildOptions(options, { headers: req.headers });	264✔
32	const busboy = new Busboy(busboyOptions);	264✔
33
34	// Close connection with specified reason and http code, default: 400 Bad Request.
35	const closeConnection = (code, reason) => {	264✔
36	req.unpipe(busboy);	3✔
37	res.writeHead(code \|\| 400, { Connection: 'close' });	3!
38	res.end(reason \|\| 'Bad Request');	3!
39	};
40
41	// Build multipart req.body fields
42	busboy.on('field', (field, val) => req.body = buildFields(req.body, field, val));	264✔
43
44	// Build req.files fields
45	busboy.on('file', (field, file, name, encoding, mime) => {	264✔
46	// Parse file name(cutting huge names, decoding, etc..).
47	const filename = parseFileName(options, name);	279✔
48	// Define methods and handlers for upload process.
49	const {	279✔
50	dataHandler,
51	getFilePath,
52	getFileSize,
53	getHash,
54	complete,
55	cleanup,
56	getWritePromise
57	} = options.useTempFiles	279✔
58	? tempFileHandler(options, field, filename) // Upload into temporary file.
59	: memHandler(options, field, filename); // Upload into RAM.
60	// Define upload timer.
61	const uploadTimer = new UploadTimer(options.uploadTimeout, () => {	279✔
62	file.removeAllListeners('data');	9✔
63	file.resume();	9✔
64	// After destroy an error event will be emitted and file clean up will be done.
65	file.destroy(new Error(`Upload timeout ${field}->${filename}, bytes:${getFileSize()}`));	9✔
66	});
67
68	file.on('limit', () => {	279✔
69	debugLog(options, `Size limit reached for ${field}->${filename}, bytes:${getFileSize()}`);	9✔
70	// Reset upload timer in case of file limit reached.
71	uploadTimer.clear();	9✔
72	// Run a user defined limit handler if it has been set.
73	if (isFunc(options.limitHandler)) return options.limitHandler(req, res, next);	9✔
74	// Close connection with 413 code and do cleanup if abortOnLimit set(default: false).
75	if (options.abortOnLimit) {	6✔
76	debugLog(options, `Aborting upload because of size limit ${field}->${filename}.`);	3✔
77	closeConnection(413, options.responseOnLimit);	3✔
78	cleanup();	3✔
79	}
80	});
81
82	file.on('data', (data) => {	279✔
83	uploadTimer.set(); // Refresh upload timer each time new data chunk came.	1,078✔
84	dataHandler(data); // Handle new piece of data.	1,078✔
85	});
86
87	file.on('end', () => {	279✔
88	const size = getFileSize();	264✔
89	// Debug logging for file upload ending.
90	debugLog(options, `Upload finished ${field}->${filename}, bytes:${size}`);	264✔
91	// Reset upload timer in case of end event.
92	uploadTimer.clear();	264✔
93	// See https://github.com/richardgirges/express-fileupload/issues/191
94	// Do not add file instance to the req.files if original name and size are empty.
95	// Empty name and zero size indicates empty file field in the posted form.
96	if (!name && size === 0) {	264!
97	if (options.useTempFiles) {	×
98	cleanup();	×
99	debugLog(options, `Removing the empty file ${field}->${filename}`);	×
100	}
101	return debugLog(options, `Don't add file instance if original name and size are empty`);	×
102	}
103	req.files = buildFields(req.files, field, fileFactory({	264✔
104	buffer: complete(),
105	name: filename,
106	tempFilePath: getFilePath(),
107	hash: getHash(),
108	size,
109	encoding,
110	truncated: file.truncated,
111	mimetype: mime
112	}, options));
113
114	if (!req[waitFlushProperty]) {	264✔
115	req[waitFlushProperty] = [];	234✔
116	}
117	req[waitFlushProperty].push(getWritePromise());	264✔
118	});
119
120	file.on('error', (err) => {	279✔
121	uploadTimer.clear(); // Reset upload timer in case of errors.	9✔
122	debugLog(options, err);	9✔
123	cleanup();	9✔
124	next();	9✔
125	});
126
127	// Debug logging for a new file upload.
128	debugLog(options, `New upload started ${field}->${filename}, bytes:${getFileSize()}`);	279✔
129	// Set new upload timeout for a new file.
130	uploadTimer.set();	279✔
131	});
132
133	busboy.on('filesLimit', () => {	264✔
134	debugLog(options, `Number of files limit reached for ${field}`);	3✔
135	// Reset upload timer in case of file limit reached.
136	uploadTimer.clear();	×
137	// Run a user defined limit handler if it has been set.
138	if (isFunc(options.numFilesLimitHandler)){	×
139	return options.numFilesLimitHandler(req, res, next);	×
140	}
141	});
142
143	busboy.on('finish', () => {	264✔
144	debugLog(options, `Busboy finished parsing request.`);	246✔
145	if (options.parseNested) {	246✔
146	req.body = processNested(req.body);	3✔
147	req.files = processNested(req.files);	3✔
148	}
149
150	if (!req[waitFlushProperty]) return next();	246✔
151	Promise.all(req[waitFlushProperty])	231✔
152	.then(() => {
153	delete req[waitFlushProperty];	231✔
154	next();	231✔
155	}).catch(err => {
156	delete req[waitFlushProperty];	×
157	debugLog(options, `Error while waiting files flush: ${err}`);	×
158	next(err);	×
159	});
160	});
161
162	busboy.on('error', (err) => {	264✔
163	debugLog(options, `Busboy error`);	×
164	next(err);	×
165	});
166
167	req.pipe(busboy);	264✔
168	};

richardgirges / express-fileupload / 312

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous