Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

fix(backend): wrap PlatformCostLog metadata in SafeJson to fix silent DataError (#12713)

Zamil Majdy705bd2793029
diff --git a/autogpt_platform/backend/backend/data/platform_cost.py b/autogpt_platform/backend/backend/data/platform_cost.py
index aebbbe1d99..6865967627 100644
--- a/autogpt_platform/backend/backend/data/platform_cost.py
+++ b/autogpt_platform/backend/backend/data/platform_cost.py
@@ -4,10 +4,12 @@ from datetime import datetime, timedelta, timezone
from typing import Any
from prisma.models import PlatformCostLog as PrismaLog
+from prisma.types import PlatformCostLogCreateInput
from pydantic import BaseModel
from backend.data.db import query_raw_with_schema
from backend.util.cache import cached
+from backend.util.json import SafeJson
logger = logging.getLogger(__name__)
@@ -52,28 +54,28 @@ class PlatformCostEntry(BaseModel):
async def log_platform_cost(entry: PlatformCostEntry) -> None:
await PrismaLog.prisma().create(
- data={
- "userId": entry.user_id,
- "graphExecId": entry.graph_exec_id,
- "nodeExecId": entry.node_exec_id,
- "graphId": entry.graph_id,
- "nodeId": entry.node_id,
- "blockId": entry.block_id,
- "blockName": entry.block_name,
+ data=PlatformCostLogCreateInput(
+ userId=entry.user_id,
+ graphExecId=entry.graph_exec_id,
+ nodeExecId=entry.node_exec_id,
+ graphId=entry.graph_id,
+ nodeId=entry.node_id,
+ blockId=entry.block_id,
+ blockName=entry.block_name,
# Normalize to lowercase so the (provider, createdAt) index is always
# used without LOWER() on the read side.
- "provider": entry.provider.lower(),
- "credentialId": entry.credential_id,
- "costMicrodollars": entry.cost_microdollars,
- "inputTokens": entry.input_tokens,
- "outputTokens": entry.output_tokens,
- "dataSize": entry.data_size,
- "duration": entry.duration,
- "model": entry.model,
- "trackingType": entry.tracking_type,
- "trackingAmount": entry.tracking_amount,
- "metadata": entry.metadata,
- }
+ provider=entry.provider.lower(),
+ credentialId=entry.credential_id,
+ costMicrodollars=entry.cost_microdollars,
+ inputTokens=entry.input_tokens,
+ outputTokens=entry.output_tokens,
+ dataSize=entry.data_size,
+ duration=entry.duration,
+ model=entry.model,
+ trackingType=entry.tracking_type,
+ trackingAmount=entry.tracking_amount,
+ metadata=SafeJson(entry.metadata or {}),
+ )
)
diff --git a/autogpt_platform/backend/backend/data/platform_cost_integration_test.py b/autogpt_platform/backend/backend/data/platform_cost_integration_test.py
new file mode 100644
index 0000000000..10fe35d748
--- /dev/null
+++ b/autogpt_platform/backend/backend/data/platform_cost_integration_test.py
@@ -0,0 +1,79 @@
+"""
+Integration tests for platform cost logging.
+
+These tests run actual database operations to verify that SafeJson metadata
+round-trips correctly through Prisma — catching the DataError that occurred
+when a plain Python dict was passed to the Prisma Json? field.
+"""
+
+import uuid
+
+import pytest
+from prisma.models import PlatformCostLog as PrismaLog
+from prisma.models import User
+
+from backend.util.json import SafeJson
+
+from .platform_cost import PlatformCostEntry, log_platform_cost
+
+
+async def cost_log_user():
+ """Create a throw-away user and clean up cost logs after the test."""
+ user_id = str(uuid.uuid4())
+ await User.prisma().create(
+ data={
+ "id": user_id,
+ "email": f"cost-test-{user_id}@example.com",
+ "topUpConfig": SafeJson({}),
+ "timezone": "UTC",
+ }
+ )
+ yield user_id
+ await PrismaLog.prisma().delete_many(where={"userId": user_id})
+ await User.prisma().delete(where={"id": user_id})
+
+
[email protected](loop_scope="session")
+async def test_log_platform_cost_metadata_round_trip(cost_log_user):
+ """
+ Verify that SafeJson metadata is persisted and read back correctly.
+
+ This test would have caught the DataError that silently swallowed all cost
+ log writes when a plain Python dict was passed to the Prisma Json? field.
+ """
+ user_id = cost_log_user
+ entry = PlatformCostEntry(
+ user_id=user_id,
+ block_name="TestBlock",
+ provider="openai",
+ cost_microdollars=5000,
+ input_tokens=100,
+ output_tokens=50,
+ model="gpt-4",
+ metadata={"key": "val", "nested": {"x": 1}},
+ )
+ await log_platform_cost(entry)
+
+ rows = await PrismaLog.prisma().find_many(where={"userId": user_id})
+ assert len(rows) == 1
+ assert rows[0].metadata == {"key": "val", "nested": {"x": 1}}
+ assert rows[0].provider == "openai"
+ assert rows[0].costMicrodollars == 5000
+
+
[email protected](loop_scope="session")
+async def test_log_platform_cost_metadata_none(cost_log_user):
+ """Verify that None metadata falls back to {} (not a DataError)."""
+ user_id = cost_log_user
+ entry = PlatformCostEntry(
+ user_id=user_id,
+ block_name="TestBlock",
+ provider="anthropic",
+ metadata=None,
+ )
+ await log_platform_cost(entry)
+
+ rows = await PrismaLog.prisma().find_many(where={"userId": user_id})
+ assert len(rows) == 1
+ assert rows[0].metadata == {}
diff --git a/autogpt_platform/backend/backend/data/platform_cost_test.py b/autogpt_platform/backend/backend/data/platform_cost_test.py
index c160adea1c..af150346a5 100644
--- a/autogpt_platform/backend/backend/data/platform_cost_test.py
+++ b/autogpt_platform/backend/backend/data/platform_cost_test.py
@@ -4,6 +4,9 @@ from datetime import datetime, timezone
from unittest.mock import AsyncMock, patch
import pytest
+from prisma import Json
+
+from backend.util.json import SafeJson
from .platform_cost import (
PlatformCostEntry,
@@ -122,9 +125,10 @@ class TestLogPlatformCost:
mock_create.assert_awaited_once()
data = mock_create.call_args[1]["data"]
assert data["userId"] == "user-1"
- assert data["blockId"] == "block-1"
assert data["blockName"] == "TestBlock"
- assert data["metadata"] == {"key": "val"}
+ assert data["provider"] == "openai"
+ # metadata must be wrapped in SafeJson (a prisma.Json subclass), not a plain dict
+ assert isinstance(data["metadata"], Json)
@pytest.mark.asyncio
async def test_metadata_none_passes_none(self):
@@ -134,7 +138,9 @@ class TestLogPlatformCost:
entry = _make_entry(metadata=None)
await log_platform_cost(entry)
data = mock_create.call_args[1]["data"]
- assert data["metadata"] is None
+ # None falls back to SafeJson({}) so Prisma always gets a valid Json value
+ assert isinstance(data["metadata"], Json)
+ assert data["metadata"] == SafeJson({})
class TestLogPlatformCostSafe: