@eggjs/schedule 6.0.0-beta.20 → 6.0.0-beta.22

package/dist/agent-DUNNeo72.d.ts

@@ -1,100 +0,0 @@
-import { EggScheduleConfig } from "./config.default-Oe7rctMS.js";
-import { EggScheduleItem, EggScheduleJobInfo } from "./types-D3XkzB3g.js";
-import { CronExpression } from "cron-parser";
-import safeTimers from "safe-timers";
-import { Agent, EggLogger } from "egg";
-
-//#region src/lib/strategy/base.d.ts
-declare class BaseStrategy {
-  protected agent: ScheduleAgent;
-  protected scheduleConfig: EggScheduleConfig;
-  protected key: string;
-  protected logger: EggLogger;
-  protected closed: boolean;
-  count: number;
-  constructor(scheduleConfig: EggScheduleConfig, agent: ScheduleAgent, key: string);
-  /** keep compatibility */
-  get schedule(): EggScheduleConfig;
-  start(): Promise<void>;
-  close(): Promise<void>;
-  onJobStart(_info: EggScheduleJobInfo): void;
-  onJobFinish(_info: EggScheduleJobInfo): void;
-  /**
-   * trigger one worker
-   *
-   * @param {...any} args - pass to job task
-   */
-  sendOne(...args: any[]): void;
-  /**
-   * trigger all worker
-   *
-   * @param {...any} args - pass to job task
-   */
-  sendAll(...args: any[]): void;
-  getSeqId(): string;
-}
-//#endregion
-//#region src/lib/strategy/timer.d.ts
-declare abstract class TimerStrategy extends BaseStrategy {
-  #private;
-  protected cronInstance?: CronExpression;
-  constructor(scheduleConfig: EggScheduleConfig, agent: ScheduleAgent, key: string);
-  protected handler(): void;
-  start(): Promise<void>;
-  onJobStart(): void;
-  /**
-   * calculate next tick
-   *
-   * @return {Number|undefined} time interval, if out of range then return `undefined`
-   */
-  protected getNextTick(): number | undefined;
-  protected safeTimeout(handler: () => void, delay: number, ...args: any[]): number | safeTimers.Timeout;
-}
-//#endregion
-//#region src/lib/schedule.d.ts
-declare class Schedule {
-  #private;
-  closed: boolean;
-  constructor(agent: ScheduleAgent);
-  /**
-   * register a custom Schedule Strategy
-   * @param {String} type - strategy type
-   * @param {Strategy} clz - Strategy class
-   */
-  use(type: string, clz: typeof BaseStrategy): void;
-  /**
-   * load all schedule jobs, then initialize and register special strategy
-   */
-  init(): Promise<void>;
-  registerSchedule(scheduleItem: EggScheduleItem): void;
-  unregisterSchedule(key: string): boolean;
-  /**
-   * job finish event handler
-   *
-   * @param {Object} info - { id, key, success, message, workerId }
-   */
-  onJobFinish(info: EggScheduleJobInfo): void;
-  /**
-   * start schedule
-   */
-  start(): Promise<void>;
-  close(): Promise<void>;
-}
-//#endregion
-//#region src/app/extend/agent.d.ts
-declare class ScheduleAgent extends Agent {
-  /**
-   * @member agent#ScheduleStrategy
-   */
-  get ScheduleStrategy(): typeof BaseStrategy;
-  /**
-   * @member agent#TimerScheduleStrategy
-   */
-  get TimerScheduleStrategy(): typeof TimerStrategy;
-  /**
-   * @member agent#schedule
-   */
-  get schedule(): Schedule;
-}
-//#endregion
-export { BaseStrategy, Schedule, ScheduleAgent, TimerStrategy };

package/dist/all-DY7LEzzF.js

@@ -1,11 +0,0 @@
-import { TimerStrategy } from "./timer-B-5D2wim.js";
-
-//#region src/lib/strategy/all.ts
-var AllStrategy = class extends TimerStrategy {
-	handler() {
-		this.sendAll();
-	}
-};
-
-//#endregion
-export { AllStrategy };

package/dist/application-Be3vYRp0.d.ts

