import {type QueueAddOptions} from "p-queue/dist/options";
import {type Logger}          from "winston";
import {type IEndpointParams} from "../endpoint";

export interface IJob<TParams = any> {
	readonly id: string;
	readonly name: string;
	readonly status: IJobStatus;
	readonly total: number;
	readonly progress: number;
	readonly success: number;
	readonly successRatio: number;
	readonly failure: number;
	readonly failureRatio: number;
	readonly skip: number;
	readonly skipRatio: number;
	readonly created: Date;
	readonly started?: Date | null;
	readonly finished?: Date | null;
	readonly userId?: string | null;
	readonly params: TParams;
}

export type IJobParams<T> = T extends IJob<infer TParams> ? TParams : T;

export interface IJobProgress {
	readonly jobId: string;

	result(): IJobStatus | undefined;

	success(): number;

	failure(): number;

	skip(): number;

	setTotal(total: number): Promise<any>;

	setStatus(status: IJobStatus): Promise<any>;

	onSuccess(): Promise<any>;

	onFailure(): Promise<any>;

	onSkip(): Promise<any>;

	setResult(result: IJobStatus): void;

	isReview(): boolean;
}

export interface IJobHandlerRequest<TParams> {
	name: string;
	job: IJob<TParams>;
	params: TParams;
	userId?: string | null;
	jobProgress: IJobProgress;
	logger: Logger;

	progress<TResult>(callback: () => Promise<TResult>, sleep?: number): Promise<TResult | void>;
}

export interface IJobProcessor<TParams = any> {
	request(params: IEndpointParams<TParams, IJob<TParams>>, queue?: QueueAddOptions): Promise<IJob<TParams>>;

	async(params: TParams, userId?: string | null, queue?: QueueAddOptions): Promise<IJob<TParams>>;

	handler(request: IJobHandlerRequest<TParams>): Promise<any>;
}

export type IJobStatus =
	"NEW"
	| "RUNNING"
	| "SUCCESS"
	| "FAILURE"
	| "REVIEW"
	| "DONE";