feat(api, robot-server): get historical and current command errors

api/tests/opentrons/protocol_engine/state/test_command_state.py

@@ -1104,7 +1104,7 @@ def test_get_state_update_for_false_positive() -> None:
 
 
 def test_get_errors_slice_empty() -> None:
-    """It should return a slice from the tail if no current command."""
+    """It should return an empty error list."""
     subject = CommandStore(
         config=_make_config(),
         error_recovery_policy=_placeholder_error_recovery_policy,
@@ -1126,11 +1126,6 @@ def test_get_errors_slice() -> None:
 
     subject_view = CommandView(subject.state)
 
-    # error_1 = ErrorOccurrence.construct(id="error-id-1")  # type: ignore[call-arg]
-    # error_2 = ErrorOccurrence.construct(id="error-id-2")  # type: ignore[call-arg]
-    # error_3 = ErrorOccurrence.construct(id="error-id-3")  # type: ignore[call-arg]
-    # error_4 = ErrorOccurrence.construct(id="error-id-4")  # type: ignore[call-arg]
-
     queue_1 = actions.QueueCommandAction(
         request=commands.WaitForResumeCreate(
             params=commands.WaitForResumeParams(), key="command-key-1"

robot-server/robot_server/persistence/_migrations/v7_to_v8.py

@@ -3,6 +3,7 @@
 Summary of changes from schema 7:
 
 - Adds a new command_error to store the commands error in the commands table
+- Adds a new command_status to store the commands status in the commands table
 """
 
 import json
@@ -13,7 +14,7 @@
 
 import sqlalchemy
 
-from ..database import sql_engine_ctx, sqlite_rowid
+from ..database import sql_engine_ctx
 from ..tables import schema_8
 from .._folder_migrator import Migration
 
@@ -38,7 +39,7 @@ def migrate(self, source_dir: Path, dest_dir: Path) -> None:
         with ExitStack() as exit_stack:
             dest_engine = exit_stack.enter_context(sql_engine_ctx(dest_db_file))
 
-            schema_8.metadata.create_all(dest_engine)
+            # schema_8.metadata.create_all(dest_engine)
 
             dest_transaction = exit_stack.enter_context(dest_engine.begin())
 
@@ -72,10 +73,10 @@ def add_column(
 def _migrate_command_table_with_new_command_error_col_and_command_status(
     dest_transaction: sqlalchemy.engine.Connection,
 ) -> None:
-    """Add a new 'command_intent' column to run_command_table table."""
+    """Add a new 'command_error' and 'command_status' column to run_command_table table."""
     commands_table = schema_8.run_command_table
-    select_commands = sqlalchemy.select(commands_table).order_by(sqlite_rowid)
-
+    select_commands = sqlalchemy.select(commands_table)
+    commands_to_update = []
     for row in dest_transaction.execute(select_commands).all():
         data = json.loads(row.command)
         new_command_error = (
@@ -85,12 +86,42 @@ def _migrate_command_table_with_new_command_error_col_and_command_status(
             else json.dumps(data["error"])
         )
         # parse json as enum
-        new_command_status = CommandStatusSQLEnum(data["status"])
+        new_command_status = _convert_commands_status_to_sql_command_status(
+            data["status"]
+        )
+        commands_to_update.append(
+            {
+                "_id": row.row_id,
+                "command_error": new_command_error,
+                "command_status": new_command_status,
+            }
+        )
 
+    if len(commands_to_update) > 0:
         update_commands = (
-            sqlalchemy.update(schema_8.run_command_table)
-            .where(schema_8.run_command_table.c.row_id == row.row_id)
-            .values(command_error=new_command_error, command_status=new_command_status)
+            sqlalchemy.update(commands_table)
+            .where(commands_table.c.row_id == sqlalchemy.bindparam("_id"))
+            .values(
+                {
+                    "command_error": sqlalchemy.bindparam("command_error"),
+                    "command_status": sqlalchemy.bindparam("command_status"),
+                }
+            )
         )
-
-        dest_transaction.execute(update_commands)
+        dest_transaction.execute(update_commands, commands_to_update)
+
+
+def _convert_commands_status_to_sql_command_status(
+    status: str,
+) -> CommandStatusSQLEnum:
+    match status:
+        case "queued":
+            return CommandStatusSQLEnum.QUEUED
+        case "running":
+            return CommandStatusSQLEnum.RUNNING
+        case "failed":
+            return CommandStatusSQLEnum.FAILED
+        case "succeeded":
+            return CommandStatusSQLEnum.SUCCEEDED
+        case _:
+            assert False, "command status is unknown"

robot-server/robot_server/persistence/tables/schema_8.py

@@ -213,6 +213,7 @@ class CommandStatusSQLEnum(enum.Enum):
     sqlalchemy.Column(
         "run_id", sqlalchemy.String, sqlalchemy.ForeignKey("run.id"), nullable=False
     ),
+    # command_index in commands enumeration
     sqlalchemy.Column("index_in_run", sqlalchemy.Integer, nullable=False),
     sqlalchemy.Column("command_id", sqlalchemy.String, nullable=False),
     sqlalchemy.Column("command", sqlalchemy.String, nullable=False),
@@ -240,12 +241,12 @@ class CommandStatusSQLEnum(enum.Enum):
         "index_in_run",
         unique=True,
     ),
-    # TODO(tz, 12-11-2024): change index to command_error when partial index is supported.
     sqlalchemy.Index(
-        "ix_run_run_id_index_in_run_command_status",  # An arbitrary name for the index.
+        "ix_run_run_id_command_status_index_in_run",  # An arbitrary name for the index.
         "run_id",
-        "index_in_run",
         "command_status",
+        "index_in_run",
+        unique=True,
     ),
 )
 

robot-server/robot_server/runs/run_store.py

@@ -189,7 +189,9 @@ def update_run_state(
                         "command_error": pydantic_to_json(command.error)
                         if command.error
                         else None,
-                        "command_status": CommandStatusSQLEnum(command.status.value),
+                        "command_status": _convert_commands_status_to_sql_command_status(
+                            command.status.value
+                        ),
                     },
                 )
 
@@ -812,3 +814,19 @@ def _convert_state_to_sql_values(
         "_updated_at": utc_now(),
         "run_time_parameters": pydantic_list_to_json(run_time_parameters),
     }
+
+
+def _convert_commands_status_to_sql_command_status(
+    status: str,
+) -> CommandStatusSQLEnum:
+    match status:
+        case "queued":
+            return CommandStatusSQLEnum.QUEUED
+        case "running":
+            return CommandStatusSQLEnum.RUNNING
+        case "failed":
+            return CommandStatusSQLEnum.FAILED
+        case "succeeded":
+            return CommandStatusSQLEnum.SUCCEEDED
+        case _:
+            assert False, "command status is unknown"

robot-server/tests/persistence/test_tables.py

@@ -126,7 +126,7 @@
     CREATE INDEX ix_protocol_protocol_kind ON protocol (protocol_kind)
     """,
     """
-    CREATE INDEX ix_run_run_id_index_in_run_command_status ON run_command (run_id, index_in_run, command_status)
+    CREATE UNIQUE INDEX ix_run_run_id_command_status_index_in_run ON run_command (run_id, command_status, index_in_run)
     """,
     """
     CREATE INDEX ix_run_command_command_intent ON run_command (command_intent)

robot-server/tests/runs/test_run_store.py

@@ -60,7 +60,7 @@ def subject(
 
 @pytest.fixture
 def protocol_commands() -> List[pe_commands.Command]:
-    """Get a StateSummary value object."""
+    """Get protocol commands list."""
     return [
         pe_commands.WaitForResume(
             id="pause-1",
@@ -102,7 +102,7 @@ def protocol_commands() -> List[pe_commands.Command]:
 
 @pytest.fixture
 def protocol_commands_errors() -> List[pe_commands.Command]:
-    """Get a StateSummary value object."""
+    """Get protocol commands errors list."""
     return [
         pe_commands.WaitForResume(
             id="pause-1",
@@ -360,7 +360,6 @@ async def test_update_run_state_command_with_errors(
         length=len(protocol_commands_errors),
         cursor=0,
     )
-    print(command_errors_result)
 
     assert command_errors_result.commands_errors == [
         item.error for item in protocol_commands_errors