@@ -1,22 +0,0 @@
-import { EggScheduleItem } from "./types-D3XkzB3g.js";
-import { Application } from "egg";
-
-//#region src/lib/schedule_worker.d.ts
-declare class ScheduleWorker {
-  #private;
-  scheduleItems: Record<string, EggScheduleItem>;
-  constructor(app: ScheduleApplication);
-  init(): Promise<void>;
-  registerSchedule(scheduleItem: EggScheduleItem): void;
-  unregisterSchedule(key: string): void;
-}
-//#endregion
-//#region src/app/extend/application.d.ts
-declare class ScheduleApplication extends Application {
-  /**
-   * @member app#schedule
-   */
-  get scheduleWorker(): ScheduleWorker;
-}
-//#endregion
-export { ScheduleApplication, ScheduleWorker };

package/dist/application-CtPD5smr.js

@@ -1,18 +0,0 @@
-import { ScheduleWorker } from "./schedule_worker-DsbRF__K.js";
-import { Application } from "egg";
-
-//#region src/app/extend/application.ts
-const SCHEDULE_WORKER = Symbol("application scheduleWorker");
-var ScheduleApplication = class extends Application {
-	/**
-	* @member app#schedule
-	*/
-	get scheduleWorker() {
-		let scheduleWorker = this[SCHEDULE_WORKER];
-		if (!scheduleWorker) this[SCHEDULE_WORKER] = scheduleWorker = new ScheduleWorker(this);
-		return scheduleWorker;
-	}
-};
-
-//#endregion
-export { ScheduleApplication };

package/dist/application.unittest-BySM_r-a.js

@@ -1,46 +0,0 @@
-import { ScheduleApplication } from "./application-CtPD5smr.js";
-import { debuglog } from "node:util";
-import path from "node:path";
-import { importResolve } from "@eggjs/utils";
-
-//#region src/app/extend/application.unittest.ts
-const debug = debuglog("egg/schedule/app");
-var ScheduleApplicationUnittest = class extends ScheduleApplication {
-	async runSchedule(schedulePath, ...args) {
-		debug("[runSchedule] start schedulePath: %o, args: %o", schedulePath, args);
-		const config = this.config;
-		const directory = [path.join(config.baseDir, "app/schedule"), ...config.schedule.directory];
-		if (path.isAbsolute(schedulePath)) schedulePath = importResolve(schedulePath);
-		else for (const dir of directory) {
-			const trySchedulePath = path.join(dir, schedulePath);
-			try {
-				schedulePath = importResolve(trySchedulePath);
-				break;
-			} catch (err) {
-				debug("[runSchedule] importResolve %o error: %s", trySchedulePath, err);
-			}
-		}
-		debug("[runSchedule] resolve schedulePath: %o", schedulePath);
-		let schedule;
-		try {
-			schedule = this.scheduleWorker.scheduleItems[schedulePath];
-			if (!schedule) {
-				debug("[runSchedule] Cannot find schedule %o, scheduleItems: %o", schedulePath, this.scheduleWorker.scheduleItems);
-				throw new TypeError(`Cannot find schedule ${schedulePath}`);
-			}
-		} catch (err) {
-			err.message = `[@eggjs/schedule] ${err.message}`;
-			throw err;
-		}
-		const ctx = this.createAnonymousContext({
-			method: "SCHEDULE",
-			url: `/__schedule?path=${schedulePath}&${schedule.scheduleQueryString}`
-		});
-		return await this.ctxStorage.run(ctx, async () => {
-			return await schedule.task(ctx, ...args);
-		});
-	}
-};
-
-//#endregion
-export { ScheduleApplicationUnittest };

package/dist/application.unittest-DOurfxcE.d.ts

@@ -1,8 +0,0 @@
-import { ScheduleApplication } from "./application-Be3vYRp0.js";
-
-//#region src/app/extend/application.unittest.d.ts
-declare class ScheduleApplicationUnittest extends ScheduleApplication {
-  runSchedule(schedulePath: string, ...args: any[]): Promise<void>;
-}
-//#endregion
-export { ScheduleApplicationUnittest };

package/dist/base-BQ53Qv2t.js

