JobContext.ts 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. import BaseModule from "./BaseModule";
  2. import Job from "./Job";
  3. import JobQueue from "./JobQueue";
  4. import { Log } from "./LogBook";
  5. import { SessionSchema } from "./schemas/session";
  6. import { JobOptions } from "./types/JobOptions";
  7. import { Jobs, Modules } from "./types/Modules";
  8. export default class JobContext {
  9. public readonly job: Job;
  10. public readonly jobQueue: JobQueue;
  11. private session?: SessionSchema;
  12. public constructor(job: Job, session?: SessionSchema) {
  13. this.job = job;
  14. this.jobQueue = JobQueue.getPrimaryInstance();
  15. this.session = session;
  16. }
  17. /**
  18. * Log a message in the context of the current job, which automatically sets the category and data
  19. *
  20. * @param log - Log message or object
  21. */
  22. public log(log: string | Omit<Log, "timestamp" | "category">) {
  23. return this.job.log(log);
  24. }
  25. public getSession() {
  26. return this.session;
  27. }
  28. public setSession(session?: SessionSchema) {
  29. this.session = session;
  30. }
  31. /**
  32. * executeJob - Execute a job
  33. *
  34. * @param moduleName - Module name
  35. * @param jobName - Job name
  36. * @param params - Params
  37. */
  38. public async executeJob<
  39. ModuleNameType extends keyof Jobs & keyof Modules,
  40. JobNameType extends keyof Jobs[ModuleNameType] &
  41. keyof Omit<Modules[ModuleNameType], keyof BaseModule>,
  42. PayloadType extends "payload" extends keyof Jobs[ModuleNameType][JobNameType]
  43. ? Jobs[ModuleNameType][JobNameType]["payload"] extends undefined
  44. ? Record<string, never>
  45. : Jobs[ModuleNameType][JobNameType]["payload"]
  46. : Record<string, never>,
  47. ReturnType = "returns" extends keyof Jobs[ModuleNameType][JobNameType]
  48. ? Jobs[ModuleNameType][JobNameType]["returns"]
  49. : never
  50. >(
  51. moduleName: ModuleNameType,
  52. jobName: JobNameType,
  53. payload: PayloadType,
  54. options?: JobOptions
  55. ): Promise<ReturnType> {
  56. return new Job(jobName.toString(), moduleName, payload, {
  57. session: this.session,
  58. ...(options ?? {})
  59. }).execute();
  60. }
  61. }