@runium/core 0.0.3 → 0.0.4

package/index.d.ts

@@ -1,4 +1,6 @@
+import { ChildProcessWithoutNullStreams } from 'node:child_process';
 import { EventEmitter } from 'node:events';
+import { WriteStream } from 'node:fs';
 
 export declare function applyMacros(text: string, macros: MacrosCollection): string;
 
@@ -62,7 +64,7 @@ export declare class Project extends EventEmitter {
     setConfig(config: ProjectConfig): void;
     getState(): ProjectState;
     start(): Promise<void>;
-    stop(): Promise<void>;
+    stop(reason?: string): Promise<void>;
     extendValidationSchema(extensions: ProjectSchemaExtension): void;
     registerAction(type: string, processor: RuniumActionProcessor): void;
     registerTask(type: string, processor: RuniumTaskConstructor<unknown, any>): void;
@@ -180,6 +182,7 @@ export declare interface ProjectSchemaExtension {
 export declare interface ProjectState {
     status: ProjectStatus;
     timestamp: number;
+    reason?: string;
 }
 
 export declare enum ProjectStatus {
@@ -286,7 +289,7 @@ export declare abstract class RuniumTask<Options = unknown, State = RuniumTaskSt
     abstract getOptions(): Options;
     abstract getState(): State;
     abstract start(): Promise<void>;
-    abstract stop(): Promise<void>;
+    abstract stop(reason?: string): Promise<void>;
     abstract restart(): Promise<void>;
 }
 
@@ -298,6 +301,7 @@ export declare interface RuniumTaskState {
     iteration: number;
     exitCode?: number;
     error?: Error;
+    reason?: string;
 }
 
 export declare abstract class RuniumTrigger<Options extends RuniumTriggerOptions> {
@@ -330,12 +334,26 @@ export declare const SILENT_EXIT_CODE = -1;
 
 export declare class Task extends RuniumTask<TaskOptions, TaskState> {
     protected readonly options: TaskOptions;
+    protected state: TaskState;
+    protected process: ChildProcessWithoutNullStreams | null;
+    protected stdoutStream: WriteStream | null;
+    protected stderrStream: WriteStream | null;
+    protected ttlTimer: NodeJS.Timeout | null;
     constructor(options: TaskOptions);
     getState(): TaskState;
     getOptions(): TaskOptions;
     start(): Promise<void>;
-    stop(): Promise<void>;
+    stop(reason?: string): Promise<void>;
     restart(): Promise<void>;
+    protected updateState(state: Partial<TaskState>): void;
+    protected initLogStreams(): Promise<void>;
+    protected setTTLTimer(): void;
+    protected addProcessListeners(): void;
+    protected onStdOutData(data: Buffer): void;
+    protected onStdErrData(data: Buffer): void;
+    protected onExit(code: number | null): void;
+    protected onError(error: Error): void;
+    protected cleanup(): void;
 }
 
 export declare enum TaskEvent {

package/index.js

@@ -148,16 +148,16 @@ class et extends C {
       }
     }
   }
-  async stop() {
-    if (this.process && this.state.status !== "stopping" && this.state.status === "started") return this.updateState({ status: "stopping" }), new Promise((t) => {
-      const s = this.options.stopSignal || "SIGTERM";
-      this.process.kill(s), this.process.on("exit", () => {
-        t();
+  async stop(t = "") {
+    if (this.process && this.state.status !== "stopping" && this.state.status === "started") return this.updateState({ status: "stopping", reason: t }), new Promise((s) => {
+      const r = this.options.stopSignal || "SIGTERM";
+      this.process.kill(r), this.process.on("exit", () => {
+        s();
       });
     });
   }
   async restart() {
-    await this.stop(), this.start();
+    await this.stop("restart"), this.start();
   }
   updateState(t) {
     const s = { ...this.state, ...t, timestamp: Date.now() };
@@ -177,7 +177,7 @@ class et extends C {
   setTTLTimer() {
     const { ttl: t } = this.options;
     t && this.process && (this.ttlTimer = setTimeout(() => {
-      this.stop();
+      this.stop("ttl");
     }, t));
   }
   addProcessListeners() {
@@ -215,7 +215,7 @@ function ot(e, t) {
   return { type: "object", properties: { ...structuredClone(k), type: { type: "string", const: e }, ...s }, required: ["id", "type", "action", ...r], additionalProperties: !1 };
 }
 function nt() {
-  const e = { $schema: "https://json-schema.org/draft/2020-12/schema", $id: "https://example.com/schemas/project.json", title: "Project", type: "object", properties: { id: { type: "string" }, name: { type: "string" }, tasks: { type: "array", items: { oneOf: [{ $ref: "#/$defs/Runium_TaskConfig" }] }, minItems: 1, uniqueItemProperties: ["id"] }, triggers: { type: "array", items: { $ref: "#/$defs/Runium_Trigger" }, uniqueItemProperties: ["id"] } }, required: ["id", "tasks"], additionalProperties: !1, $defs: { Runium_EnvValue: { type: ["string", "number", "boolean"] }, Runium_Env: { type: "object", additionalProperties: { $ref: "#/$defs/Runium_EnvValue" } }, Runium_TaskStartMode: { type: "string", enum: Object.values(R) }, Runium_TaskHandler: { type: "object", properties: { action: { $ref: "#/$defs/Runium_Action" }, condition: { $ref: "#/$defs/Runium_TaskStateCondition" } }, required: ["action", "condition"], additionalProperties: !1 }, Runium_TaskStateCondition: { oneOf: [{ type: "string" }, { type: "boolean" }, { $ref: "#/$defs/Runium_TaskState" }] }, Runium_TaskState: { type: "object", properties: { status: { $ref: "#/$defs/Runium_TaskStatus" }, iteration: { type: "number", minimum: 0 }, exitCode: { type: "number", minimum: 0 } }, additionalProperties: !1 }, Runium_TaskStatus: { type: "string", enum: Object.values(h) }, Runium_TaskDependency: { type: "object", properties: { taskId: { type: "string" }, condition: { $ref: "#/$defs/Runium_TaskStateCondition" } }, required: ["taskId", "condition"], additionalProperties: !1 }, Runium_Trigger: { oneOf: [{ $ref: "#/$defs/Runium_TriggerEvent" }, { $ref: "#/$defs/Runium_TriggerInterval" }, { $ref: "#/$defs/Runium_TriggerTimeout" }] }, Runium_TriggerEvent: { type: "object", properties: { ...structuredClone(k), type: { const: l.EVENT }, event: { type: "string" } }, required: ["id", "type", "event", "action"], additionalProperties: !1 }, Runium_TriggerInterval: { type: "object", properties: { ...structuredClone(k), type: { const: l.INTERVAL }, interval: { type: "number", minimum: 0 } }, required: ["id", "type", "interval", "action"], additionalProperties: !1 }, Runium_TriggerTimeout: { type: "object", properties: { ...structuredClone(k), type: { const: l.TIMEOUT }, timeout: { type: "number", minimum: 0 } }, required: ["id", "type", "timeout", "action"], additionalProperties: !1 }, Runium_Action: { oneOf: [{ $ref: "#/$defs/Runium_ActionEmitEvent" }, { $ref: "#/$defs/Runium_ActionProcessTask" }, { $ref: "#/$defs/Runium_ActionStopProject" }, { $ref: "#/$defs/Runium_ActionToggleTrigger" }] }, Runium_ActionEmitEvent: { type: "object", properties: { type: { type: "string", const: d.EMIT_EVENT }, event: { type: "string" } }, required: ["type", "event"], additionalProperties: !1 }, Runium_ActionProcessTask: { type: "object", properties: { type: { type: "string", enum: [d.START_TASK, d.RESTART_TASK, d.STOP_TASK] }, taskId: { type: "string" } }, required: ["type", "taskId"], additionalProperties: !1 }, Runium_ActionStopProject: { type: "object", properties: { type: { type: "string", const: d.STOP_PROJECT } }, required: ["type"], additionalProperties: !1 }, Runium_ActionToggleTrigger: { type: "object", properties: { type: { type: "string", enum: [d.ENABLE_TRIGGER, d.DISABLE_TRIGGER] }, triggerId: { type: "string" } }, required: ["type", "triggerId"], additionalProperties: !1 }, Runium_TaskConfig: { ...D(f.DEFAULT, { $ref: "#/$defs/Runium_TaskOptions" }) }, Runium_TaskOptions: { type: "object", properties: { command: { type: "string" }, arguments: { type: "array", items: { type: "string" } }, shell: { type: "boolean" }, cwd: { type: "string" }, env: { $ref: "#/$defs/Runium_Env" }, ttl: { type: "number" }, log: { $ref: "#/$defs/Runium_TaskLog" }, stopSignal: { type: "string" } }, required: ["command"], additionalProperties: !1 }, Runium_TaskRestartPolicy: { oneOf: [{ $ref: "#/$defs/Runium_TaskRestartPolicyAlways" }, { $ref: "#/$defs/Runium_TaskRestartPolicyOnFailure" }] }, Runium_TaskRestartPolicyAlways: { type: "object", required: ["policy"], properties: { policy: { const: T.ALWAYS }, delay: { type: "number" } }, additionalProperties: !1 }, Runium_TaskRestartPolicyOnFailure: { type: "object", required: ["policy"], properties: { policy: { const: T.ON_FAILURE }, delay: { type: "number" }, maxRetries: { type: "number" } }, additionalProperties: !1 }, Runium_TaskLog: { type: "object", properties: { stdout: { type: ["string", "null"] }, stderr: { type: ["string", "null"] } }, additionalProperties: !1 } } };
+  const e = { $schema: "https://json-schema.org/draft/2020-12/schema", $id: "https://example.com/schemas/project.json", title: "Project", type: "object", properties: { id: { type: "string" }, name: { type: "string" }, tasks: { type: "array", items: { oneOf: [{ $ref: "#/$defs/Runium_TaskConfig" }] }, minItems: 1, uniqueItemProperties: ["id"] }, triggers: { type: "array", items: { $ref: "#/$defs/Runium_Trigger" }, uniqueItemProperties: ["id"] } }, required: ["id", "tasks"], additionalProperties: !1, $defs: { Runium_EnvValue: { type: ["string", "number", "boolean"] }, Runium_Env: { type: "object", additionalProperties: { $ref: "#/$defs/Runium_EnvValue" } }, Runium_TaskStartMode: { type: "string", enum: Object.values(R) }, Runium_TaskHandler: { type: "object", properties: { action: { $ref: "#/$defs/Runium_Action" }, condition: { $ref: "#/$defs/Runium_TaskStateCondition" } }, required: ["action", "condition"], additionalProperties: !1 }, Runium_TaskStateCondition: { oneOf: [{ type: "string" }, { type: "boolean" }, { $ref: "#/$defs/Runium_TaskState" }] }, Runium_TaskState: { type: "object", properties: { status: { $ref: "#/$defs/Runium_TaskStatus" }, iteration: { type: "number", minimum: 0 }, exitCode: { type: "number", minimum: 0 }, reason: { type: "string" } }, additionalProperties: !1 }, Runium_TaskStatus: { type: "string", enum: Object.values(h) }, Runium_TaskDependency: { type: "object", properties: { taskId: { type: "string" }, condition: { $ref: "#/$defs/Runium_TaskStateCondition" } }, required: ["taskId", "condition"], additionalProperties: !1 }, Runium_Trigger: { oneOf: [{ $ref: "#/$defs/Runium_TriggerEvent" }, { $ref: "#/$defs/Runium_TriggerInterval" }, { $ref: "#/$defs/Runium_TriggerTimeout" }] }, Runium_TriggerEvent: { type: "object", properties: { ...structuredClone(k), type: { const: l.EVENT }, event: { type: "string" } }, required: ["id", "type", "event", "action"], additionalProperties: !1 }, Runium_TriggerInterval: { type: "object", properties: { ...structuredClone(k), type: { const: l.INTERVAL }, interval: { type: "number", minimum: 0 } }, required: ["id", "type", "interval", "action"], additionalProperties: !1 }, Runium_TriggerTimeout: { type: "object", properties: { ...structuredClone(k), type: { const: l.TIMEOUT }, timeout: { type: "number", minimum: 0 } }, required: ["id", "type", "timeout", "action"], additionalProperties: !1 }, Runium_Action: { oneOf: [{ $ref: "#/$defs/Runium_ActionEmitEvent" }, { $ref: "#/$defs/Runium_ActionProcessTask" }, { $ref: "#/$defs/Runium_ActionStopProject" }, { $ref: "#/$defs/Runium_ActionToggleTrigger" }] }, Runium_ActionEmitEvent: { type: "object", properties: { type: { type: "string", const: d.EMIT_EVENT }, event: { type: "string" } }, required: ["type", "event"], additionalProperties: !1 }, Runium_ActionProcessTask: { type: "object", properties: { type: { type: "string", enum: [d.START_TASK, d.RESTART_TASK, d.STOP_TASK] }, taskId: { type: "string" } }, required: ["type", "taskId"], additionalProperties: !1 }, Runium_ActionStopProject: { type: "object", properties: { type: { type: "string", const: d.STOP_PROJECT } }, required: ["type"], additionalProperties: !1 }, Runium_ActionToggleTrigger: { type: "object", properties: { type: { type: "string", enum: [d.ENABLE_TRIGGER, d.DISABLE_TRIGGER] }, triggerId: { type: "string" } }, required: ["type", "triggerId"], additionalProperties: !1 }, Runium_TaskConfig: { ...D(f.DEFAULT, { $ref: "#/$defs/Runium_TaskOptions" }) }, Runium_TaskOptions: { type: "object", properties: { command: { type: "string" }, arguments: { type: "array", items: { type: "string" } }, shell: { type: "boolean" }, cwd: { type: "string" }, env: { $ref: "#/$defs/Runium_Env" }, ttl: { type: "number" }, log: { $ref: "#/$defs/Runium_TaskLog" }, stopSignal: { type: "string" } }, required: ["command"], additionalProperties: !1 }, Runium_TaskRestartPolicy: { oneOf: [{ $ref: "#/$defs/Runium_TaskRestartPolicyAlways" }, { $ref: "#/$defs/Runium_TaskRestartPolicyOnFailure" }] }, Runium_TaskRestartPolicyAlways: { type: "object", required: ["policy"], properties: { policy: { const: T.ALWAYS }, delay: { type: "number" } }, additionalProperties: !1 }, Runium_TaskRestartPolicyOnFailure: { type: "object", required: ["policy"], properties: { policy: { const: T.ON_FAILURE }, delay: { type: "number" }, maxRetries: { type: "number" } }, additionalProperties: !1 }, Runium_TaskLog: { type: "object", properties: { stdout: { type: ["string", "null"] }, stderr: { type: ["string", "null"] } }, additionalProperties: !1 } } };
   return Object.freeze(e);
 }
 function at(e, t) {
@@ -359,15 +359,15 @@ class jt extends O {
     }
     this.updateState({ status: "started" });
   }
-  async stop() {
+  async stop(t = "") {
     if (this.state.status !== "started" && this.state.status !== "starting") return;
-    this.updateState({ status: "stopping" }), this.cleanupTriggers();
-    const t = this.getTasksStartOrder().reverse(), s = [];
-    for (const r of t) if (this.tasks.has(r)) {
-      const { instance: i } = this.tasks.get(r), { status: o } = i.getState();
-      o === h.STARTED && s.push(i.stop());
+    this.updateState({ status: "stopping", reason: t }), this.cleanupTriggers();
+    const s = this.getTasksStartOrder().reverse(), r = [];
+    for (const i of s) if (this.tasks.has(i)) {
+      const { instance: o } = this.tasks.get(i), { status: a } = o.getState();
+      a === h.STARTED && r.push(o.stop("project-stop"));
     }
-    await Promise.allSettled(s), this.updateState({ status: "stopped" });
+    await Promise.allSettled(r), this.updateState({ status: "stopped" });
   }
   extendValidationSchema(t) {
     this.schema = at(this.schema, t);
@@ -445,7 +445,7 @@ class jt extends O {
   async stopTask(t) {
     if (this.tasks.has(t)) {
       const { instance: s } = this.tasks.get(t), { status: r } = s.getState();
-      if (r === h.STARTED) return this.emit("stop-task", t), s.stop();
+      if (r === h.STARTED) return this.emit("stop-task", t), s.stop("action-stop");
     }
   }
   async restartTask(t) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runium/core",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Runium Core",
   "author": "TheBeastApp",
   "license": "MIT",