feat(backend): Add graph/node id & execution id on CreditTransaction table

autogpt_platform/backend/backend/data/credit.py

@@ -12,6 +12,7 @@
 from backend.data.block import Block, BlockInput, get_block
 from backend.data.block_cost_config import BLOCK_COSTS
 from backend.data.cost import BlockCost, BlockCostType
+from backend.data.execution import NodeExecutionEntry
 from backend.data.user import get_user_by_id
 from backend.util.settings import Settings
 
@@ -33,19 +34,15 @@ async def get_credits(self, user_id: str) -> int:
     @abstractmethod
     async def spend_credits(
         self,
-        user_id: str,
-        block_id: str,
-        input_data: BlockInput,
+        entry: NodeExecutionEntry,
         data_size: float,
         run_time: float,
     ) -> int:
         """
         Spend the credits for the user based on the block usage.
 
         Args:
-            user_id (str): The user ID.
-            block_id (str): The block ID.
-            input_data (BlockInput): The input data for the block.
+            entry (NodeExecutionEntry): The node execution identifiers & data.
             data_size (float): The size of the data being processed.
             run_time (float): The time taken to run the block.
 
@@ -168,7 +165,6 @@ async def _add_transaction(
         transaction_type: CreditTransactionType,
         is_active: bool = True,
         transaction_key: str | None = None,
-        block_id: str | None = None,
         metadata: Json = Json({}),
     ):
         async with db.locked_transaction(f"usr_trx_{user_id}"):
@@ -185,7 +181,6 @@ async def _add_transaction(
                 "amount": amount,
                 "runningBalance": user_balance + amount,
                 "type": transaction_type,
-                "blockId": block_id,
                 "metadata": metadata,
                 "isActive": is_active,
                 "createdAt": self.time_now(),
@@ -251,29 +246,31 @@ def _is_cost_filter_match(
 
     async def spend_credits(
         self,
-        user_id: str,
-        block_id: str,
-        input_data: BlockInput,
+        entry: NodeExecutionEntry,
         data_size: float,
         run_time: float,
     ) -> int:
-        block = get_block(block_id)
+        block = get_block(entry.block_id)
         if not block:
-            raise ValueError(f"Block not found: {block_id}")
+            raise ValueError(f"Block not found: {entry.block_id}")
 
         cost, matching_filter = self._block_usage_cost(
-            block=block, input_data=input_data, data_size=data_size, run_time=run_time
+            block=block, input_data=entry.data, data_size=data_size, run_time=run_time
         )
         if cost == 0:
             return 0
 
         await self._add_transaction(
-            user_id=user_id,
+            user_id=entry.user_id,
             amount=-cost,
             transaction_type=CreditTransactionType.USAGE,
-            block_id=block.id,
             metadata=Json(
                 {
+                    "graph_exec_id": entry.graph_exec_id,
+                    "graph_id": entry.graph_id,
+                    "node_id": entry.node_id,
+                    "node_exec_id": entry.node_exec_id,
+                    "block_id": entry.block_id,
                     "block": block.name,
                     "input": matching_filter,
                 }

autogpt_platform/backend/backend/data/execution.py

@@ -31,6 +31,7 @@ class NodeExecutionEntry(BaseModel):
     graph_id: str
     node_exec_id: str
     node_id: str
+    block_id: str
     data: BlockInput
 
 

autogpt_platform/backend/backend/executor/database.py

@@ -4,6 +4,7 @@
 from backend.data.credit import get_user_credit_model
 from backend.data.execution import (
     ExecutionResult,
+    NodeExecutionEntry,
     RedisExecutionEventBus,
     create_graph_execution,
     get_execution_results,
@@ -79,7 +80,7 @@ def wrapper(self, *args: P.args, **kwargs: P.kwargs) -> R:
     # Credits
     user_credit_model = get_user_credit_model()
     spend_credits = cast(
-        Callable[[Any, str, str, dict[str, str], float, float], int],
+        Callable[[Any, NodeExecutionEntry, float, float], int],
         exposed_run_and_wait(user_credit_model.spend_credits),
     )
 

autogpt_platform/backend/backend/executor/manager.py

@@ -238,7 +238,8 @@ def update_execution(status: ExecutionStatus) -> ExecutionResult:
                 if res.end_time and res.start_time
                 else 0
             )
-            db_client.spend_credits(user_id, node_block.id, input_data, s, t)
+            data.data = input_data
+            db_client.spend_credits(data, s, t)
 
         # Update execution stats
         if execution_stats is not None:
@@ -257,7 +258,7 @@ def _enqueue_next_nodes(
     log_metadata: LogMetadata,
 ) -> list[NodeExecutionEntry]:
     def add_enqueued_execution(
-        node_exec_id: str, node_id: str, data: BlockInput
+        node_exec_id: str, node_id: str, block_id: str, data: BlockInput
     ) -> NodeExecutionEntry:
         exec_update = db_client.update_execution_status(
             node_exec_id, ExecutionStatus.QUEUED, data
@@ -269,6 +270,7 @@ def add_enqueued_execution(
             graph_id=graph_id,
             node_exec_id=node_exec_id,
             node_id=node_id,
+            block_id=block_id,
             data=data,
         )
 
@@ -322,7 +324,12 @@ def register_next_executions(node_link: Link) -> list[NodeExecutionEntry]:
             # Input is complete, enqueue the execution.
             log_metadata.info(f"Enqueued {suffix}")
             enqueued_executions.append(
-                add_enqueued_execution(next_node_exec_id, next_node_id, next_node_input)
+                add_enqueued_execution(
+                    node_exec_id=next_node_exec_id,
+                    node_id=next_node_id,
+                    block_id=next_node.block_id,
+                    data=next_node_input,
+                )
             )
 
             # Next execution stops here if the link is not static.
@@ -352,7 +359,12 @@ def register_next_executions(node_link: Link) -> list[NodeExecutionEntry]:
                     continue
                 log_metadata.info(f"Enqueueing static-link execution {suffix}")
                 enqueued_executions.append(
-                    add_enqueued_execution(iexec.node_exec_id, next_node_id, idata)
+                    add_enqueued_execution(
+                        node_exec_id=iexec.node_exec_id,
+                        node_id=next_node_id,
+                        block_id=next_node.block_id,
+                        data=idata,
+                    )
                 )
             return enqueued_executions
 
@@ -837,6 +849,7 @@ def add_execution(
                     graph_id=node_exec.graph_id,
                     node_exec_id=node_exec.node_exec_id,
                     node_id=node_exec.node_id,
+                    block_id=node_exec.block_id,
                     data=node_exec.input_data,
                 )
             )

autogpt_platform/backend/migrations/20250115382614_reshape_transaction_metadata_column/migration.sql

@@ -0,0 +1,35 @@
+/*
+  Warnings:
+
+  - You are about to drop the column `blockId` on the `CreditTransaction` table. All the data in the column will be moved to metadata->block_id.
+
+*/
+BEGIN;
+
+-- DropForeignKey blockId
+ALTER TABLE "CreditTransaction" DROP CONSTRAINT "CreditTransaction_blockId_fkey";
+
+-- Update migrate blockId into metadata->"block_id"
+UPDATE "CreditTransaction"
+SET "metadata" = jsonb_set(
+    COALESCE("metadata"::jsonb, '{}'),
+    '{block_id}',
+    to_jsonb("blockId")
+)
+WHERE "blockId" IS NOT NULL;
+
+-- AlterTable drop blockId
+ALTER TABLE "CreditTransaction" DROP COLUMN "blockId";
+
+COMMIT;
+
+/*
+    These indices dropped below were part of the cleanup during the schema change applied above.
+    These indexes were not useful and will not impact anything upon their removal.
+*/
+
+-- DropIndex
+DROP INDEX "StoreListingReview_storeListingVersionId_idx";
+
+-- DropIndex
+DROP INDEX "StoreListingSubmission_Status_idx";

autogpt_platform/backend/schema.prisma

@@ -32,12 +32,12 @@ model User {
   AgentPreset AgentPreset[]
   UserAgent   UserAgent[]
 
-  Profile                     Profile[]
-  StoreListing                StoreListing[]
-  StoreListingReview          StoreListingReview[]
-  StoreListingSubmission      StoreListingSubmission[]
-  APIKeys                     APIKey[]
-  IntegrationWebhooks         IntegrationWebhook[]
+  Profile                Profile[]
+  StoreListing           StoreListing[]
+  StoreListingReview     StoreListingReview[]
+  StoreListingSubmission StoreListingSubmission[]
+  APIKeys                APIKey[]
+  IntegrationWebhooks    IntegrationWebhook[]
 
   @@index([id])
   @@index([email])
@@ -64,23 +64,23 @@ model AgentGraph {
   AgentNodes          AgentNode[]
   AgentGraphExecution AgentGraphExecution[]
 
-  AgentPreset                 AgentPreset[]
-  UserAgent                   UserAgent[]
-  StoreListing                StoreListing[]
-  StoreListingVersion         StoreListingVersion?
+  AgentPreset         AgentPreset[]
+  UserAgent           UserAgent[]
+  StoreListing        StoreListing[]
+  StoreListingVersion StoreListingVersion?
 
   @@id(name: "graphVersionId", [id, version])
   @@index([userId, isActive])
 }
 
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 ////////////////   USER SPECIFIC DATA   ////////////////////
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 
 // An AgentPrest is an Agent + User Configuration of that agent.
-// For example, if someone has created a weather agent and they want to set it up to 
+// For example, if someone has created a weather agent and they want to set it up to
 // Inform them of extreme weather warnings in Texas, the agent with the configuration to set it to
 // monitor texas, along with the cron setup or webhook tiggers, is an AgentPreset
 model AgentPreset {
@@ -102,9 +102,9 @@ model AgentPreset {
   agentVersion Int
   Agent        AgentGraph @relation(fields: [agentId, agentVersion], references: [id, version], onDelete: Cascade)
 
-  InputPresets           AgentNodeExecutionInputOutput[] @relation("AgentPresetsInputData")
-  UserAgents             UserAgent[]
-  AgentExecution         AgentGraphExecution[]
+  InputPresets   AgentNodeExecutionInputOutput[] @relation("AgentPresetsInputData")
+  UserAgents     UserAgent[]
+  AgentExecution AgentGraphExecution[]
 
   @@index([userId])
 }
@@ -134,11 +134,11 @@ model UserAgent {
   @@index([userId])
 }
 
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 ////////   AGENT DEFINITION AND EXECUTION TABLES    ////////
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 
 // This model describes a single node in the Agent Graph/Flow (Multi Agent System).
 model AgentNode {
@@ -207,7 +207,6 @@ model AgentBlock {
 
   // Prisma requires explicit back-references.
   ReferencedByAgentNode AgentNode[]
-  CreditTransaction     CreditTransaction[]
 }
 
 // This model describes the status of an AgentGraphExecution or AgentNodeExecution.
@@ -345,11 +344,11 @@ model AnalyticsDetails {
   @@index([type])
 }
 
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 //////////////   METRICS TRACKING TABLES    ////////////////
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 model AnalyticsMetrics {
   id        String   @id @default(uuid())
   createdAt DateTime @default(now())
@@ -375,21 +374,18 @@ enum CreditTransactionType {
   USAGE
 }
 
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 ////////   ACCOUNTING AND CREDIT SYSTEM TABLES    //////////
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 model CreditTransaction {
   transactionKey String   @default(uuid())
   createdAt      DateTime @default(now())
 
   userId String
   user   User   @relation(fields: [userId], references: [id], onDelete: Cascade)
 
-  blockId String?
-  block   AgentBlock? @relation(fields: [blockId], references: [id])
-
   amount Int
   type   CreditTransactionType
 
@@ -402,19 +398,19 @@ model CreditTransaction {
   @@index([userId, createdAt])
 }
 
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 //////////////   Store TABLES    ///////////////////////////
-//////////////////////////////////////////////////////////// 
-//////////////////////////////////////////////////////////// 
+////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////
 
 model Profile {
   id        String   @id @default(uuid())
   createdAt DateTime @default(now())
   updatedAt DateTime @default(now()) @updatedAt
 
   // Only 1 of user or group can be set.
-  // The user this profile belongs to, if any. 
+  // The user this profile belongs to, if any.
   userId String?
   User   User?   @relation(fields: [userId], references: [id], onDelete: Cascade)
 
@@ -528,7 +524,7 @@ model StoreListingVersion {
   agentVersion Int
   Agent        AgentGraph @relation(fields: [agentId, agentVersion], references: [id, version])
 
-  // The detials for this version of the agent, this allows the author to update the details of the agent,
+  // The details for this version of the agent, this allows the author to update the details of the agent,
   // But still allow using old versions of the agent with there original details.
   // TODO: Create a database view that shows only the latest version of each store listing.
   slug        String
@@ -573,7 +569,6 @@ model StoreListingReview {
   comments String?
 
   @@unique([storeListingVersionId, reviewByUserId])
-  @@index([storeListingVersionId])
 }
 
 enum SubmissionStatus {
@@ -601,7 +596,6 @@ model StoreListingSubmission {
   reviewComments String?
 
   @@index([storeListingId])
-  @@index([Status])
 }
 
 enum APIKeyPermission {