Merge pull request #652 from cloudflare/jspspike/cron-trigger

Trigger scheduled handler on '/cdn-cgi/mf/scheduled'
cloudflare · Aug 14, 2023 · 3b4b175 · 3b4b175
2 parents cf080a8 + 9b183da
commit 3b4b175
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 15 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/miniflare/package.json b/packages/miniflare/package.json
@@ -45,7 +45,7 @@
     "zod": "^3.20.6"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20230419.0",
+    "@cloudflare/workers-types": "^4.20230807.0",
     "@types/better-sqlite3": "^7.6.2",
     "@types/debug": "^4.1.7",
     "@types/estree": "^1.0.0",

diff --git a/packages/miniflare/src/workers/core/entry.worker.ts b/packages/miniflare/src/workers/core/entry.worker.ts
@@ -159,11 +159,29 @@ async function handleQueue(
   const flattened = await request.json<number | unknown[]>();
   const messages = unflatten(flattened, structuredSerializableRevivers);
   const queueResponse = await service.queue(queueName, messages);
-  (queueResponse as QueueResponse & { time: number }).time =
+  (queueResponse as FetcherQueueResult & { time: number }).time =
     Date.now() - startTime;
   return Response.json(queueResponse);
 }
 
+async function handleScheduled(
+  params: URLSearchParams,
+  service: Fetcher
+): Promise<Response> {
+  const time = params.get("time");
+  const scheduledTime = time ? new Date(parseInt(time)) : undefined;
+  const cron = params.get("cron") ?? undefined;
+
+  const result = await service.scheduled({
+    scheduledTime,
+    cron,
+  });
+
+  return new Response(result.outcome, {
+    status: result.outcome === "ok" ? 200 : 500,
+  });
+}
+
 export default <ExportedHandler<Env>>{
   async fetch(request, env, ctx) {
     const startTime = Date.now();
@@ -183,11 +201,14 @@ export default <ExportedHandler<Env>>{
 
     try {
       const customEvent = request.headers.get(CoreHeaders.CUSTOM_EVENT);
-      // TODO(soon): support scheduled events, requires support from workerd
       if (customEvent === "queue") {
         return await handleQueue(request, url, service, startTime);
       }
 
+      if (url.pathname === "/cdn-cgi/mf/scheduled") {
+        return await handleScheduled(url.searchParams, service);
+      }
+
       let response = await service.fetch(request);
       if (!isDispatchFetch) {
         response = await maybePrettifyError(request, response, env);

diff --git a/packages/miniflare/test/index.spec.ts b/packages/miniflare/test/index.spec.ts
@@ -498,3 +498,31 @@ test("Miniflare: Accepts https requests", async (t) => {
 
   t.assert(log.logs[0][1].startsWith("Ready on https://"));
 });
+
+test("Miniflare: Manually triggered scheduled events", async (t) => {
+  const log = new TestLog(t);
+
+  const mf = new Miniflare({
+    log,
+    modules: true,
+    script: `
+    let scheduledRun = false;
+    export default {
+      fetch() {
+        return new Response(scheduledRun);
+      },
+      scheduled() {
+        scheduledRun = true;
+      }
+    }`,
+  });
+
+  let res = await mf.dispatchFetch("http://localhost");
+  t.is(await res.text(), "false");
+
+  res = await mf.dispatchFetch("http://localhost/cdn-cgi/mf/scheduled");
+  t.is(await res.text(), "ok");
+
+  res = await mf.dispatchFetch("http://localhost");
+  t.is(await res.text(), "true");
+});
diff --git a/packages/miniflare/test/plugins/d1/shared.ts b/packages/miniflare/test/plugins/d1/shared.ts
@@ -54,9 +54,6 @@ export class TestD1Database implements D1Database {
     return this[kSend]("/batch", statements);
   }
 
-  // @ts-expect-error this function should return a `Promise<D1ExecResult>`,
-  //  not a `Promise<D1Result<T>>`, `@cloudflare/workers-types` is wrong here
-  //  TODO(now): fix in `@cloudflare/workers-types`
   async exec(query: string): Promise<D1ExecResult> {
     return this[kSend]("/exec", query);
   }

diff --git a/packages/miniflare/test/plugins/d1/suite.ts b/packages/miniflare/test/plugins/d1/suite.ts
@@ -192,7 +192,7 @@ export default (binding: string, WORKER_PATH: string) => {
     const select = await db.prepare(`SELECT * FROM ${tableColours}`);
     let result: ColourRow | null = await select.first<ColourRow>();
     t.deepEqual(result, { id: 1, name: "red", rgb: 0xff0000 });
-    let id = await select.first<number>("id");
+    let id: number | null = await select.first<number>("id");
     t.is(id, 1);
 
     // Check with multiple statements (should only match on first statement)