#148

pending completion

Build # #148

Build Type

push

GithubActions

Committed by

web-flow

Commit Message

<a href="https://github.com/jeremydaly/lambda-api/commit/<a class=hub.com/jeremydaly/lambda-api/commit/<a class="double-link" href="https://git"><a class=hub.com/jeremydaly/lambda-api/commit/<a class="double-link" href="https://git"><a class=hub.com/jeremydaly/lambda-api/commit/<a class="double-link" href="https://git"><a class=hub.com/jeremydaly/lambda-api/commit/14413c7efb499a5d239a8d8af74e4e08d4b05c66">14413c7ef">&lt;a href=&quot;https://github.com/jeremydaly/lambda-api/commit/</a><a class="double-link" href="https://github.com/jeremydaly/lambda-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/jeremydaly/lambda-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/jeremydaly/lambda-api/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/jeremydaly/lambda-api/commit/14413c7efb499a5d239a8d8af74e4e08d4b05c66">14413c7ef</a><a href="https://github.com/jeremydaly/lambda-api/commit/14413c7efb499a5d239a8d8af74e4e08d4b05c66">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/jeremydaly/lambda-api/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/jeremydaly/lambda-api/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/jeremydaly/lambda-api/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/jeremydaly/lambda-api/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/jeremydaly/lambda-api/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/jeremydaly/lambda-api/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/jeremydaly/lambda-api/commit/14413c7efb499a5d239a8d8af74e4e08d4b05c66&quot;&gt;14413c7ef&lt;/a&gt;&lt;a href=&quot;https://github.com/jeremydaly/lambda-api/commit/14413c7efb499a5d239a8d8af74e4e08d4b05c66&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/jeremydaly/lambda-api/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;qu... (continued)

Run Details

730 of 739 branches covered (98.78%)

Branch coverage included in aggregate %.

565 of 565 new or added lines in 9 files covered. (100.0%)

645 of 648 relevant lines covered (99.54%)

184.56 hits per line

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

98.75

/lib/response.js

'use strict';

/**
 * Lightweight web framework for your serverless applications
 * @author Jeremy Daly <jeremy@jeremydaly.com>
 * @license MIT
 */

const UTILS = require('./utils.js');

const fs = require('fs'); // Require Node.js file system
const path = require('path'); // Require Node.js path
const compression = require('./compression'); // Require compression lib
const { ResponseError, FileError } = require('./errors'); // Require custom errors

// Require AWS S3 service
const S3 = require('./s3-service');

class RESPONSE {
  // Create the constructor function.
  constructor(app, request) {
    // Add a reference to the main app
    app._response = this;

    // Create a reference to the app
    this.app = app;

    // Create a reference to the request
    this._request = request;

    // Create a reference to the JSON serializer
    this._serializer = app._serializer;

    // Set the default state to processing
    this._state = 'processing';

    // Default statusCode to 200
    this._statusCode = 200;

    // Default the header
    this._headers = Object.assign(
      {
        // Set the Content-Type by default
        'content-type': ['application/json'], //charset=UTF-8
      },
      app._headers
    );

    // base64 encoding flag
    this._isBase64 = app._isBase64;

    // compression flag
    this._compression = app._compression;

    // Default callback function
    this._callback = 'callback';

    // Default Etag support
    this._etag = false;

    // Default response object
    this._response = {};
  }

  // Sets the statusCode
  status(code) {
    this._statusCode = code;
    return this;
  }

  // Adds a header field
  header(key, value, append) {
    let _key = key.toLowerCase(); // store as lowercase
    let _values = value ? (Array.isArray(value) ? value : [value]) : [''];
    this._headers[_key] = append
      ? this.hasHeader(_key)
        ? this._headers[_key].concat(_values)
        : _values
      : _values;
    return this;
  }

  // Gets a header field
  getHeader(key, asArr) {
    if (!key)
      return asArr
        ? this._headers
        : Object.keys(this._headers).reduce(
            (headers, key) =>
              Object.assign(headers, { [key]: this._headers[key].toString() }),
            {}
          ); // return all headers
    return asArr
      ? this._headers[key.toLowerCase()]
      : this._headers[key.toLowerCase()]
      ? this._headers[key.toLowerCase()].toString()
      : undefined;
  }

  getHeaders() {
    return this._headers;
  }

  // Removes a header field
  removeHeader(key) {
    delete this._headers[key.toLowerCase()];
    return this;
  }

  // Returns boolean if header exists
  hasHeader(key) {
    return this.getHeader(key ? key : '') !== undefined;
  }

  // Convenience method for JSON
  json(body) {
    this.header('Content-Type', 'application/json').send(
      this._serializer(body)
    );
  }

