Rename Scheduler class to CronScheduler

Author: mrbbot

packages/miniflare/src/api.ts

@@ -19,7 +19,7 @@ import { HTTPPlugin, createServer, startServer } from "@miniflare/http-server";
 import { KVNamespace, KVPlugin } from "@miniflare/kv";
 import { VMScriptRunner } from "@miniflare/runner-vm";
 import {
-  Scheduler,
+  CronScheduler,
   SchedulerPlugin,
   startScheduler,
 } from "@miniflare/scheduler";
@@ -131,7 +131,7 @@ export class Miniflare extends MiniflareCore<Plugins> {
     return startServer(this, options);
   }
 
-  startScheduler(): Promise<Scheduler<Plugins>> {
+  startScheduler(): Promise<CronScheduler<Plugins>> {
     return startScheduler(this);
   }
 }

packages/scheduler/src/index.ts

@@ -9,7 +9,7 @@ import { SchedulerPlugin } from "./plugin";
 
 export * from "./plugin";
 
-export interface CronScheduler {
+export interface CronSchedulerImpl {
   setInterval(cron: Cron, task: () => any): ITimerHandle;
   clearTimeoutOrInterval(handle: ITimerHandle): void;
 }
@@ -20,14 +20,14 @@ export type SchedulerPluginSignatures = CorePluginSignatures & {
 
 const kReload = Symbol("kReload");
 
-export class Scheduler<Plugins extends SchedulerPluginSignatures> {
+export class CronScheduler<Plugins extends SchedulerPluginSignatures> {
   // noinspection JSMismatchedCollectionQueryUpdate
   private previousValidatedCrons?: Cron[];
   private scheduledHandles?: ITimerHandle[];
 
   constructor(
     private readonly mf: MiniflareCore<Plugins>,
-    private readonly cronScheduler: Promise<CronScheduler> = import(
+    private readonly cronScheduler: Promise<CronSchedulerImpl> = import(
       "cron-schedule"
     ).then((module) => module.TimerBasedCronScheduler)
   ) {
@@ -76,9 +76,9 @@ export class Scheduler<Plugins extends SchedulerPluginSignatures> {
 
 export async function startScheduler<Plugins extends SchedulerPluginSignatures>(
   mf: MiniflareCore<Plugins>,
-  cronScheduler?: Promise<CronScheduler>
-): Promise<Scheduler<Plugins>> {
-  const scheduler = new Scheduler(mf, cronScheduler);
+  cronScheduler?: Promise<CronSchedulerImpl>
+): Promise<CronScheduler<Plugins>> {
+  const scheduler = new CronScheduler(mf, cronScheduler);
   const reloadEvent = new ReloadEvent("reload", {
     plugins: await mf.getPlugins(),
     initial: false,

packages/scheduler/test/index.spec.ts

@@ -2,7 +2,7 @@ import { setImmediate } from "timers/promises";
 import { BindingsPlugin, ScheduledEvent } from "@miniflare/core";
 import {
   CronScheduler,
-  Scheduler,
+  CronSchedulerImpl,
   SchedulerPlugin,
   startScheduler,
 } from "@miniflare/scheduler";
@@ -14,10 +14,10 @@ import { Cron, ITimerHandle } from "cron-schedule";
 // Waiting for CRONs is slow, so mock out a scheduler with manual dispatch
 function createCronScheduler(): [
   dispatch: (cron: string) => Promise<void>,
-  scheduler: Promise<CronScheduler>
+  scheduler: Promise<CronSchedulerImpl>
 ] {
   const crons = new Map<string, Set<() => Awaitable<void>>>();
-  const scheduler: CronScheduler = {
+  const scheduler: CronSchedulerImpl = {
     setInterval(cron: Cron, task: () => Awaitable<void>): ITimerHandle {
       const spec = cron.toString();
       const set = crons.get(spec) ?? new Set();
@@ -37,7 +37,7 @@ function createCronScheduler(): [
   return [dispatch, Promise.resolve(scheduler)];
 }
 
-test("Scheduler: schedules tasks for validated CRONs on reload", async (t) => {
+test("CronScheduler: schedules tasks for validated CRONs on reload", async (t) => {
   let events: ScheduledEvent[] = [];
   const log = new TestLog();
   const mf = useMiniflare(
@@ -51,7 +51,7 @@ test("Scheduler: schedules tasks for validated CRONs on reload", async (t) => {
   );
   await mf.getPlugins(); // Wait for initial reload
   const [dispatch, cronScheduler] = createCronScheduler();
-  new Scheduler(mf, cronScheduler);
+  new CronScheduler(mf, cronScheduler);
   await setImmediate();
 
   // Check scheduler requires reload to schedule tasks
@@ -73,7 +73,7 @@ test("Scheduler: schedules tasks for validated CRONs on reload", async (t) => {
   t.is(events[0].cron, "30 * * * *");
   t.regex(log.logs[0][1], /^SCHD 30 \* \* \* \* \(\d+\.\d+ms\)$/);
 });
-test("Scheduler: destroys tasks when CRONs change", async (t) => {
+test("CronScheduler: destroys tasks when CRONs change", async (t) => {
   const events: ScheduledEvent[] = [];
   // noinspection JSUnusedGlobalSymbols
   const options = {
@@ -84,7 +84,7 @@ test("Scheduler: destroys tasks when CRONs change", async (t) => {
   const mf = useMiniflare({ SchedulerPlugin, BindingsPlugin }, options);
   await mf.getPlugins(); // Wait for initial reload
   const [dispatch, cronScheduler] = createCronScheduler();
-  new Scheduler(mf, cronScheduler);
+  new CronScheduler(mf, cronScheduler);
   await mf.reload(); // Schedule tasks
 
   t.is(events.length, 0);
@@ -99,7 +99,7 @@ test("Scheduler: destroys tasks when CRONs change", async (t) => {
   t.is(events.length, 2);
 });
 
-test("Scheduler: dispose: destroys tasks and removes reload listener", async (t) => {
+test("CronScheduler: dispose: destroys tasks and removes reload listener", async (t) => {
   const events: ScheduledEvent[] = [];
   const mf = useMiniflare(
     { SchedulerPlugin, BindingsPlugin },
@@ -111,7 +111,7 @@ test("Scheduler: dispose: destroys tasks and removes reload listener", async (t)
   );
   await mf.getPlugins(); // Wait for initial reload
   const [dispatch, cronScheduler] = createCronScheduler();
-  const scheduler = new Scheduler(mf, cronScheduler);
+  const scheduler = new CronScheduler(mf, cronScheduler);
   await mf.reload(); // Schedule tasks
 
   t.is(events.length, 0);