@@ -1,73 +0,0 @@
-//#region src/lib/strategy/base.ts
-var BaseStrategy = class {
-	agent;
-	scheduleConfig;
-	key;
-	logger;
-	closed = false;
-	count = 0;
-	constructor(scheduleConfig, agent, key) {
-		this.agent = agent;
-		this.key = key;
-		this.scheduleConfig = scheduleConfig;
-		this.logger = this.agent.getLogger("scheduleLogger");
-	}
-	/** keep compatibility */
-	get schedule() {
-		return this.scheduleConfig;
-	}
-	async start() {}
-	async close() {
-		this.closed = true;
-	}
-	onJobStart(_info) {}
-	onJobFinish(_info) {}
-	/**
-	* trigger one worker
-	*
-	* @param {...any} args - pass to job task
-	*/
-	sendOne(...args) {
-		/* istanbul ignore next */
-		if (this.agent.schedule.closed) {
-			this.logger.warn(`${this.key} skip due to schedule closed`);
-			return;
-		}
-		this.count++;
-		const info = {
-			key: this.key,
-			id: this.getSeqId(),
-			args
-		};
-		this.logger.info(`[Job#${info.id}] ${info.key} triggered, send random by agent`);
-		this.agent.messenger.sendRandom("egg-schedule", info);
-		this.onJobStart(info);
-	}
-	/**
-	* trigger all worker
-	*
-	* @param {...any} args - pass to job task
-	*/
-	sendAll(...args) {
-		/* istanbul ignore next */
-		if (this.agent.schedule.closed) {
-			this.logger.warn(`${this.key} skip due to schedule closed`);
-			return;
-		}
-		this.count++;
-		const info = {
-			key: this.key,
-			id: this.getSeqId(),
-			args
-		};
-		this.logger.info(`[Job#${info.id}] ${info.key} triggered, send all by agent`);
-		this.agent.messenger.send("egg-schedule", info);
-		this.onJobStart(info);
-	}
-	getSeqId() {
-		return `${Date.now()}${process.hrtime().join("")}${this.count}`;
-	}
-};
-
-//#endregion
-export { BaseStrategy };

package/dist/config.default-Oe7rctMS.d.ts

@@ -1,20 +0,0 @@
-import { ParserOptions } from "cron-parser";
-import { PartialEggConfig } from "egg";
-
-//#region src/config/config.default.d.ts
-interface EggScheduleConfig {
-  type?: 'worker' | 'all';
-  interval?: string | number;
-  cron?: string;
-  cronOptions?: ParserOptions;
-  immediate?: boolean;
-  disable?: boolean;
-  env?: string[];
-  /**
-   * custom additional directory, full path
-   */
-  directory: string[];
-}
-declare const _default: PartialEggConfig;
-//#endregion
-export { EggScheduleConfig, _default };

package/dist/load_schedule-BwGbsGkz.js

@@ -1,61 +0,0 @@
-import assert from "node:assert";
-import path from "node:path";
-import { stringify } from "node:querystring";
-import { isClass, isFunction, isGeneratorFunction } from "is-type-of";
-import { importResolve } from "@eggjs/utils";
-
-//#region src/lib/load_schedule.ts
-function getScheduleLoader(app) {
-	return class ScheduleLoader extends app.loader.FileLoader {
-		async load() {
-			const target = this.options.target;
-			const items = await this.parse();
-			for (const item of items) {
-				const schedule = item.exports;
-				const fullpath = item.fullpath;
-				const scheduleConfig = schedule.schedule;
-				assert(scheduleConfig, `schedule(${fullpath}): must have "schedule" and "task" properties`);
-				assert(isClass(schedule) || isFunction(schedule.task), `schedule(${fullpath}: \`schedule.task\` should be function or \`schedule\` should be class`);
-				let task;
-				if (isClass(schedule)) {
-					assert(!isGeneratorFunction(schedule.prototype.subscribe), `schedule(${fullpath}): "schedule" generator function is not support, should use async function instead`);
-					task = async (ctx, ...args) => {
-						return new schedule(ctx).subscribe(...args);
-					};
-				} else {
-					assert(!isGeneratorFunction(schedule.task), `schedule(${fullpath}): "task" generator function is not support, should use async function instead`);
-					task = schedule.task;
-				}
-				const env = app.config.env;
-				const envList = schedule.schedule.env;
-				if (Array.isArray(envList) && !envList.includes(env)) {
-					app.coreLogger.info(`[@eggjs/schedule]: ignore schedule ${fullpath} due to \`schedule.env\` not match`);
-					continue;
-				}
-				const realFullpath = importResolve(fullpath);
-				target[realFullpath] = {
-					schedule: scheduleConfig,
-					scheduleQueryString: stringify(scheduleConfig),
-					task,
-					key: realFullpath
-				};
-			}
-			return target;
-		}
-	};
-}
-async function loadSchedule(app) {
-	const dirs = [...app.loader.getLoadUnits().map((unit) => path.join(unit.path, "app/schedule")), ...app.config.schedule.directory];
-	const Loader = getScheduleLoader(app);
-	const schedules = {};
-	await new Loader({
-		directory: dirs,
-		target: schedules,
-		inject: app
-	}).load();
-	Reflect.set(app, "schedules", schedules);
-	return schedules;
-}
-
-//#endregion
-export { loadSchedule };

