@mastra/dynamodb 0.14.5 → 0.14.6-alpha.0

package/src/storage/domains/workflows/index.ts

@@ -1,334 +0,0 @@
-import { ErrorCategory, ErrorDomain, MastraError } from '@mastra/core/error';
-import { WorkflowsStorage } from '@mastra/core/storage';
-import type { WorkflowRun, WorkflowRuns } from '@mastra/core/storage';
-import type { StepResult, WorkflowRunState } from '@mastra/core/workflows';
-import type { Service } from 'electrodb';
-
-// Define the structure for workflow snapshot items retrieved from DynamoDB
-interface WorkflowSnapshotDBItem {
-  entity: string; // Typically 'workflow_snapshot'
-  workflow_name: string;
-  run_id: string;
-  snapshot: WorkflowRunState; // Should be WorkflowRunState after ElectroDB get attribute processing
-  createdAt: string; // ISO Date string
-  updatedAt: string; // ISO Date string
-  resourceId?: string;
-}
-
-function formatWorkflowRun(snapshotData: WorkflowSnapshotDBItem): WorkflowRun {
-  return {
-    workflowName: snapshotData.workflow_name,
-    runId: snapshotData.run_id,
-    snapshot: snapshotData.snapshot as WorkflowRunState,
-    createdAt: new Date(snapshotData.createdAt),
-    updatedAt: new Date(snapshotData.updatedAt),
-    resourceId: snapshotData.resourceId,
-  };
-}
-
-export class WorkflowStorageDynamoDB extends WorkflowsStorage {
-  private service: Service<Record<string, any>>;
-  constructor({ service }: { service: Service<Record<string, any>> }) {
-    super();
-
-    this.service = service;
-  }
-
-  updateWorkflowResults(
-    {
-      // workflowName,
-      // runId,
-      // stepId,
-      // result,
-      // runtimeContext,
-    }: {
-      workflowName: string;
-      runId: string;
-      stepId: string;
-      result: StepResult<any, any, any, any>;
-      runtimeContext: Record<string, any>;
-    },
-  ): Promise<Record<string, StepResult<any, any, any, any>>> {
-    throw new Error('Method not implemented.');
-  }
-  updateWorkflowState(
-    {
-      // workflowName,
-      // runId,
-      // opts,
-    }: {
-      workflowName: string;
-      runId: string;
-      opts: {
-        status: string;
-        result?: StepResult<any, any, any, any>;
-        error?: string;
-        suspendedPaths?: Record<string, number[]>;
-        waitingPaths?: Record<string, number[]>;
-      };
-    },
-  ): Promise<WorkflowRunState | undefined> {
-    throw new Error('Method not implemented.');
-  }
-
-  // Workflow operations
-  async persistWorkflowSnapshot({
-    workflowName,
-    runId,
-    snapshot,
-  }: {
-    workflowName: string;
-    runId: string;
-    snapshot: WorkflowRunState;
-  }): Promise<void> {
-    this.logger.debug('Persisting workflow snapshot', { workflowName, runId });
-
-    try {
-      const resourceId = 'resourceId' in snapshot ? snapshot.resourceId : undefined;
-      const now = new Date().toISOString();
-      // Prepare data including the 'entity' type
-      const data = {
-        entity: 'workflow_snapshot', // Add entity type
-        workflow_name: workflowName,
-        run_id: runId,
-        snapshot: JSON.stringify(snapshot), // Stringify the snapshot object
-        createdAt: now,
-        updatedAt: now,
-        resourceId,
-      };
-      // Use upsert instead of create to handle both create and update cases
-      await this.service.entities.workflow_snapshot.upsert(data).go();
-    } catch (error) {
-      throw new MastraError(
-        {
-          id: 'STORAGE_DYNAMODB_STORE_PERSIST_WORKFLOW_SNAPSHOT_FAILED',
-          domain: ErrorDomain.STORAGE,
-          category: ErrorCategory.THIRD_PARTY,
-          details: { workflowName, runId },
-        },
-        error,
-      );
-    }
-  }
-
-  async loadWorkflowSnapshot({
-    workflowName,
-    runId,
-  }: {
-    workflowName: string;
-    runId: string;
-  }): Promise<WorkflowRunState | null> {
-    this.logger.debug('Loading workflow snapshot', { workflowName, runId });
-
-    try {
-      // Provide *all* composite key components for the primary index ('entity', 'workflow_name', 'run_id')
-      const result = await this.service.entities.workflow_snapshot
-        .get({
-          entity: 'workflow_snapshot', // Add entity type
-          workflow_name: workflowName,
-          run_id: runId,
-        })
-        .go();
-
-      if (!result.data?.snapshot) {
-        // Check snapshot exists
-        return null;
-      }
-
-      // Parse the snapshot string
-      return result.data.snapshot as WorkflowRunState;
-    } catch (error) {
-      throw new MastraError(
-        {
-          id: 'STORAGE_DYNAMODB_STORE_LOAD_WORKFLOW_SNAPSHOT_FAILED',
-          domain: ErrorDomain.STORAGE,
-          category: ErrorCategory.THIRD_PARTY,
-          details: { workflowName, runId },
-        },
-        error,
-      );
-    }
-  }
-
-  async getWorkflowRuns(args?: {
-    workflowName?: string;
-    fromDate?: Date;
-    toDate?: Date;
-    limit?: number;
-    offset?: number;
-    resourceId?: string;
-  }): Promise<WorkflowRuns> {
-    this.logger.debug('Getting workflow runs', { args });
-
-    try {
-      // Default values
-      const limit = args?.limit || 10;
-      const offset = args?.offset || 0;
-
-      let query;
-
-      if (args?.workflowName) {
-        // Query by workflow name using the primary index
-        // Provide *all* composite key components for the PK ('entity', 'workflow_name')
-        query = this.service.entities.workflow_snapshot.query.primary({
-          entity: 'workflow_snapshot', // Add entity type
-          workflow_name: args.workflowName,
-        });
-      } else {
-        // If no workflow name, we need to scan
-        // This is not ideal for production with large datasets
-        this.logger.warn('Performing a scan operation on workflow snapshots - consider using a more specific query');
-        query = this.service.entities.workflow_snapshot.scan; // Scan still uses the service entity
-      }
-
-      const allMatchingSnapshots: WorkflowSnapshotDBItem[] = [];
-      let cursor: string | null = null;
-      const DYNAMODB_PAGE_SIZE = 100; // Sensible page size for fetching
-
-      do {
-        const pageResults: { data: WorkflowSnapshotDBItem[]; cursor: string | null } = await query.go({
-          limit: DYNAMODB_PAGE_SIZE,
-          cursor,
-        });
-
-        if (pageResults.data && pageResults.data.length > 0) {
-          let pageFilteredData: WorkflowSnapshotDBItem[] = pageResults.data;
-
-          // Apply date filters if specified
-          if (args?.fromDate || args?.toDate) {
-            pageFilteredData = pageFilteredData.filter((snapshot: WorkflowSnapshotDBItem) => {
-              const createdAt = new Date(snapshot.createdAt);
-              if (args.fromDate && createdAt < args.fromDate) {
-                return false;
-              }
-              if (args.toDate && createdAt > args.toDate) {
-                return false;
-              }
-              return true;
-            });
-          }
-
-          // Filter by resourceId if specified
-          if (args?.resourceId) {
-            pageFilteredData = pageFilteredData.filter((snapshot: WorkflowSnapshotDBItem) => {
-              return snapshot.resourceId === args.resourceId;
-            });
-          }
-          allMatchingSnapshots.push(...pageFilteredData);
-        }
-
-        cursor = pageResults.cursor;
-      } while (cursor);
-
-      if (!allMatchingSnapshots.length) {
-        return { runs: [], total: 0 };
-      }
-
-      // Apply offset and limit to the accumulated filtered results
-      const total = allMatchingSnapshots.length;
-      const paginatedData = allMatchingSnapshots.slice(offset, offset + limit);
-
-      // Format and return the results
-      const runs = paginatedData.map((snapshot: WorkflowSnapshotDBItem) => formatWorkflowRun(snapshot));
-
-      return {
-        runs,
-        total,
-      };
-    } catch (error) {
-      throw new MastraError(
-        {
-          id: 'STORAGE_DYNAMODB_STORE_GET_WORKFLOW_RUNS_FAILED',
-          domain: ErrorDomain.STORAGE,
-          category: ErrorCategory.THIRD_PARTY,
-          details: { workflowName: args?.workflowName || '', resourceId: args?.resourceId || '' },
-        },
-        error,
-      );
-    }
-  }
-
-  async getWorkflowRunById(args: { runId: string; workflowName?: string }): Promise<WorkflowRun | null> {
-    const { runId, workflowName } = args;
-    this.logger.debug('Getting workflow run by ID', { runId, workflowName });
-
-    console.log('workflowName', workflowName);
-    console.log('runId', runId);
-
-    try {
-      // If we have a workflowName, we can do a direct get using the primary key
-      if (workflowName) {
-        this.logger.debug('WorkflowName provided, using direct GET operation.');
-        const result = await this.service.entities.workflow_snapshot
-          .get({
-            entity: 'workflow_snapshot', // Entity type for PK
-            workflow_name: workflowName,
-            run_id: runId,
-          })
-          .go();
-
-        console.log('result', result);
-
-        if (!result.data) {
-          return null;
-        }
-
-        const snapshot = result.data.snapshot;
-        return {
-          workflowName: result.data.workflow_name,
-          runId: result.data.run_id,
-          snapshot,
-          createdAt: new Date(result.data.createdAt),
-          updatedAt: new Date(result.data.updatedAt),
-          resourceId: result.data.resourceId,
-        };
-      }
-
-      // Otherwise, if workflowName is not provided, use the GSI on runId.
-      // This is more efficient than a full table scan.
-      this.logger.debug(
-        'WorkflowName not provided. Attempting to find workflow run by runId using GSI. Ensure GSI (e.g., "byRunId") is defined on the workflowSnapshot entity with run_id as its key and provisioned in DynamoDB.',
-      );
-
-      // IMPORTANT: This assumes a GSI (e.g., named 'byRunId') exists on the workflowSnapshot entity
-      // with 'run_id' as its partition key. This GSI must be:
-      // 1. Defined in your ElectroDB model (e.g., in stores/dynamodb/src/entities/index.ts).
-      // 2. Provisioned in the actual DynamoDB table (e.g., via CDK/CloudFormation).
-      // The query key object includes 'entity' as it's good practice with ElectroDB and single-table design,
-      // aligning with how other GSIs are queried in this file.
-      const result = await this.service.entities.workflow_snapshot.query
-        .gsi2({ entity: 'workflow_snapshot', run_id: runId }) // Replace 'byRunId' with your actual GSI name
-        .go();
-
-      // If the GSI query returns multiple items (e.g., if run_id is not globally unique across all snapshots),
-      // this will take the first one. The original scan logic also effectively took the first match found.
-      // If run_id is guaranteed unique, result.data should contain at most one item.
-      const matchingRunDbItem: WorkflowSnapshotDBItem | null =
-        result.data && result.data.length > 0 ? result.data[0] : null;
-
-      if (!matchingRunDbItem) {
-        return null;
-      }
-
-      const snapshot = matchingRunDbItem.snapshot;
-      return {
-        workflowName: matchingRunDbItem.workflow_name,
-        runId: matchingRunDbItem.run_id,
-        snapshot,
-        createdAt: new Date(matchingRunDbItem.createdAt),
-        updatedAt: new Date(matchingRunDbItem.updatedAt),
-        resourceId: matchingRunDbItem.resourceId,
-      };
-    } catch (error) {
-      throw new MastraError(
-        {
-          id: 'STORAGE_DYNAMODB_STORE_GET_WORKFLOW_RUN_BY_ID_FAILED',
-          domain: ErrorDomain.STORAGE,
-          category: ErrorCategory.THIRD_PARTY,
-          details: { runId, workflowName: args?.workflowName || '' },
-        },
-        error,
-      );
-    }
-  }
-}