ModuleManager.ts 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. import { ModuleStatus } from "./BaseModule";
  2. import JobQueue from "./JobQueue";
  3. import { Modules, ModuleClass } from "./types/Modules";
  4. export default class ModuleManager {
  5. static primaryInstance = new this();
  6. private _modules?: Modules;
  7. /**
  8. * getStatus - Get status of modules
  9. *
  10. * @returns Module statuses
  11. */
  12. public getStatus() {
  13. const status: Record<string, ModuleStatus> = {};
  14. Object.entries(this._modules || {}).forEach(([name, module]) => {
  15. status[name] = module.getStatus();
  16. });
  17. return status;
  18. }
  19. /**
  20. * Gets a module
  21. *
  22. */
  23. public getModule(moduleName: keyof Modules) {
  24. return this._modules && this._modules[moduleName];
  25. }
  26. /**
  27. * loadModule - Load and initialize module
  28. *
  29. * @param moduleName - Name of the module
  30. * @returns Module
  31. */
  32. private async _loadModule<T extends keyof Modules>(moduleName: T) {
  33. const mapper = {
  34. api: "APIModule",
  35. data: "DataModule",
  36. events: "EventsModule",
  37. stations: "StationModule",
  38. websocket: "WebSocketModule"
  39. };
  40. const { default: Module }: { default: ModuleClass<Modules[T]> } =
  41. await import(`./modules/${mapper[moduleName]}`);
  42. return new Module();
  43. }
  44. /**
  45. * loadModules - Load and initialize all modules
  46. *
  47. * @returns Promise
  48. */
  49. private async _loadModules() {
  50. this._modules = {
  51. api: await this._loadModule("api"),
  52. data: await this._loadModule("data"),
  53. events: await this._loadModule("events"),
  54. stations: await this._loadModule("stations"),
  55. websocket: await this._loadModule("websocket")
  56. };
  57. }
  58. /**
  59. * startModule - Start module
  60. */
  61. private async _startModule(module: Modules[keyof Modules]) {
  62. switch (module.getStatus()) {
  63. case ModuleStatus.STARTING:
  64. case ModuleStatus.STARTED:
  65. return;
  66. case ModuleStatus.ERROR:
  67. throw new Error("Dependent module failed to start");
  68. case ModuleStatus.STOPPING:
  69. case ModuleStatus.STOPPED:
  70. case ModuleStatus.DISABLED:
  71. throw new Error("Dependent module is unavailable");
  72. default:
  73. break;
  74. }
  75. for (const name of module.getDependentModules()) {
  76. const dependency = this.getModule(name);
  77. if (!dependency) throw new Error("Dependent module not found");
  78. // eslint-disable-next-line no-await-in-loop
  79. await this._startModule(dependency);
  80. }
  81. await module.startup().catch(async err => {
  82. module.setStatus(ModuleStatus.ERROR);
  83. throw err;
  84. });
  85. }
  86. /**
  87. * getJobs - Get jobs for all modules
  88. */
  89. public getJobs() {
  90. if (!this._modules) return [];
  91. return Object.fromEntries(
  92. Object.entries(this._modules).map(([name, module]) => [
  93. name,
  94. module.getJobs()
  95. ])
  96. );
  97. }
  98. /**
  99. * startup - Handle startup
  100. */
  101. public async startup() {
  102. try {
  103. await this._loadModules();
  104. if (!this._modules) throw new Error("No modules were loaded");
  105. for (const module of Object.values(this._modules)) {
  106. // eslint-disable-next-line no-await-in-loop
  107. await this._startModule(module);
  108. }
  109. JobQueue.getPrimaryInstance().resume();
  110. } catch (err) {
  111. await this.shutdown();
  112. throw err;
  113. }
  114. }
  115. /**
  116. * shutdown - Handle shutdown
  117. */
  118. public async shutdown() {
  119. if (this._modules) {
  120. const modules = Object.entries(this._modules).filter(([, module]) =>
  121. [
  122. ModuleStatus.STARTED,
  123. ModuleStatus.STARTING,
  124. ModuleStatus.ERROR
  125. ].includes(module.getStatus())
  126. );
  127. const shutdownOrder: (keyof Modules)[] = [];
  128. for (const [name, module] of modules) {
  129. if (!shutdownOrder.includes(name)) shutdownOrder.push(name);
  130. const dependencies = module.getDependentModules();
  131. dependencies
  132. .filter(dependency => shutdownOrder.includes(dependency))
  133. .forEach(dependency => {
  134. shutdownOrder.splice(
  135. shutdownOrder.indexOf(dependency),
  136. 1
  137. );
  138. });
  139. shutdownOrder.push(...dependencies);
  140. }
  141. for (const moduleName of shutdownOrder) {
  142. // eslint-disable-next-line no-await-in-loop
  143. await this.getModule(moduleName)?.shutdown();
  144. }
  145. }
  146. }
  147. static getPrimaryInstance(): ModuleManager {
  148. return this.primaryInstance;
  149. }
  150. static setPrimaryInstance(instance: ModuleManager) {
  151. this.primaryInstance = instance;
  152. }
  153. }