@brandboostinggmbh/observable-workflows 0.13.2 → 0.14.0

package/dist/index.d.ts

@@ -536,4 +536,29 @@ type R2ExternalBlobStorageOptions = {
 declare function createR2ExternalBlobStorage(options: R2ExternalBlobStorageOptions): ExternalBlobStorage;
 
 //#endregion
-export { ConsoleWrapper, DateRangeFilter, ExternalBlobStorage, HandleWorkflowQueueMessageParams, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, PropertyFilter, QueueWorkflowContextOptions, R2ExternalBlobStorageOptions, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, StringFilter, ValueTypeMap, WorkflowContext, WorkflowContextInstance, WorkflowContextOptions, WorkflowEnqueueBatchItem, WorkflowFilter, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, serializeWithExternalStorage, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };
+//#region src/observableWorkflows/createCleanupManager.d.ts
+type DeleteConfig = {
+  deleteWorkflowsOlderThanDays: number;
+  delete: {
+    successfulWorkflows: boolean;
+    failedWorkflows: boolean;
+    /** Workflows that are still in progress after a long time, might have failed non-gracefully and are therefore not correctly marked as failed.*/
+    inProgressWorkflows: boolean;
+  };
+};
+declare const createCleanupManager: (context: {
+  D1: D1Database;
+  tenantId: string;
+  serializer?: Serializer;
+  externalBlobStorage?: ExternalBlobStorage;
+}) => {
+  countAffectedWorkflows: (config: DeleteConfig) => Promise<{
+    count: number;
+  }>;
+  deleteOldWorkflows: (config: DeleteConfig) => Promise<{
+    deletedCount: number;
+  }>;
+};
+
+//#endregion
+export { ConsoleWrapper, DateRangeFilter, ExternalBlobStorage, HandleWorkflowQueueMessageParams, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, PropertyFilter, QueueWorkflowContextOptions, R2ExternalBlobStorageOptions, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, StringFilter, ValueTypeMap, WorkflowContext, WorkflowContextInstance, WorkflowContextOptions, WorkflowEnqueueBatchItem, WorkflowFilter, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, createCleanupManager, createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, serializeWithExternalStorage, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };

package/dist/index.js

@@ -19,12 +19,19 @@ async function detectSchemaVersion(db) {
 	if (stepTableInfo) {
 		const hasResultRef = stepTableInfo.sql.includes("resultRef");
 		const hasErrorRef = stepTableInfo.sql.includes("errorRef");
-		if (hasResultRef && hasErrorRef) stepTable = "v2";
+		const hasInstanceIdFK = stepTableInfo.sql.includes("FOREIGN KEY (instanceId) REFERENCES WorkflowTable(instanceId)");
+		if (hasInstanceIdFK && hasResultRef && hasErrorRef) stepTable = "v5";
+		else if (hasResultRef && hasErrorRef) stepTable = "v2";
 		else stepTable = "v1";
 	}
 	const logTableInfo = await db.prepare(`SELECT sql FROM sqlite_master WHERE type='table' AND name='LogTable'`).first();
 	let logTable = "missing";
-	if (logTableInfo) logTable = "v1";
+	if (logTableInfo) {
+		const hasStepTableCascadeFK = logTableInfo.sql.includes("FOREIGN KEY (instanceId, stepName) REFERENCES StepTable(instanceId, stepName) ON DELETE CASCADE");
+		const hasWorkflowTableFK = logTableInfo.sql.includes("FOREIGN KEY (instanceId) REFERENCES WorkflowTable(instanceId) ON DELETE CASCADE");
+		if (hasStepTableCascadeFK && hasWorkflowTableFK) logTable = "v5";
+		else logTable = "v1";
+	}
 	const workflowPropertiesInfo = await db.prepare(`SELECT sql FROM sqlite_master WHERE type='table' AND name='WorkflowProperties'`).first();
 	let workflowProperties = "missing";
 	if (workflowPropertiesInfo) workflowProperties = "v1";
@@ -167,7 +174,8 @@ async function migrateStepTable(db, currentVersion) {
           resultRef TEXT,
           errorRef TEXT,
           tenantId TEXT NOT NULL,
-          PRIMARY KEY (instanceId, stepName)
+          PRIMARY KEY (instanceId, stepName),
+          FOREIGN KEY (instanceId) REFERENCES WorkflowTable(instanceId) ON DELETE CASCADE
         )`
 ).run();
 		return;
@@ -195,8 +203,8 @@ async function migrateLogTable(db, currentVersion) {
           type TEXT NOT NULL,
           logOrder INTEGER NOT NULL,
           tenantId TEXT NOT NULL,
-          FOREIGN KEY (instanceId, stepName) REFERENCES StepTable(instanceId, stepName)
-          DEFERRABLE INITIALLY DEFERRED
+          FOREIGN KEY (instanceId, stepName) REFERENCES StepTable(instanceId, stepName) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
+          FOREIGN KEY (instanceId) REFERENCES WorkflowTable(instanceId) ON DELETE CASCADE
         )`
 ).run();
 		return;
@@ -898,6 +906,7 @@ const createLogAccessor = (context) => {
       WHERE tenantId = ? AND (? IS NULL OR instanceId = ?)  
       `
 ).bind(context.tenantId, instanceId ?? null, instanceId ?? null).all();
+		console.log(`debug getPropertiesKeys: ${JSON.stringify(result)}`);
 		if (!result.results) return [];
 		return result.results.map((row) => ({
 			key: row.key,
@@ -1303,4 +1312,50 @@ function createR2ExternalBlobStorage(options) {
 }
 
 //#endregion
-export { createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, serializeWithExternalStorage, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };
+//#region src/observableWorkflows/createCleanupManager.ts
+const createCleanupManager = (context) => {
+	const countAffectedWorkflows = async (config) => {
+		const statuses = [];
+		if (config.delete.successfulWorkflows) statuses.push("completed");
+		if (config.delete.failedWorkflows) statuses.push("failed");
+		if (config.delete.inProgressWorkflows) statuses.push("pending");
+		if (statuses.length === 0) return { count: 0 };
+		const statusPlaceholders = statuses.map(() => "?").join(", ");
+		const result = await context.D1.prepare(
+			/* sql */
+			`
+      SELECT COUNT(*) as count 
+      FROM WorkflowTable 
+      WHERE tenantId = ? 
+        AND startTime < (strftime('%s', 'now', '-' || ? || ' days') * 1000)
+        AND workflowStatus IN (${statusPlaceholders})
+    `
+).bind(context.tenantId, config.deleteWorkflowsOlderThanDays, ...statuses).first();
+		return result;
+	};
+	const deleteOldWorkflows = async (config) => {
+		const statuses = [];
+		if (config.delete.successfulWorkflows) statuses.push("completed");
+		if (config.delete.failedWorkflows) statuses.push("failed");
+		if (config.delete.inProgressWorkflows) statuses.push("pending");
+		if (statuses.length === 0) return { deletedCount: 0 };
+		const statusPlaceholders = statuses.map(() => "?").join(", ");
+		const result = await context.D1.prepare(
+			/* sql */
+			`
+      DELETE FROM WorkflowTable 
+      WHERE tenantId = ? 
+        AND startTime < (strftime('%s', 'now', '-' || ? || ' days') * 1000)
+        AND workflowStatus IN (${statusPlaceholders})
+    `
+).bind(context.tenantId, config.deleteWorkflowsOlderThanDays, ...statuses).run();
+		return { deletedCount: result.meta.changes || 0 };
+	};
+	return {
+		countAffectedWorkflows,
+		deleteOldWorkflows
+	};
+};
+
+//#endregion
+export { createCleanupManager, createLogAccessor, createQueueWorkflowContext, createR2ExternalBlobStorage, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, deserializeWithExternalStorage, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, serializeWithExternalStorage, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brandboostinggmbh/observable-workflows",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "description": "My awesome typescript library",
   "type": "module",
   "license": "MIT",