@h3ravel/queue 11.15.0-alpha.16 → 11.17.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="./app.globals.d.ts" />
+import { RuntimeException } from "@h3ravel/support";
 import { ClassConstructor, JobPayload } from "@h3ravel/contracts";
 import { Container, ServiceProvider } from "@h3ravel/core";
-import { RuntimeException } from "@h3ravel/support";
 
 //#region src/Contracts/JobContract.d.ts
 type JobClassConstructor = (new (...args: any) => any);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/queue",
-  "version": "11.15.0-alpha.16",
+  "version": "11.17.0",
   "description": "Job queues, workers and broadcasting support system for H3ravel.",
   "h3ravel": {
     "providers": [
@@ -8,9 +8,7 @@
     ]
   },
   "type": "module",
-  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -41,15 +39,15 @@
     "laravel"
   ],
   "peerDependencies": {
-    "@h3ravel/core": "^1.29.0-alpha.16",
-    "@h3ravel/contracts": "^1.29.0-alpha.16"
+    "@h3ravel/core": "^2.0.0",
+    "@h3ravel/contracts": "^2.0.0"
   },
   "devDependencies": {
     "typescript": "^6.0.0"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",
-    "dev": "tsx watch src/index.ts",
+    "dev": "tsdown --watch --config-loader unrun",
     "start": "node dist/index.js",
     "lint": "eslint . --ext .ts",
     "test": "jest --passWithNoTests",

package/dist/index.cjs

@@ -1,355 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-let _h3ravel_support = require("@h3ravel/support");
-let _h3ravel_contracts = require("@h3ravel/contracts");
-let _h3ravel_core = require("@h3ravel/core");
-//#region src/Events/JobFailed.ts
-var JobFailed = class {
-	connectionName;
-	job;
-	exception;
-	/**
-	* Create a new event instance.
-	*
-	* @param  connectionName  The connection name.
-	* @param  job  The job instance.
-	* @param  exception  The exception that caused the job to fail.
-	*/
-	constructor(connectionName, job, exception) {
-		this.connectionName = connectionName;
-		this.job = job;
-		this.exception = exception;
-	}
-};
-//#endregion
-//#region src/Exceptions/ManuallyFailedException.ts
-var ManuallyFailedException = class extends _h3ravel_support.RuntimeException {};
-//#endregion
-//#region src/Exceptions/MaxAttemptsExceededException.ts
-var MaxAttemptsExceededException = class MaxAttemptsExceededException extends _h3ravel_support.RuntimeException {
-	/**
-	* The job instance.
-	*/
-	job;
-	/**
-	* Create a new instance for the job.
-	*
-	* @param job
-	*/
-	static forJob(job) {
-		return (0, _h3ravel_support.tap)(new MaxAttemptsExceededException(job.resolveName() + " has been attempted too many times."), (e) => {
-			e.job = job;
-		});
-	}
-};
-//#endregion
-//#region src/Exceptions/TimeoutExceededException.ts
-var TimeoutExceededException = class TimeoutExceededException extends MaxAttemptsExceededException {
-	/**
-	* Create a new instance for the job.
-	*
-	* @param  job
-	*/
-	static forJob(job) {
-		return (0, _h3ravel_support.tap)(new TimeoutExceededException(job.resolveName() + " has timed out."), (e) => {
-			e.job = job;
-		});
-	}
-};
-//#endregion
-//#region src/Jobs/JobName.ts
-var JobName = class {
-	/**
-	* Parse the given job name into a class / method array.
-	*
-	* @param  job
-	*/
-	static parse(_job) {
-		return [{}, ""];
-	}
-	/**
-	* Get the resolved name of the queued job class.
-	*
-	* @param  name
-	* @param  payload
-	*/
-	static resolve(name, payload) {
-		if (!payload.displayName) return payload.displayName;
-		return name;
-	}
-	/**
-	* Get the class name for queued job class.
-	*
-	* @param  name
-	* @param  payload
-	*/
-	static resolveClassName(name, payload) {
-		if (typeof payload.data.commandName === "string") return payload.data.commandName;
-		return name;
-	}
-};
-//#endregion
-//#region src/Jobs/Job.ts
-var Job = class {
-	/**
-	* The job handler instance.
-	*/
-	instance;
-	/**
-	* The IoC container instance.
-	*/
-	container;
-	/**
-	* Indicates if the job has been deleted.
-	*/
-	deleted = false;
-	/**
-	* Indicates if the job has been released.
-	*/
-	released = false;
-	/**
-	* Indicates if the job has failed.
-	*/
-	failed = false;
-	/**
-	* The name of the connection the job belongs to.
-	*/
-	connectionName;
-	/**
-	* The name of the queue the job belongs to.
-	*/
-	queue;
-	/**
-	* Get the UUID of the job.
-	*
-	* @return string|null
-	*/
-	uuid() {
-		return this.payload()["uuid"] ?? null;
-	}
-	/**
-	* Fire the job.
-	*
-	* @return void
-	*/
-	fire() {
-		const payload = this.payload();
-		const [instance, method] = JobName.parse(payload["job"]);
-		(this.instance = this.resolve(instance))[method](this, payload["data"]);
-	}
-	/**
-	* Delete the job from the queue.
-	*/
-	delete() {
-		this.deleted = true;
-	}
-	/**
-	* Determine if the job has been deleted.
-	*/
-	isDeleted() {
-		return this.deleted;
-	}
-	/**
-	* Release the job back into the queue after (n) seconds.
-	*
-	* @param delay
-	*/
-	release(_delay = 0) {
-		this.released = true;
-	}
-	/**
-	* Determine if the job was released back into the queue.
-	*
-	* @return bool
-	*/
-	isReleased() {
-		return this.released;
-	}
-	/**
-	* Determine if the job has been deleted or released.
-	*/
-	isDeletedOrReleased() {
-		return this.isDeleted() || this.isReleased();
-	}
-	/**
-	* Determine if the job has been marked as a failure.
-	*/
-	hasFailed() {
-		return this.failed;
-	}
-	/**
-	* Mark the job as "failed".
-	*/
-	markAsFailed() {
-		this.failed = true;
-	}
-	/**
-	* Delete the job, call the "failed" method, and raise the failed job event.
-	*
-	* @param e
-	*/
-	fail(e) {
-		this.markAsFailed();
-		if (this.isDeleted()) return;
-		if (this.shouldRollBackDatabaseTransaction(e)) this.container.make("db").connection(this.container.make("config").get("queue.failed.database")).rollBack(0);
-		try {
-			this.delete();
-			this.failedJob(e);
-		} finally {
-			this.resolve(_h3ravel_contracts.IDispatcher).dispatch(new JobFailed(this.connectionName, this, e || new ManuallyFailedException()));
-		}
-	}
-	/**
-	* Determine if the current database transaction should be rolled back to level zero.
-	*
-	* @param  e
-	*/
-	shouldRollBackDatabaseTransaction(e) {
-		return e instanceof TimeoutExceededException && this.container.make("config").get("queue.failed.database") && ["database", "database-uuids"].includes(this.container.make("config").get("queue.failed.driver")) && this.container.has("db");
-	}
-	/**
-	* Process an exception that caused the job to fail.
-	*
-	* @param  e
-	*/
-	failedJob(e, ..._args) {
-		const payload = this.payload();
-		const [classInstance] = JobName.parse(payload.job);
-		this.instance = this.resolve(classInstance);
-		if (typeof this.instance.failed === "function") this.instance.failedJob(payload.data, e, payload.uuid ?? "", this);
-	}
-	/**
-	* Resolve the given class.
-	*/
-	resolve(className) {
-		return this.container.make(className);
-	}
-	/**
-	* Get the resolved job handler instance.
-	*
-	* @return mixed
-	*/
-	getResolvedJob() {
-		return this.instance;
-	}
-	/**
-	* Get the decoded body of the job.
-	*/
-	payload() {
-		return JSON.parse(this.getRawBody());
-	}
-	/**
-	* Get the number of times to attempt a job.
-	*
-	* @return int|null
-	*/
-	maxTries() {
-		return this.payload()["maxTries"] ?? null;
-	}
-	/**
-	* Get the number of times to attempt a job after an exception.
-	*
-	* @return int|null
-	*/
-	maxExceptions() {
-		return this.payload()["maxExceptions"] ?? null;
-	}
-	/**
-	* Determine if the job should fail when it timeouts.
-	*
-	* @return bool
-	*/
-	shouldFailOnTimeout() {
-		return this.payload()["failOnTimeout"] ?? false;
-	}
-	/**
-	* The number of seconds to wait before retrying a job that encountered an uncaught exception.
-	*
-	* @return int|int[]|null
-	*/
-	backoff() {
-		return this.payload()["backoff"] ?? this.payload()["delay"] ?? null;
-	}
-	/**
-	* Get the number of seconds the job can run.
-	*
-	* @return int|null
-	*/
-	timeout() {
-		return this.payload()["timeout"] ?? null;
-	}
-	/**
-	* Get the timestamp indicating when the job should timeout.
-	*
-	* @return int|null
-	*/
-	retryUntil() {
-		return this.payload()["retryUntil"] ?? null;
-	}
-	/**
-	* Get the name of the queued job class.
-	*
-	* @return string
-	*/
-	getName() {
-		return this.payload()["job"];
-	}
-	/**
-	* Get the resolved display name of the queued job class.
-	*
-	* Resolves the name of "wrapped" jobs such as class-based handlers.
-	*/
-	resolveName() {
-		return JobName.resolve(this.getName(), this.payload());
-	}
-	/**
-	* Get the class of the queued job.
-	*
-	* Resolves the class of "wrapped" jobs such as class-based handlers.
-	*
-	* @return string
-	*/
-	resolveQueuedJobClass() {
-		return JobName.resolveClassName(this.getName(), this.payload());
-	}
-	/**
-	* Get the name of the connection the job belongs to.
-	*/
-	getConnectionName() {
-		return this.connectionName;
-	}
-	/**
-	* Get the name of the queue the job belongs to.
-	*/
-	getQueue() {
-		return this.queue;
-	}
-	/**
-	* Get the service container instance.
-	*/
-	getContainer() {
-		return this.container;
-	}
-};
-//#endregion
-//#region src/Providers/QueueServiceProvider.ts
-/**
-* Queues and workers.
-* 
-* Register QueueManager.
-* Load drivers (Redis, in-memory).
-* Register job dispatcher and workers.
-* 
-* Auto-Registered if @h3ravel/queue is installed
-*/
-var QueueServiceProvider = class extends _h3ravel_core.ServiceProvider {
-	static priority = 991;
-	register() {}
-};
-//#endregion
-exports.Job = Job;
-exports.JobFailed = JobFailed;
-exports.JobName = JobName;
-exports.ManuallyFailedException = ManuallyFailedException;
-exports.MaxAttemptsExceededException = MaxAttemptsExceededException;
-exports.QueueServiceProvider = QueueServiceProvider;
-exports.TimeoutExceededException = TimeoutExceededException;