  // Convenience method for JSONP
  jsonp(body) {
    // Check the querystring for callback or cb
    let query = this.app._event.queryStringParameters || {};
    let cb = query[this.app._callbackName];

    this.header('Content-Type', 'application/json').send(
      (cb ? cb.replace(' ', '_') : 'callback') +
        '(' +
        this._serializer(body) +
        ')'
    );
  }

  // Convenience method for HTML
  html(body) {
    this.header('Content-Type', 'text/html').send(body);
  }

  // Convenience method for setting Location header
  location(path) {
    this.header('Location', UTILS.encodeUrl(path));
    return this;
  }

  // Convenience method for Redirect
  async redirect(path) {
    let statusCode = 302; // default

    try {
      // If status code is provided
      if (arguments.length === 2) {
        if ([300, 301, 302, 303, 307, 308].includes(arguments[0])) {
          statusCode = arguments[0];
          path = arguments[1];
        } else {
          throw new ResponseError(
            arguments[0] + ' is an invalid redirect status code',
            arguments[0]
          );
        }
      }

      // Auto convert S3 paths to signed URLs
      if (UTILS.isS3(path)) path = await this.getLink(path);

      let url = UTILS.escapeHtml(path);

      this.location(path)
        .status(statusCode)
        .html(
          `<p>${statusCode} Redirecting to <a href="${url}">${url}</a></p>`
        );
    } catch (e) {
      this.error(e);
    }
  } // end redirect

  // Convenience method for retrieving a signed link to an S3 bucket object
  async getLink(path, expires, callback) {
    let params = UTILS.parseS3(path);

    // Default Expires
    params.Expires = !isNaN(expires) ? parseInt(expires) : 900;

    // Default callback
    let fn =
      typeof expires === 'function'
        ? expires
        : typeof callback === 'function'
        ? callback
        : (e) => {
            if (e) this.error(e);
          };

    // getSignedUrl doesn't support .promise()
    return await new Promise((r) =>
      S3.getSignedUrl('getObject', params, async (e, url) => {
        if (e) {
          // Execute callback with caught error
          await fn(e);
          this.error(e); // Throw error if not done in callback
        }
        r(url); // return the url
      })
    );
  } // end getLink

  // Convenience method for setting cookies
  // see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
  cookie(name, value, opts = {}) {
    // Set the name and value of the cookie
    let cookieString =
      (typeof name !== 'string' ? name.toString() : name) +
      '=' +
      encodeURIComponent(UTILS.encodeBody(value));

    // domain (String): Domain name for the cookie
    cookieString += opts.domain ? '; Domain=' + opts.domain : '';

    // expires (Date): Expiry date of the cookie, convert to GMT
    cookieString +=
      opts.expires && typeof opts.expires.toUTCString === 'function'
        ? '; Expires=' + opts.expires.toUTCString()
        : '';

    // httpOnly (Boolean): Flags the cookie to be accessible only by the web server
    cookieString += opts.httpOnly && opts.httpOnly === true ? '; HttpOnly' : '';

    // maxAge (Number) Set expiry time relative to the current time in milliseconds
    cookieString +=
      opts.maxAge && !isNaN(opts.maxAge)
        ? '; MaxAge=' +
          ((opts.maxAge / 1000) | 0) +
          (!opts.expires
            ? '; Expires=' + new Date(Date.now() + opts.maxAge).toUTCString()
            : '')
        : '';

    // path (String): Path for the cookie
    cookieString += opts.path ? '; Path=' + opts.path : '; Path=/';

    // secure (Boolean): Marks the cookie to be used with HTTPS only
    cookieString += opts.secure && opts.secure === true ? '; Secure' : '';

    // sameSite (Boolean or String) Value of the “SameSite” Set-Cookie attribute
    // see https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-4.1.1.
    cookieString +=
      opts.sameSite !== undefined
        ? '; SameSite=' +
          (opts.sameSite === true
            ? 'Strict'
            : opts.sameSite === false
            ? 'Lax'
            : opts.sameSite)
        : '';

    this.header('Set-Cookie', cookieString, true);
    return this;
  }

  // Convenience method for clearing cookies
  clearCookie(name, opts = {}) {
    let options = Object.assign(opts, { expires: new Date(1), maxAge: -1000 });
    return this.cookie(name, '', options);
  }

  // Set content-disposition header and content type
  attachment(filename) {
    // Check for supplied filename/path
    let name =
      typeof filename === 'string' && filename.trim().length > 0
        ? path.parse(filename)
        : undefined;
    this.header(
      'Content-Disposition',
      'attachment' + (name ? '; filename="' + name.base + '"' : '')
    );

    // If name exits, attempt to set the type
    if (name) {
      this.type(name.ext);
    }
    return this;
  }