package/dist/schedule-C0pZBoiR.js

@@ -1,77 +0,0 @@
-import { loadSchedule } from "./load_schedule-BwGbsGkz.js";
-import { debuglog } from "node:util";
-
-//#region src/lib/schedule.ts
-const debug = debuglog("egg/schedule/lib/schedule");
-var Schedule = class {
-	closed = false;
-	#agent;
-	#logger;
-	#strategyClassMap = /* @__PURE__ */ new Map();
-	#strategyInstanceMap = /* @__PURE__ */ new Map();
-	constructor(agent) {
-		this.#agent = agent;
-		this.#logger = agent.getLogger("scheduleLogger");
-	}
-	/**
-	* register a custom Schedule Strategy
-	* @param {String} type - strategy type
-	* @param {Strategy} clz - Strategy class
-	*/
-	use(type, clz) {
-		this.#strategyClassMap.set(type, clz);
-		debug("use type: %o", type);
-	}
-	/**
-	* load all schedule jobs, then initialize and register special strategy
-	*/
-	async init() {
-		const scheduleItems = await loadSchedule(this.#agent);
-		for (const scheduleItem of Object.values(scheduleItems)) this.registerSchedule(scheduleItem);
-	}
-	registerSchedule(scheduleItem) {
-		const { key, schedule } = scheduleItem;
-		const type = schedule.type;
-		if (schedule.disable) return;
-		const Strategy = this.#strategyClassMap.get(type);
-		if (!Strategy) {
-			const err = /* @__PURE__ */ new Error(`schedule type [${type}] is not defined`);
-			err.name = "EggScheduleError";
-			throw err;
-		}
-		const instance = new Strategy(schedule, this.#agent, key);
-		this.#strategyInstanceMap.set(key, instance);
-		debug("registerSchedule type: %o, config: %o, key: %o", type, schedule, key);
-	}
-	unregisterSchedule(key) {
-		debug("unregisterSchedule key: %o", key);
-		return this.#strategyInstanceMap.delete(key);
-	}
-	/**
-	* job finish event handler
-	*
-	* @param {Object} info - { id, key, success, message, workerId }
-	*/
-	onJobFinish(info) {
-		this.#logger.debug(`[Job#${info.id}] ${info.key} finish event received by agent from worker#${info.workerId}`);
-		const instance = this.#strategyInstanceMap.get(info.key);
-		/* istanbul ignore else */
-		if (instance) instance.onJobFinish(info);
-	}
-	/**
-	* start schedule
-	*/
-	async start() {
-		debug("start");
-		this.closed = false;
-		for (const instance of this.#strategyInstanceMap.values()) instance.start();
-	}
-	async close() {
-		this.closed = true;
-		for (const instance of this.#strategyInstanceMap.values()) await instance.close();
-		debug("close");
-	}
-};
-
-//#endregion
-export { Schedule };

package/dist/schedule_worker-DsbRF__K.js

@@ -1,22 +0,0 @@
-import { loadSchedule } from "./load_schedule-BwGbsGkz.js";
-
-//#region src/lib/schedule_worker.ts
-var ScheduleWorker = class {
-	#app;
-	scheduleItems = {};
-	constructor(app) {
-		this.#app = app;
-	}
-	async init() {
-		this.scheduleItems = await loadSchedule(this.#app);
-	}
-	registerSchedule(scheduleItem) {
-		this.scheduleItems[scheduleItem.key] = scheduleItem;
-	}
-	unregisterSchedule(key) {
-		delete this.scheduleItems[key];
-	}
-};
-
-//#endregion
-export { ScheduleWorker };

package/dist/timer-B-5D2wim.js

@@ -1,71 +0,0 @@
-import { BaseStrategy } from "./base-BQ53Qv2t.js";
-import assert from "node:assert";
-import cronParser from "cron-parser";
-import { ms } from "humanize-ms";
-import safeTimers from "safe-timers";
-import { logDate } from "utility";
-
-//#region src/lib/strategy/timer.ts
-var TimerStrategy = class extends BaseStrategy {
-	cronInstance;
-	constructor(scheduleConfig, agent, key) {
-		super(scheduleConfig, agent, key);
-		const { interval, cron, cronOptions, immediate } = this.scheduleConfig;
-		assert(interval || cron || immediate, `[@eggjs/schedule] ${this.key} \`schedule.interval\` or \`schedule.cron\` or \`schedule.immediate\` must be present`);
-		if (cron) try {
-			this.cronInstance = cronParser.parseExpression(cron, cronOptions);
-		} catch (err) {
-			throw new TypeError(`[@eggjs/schedule] ${this.key} parse cron instruction(${cron}) error: ${err.message}`, { cause: err });
-		}
-	}
-	handler() {
-		throw new TypeError(`[@eggjs/schedule] ${this.key} strategy should override \`handler()\` method`);
-	}
-	async start() {
-		/* istanbul ignore next */
-		if (this.agent.schedule.closed) return;
-		if (this.scheduleConfig.immediate) {
-			this.logger.info(`[Timer] ${this.key} next time will execute immediate`);
-			setImmediate(() => this.handler());
-		} else this.#scheduleNext();
-	}
-	#scheduleNext() {
-		/* istanbul ignore next */
-		if (this.agent.schedule.closed) return;
-		const nextTick = this.getNextTick();
-		if (nextTick) {
-			this.logger.info(`[Timer] ${this.key} next time will execute after ${nextTick}ms at ${logDate(new Date(Date.now() + nextTick))}`);
-			this.safeTimeout(() => this.handler(), nextTick);
-		} else this.logger.info(`[Timer] ${this.key} reach endDate, will stop`);
-	}
-	onJobStart() {
-		this.#scheduleNext();
-	}
-	/**
-	* calculate next tick
-	*
-	* @return {Number|undefined} time interval, if out of range then return `undefined`
-	*/
-	getNextTick() {
-		if (this.scheduleConfig.interval) return ms(this.scheduleConfig.interval);
-		if (this.cronInstance) {
-			const now = Date.now();
-			let nextTick;
-			do
-				try {
-					nextTick = this.cronInstance.next().getTime();
-				} catch (err) {
-					this.logger.info(`[Timer] ${this.key} cron out of the timespan range, error: %s`, err);
-					return;
-				}
-			while (now >= nextTick);
-			return nextTick - now;
-		}
-	}
-	safeTimeout(handler, delay, ...args) {
-		return (delay < safeTimers.maxInterval ? setTimeout : safeTimers.setTimeout)(handler, delay, ...args);
-	}
-};
-
-//#endregion
-export { TimerStrategy };

package/dist/types-C43iyhAd.js

@@ -1 +0,0 @@
-export {  };

package/dist/types-CPNMyF89.js

@@ -1 +0,0 @@
-export {  };

package/dist/types-D3XkzB3g.d.ts

@@ -1,21 +0,0 @@
-import { EggScheduleConfig } from "./config.default-Oe7rctMS.js";
-
-//#region src/lib/types.d.ts
-type EggScheduleTask = (ctx: any, ...args: any[]) => Promise<void>;
-interface EggScheduleItem {
-  schedule: EggScheduleConfig;
-  scheduleQueryString: string;
-  task: EggScheduleTask;
-  key: string;
-}
-interface EggScheduleJobInfo {
-  id: string;
-  key: string;
-  workerId: number;
-  args: any[];
-  success?: boolean;
-  message?: string;
-  rt?: number;
-}
-//#endregion
-export { EggScheduleItem, EggScheduleJobInfo, EggScheduleTask };

package/dist/types-VUtK3imu.d.ts

@@ -1,17 +0,0 @@
-import { EggScheduleConfig } from "./config.default-Oe7rctMS.js";
-
-//#region src/types.d.ts
-declare module 'egg' {
-  interface EggAppConfig {
-    /**
-     * Schedule Config
-     * @see https://www.eggjs.org/zh-CN/basics/schedule
-     */
-    schedule: EggScheduleConfig;
-  }
-}
-declare module '@eggjs/mock' {
-  interface MockApplication {
-    runSchedule(schedulePath: string, ...args: any[]): Promise<any>;
-  }
-}

package/dist/worker-Dc570kZo.js

@@ -1,11 +0,0 @@
-import { TimerStrategy } from "./timer-B-5D2wim.js";
-
-//#region src/lib/strategy/worker.ts
-var WorkerStrategy = class extends TimerStrategy {
-	handler() {
-		this.sendOne();
-	}
-};
-
-//#endregion
-export { WorkerStrategy };