@momsfriendlydevco/cowboy 1.4.0 → 1.5.0

package/README.md

@@ -10,6 +10,7 @@ Features:
 * Built in middleware + request validation via [Joi](https://joi.dev)
 * Built-in debug support for testkits + Wrangler
 * Built-in JSON / Multipart (or FormData) / Plain text decoding and population of `req.body`
+* Scheduled tasks can return promises and they are automatically awaited (no need to do `ctx.waitUntil()`)
 
 
 Examples

package/lib/cowboy.js

@@ -25,10 +25,11 @@ export class Cowboy {
 	* General settings for this Cowboy instance
 	*
 	* @type {Object}
+	* @property {Boolean|'VAR'} scheduler Add a generic `/__scheduled` endpoint to execute any queued scheduler. If value is `'VAR'` this will only apply if the env `COWBOY_SCHEDULER` is set and truthy
 	* @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,
+		scheduler: 'VAR',
 		pathTidy(path) {
 			return path
 				.replace(/^\/api\/\w+/, '/')
@@ -62,7 +63,7 @@ export class Cowboy {
 	* Queue up a middleware path
 	* All given middleware is called in sequence, if middleware
 	*
-	* @param {String|Array<String>} methods A method matcher or array of available methods
+	* @param {String|Array<String>} methods A method matcher or array of available methods in upper-case
 	* @param {String|RegExp|Array<String|RegExp>} paths A prefix path to match
 	* @param {CowboyMiddleware...} middleware Middleware to call in sequence
 	*
@@ -118,6 +119,60 @@ export class Cowboy {
 		if (env.COWBOY_DEBUG)
 			debug.enabled = true;
 
+		if ( // Setup scheduler endpoint if this is the first fetch() hit were we can access the `env` state
+			!this._schedulerSetup
+			&& (
+				this.settings.scheduler === true
+				|| (
+					this.settings.scheduler == 'VAR'
+					&& env.COWBOY_SCHEDULER
+				)
+			)
+		) {
+			console.log('Scheduler setup against /__scheduled');
+			this._schedulerSetup = true;
+
+			// Find first GET operation
+			let routeIndex = this.routes.findIndex(r => r.methods.some(m => m == 'GET'));
+			if (routeIndex < 0) routeIndex = this.routes.length; // If no GETS, assume end position
+
+			// Splice into position before first GET
+			let matcher = compileRoutePaths('/__scheduled');
+			this.routes.splice(routeIndex, 0, {
+				methods: ['GET'],
+				paths: matcher.paths,
+				matcher,
+				middleware: [
+					async (req, res, env) => {
+						debug('Executing schedule handler');
+						if (!this.schedule.handler) return res.status(404).send('No scheduler installed');
+
+						try {
+							let result = await this.schedule.handler.call(
+								this,
+								{ // Faked Cloudflare `controller` context
+									cron: 'FAKE',
+									type: 'scheduled',
+									scheduledTime: (new Date()).toISOString(),
+								},
+								env,
+								{ // Faked Cloudflare `ctx` context - we provide a fake waitUntil here
+									waitUntil() {
+										throw new Error('ctx.waitUntil() functionality is provided natively by Cowboy.schedule(cb:Function) - just return a promise instead of using it');
+									},
+								},
+							);
+							debug('Got scheduler response', result);
+							return res.send(result);
+						} catch (e) {
+							return res.status(400).send(`Scheduler threw error: ${e.toString()}`);
+						}
+					},
+				]
+			});
+		}
+
+
 		// Create basic [req]uest / [res]ponse objects
 		let req = new CowboyRequest(cfReq, {
 			router: this,
@@ -167,23 +222,6 @@ export class Cowboy {
 	}
 
 
-	/**
-	* Set up Cloudflare response to "scheduled" call
-	* This is really just a map to the last handler we installed to .schedule(cb) - for now
-	*
-	* @param {CloudflareEvent} event The Cloudflare event context passed
-	* @param {Object} env Environment variables
-	* @param {CloudflareContext} ctx The Cloudflare context to respond to
-	*
-	* @returns {Cowboy} This chainable Cowboy router instance
-	*/
-	scheduled(event, env, ctx) {
-		if (!this.schedule.handler) throw new Error('Attemped to access Cowboy.scheduled without first calling .schedule() to set something up!');
-		this.schedule.handler.call(this, event, env, ctx);
-		return this;
-	}
-
-
 	/**
 	* Call a router function as if it were invoked directly
 	* This function exists as an easier way to remap body contents without
@@ -295,12 +333,43 @@ export class Cowboy {
 	* @returns {Cowboy} This chainable Cowboy router instance
 	*/
 	schedule(handler) {
-		console.info('Installed schedule event handler. Access via http://localhost:8787/__scheduled');
+		debug('Installed schedule event handler');
 		this.schedule.handler = handler;
 		return this;
 	}
 
 
+	/**
+	* Set up Cloudflare response to "scheduled" call
+	* This is really just a map to the last handler we installed to .schedule(cb) - for now
+	*
+	* @param {CloudflareEvent} event The Cloudflare event context passed
+	* @param {Object} env Environment variables
+	* @param {CloudflareContext} ctx The Cloudflare context to respond to
+	*
+	* @returns {Cowboy} This chainable Cowboy router instance
+	*/
+	scheduled(event, env, ctx) {
+		if (!this.schedule.handler) throw new Error('Attemped to access Cowboy.scheduled without first calling .schedule() to set something up!');
+
+		// Wrap all scheduler calls in ctx.waitUntil() so promises are always waited on
+		ctx.waitUntil(
+			this.schedule.handler.call(
+				this,
+				event,
+				env,
+				{
+					waitUntil() {
+						throw new Error('ctx.waitUntil() functionality is provided natively by Cowboy.schedule(cb:Function) - just return a promise instead of using it');
+					},
+				},
+			)
+		);
+
+		return this;
+	}
+
+
 	/**
 	* Generial Init() sequence
 	* This will be run automatically on setup or the first fetch()
@@ -310,10 +379,6 @@ export class Cowboy {
 		if (this.doneInit) return this; // Already completed init
 		debug('INIT!');
 
-		if (this.settings.patchAxios) {
-			// TODO: Patch Axios somehow
-			// axios.defaults.adapter = axiosFetchAdapter;
-		}
 		return this;
 	}
 }

package/lib/testkit.js

@@ -19,6 +19,7 @@ export let worker;
 * @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 {Boolean} [options.debug=false] Force debug as if `DEBUG=cowboy` was set
+* @param {Boolean} [options.scheduler=false] Bind any scedhuler callback to `/__scheduled`
 * @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
@@ -32,6 +33,7 @@ export function start(options) {
 		axios: null,
 		server: true,
 		debug: false,
+		scheduler: false,
 		logOutput: output => console.log('WRANGLER>', output),
 		logOutputErr: output => console.log('WRANGLER!', output),
 		host: '127.0.0.1',
@@ -70,6 +72,9 @@ export function start(options) {
 					...(debug.enabled ? [
 						'--var=COWBOY_DEBUG:1'
 					]: []),
+					...(settings.scheduler ? [
+						'--var=COWBOY_SCHEDULER:1'
+					]: []),
 				]);
 
 				worker.stdout.on('data', data => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@momsfriendlydevco/cowboy",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Wrapper around Cloudflare Wrangler to provide a more Express-like experience",
   "scripts": {
     "lint": "eslint"