  // Convenience method combining attachment() and sendFile()
  download(file, filename, options, callback) {
    let name = filename;
    let opts = typeof options === 'object' ? options : {};
    let fn = typeof callback === 'function' ? callback : undefined;

    // Add optional parameter support for callback
    if (typeof filename === 'function') {
      name = undefined;
      fn = filename;
    } else if (typeof options === 'function') {
      fn = options;
    }

    // Add optional parameter support for options
    if (typeof filename === 'object') {
      name = undefined;
      opts = filename;
    }

    // Add the Content-Disposition header
    this.attachment(
      name ? name : typeof file === 'string' ? path.basename(file) : null
    );

    // Send the file
    this.sendFile(file, opts, fn);
  }

  // Convenience method for returning static files
  async sendFile(file, options, callback) {
    let buffer, modified;

    let opts = typeof options === 'object' ? options : {};
    let fn = typeof callback === 'function' ? callback : () => {};

    // Add optional parameter support
    if (typeof options === 'function') {
      fn = options;
    }

    // Begin a try-catch block for callback errors
    try {
      // Create buffer based on input
      if (typeof file === 'string') {
        let filepath = file.trim();

        // If an S3 file identifier
        if (/^s3:\/\//i.test(filepath)) {
          let params = UTILS.parseS3(filepath);

          // Attempt to get the object from S3
          let data = await S3.getObject(params).promise();

          // Set results, type and header
          buffer = data.Body;
          modified = data.LastModified;
          this.type(data.ContentType);
          this.header('ETag', data.ETag);

          // else try and load the file locally
        } else {
          buffer = fs.readFileSync((opts.root ? opts.root : '') + filepath);
          modified =
            opts.lastModified !== false
              ? fs.statSync((opts.root ? opts.root : '') + filepath).mtime
              : undefined;
          this.type(path.extname(filepath));
        }
        // If the input is a buffer, pass through
      } else if (Buffer.isBuffer(file)) {
        buffer = file;
      } else {
        throw new FileError('Invalid file', { path: file });
      }

      // Add headers from options
      if (typeof opts.headers === 'object') {
        Object.keys(opts.headers).map((header) => {
          this.header(header, opts.headers[header]);
        });
      }

      // Add cache-control headers
      if (opts.cacheControl !== false) {
        if (opts.cacheControl !== true && opts.cacheControl !== undefined) {
          this.cache(opts.cacheControl);
        } else {
          this.cache(!isNaN(opts.maxAge) ? opts.maxAge : 0, opts.private);
        }
      }

      // Add last-modified headers
      if (opts.lastModified !== false) {
        this.modified(opts.lastModified ? opts.lastModified : modified);
      }

      // Execute callback
      await fn();

      // Set base64 encoding flag
      this._isBase64 = true;
      // Convert buffer to base64 string
      this.send(buffer.toString('base64'));
    } catch (e) {
      // TODO: Add second catch?
      // Execute callback with caught error
      await fn(e);

      // If missing file
      if (e.code === 'ENOENT') {
        this.error(new FileError('No such file', e));
      } else {
        this.error(e); // Throw error if not done in callback
      }
    }
  } // end sendFile

  // Convenience method for setting type
  type(type) {
    let mimeType = UTILS.mimeLookup(type, this.app._mimeTypes);
    if (mimeType) {
      this.header('Content-Type', mimeType);
    }
    return this;
  }

  // Convenience method for sending status codes
  sendStatus(status) {
    this.status(status).send(UTILS.statusLookup(status));
  }

  // Convenience method for setting CORS headers
  cors(options) {
    const opts = typeof options === 'object' ? options : {};

    // Check for existing headers
    let acao = this.getHeader('Access-Control-Allow-Origin');
    let acam = this.getHeader('Access-Control-Allow-Methods');
    let acah = this.getHeader('Access-Control-Allow-Headers');

    // Default CORS headers
    this.header(
      'Access-Control-Allow-Origin',
      opts.origin ? opts.origin : acao ? acao : '*'
    );
    this.header(
      'Access-Control-Allow-Methods',
      opts.methods
        ? opts.methods
        : acam
        ? acam
        : 'GET, PUT, POST, DELETE, OPTIONS'
    );
    this.header(
      'Access-Control-Allow-Headers',
      opts.headers
        ? opts.headers
        : acah
        ? acah
        : 'Content-Type, Authorization, Content-Length, X-Requested-With'
    );

    // Optional CORS headers
    if (opts.maxAge && !isNaN(opts.maxAge))
      this.header(
        'Access-Control-Max-Age',
        ((opts.maxAge / 1000) | 0).toString()
      );
    if (opts.credentials)
      this.header(
        'Access-Control-Allow-Credentials',
        opts.credentials.toString()
      );
    if (opts.exposeHeaders)
      this.header('Access-Control-Expose-Headers', opts.exposeHeaders);

    return this;
  }

