JobContext.ts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. import { Types } from "mongoose";
  2. import BaseModule from "./BaseModule";
  3. import Job from "./Job";
  4. import JobQueue from "./JobQueue";
  5. import { Log } from "./LogBook";
  6. import { SessionSchema } from "./schemas/session";
  7. import { JobOptions } from "./types/JobOptions";
  8. import { Jobs, Modules } from "./types/Modules";
  9. import { UserSchema } from "./schemas/user";
  10. import { Models } from "./types/Models";
  11. export default class JobContext {
  12. public readonly job: Job;
  13. public readonly jobQueue: JobQueue;
  14. private session?: SessionSchema;
  15. private user?: UserSchema;
  16. private permissions?: Record<string, boolean>;
  17. public constructor(job: Job, session?: SessionSchema) {
  18. this.job = job;
  19. this.jobQueue = JobQueue.getPrimaryInstance();
  20. this.session = session;
  21. }
  22. /**
  23. * Log a message in the context of the current job, which automatically sets the category and data
  24. *
  25. * @param log - Log message or object
  26. */
  27. public log(log: string | Omit<Log, "timestamp" | "category">) {
  28. return this.job.log(log);
  29. }
  30. public getSession() {
  31. return this.session;
  32. }
  33. public setSession(session?: SessionSchema) {
  34. this.session = session;
  35. }
  36. /**
  37. * executeJob - Execute a job
  38. *
  39. * @param moduleName - Module name
  40. * @param jobName - Job name
  41. * @param params - Params
  42. */
  43. public async executeJob<
  44. ModuleNameType extends keyof Jobs & keyof Modules,
  45. JobNameType extends keyof Jobs[ModuleNameType] &
  46. keyof Omit<Modules[ModuleNameType], keyof BaseModule>,
  47. PayloadType extends "payload" extends keyof Jobs[ModuleNameType][JobNameType]
  48. ? Jobs[ModuleNameType][JobNameType]["payload"] extends undefined
  49. ? Record<string, never>
  50. : Jobs[ModuleNameType][JobNameType]["payload"]
  51. : Record<string, never>,
  52. ReturnType = "returns" extends keyof Jobs[ModuleNameType][JobNameType]
  53. ? Jobs[ModuleNameType][JobNameType]["returns"]
  54. : never
  55. >(
  56. moduleName: ModuleNameType,
  57. jobName: JobNameType,
  58. payload: PayloadType,
  59. options?: JobOptions
  60. ): Promise<ReturnType> {
  61. return new Job(jobName.toString(), moduleName, payload, {
  62. session: this.session,
  63. ...(options ?? {})
  64. }).execute();
  65. }
  66. public async getModel(model: keyof Models) {
  67. return this.executeJob("data", "getModel", model);
  68. }
  69. public async getUser(refresh = false) {
  70. if (!this.session?.userId) throw new Error("No user found for session");
  71. if (this.user && !refresh) return this.user;
  72. const User = await this.getModel("user");
  73. this.user = await User.findById(this.session.userId);
  74. if (!this.user) throw new Error("No user found for session");
  75. return this.user;
  76. }
  77. public async assertLoggedIn() {
  78. if (!this.session?.userId) throw new Error("No user found for session");
  79. }
  80. public async getUserPermissions(
  81. scope?: { stationId?: Types.ObjectId },
  82. refresh = false
  83. ) {
  84. if (this.permissions && !refresh) return this.permissions;
  85. this.permissions = await this.executeJob(
  86. "api",
  87. "getUserPermissions",
  88. scope ?? {}
  89. );
  90. return this.permissions;
  91. }
  92. public async assertPermission(
  93. permission: string,
  94. scope?: { stationId?: Types.ObjectId }
  95. ) {
  96. const permissions = await this.getUserPermissions(scope);
  97. if (!permissions[permission])
  98. throw new Error("Insufficient permissions");
  99. }
  100. }