@momsfriendlydevco/cowboy 1.0.3 → 1.0.5

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

@@ -27,6 +27,7 @@ export class Cowboy {
 	* @property {Function} pathTidy Additional tidyup for server request paths, useful if the API does not live at the server root. Defaults to removing a "/api/:worker/" prefix
 	*/
 	settings = {
+		patchAxios: true,
 		pathTidy(path) {
 			return path.replace(/^\/api\/\w+/, '/');
 		},
@@ -47,6 +48,13 @@ export class Cowboy {
 	routes = [];
 
 
+	/**
+	* Has completed one init() cycle
+	* @type {Boolean}
+	*/
+	doneInit = false;
+
+
 	/**
 	* Queue up a middleware path
 	* All given middleware is called in sequence, if middleware
@@ -70,6 +78,7 @@ export class Cowboy {
 	/**
 	* Prepend middleware which will be used for all routes
 	* @param {CowboyMiddleware} middleware Middleware to use
+	* @returns {Cowboy} This chainable Cowboy router instance
 	*/
 	use(...middleware) {
 		this.earlyMiddleware.push(middleware);
@@ -101,26 +110,32 @@ export class Cowboy {
 	* @returns {Promise<CowboyResponse>} A promise which will eventually resolve when all middleware completes
 	*/
 	async fetch(cfReq, env) {
-		if (env.COWBOY_DEBUG) {
+		this.init();
+
+		if (env.COWBOY_DEBUG)
 			debug.enabled = true;
-			debug('Cowboy Worker debugging is enabled');
-		}
 
 		// Create basic [req]uest / [res]ponse objects
 		let req = new CowboyRequest(cfReq, {
 			router: this,
 			pathTidy: this.settings.pathTidy,
 		});
+		if (cfReq.body) req.body = await cfReq.json();
+
 		let res = new CowboyResponse();
+		debug('Incoming request:', req.toString());
 
 		// Exec all earlyMiddleware - every time
-		await this.execMiddleware({req, res, middleware: this.earlyMiddleware});
+		await this.execMiddleware({
+			req, res,
+			middleware: this.earlyMiddleware,
+		});
 
 		// Find matching route
 		let route = this.resolve(req);
 		if (!route) {
 			if (debug.enabled) {
-				debug(`No matching route for "${req.method} ${req.path}"`);
+				debug(`No matching route for "${req.toString()}"`);
 				this.routes.forEach((r, i) =>
 					debug(
 						`Route #${i}`,
@@ -133,7 +148,10 @@ export class Cowboy {
 		}
 
 		// Exec route middleware
-		let response = await this.execMiddleware({req, res, middleware: route.middleware});
+		let response = await this.execMiddleware({
+			req, res,
+			middleware: route.middleware,
+		});
 
 		if (!response) throw new Error('Middleware chain ended without returning a response!');
 		if (!response.toCloudflareResponse) throw new Error('Eventual middleware chain output should have a .toCloudflareResponse() method');
@@ -142,12 +160,12 @@ export class Cowboy {
 
 
 	async execMiddleware({middleware, req, res}) {
-		let middlewareStack = [...middleware] // Shallow copy middleware stack to execute
+		let middlewareStack = middleware
 			.map(m => {
 				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
+					: typeof m == 'string' ? CowboyMiddleware[m].apply(this) // Lookup from middleware with defaults
+					: Array.isArray(m) ? CowboyMiddleware[m[0]].apply(this, 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)');
@@ -157,12 +175,29 @@ export class Cowboy {
 		let response; // Response to eventually send
 		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
+			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) {
+				let errorText = typeof e == 'string' ? e : e.toString();
+
+				debug('Error thrown', errorText);
+
+				// Form: '404: Not found'
+				if (/^(\d{3}):/.test(errorText)) {
+					let errorBits = /^(?<status>\d{3}):?(?<text>.*)$/.exec(errorText).groups;
+					res.status(errorBits.status).send(errorBits.text);
+				} else { // Generic error - assume 400
+					res.status(400).send(e.toString());
+				}
+
 				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);
 			}
 		}
 		return response;
@@ -176,6 +211,23 @@ export class Cowboy {
 	post(path, ...middleware) { return this.route('POST', path, ...middleware) }
 	put(path, ...middleware) { return this.route('PUT', path, ...middleware) }
 	options(path, ...middleware) { return this.route('OPTIONS', path, ...middleware) }
+
+
+	/**
+	* Generial Init() sequence
+	* This will be run automatically on setup or the first fetch()
+	* @returns {Cowboy} This chainable Cowboy router instance
+	*/
+	init() {
+		debug('INIT!');
+		if (this.doneInit) return this; // Already completed init
+
+		if (this.settings.patchAxios) {
+			// TODO: Patch Axios somehow
+			// axios.defaults.adapter = axiosFetchAdapter;
+		}
+		return this;
+	}
 }
 
 
@@ -191,5 +243,7 @@ export default function cowboy(options) {
 		fetch: cowboyInstance.fetch.bind(cowboyInstance),
 	});
 
+	cowboyInstance.init();
+
 	return cowboyInstance;
 }

package/lib/request.js

@@ -36,4 +36,13 @@ export default class CowboyRequest {
 		this.path = this.pathTidy(url.pathname);
 		this.hostname = url.hostname;
 	}
+
+
+	/**
+	* Utility function to simplify an incoming request
+	* @returns {String} Human readable string
+	*/
+	toString() {
+		return `${this.method} ${this.path}`;
+	}
 }

package/lib/response.js

@@ -99,7 +99,7 @@ export default class CowboyResponse {
 			status: this.code,
 			headers: this.headers,
 		};
-		console.log('Build response', JSON.stringify(cfOptions));
+		console.log('Build response', JSON.stringify({...cfOptions, body: this.body}, null, '\t'));
 		return new this.CloudflareResponse(this.body, cfOptions);
 	}
 }

package/lib/testkit.js

@@ -17,6 +17,7 @@ export let worker;
 *
 * @param {Object} [options] Additional options to mutate behaviour
 * @param {Axios} [options.axios] Axios instance to mutate with the base URL, if specified
+* @param {Boolean} [options.server=true] Initialize a local server - disable this if you're running your own
 * @param {Function} [options.logOutput] Function to wrap STDOUT output. Called as `(line:String)`
 * @param {Function} [options.logOutputErr] Function to wrap STDERR output. Called as `(line:String)`
 * @param {String} [options.host='127.0.0.1'] Host to run Wrangler on
@@ -28,6 +29,7 @@ export let worker;
 export function start(options) {
 	let settings = {
 		axios: null,
+		server: true,
 		logOutput: output => console.log('WRANGLER>', output),
 		logOutputErr: output => console.log('WRANGLER!', output),
 		host: '127.0.0.1',
@@ -51,6 +53,7 @@ export function start(options) {
 		// }}}
 		// Launch worker {{{
 		.then(()=> {
+			if (!settings.server) return;
 			debug('Running Wrangler against script', wranglerConfig.main);
 
 			let isRunning = false;

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.3",
+  "version": "1.0.5",
   "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",