  // Enable/Disable Etag
  etag(enable) {
    this._etag = enable === true ? true : false;
    return this;
  }

  // Add cache-control headers
  cache(maxAge, isPrivate = false) {
    // if custom string value
    if (maxAge !== true && maxAge !== undefined && typeof maxAge === 'string') {
      this.header('Cache-Control', maxAge);
    } else if (maxAge === false) {
      this.header('Cache-Control', 'no-cache, no-store, must-revalidate');
    } else {
      maxAge = maxAge && !isNaN(maxAge) ? (maxAge / 1000) | 0 : 0;
      this.header(
        'Cache-Control',
        (isPrivate === true ? 'private, ' : '') + 'max-age=' + maxAge
      );
      this.header('Expires', new Date(Date.now() + maxAge).toUTCString());
    }
    return this;
  }

  // Add last-modified headers
  modified(date) {
    if (date !== false) {
      let lastModified =
        date && typeof date.toUTCString === 'function'
          ? date
          : date && Date.parse(date)
          ? new Date(date)
          : new Date();
      this.header('Last-Modified', lastModified.toUTCString());
    }
    return this;
  }

  // Sends the request to the main callback
  send(body) {
    // Generate Etag
    if (
      this._etag && // if etag support enabled
      ['GET', 'HEAD'].includes(this._request.method) &&
      !this.hasHeader('etag') &&
      this._statusCode === 200
    ) {
      this.header('etag', '"' + UTILS.generateEtag(body) + '"');
    }

    // Check for matching Etag
    if (
      this._request.headers['if-none-match'] &&
      this._request.headers['if-none-match'] === this.getHeader('etag')
    ) {
      this.status(304);
      body = '';
    }

    let headers = {};
    let cookies = {};

    if (this._request.payloadVersion === '2.0') {
      if (this._headers['set-cookie']) {
        cookies = { cookies: this._headers['set-cookie'] };
        delete this._headers['set-cookie'];
      }
    }

    if (this._request._multiValueSupport) {
      headers = { multiValueHeaders: this._headers };
    } else {
      headers = { headers: UTILS.stringifyHeaders(this._headers) };
    }

    // Create the response
    this._response = Object.assign(
      {},
      headers,
      cookies,
      {
        statusCode: this._statusCode,
        body:
          this._request.method === 'HEAD'
            ? ''
            : UTILS.encodeBody(body, this._serializer),
        isBase64Encoded: this._isBase64,
      },
      this._request.interface === 'alb'
        ? {
            statusDescription: `${this._statusCode} ${UTILS.statusLookup(
              this._statusCode
            )}`,
          }
        : {}
    );

    // Compress the body
    if (this._compression && this._response.body) {
      const { data, contentEncoding } = compression.compress(
        this._response.body,
        this._request.headers
      );
      if (contentEncoding) {
        Object.assign(this._response, {
          body: data.toString('base64'),
          isBase64Encoded: true,
        });
        if (this._response.multiValueHeaders) {
          this._response.multiValueHeaders['content-encoding'] = [
            contentEncoding,
          ];
        } else {
          this._response.headers['content-encoding'] = contentEncoding;
        }
      }
    }

    // Trigger the callback function
    this.app._callback(null, this._response, this);
  } // end send

  // Trigger API error
  error(code, e, detail) {
    detail = typeof code !== 'number' && e !== undefined ? e : detail;
    e = typeof code !== 'number' ? code : e;
    code = typeof code === 'number' ? code : undefined;
    this.app.catchErrors(e, this, code, detail);
  } // end error
} // end Response class

// Export the response object
module.exports = RESPONSE;

