pixl-server-web 2.0.12 → 2.0.13

package/README.md

@@ -98,6 +98,7 @@ This module is a component for use in [pixl-server](https://www.github.com/jhuck
 		+ [args.perf](#argsperf)
 		+ [args.server](#argsserver)
 		+ [args.id](#argsid)
+		+ [args.setCookie](#argssetcookie)
 	* [Request Filters](#request-filters)
 - [Transaction Logging](#transaction-logging)
 	* [Request Detail Logging](#request-detail-logging)
@@ -1166,6 +1167,14 @@ This is a reference to the pixl-server object which handled the request.
 
 This is an internal ID string used by the server to track and log individual requests.
 
+### args.setCookie
+
+A utility function used to serialize cookies into the proper format, and set or append them to the `Set-Cookie` response header.  It accepts a name, a value, and an optional set of options.  Example use:
+
+```js
+args.setCookie( 'session', 'ABDEF01234567890', { path: '/', maxAge: 86400, secure: true, httpOnly: true, sameSite: 'Lax' } );
+```
+
 ## Request Filters
 
 Filters allow you to preprocess a request, before any handlers get their hands on it.  They can pass data through, manipulate it, or even interrupt and abort requests.  Filters are attached to particular URIs or URI patterns, and multiple may be applied to one request, depending on your rules.  They can be asynchronous, and can also pass data between one another if desired.

package/lib/args.js

@@ -0,0 +1,48 @@
+// Simple HTTP / HTTPS Web Server
+// A component for the pixl-server daemon framework.
+// Copyright (c) 2015 - 2025 Joseph Huckaby
+// Released under the MIT License
+
+module.exports = class Args {
+	
+	constructor(args = {}) {
+		// import k/v pairs
+		for (var key in args) this[key] = args[key];
+	}
+	
+	setCookie(name, value, opts) {
+		// set cookie in response headers
+		// opts: { maxAge?, expires?, domain?, path?, secure?, httpOnly?, sameSite? }
+		const res = this.response;
+		const enc = (s) => encodeURIComponent(s);
+		const parts = [`${enc(name)}=${value === '' ? '' : enc(value)}`];
+		
+		// serialize cookie to string
+		if (opts.maxAge != null) parts.push(`Max-Age=${Math.floor(opts.maxAge)}`);
+		if (opts.expires) parts.push(`Expires=${opts.expires.toUTCString()}`);
+		if (opts.domain) parts.push(`Domain=${opts.domain}`);
+		parts.push(`Path=${opts.path || '/'}`);
+		if (opts.secure) {
+			if (opts.secure === 'auto') {
+				if (this.request.headers.ssl) parts.push('Secure');
+			}
+			else parts.push('Secure');
+		}
+		if (opts.httpOnly !== false) parts.push('HttpOnly'); // default on
+		if (opts.sameSite) {
+			const ss = String(opts.sameSite).toLowerCase();
+			const token = ss === 'strict' ? 'Strict' : ss === 'none' ? 'None' : 'Lax';
+			parts.push(`SameSite=${token}`);
+		} else {
+			parts.push('SameSite=Lax');
+		}
+		const cookieStr = parts.join('; ');
+		
+		// append to previous set-cookie or set as solo header
+		const prev = res.getHeader('Set-Cookie');
+		if (!prev) res.setHeader('Set-Cookie', cookieStr);
+		else if (Array.isArray(prev)) res.setHeader('Set-Cookie', prev.concat(cookieStr));
+		else res.setHeader('Set-Cookie', [prev, cookieStr]);
+	}
+	
+};

package/lib/request.js

@@ -7,19 +7,20 @@ const async = require('async');
 const Formidable = require('formidable');
 const Querystring = require('querystring');
 const Perf = require('pixl-perf');
+const Args = require('./args.js');
 
 module.exports = class Request {
 
 	enqueueHTTPRequest(request, response) {
 		// enqueue request for handling as soon as concurrency limits allow
-		var args = {
+		var args = new Args({
 			id: this.getNextId('r'),
 			date: Date.now() / 1000,
 			request: request,
 			response: response,
 			state: 'queued',
 			perf: new Perf()
-		};
+		});
 		
 		// take snapshot of req and socket counts at start of request, used by perf logger at end
 		if (this.logPerfEnabled) {
@@ -252,7 +253,8 @@ module.exports = class Request {
 			var pairs = request.headers['cookie'].split(/\;\s*/);
 			for (var idx = 0, len = pairs.length; idx < len; idx++) {
 				if (pairs[idx].match(/^([^\=]+)\=(.*)$/)) {
-					args.cookies[ RegExp.$1 ] = RegExp.$2;
+					var key = RegExp.$1, value = RegExp.$2;
+					args.cookies[ decodeURIComponent(key) ] = decodeURIComponent(value);
 				}
 			} // foreach cookie
 		} // headers.cookie

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-server-web",
-	"version": "2.0.12",
+	"version": "2.0.13",
 	"description": "A web server component for the pixl-server framework.",
 	"author": "Joseph Huckaby <jhuckaby@gmail.com>",
 	"homepage": "https://github.com/jhuckaby/pixl-server-web",