@momsfriendlydevco/cowboy 1.4.1 → 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

@@ -148,10 +148,24 @@ export class Cowboy {
 						if (!this.schedule.handler) return res.status(404).send('No scheduler installed');
 
 						try {
-							let result = await this.schedule.handler.call(this, {}, env, {});
-							res.send(result);
+							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) {
-							res.status(400).send(`Scheduler threw error: ${e.toString()}`);
+							return res.status(400).send(`Scheduler threw error: ${e.toString()}`);
 						}
 					},
 				]
@@ -208,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
@@ -336,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()

package/package.json

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