1	'use strict';
2
3	/**
4	* Lightweight web framework for your serverless applications
5	* @author Jeremy Daly <jeremy@jeremydaly.com>
6	* @license MIT
7	*/
8
9	const UTILS = require('./utils.js');	26✔
10
11	const fs = require('fs'); // Require Node.js file system	26✔
12	const path = require('path'); // Require Node.js path	26✔
13	const compression = require('./compression'); // Require compression lib	26✔
14	const { ResponseError, FileError } = require('./errors'); // Require custom errors	26✔
15
16	// Require AWS S3 service
17	const S3 = require('./s3-service');	26✔
18
19	class RESPONSE {
20	// Create the constructor function.
21	constructor(app, request) {
22	// Add a reference to the main app
23	app._response = this;	659✔
24
25	// Create a reference to the app
26	this.app = app;	659✔
27
28	// Create a reference to the request
29	this._request = request;	659✔
30
31	// Create a reference to the JSON serializer
32	this._serializer = app._serializer;	659✔
33
34	// Set the default state to processing
35	this._state = 'processing';	659✔
36
37	// Default statusCode to 200
38	this._statusCode = 200;	659✔
39
40	// Default the header
41	this._headers = Object.assign(	659✔
42	{
43	// Set the Content-Type by default
44	'content-type': ['application/json'], //charset=UTF-8
45	},
46	app._headers
47	);
48
49	// base64 encoding flag
50	this._isBase64 = app._isBase64;	659✔
51
52	// compression flag
53	this._compression = app._compression;	659✔
54
55	// Default callback function
56	this._callback = 'callback';	659✔
57
58	// Default Etag support
59	this._etag = false;	659✔
60
61	// Default response object
62	this._response = {};	659✔
63	}
64
65	// Sets the statusCode
66	status(code) {
67	this._statusCode = code;	215✔
68	return this;	215✔
69	}
70
71	// Adds a header field
72	header(key, value, append) {
73	let _key = key.toLowerCase(); // store as lowercase	470✔
74	let _values = value ? (Array.isArray(value) ? value : [value]) : [''];	470✔
75	this._headers[_key] = append	470✔
76	? this.hasHeader(_key)	31✔
77	? this._headers[_key].concat(_values)
78	: _values
79	: _values;
80	return this;	470✔
81	}
82
83	// Gets a header field
84	getHeader(key, asArr) {
85	if (!key)	73✔
86	return asArr	5✔
87	? this._headers
88	: Object.keys(this._headers).reduce(
89	(headers, key) =>
90	Object.assign(headers, { [key]: this._headers[key].toString() }),	8✔
91	{}
92	); // return all headers
93	return asArr	68✔
94	? this._headers[key.toLowerCase()]
95	: this._headers[key.toLowerCase()]	66✔
96	? this._headers[key.toLowerCase()].toString()
97	: undefined;
98	}
99
100	getHeaders() {
101	return this._headers;	2✔
102	}
103
104	// Removes a header field
105	removeHeader(key) {
106	delete this._headers[key.toLowerCase()];	1✔
107	return this;	1✔
108	}
109
110	// Returns boolean if header exists
111	hasHeader(key) {
112	return this.getHeader(key ? key : '') !== undefined;	42✔
113	}
114
115	// Convenience method for JSON
116	json(body) {
117	this.header('Content-Type', 'application/json').send(	216✔
118	this._serializer(body)
119	);
120	}
121
122	// Convenience method for JSONP
123	jsonp(body) {
124	// Check the querystring for callback or cb
125	let query = this.app._event.queryStringParameters \|\| {};	6✔
126	let cb = query[this.app._callbackName];	6✔
127
128	this.header('Content-Type', 'application/json').send(	6✔
129	(cb ? cb.replace(' ', '_') : 'callback') +	6✔
130	'(' +
131	this._serializer(body) +
132	')'
133	);
134	}
135
136	// Convenience method for HTML
137	html(body) {
138	this.header('Content-Type', 'text/html').send(body);	7✔
139	}
140
141	// Convenience method for setting Location header
142	location(path) {
143	this.header('Location', UTILS.encodeUrl(path));	6✔
144	return this;	6✔
145	}
146
147	// Convenience method for Redirect
148	async redirect(path) {
149	let statusCode = 302; // default	6✔
150
151	try {	6✔
152	// If status code is provided
153	if (arguments.length === 2) {	6✔
154	if ([300, 301, 302, 303, 307, 308].includes(arguments[0])) {	3✔
155	statusCode = arguments[0];	1✔
156	path = arguments[1];	1✔
157	} else {
158	throw new ResponseError(	2✔
159	arguments[0] + ' is an invalid redirect status code',
160	arguments[0]
161	);
162	}
163	}
164
165	// Auto convert S3 paths to signed URLs
166	if (UTILS.isS3(path)) path = await this.getLink(path);	4✔
167
168	let url = UTILS.escapeHtml(path);	4✔
169
170	this.location(path)	4✔
171	.status(statusCode)
172	.html(
173	`<p>${statusCode} Redirecting to <a href="${url}">${url}</a></p>`
174	);
175	} catch (e) {
176	this.error(e);	2✔
177	}
178	} // end redirect
179
180	// Convenience method for retrieving a signed link to an S3 bucket object
181	async getLink(path, expires, callback) {
182	let params = UTILS.parseS3(path);	9✔
183
184	// Default Expires
185	params.Expires = !isNaN(expires) ? parseInt(expires) : 900;	8✔
186
187	// Default callback
188	let fn =
189	typeof expires === 'function'	8✔
190	? expires
191	: typeof callback === 'function'	7✔
192	? callback
193	: (e) => {
194	if (e) this.error(e);	1!
195	};
196
197	// getSignedUrl doesn't support .promise()
198	return await new Promise((r) =>	8✔
199	S3.getSignedUrl('getObject', params, async (e, url) => {	8✔
200	if (e) {	8✔
201	// Execute callback with caught error
202	await fn(e);	3✔
203	this.error(e); // Throw error if not done in callback	3✔
204	}
205	r(url); // return the url	8✔
206	})
207	);
208	} // end getLink
209
210	// Convenience method for setting cookies
211	// see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
212	cookie(name, value, opts = {}) {	18✔
213	// Set the name and value of the cookie
214	let cookieString =
215	(typeof name !== 'string' ? name.toString() : name) +	29✔
216	'=' +
217	encodeURIComponent(UTILS.encodeBody(value));
218
219	// domain (String): Domain name for the cookie
220	cookieString += opts.domain ? '; Domain=' + opts.domain : '';	29✔
221
222	// expires (Date): Expiry date of the cookie, convert to GMT
223	cookieString +=	29✔
224	opts.expires && typeof opts.expires.toUTCString === 'function'	68✔
225	? '; Expires=' + opts.expires.toUTCString()
226	: '';
227
228	// httpOnly (Boolean): Flags the cookie to be accessible only by the web server
229	cookieString += opts.httpOnly && opts.httpOnly === true ? '; HttpOnly' : '';	29✔
230
231	// maxAge (Number) Set expiry time relative to the current time in milliseconds
232	cookieString +=	29✔
233	opts.maxAge && !isNaN(opts.maxAge)	61✔
234	? '; MaxAge=' +
235	((opts.maxAge / 1000) \| 0) +
236	(!opts.expires	3✔
237	? '; Expires=' + new Date(Date.now() + opts.maxAge).toUTCString()
238	: '')
239	: '';
240
241	// path (String): Path for the cookie
242	cookieString += opts.path ? '; Path=' + opts.path : '; Path=/';	29✔
243
244	// secure (Boolean): Marks the cookie to be used with HTTPS only
245	cookieString += opts.secure && opts.secure === true ? '; Secure' : '';	29✔
246
247	// sameSite (Boolean or String) Value of the “SameSite” Set-Cookie attribute
248	// see https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-4.1.1.
249	cookieString +=	29✔
250	opts.sameSite !== undefined	29✔
251	? '; SameSite=' +
252	(opts.sameSite === true	3✔
253	? 'Strict'
254	: opts.sameSite === false	2✔
255	? 'Lax'
256	: opts.sameSite)
257	: '';
258
259	this.header('Set-Cookie', cookieString, true);	29✔
260	return this;	29✔
261	}
262
263	// Convenience method for clearing cookies
264	clearCookie(name, opts = {}) {	1✔
265	let options = Object.assign(opts, { expires: new Date(1), maxAge: -1000 });	2✔
266	return this.cookie(name, '', options);	2✔
267	}
268
269	// Set content-disposition header and content type
270	attachment(filename) {
271	// Check for supplied filename/path
272	let name =
273	typeof filename === 'string' && filename.trim().length > 0	20✔
274	? path.parse(filename)
275	: undefined;
276	this.header(	20✔
277	'Content-Disposition',
278	'attachment' + (name ? '; filename="' + name.base + '"' : '')	20✔
279	);
280
281	// If name exits, attempt to set the type
282	if (name) {	20✔
283	this.type(name.ext);	15✔
284	}
285	return this;	20✔
286	}
287
288	// Convenience method combining attachment() and sendFile()
289	download(file, filename, options, callback) {
290	let name = filename;	13✔
291	let opts = typeof options === 'object' ? options : {};	13✔
292	let fn = typeof callback === 'function' ? callback : undefined;	13✔
293
294	// Add optional parameter support for callback
295	if (typeof filename === 'function') {	13✔
296	name = undefined;	3✔
297	fn = filename;	3✔
298	} else if (typeof options === 'function') {	10✔
299	fn = options;	1✔
300	}
301
302	// Add optional parameter support for options
303	if (typeof filename === 'object') {	13✔
304	name = undefined;	1✔
305	opts = filename;	1✔
306	}
307
308	// Add the Content-Disposition header
309	this.attachment(	13✔
310	name ? name : typeof file === 'string' ? path.basename(file) : null	23✔
311	);
312
313	// Send the file
314	this.sendFile(file, opts, fn);	13✔
315	}
316
317	// Convenience method for returning static files
318	async sendFile(file, options, callback) {
319	let buffer, modified;
320
321	let opts = typeof options === 'object' ? options : {};	33✔
322	let fn = typeof callback === 'function' ? callback : () => {};	33✔
323
324	// Add optional parameter support
325	if (typeof options === 'function') {	33✔
326	fn = options;	4✔
327	}
328
329	// Begin a try-catch block for callback errors
330	try {	33✔
331	// Create buffer based on input
332	if (typeof file === 'string') {	33✔
333	let filepath = file.trim();	28✔
334
335	// If an S3 file identifier
336	if (/^s3:\/\//i.test(filepath)) {	28✔
337	let params = UTILS.parseS3(filepath);	8✔
338
339	// Attempt to get the object from S3
340	let data = await S3.getObject(params).promise();	6✔
341
342	// Set results, type and header
343	buffer = data.Body;	4✔
344	modified = data.LastModified;	4✔
345	this.type(data.ContentType);	4✔
346	this.header('ETag', data.ETag);	4✔
347
348	// else try and load the file locally
349	} else {
350	buffer = fs.readFileSync((opts.root ? opts.root : '') + filepath);	20✔
351	modified =	12✔
352	opts.lastModified !== false	12✔
353	? fs.statSync((opts.root ? opts.root : '') + filepath).mtime	11✔
354	: undefined;
355	this.type(path.extname(filepath));	12✔
356	}
357	// If the input is a buffer, pass through
358	} else if (Buffer.isBuffer(file)) {	5✔
359	buffer = file;	3✔
360	} else {
361	throw new FileError('Invalid file', { path: file });	2✔
362	}
363
364	// Add headers from options
365	if (typeof opts.headers === 'object') {	19✔
366	Object.keys(opts.headers).map((header) => {	3✔
367	this.header(header, opts.headers[header]);	6✔
368	});
369	}
370
371	// Add cache-control headers
372	if (opts.cacheControl !== false) {	19✔
373	if (opts.cacheControl !== true && opts.cacheControl !== undefined) {	18✔
374	this.cache(opts.cacheControl);	1✔
375	} else {
376	this.cache(!isNaN(opts.maxAge) ? opts.maxAge : 0, opts.private);	17✔
377	}
378	}
379
380	// Add last-modified headers
381	if (opts.lastModified !== false) {	19✔
382	this.modified(opts.lastModified ? opts.lastModified : modified);	18✔
383	}
384
385	// Execute callback
386	await fn();	19✔
387
388	// Set base64 encoding flag
389	this._isBase64 = true;	19✔
390	// Convert buffer to base64 string
391	this.send(buffer.toString('base64'));	19✔
392	} catch (e) {
393	// TODO: Add second catch?
394	// Execute callback with caught error
395	await fn(e);	14✔
396
397	// If missing file
398	if (e.code === 'ENOENT') {	14✔
399	this.error(new FileError('No such file', e));	8✔
400	} else {
401	this.error(e); // Throw error if not done in callback	6✔
402	}
403	}
404	} // end sendFile
405
406	// Convenience method for setting type
407	type(type) {
408	let mimeType = UTILS.mimeLookup(type, this.app._mimeTypes);	32✔
409	if (mimeType) {	32✔
410	this.header('Content-Type', mimeType);	31✔
411	}
412	return this;	32✔
413	}
414
415	// Convenience method for sending status codes
416	sendStatus(status) {
417	this.status(status).send(UTILS.statusLookup(status));	2✔
418	}
419
420	// Convenience method for setting CORS headers
421	cors(options) {
422	const opts = typeof options === 'object' ? options : {};	6✔
423
424	// Check for existing headers
425	let acao = this.getHeader('Access-Control-Allow-Origin');	6✔
426	let acam = this.getHeader('Access-Control-Allow-Methods');	6✔
427	let acah = this.getHeader('Access-Control-Allow-Headers');	6✔
428
429	// Default CORS headers
430	this.header(	6✔
431	'Access-Control-Allow-Origin',
432	opts.origin ? opts.origin : acao ? acao : '*'	10✔
433	);
434	this.header(	6✔
435	'Access-Control-Allow-Methods',
436	opts.methods	6✔
437	? opts.methods
438	: acam	4✔
439	? acam
440	: 'GET, PUT, POST, DELETE, OPTIONS'
441	);
442	this.header(	6✔
443	'Access-Control-Allow-Headers',
444	opts.headers	6✔
445	? opts.headers
446	: acah	5✔
447	? acah
448	: 'Content-Type, Authorization, Content-Length, X-Requested-With'
449	);
450
451	// Optional CORS headers
452	if (opts.maxAge && !isNaN(opts.maxAge))	6✔
453	this.header(	1✔
454	'Access-Control-Max-Age',
455	((opts.maxAge / 1000) \| 0).toString()
456	);
457	if (opts.credentials)	6✔
458	this.header(	2✔
459	'Access-Control-Allow-Credentials',
460	opts.credentials.toString()
461	);
462	if (opts.exposeHeaders)	6✔
463	this.header('Access-Control-Expose-Headers', opts.exposeHeaders);	1✔
464
465	return this;	6✔
466	}
467
468	// Enable/Disable Etag
469	etag(enable) {
470	this._etag = enable === true ? true : false;	6✔
471	return this;	6✔
472	}
473
474	// Add cache-control headers
475	cache(maxAge, isPrivate = false) {	22✔
476	// if custom string value
477	if (maxAge !== true && maxAge !== undefined && typeof maxAge === 'string') {	28✔
478	this.header('Cache-Control', maxAge);	2✔
479	} else if (maxAge === false) {	26✔
480	this.header('Cache-Control', 'no-cache, no-store, must-revalidate');	1✔
481	} else {
482	maxAge = maxAge && !isNaN(maxAge) ? (maxAge / 1000) \| 0 : 0;	25✔
483	this.header(	25✔
484	'Cache-Control',
485	(isPrivate === true ? 'private, ' : '') + 'max-age=' + maxAge	25✔
486	);
487	this.header('Expires', new Date(Date.now() + maxAge).toUTCString());	25✔
488	}
489	return this;	28✔
490	}
491
492	// Add last-modified headers
493	modified(date) {
494	if (date !== false) {	24✔
495	let lastModified =
496	date && typeof date.toUTCString === 'function'	23✔
497	? date
498	: date && Date.parse(date)	17✔
499	? new Date(date)
500	: new Date();
501	this.header('Last-Modified', lastModified.toUTCString());	23✔
502	}
503	return this;	24✔
504	}
505
506	// Sends the request to the main callback
507	send(body) {
508	// Generate Etag
509	if (	662✔
510	this._etag && // if etag support enabled	677✔
511	['GET', 'HEAD'].includes(this._request.method) &&
512	!this.hasHeader('etag') &&
513	this._statusCode === 200
514	) {
515	this.header('etag', '"' + UTILS.generateEtag(body) + '"');	5✔
516	}
517
518	// Check for matching Etag
519	if (	662✔
520	this._request.headers['if-none-match'] &&	665✔
521	this._request.headers['if-none-match'] === this.getHeader('etag')
522	) {
523	this.status(304);	2✔
524	body = '';	2✔
525	}
526
527	let headers = {};	662✔
528	let cookies = {};	662✔
529
530	if (this._request.payloadVersion === '2.0') {	662✔
531	if (this._headers['set-cookie']) {	1!
532	cookies = { cookies: this._headers['set-cookie'] };	1✔
533	delete this._headers['set-cookie'];	1✔
534	}
535	}
536
537	if (this._request._multiValueSupport) {	662✔
538	headers = { multiValueHeaders: this._headers };	657✔
539	} else {
540	headers = { headers: UTILS.stringifyHeaders(this._headers) };	5✔
541	}
542
543	// Create the response
544	this._response = Object.assign(	662✔
545	{},
546	headers,
547	cookies,
548	{
549	statusCode: this._statusCode,
550	body:
551	this._request.method === 'HEAD'	662✔
552	? ''
553	: UTILS.encodeBody(body, this._serializer),
554	isBase64Encoded: this._isBase64,
555	},
556	this._request.interface === 'alb'	662✔
557	? {
558	statusDescription: `${this._statusCode} ${UTILS.statusLookup(
559	this._statusCode
560	)}`,
561	}
562	: {}
563	);
564
565	// Compress the body
566	if (this._compression && this._response.body) {	662✔
567	const { data, contentEncoding } = compression.compress(	3✔
568	this._response.body,
569	this._request.headers
570	);
571	if (contentEncoding) {	3!
572	Object.assign(this._response, {	3✔
573	body: data.toString('base64'),
574	isBase64Encoded: true,
575	});
576	if (this._response.multiValueHeaders) {	3!
577	this._response.multiValueHeaders['content-encoding'] = [	3✔
578	contentEncoding,
579	];
580	} else {
581	this._response.headers['content-encoding'] = contentEncoding;	×
582	}
583	}
584	}
585
586	// Trigger the callback function
587	this.app._callback(null, this._response, this);	662✔
588	} // end send
589
590	// Trigger API error
591	error(code, e, detail) {
592	detail = typeof code !== 'number' && e !== undefined ? e : detail;	37✔
593	e = typeof code !== 'number' ? code : e;	37✔
594	code = typeof code === 'number' ? code : undefined;	37✔
595	this.app.catchErrors(e, this, code, detail);	37✔
596	} // end error
597	} // end Response class
598
599	// Export the response object
600	module.exports = RESPONSE;	26✔

jeremydaly / lambda-api / #148

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