@momsfriendlydevco/cowboy 1.0.2 → 1.0.4

package/README.md

@@ -296,10 +296,10 @@ cors
 Inject simple CORS headers to allow websites to use the endpoint from the browser frontend.
 
 
-validate
---------
-Validate the incoming `req` object using [Joyful](https://github.com/MomsFriendlyDevCo/Joyful).
-The only argument is the Joyful validator which is run against `req`.
+validate(key, validator)
+------------------------
+Validate the incoming `req.$KEY` object using [Joyful](https://github.com/MomsFriendlyDevCo/Joyful).
+This function takes two arguments - the `req` subkey to examine and the validation function / object.
 
 ```javascript
 import cowboy from '@momsfriendlydevco/cowboy';
@@ -307,18 +307,16 @@ import cowboy from '@momsfriendlydevco/cowboy';
 // Shorthand with defaults - just specify the name
 cowboy()
 	.get('/path',
-		['validate', joi => {
-			body: {
-				widget: joi.string().required().valid('froody', 'doodad'),
-				size: joi.number().optional(),
-			},
+		['validate', 'body', joi => {
+			widget: joi.string().required().valid('froody', 'doodad'),
+			size: joi.number().optional(),
 		})],
 		(req, res) => /* ... */
 	)
 ```
 
-validateBody
-------------
+validateBody(validator)
+-----------------------
 Shorthand validator which runs validation on the `req.body` parameter only.
 
 
@@ -328,7 +326,7 @@ import cowboy from '@momsfriendlydevco/cowboy';
 // Shorthand with defaults - just specify the name
 cowboy()
 	.get('/path',
-		['validateBody', joi => {
+		['validateBody', joi => ({
 			widget: joi.string().required().valid('froody', 'doodad'),
 			size: joi.number().optional(),
 		})],
@@ -337,8 +335,8 @@ cowboy()
 ```
 
 
-validateParams
---------------
+validateParams(validator)
+-------------------------
 Shorthand validator which runs validation on the `req.params` parameter only.
 
 
@@ -356,8 +354,8 @@ cowboy()
 ```
 
 
-validateQuery
--------------
+validateQuery(validator)
+------------------------
 Shorthand validator which runs validation on the `req.query` parameter only.
 
 

package/lib/cowboy.js

@@ -28,7 +28,7 @@ export class Cowboy {
 	*/
 	settings = {
 		pathTidy(path) {
-			return path.replace(/^\/api\/\w+\//, '/');
+			return path.replace(/^\/api\/\w+/, '/');
 		},
 	};
 
@@ -114,6 +114,7 @@ export class Cowboy {
 		let res = new CowboyResponse();
 
 		// Exec all earlyMiddleware - every time
+		debug('Run middleware');
 		await this.execMiddleware({req, res, middleware: this.earlyMiddleware});
 
 		// Find matching route
@@ -147,7 +148,7 @@ export class Cowboy {
 				let mFunc =
 					typeof m == 'function' ? m // Already a function
 					: typeof m == 'string' ? CowboyMiddleware[m]() // Lookup from middleware with defaults
-					: Array.isArray(m) ? CowboyMiddleware[m[0]](m[1]) // Lookup from middleware with options
+					: Array.isArray(m) ? CowboyMiddleware[m[0]](...m.slice(1)) // Lookup from middleware with options
 					: (()=> { throw new Error(`Unknown middleware type "${typeof m}"`) })()
 
 				if (!mFunc) throw new Error('Cowboy Middleware must be a function, string or Record(name, options)');
@@ -155,14 +156,22 @@ export class Cowboy {
 			});
 
 		let response; // Response to eventually send
+		debug('Run middleware stack', middlewareStack);
 		while (middlewareStack.length > 0) {
 			let middleware = middlewareStack.shift();
-			response = await middleware(req, res);
-			if (response?.hasSent) { // Stop middleware chain as some intermediate has signalled the chain should end
-				response = res;
+			try {
+				response = await middleware(req, res);
+				if (response?.hasSent) { // Stop middleware chain as some intermediate has signalled the chain should end
+					response = res;
+					break;
+				} else if (response && !(response instanceof CowboyResponse) && middlewareStack.length == 0) { // Last item in middleware chain returned something but it doesn't look like a regular response - wrap it
+					response = res.end(response);
+				}
+			} catch (e) {
+				debug('Error trace', e.trace);
+				res.status(500).send(e.toString());
+				response = null;
 				break;
-			} else if (response && !(response instanceof CowboyResponse) && middlewareStack.length == 0) { // Last item in middleware chain returned something but it doesn't look like a regular response - wrap it
-				response = res.end(response);
 			}
 		}
 		return response;

package/lib/response.js

@@ -66,7 +66,11 @@ export default class CowboyResponse {
 	*/
 	status(code) {
 		this.code = code;
-		if (!this.body) this.body = 'ok'; // Set body payload if we don't already have one
+		if (!this.body)
+			this.body = this.code >= 200 && this.code <= 299
+				? 'ok' // Set body payload if we don't already have one
+				: `${this.code}: Fail`
+
 		return this;
 	}
 

package/middleware/cors.js

@@ -11,8 +11,11 @@ export default function CowboyMiddlewareCORS(headers) {
 		res.set(injectHeaders);
 
 		// Handle hits to OPTIONS '/' endpoint
-		req.router.options('/', (req, res) => {
-			return res.sendStatus(200);
-		});
+		if (!req.router.loadedCors) {
+			req.router.options('/', (req, res) => {
+				return res.sendStatus(200);
+			});
+			req.router.loadedCors = true; // Mark we've already done this so we don't keep tweaking the router
+		}
 	}
 }

package/middleware/validate.js

@@ -1,8 +1,10 @@
 import joyful from '@momsfriendlydevco/joyful';
 
-export default function CowboyMiddlewareValidate(validator) {
+export default function CowboyMiddlewareValidate(subkey, validator) {
 	return (req, res) => {
-		let joyfulResult = joyful(req, validator, {throw: false});
+		let joyfulResult = joyful({
+			[subkey]: validator,
+		});
 
 		if (joyfulResult !== true) { // Failed body validation?
 			return res

package/middleware/validateBody.js

@@ -1,7 +1,7 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateBody(validator) {
-	return CowboyMiddlewareValidate({
+	return CowboyMiddlewareValidate('body', {
 		body: validator,
 	})
 }

package/middleware/validateParams.js

@@ -1,7 +1,7 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateParams(validator) {
-	return CowboyMiddlewareValidate({
+	return CowboyMiddlewareValidate('params', {
 		params: validator,
 	})
 }

package/middleware/validateQuery.js

@@ -1,7 +1,7 @@
 import CowboyMiddlewareValidate from '#middleware/validate';
 
 export default function CowboyMiddlewareValidateQuery(validator) {
-	return CowboyMiddlewareValidate({
+	return CowboyMiddlewareValidate('query', {
 		query: validator,
 	})
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@momsfriendlydevco/cowboy",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Wrapper around Cloudflare Wrangler to provide a more Express-like experience",
   "scripts": {
     "lint": "eslint ."
@@ -35,12 +35,12 @@
     "node": ">=20.x"
   },
   "dependencies": {
-    "@momsfriendlydevco/joyful": "^1.0.0",
+    "@momsfriendlydevco/joyful": "^1.0.1",
     "toml": "^3.0.0"
   },
   "devDependencies": {
     "@momsfriendlydevco/eslint-config": "^1.0.7",
-    "eslint": "^8.50.0"
+    "eslint": "^8.51.0"
   },
   "eslintConfig": {
     "extends": "@momsfriendlydevco",