[OPIK-7172] [BE][FE][SDK] feat: re-expose custom-code metric in Optimization Studio

apps/opik-backend/src/main/java/com/comet/opik/api/Optimization.java

@@ -39,6 +39,8 @@ public record Optimization(
                 Optimization.View.Write.class}) JsonNode metadata,
         @JsonView({Optimization.View.Public.class,
                 Optimization.View.Write.class}) @Valid OptimizationStudioConfig studioConfig,
+        @JsonView({Optimization.View.Public.class,
+                Optimization.View.Write.class}) @Valid @Schema(description = "Failure reason persisted when the optimization ends in error") ErrorInfo errorInfo,
         @JsonView({Optimization.View.Public.class}) @Schema(accessMode = Schema.AccessMode.READ_ONLY) UUID datasetId,
         @JsonView({Optimization.View.Public.class}) @Schema(accessMode = Schema.AccessMode.READ_ONLY) Long numTrials,
         @JsonView({

apps/opik-backend/src/main/java/com/comet/opik/api/OptimizationUpdate.java

@@ -3,10 +3,11 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import jakarta.validation.Valid;
 import lombok.Builder;
 
 @Builder(toBuilder = true)
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
-public record OptimizationUpdate(String name, OptimizationStatus status) {
+public record OptimizationUpdate(String name, OptimizationStatus status, @Valid ErrorInfo errorInfo) {
 }

apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/OptimizationsResource.java

@@ -199,7 +199,7 @@ public Response deleteOptimizationsById(
             @ApiResponse(responseCode = "204", description = "No content")})
     @RequiredPermissions(WorkspaceUserPermission.OPTIMIZATION_STUDIO_USE)
     public Response updateOptimizationsById(@PathParam("id") UUID id,
-            @RequestBody(content = @Content(schema = @Schema(implementation = OptimizationUpdate.class))) @NotNull OptimizationUpdate request) {
+            @RequestBody(content = @Content(schema = @Schema(implementation = OptimizationUpdate.class))) @NotNull @Valid OptimizationUpdate request) {
         log.info("Update optimization with id '{}', with request '{}'", id, request);
 
         optimizationService.update(id, request)

apps/opik-backend/src/main/java/com/comet/opik/domain/OptimizationDAO.java

@@ -1,6 +1,7 @@
 package com.comet.opik.domain;
 
 import com.comet.opik.api.DatasetLastOptimizationCreated;
+import com.comet.opik.api.ErrorInfo;
 import com.comet.opik.api.Optimization;
 import com.comet.opik.api.OptimizationStatus;
 import com.comet.opik.api.OptimizationStudioConfig;
@@ -37,6 +38,7 @@
 import java.util.Set;
 import java.util.UUID;
 
+import static com.comet.opik.api.ErrorInfo.ERROR_INFO_TYPE;
 import static com.comet.opik.domain.AsyncContextUtils.bindUserNameAndWorkspaceContextToStream;
 import static com.comet.opik.domain.AsyncContextUtils.bindWorkspaceIdToFlux;
 import static com.comet.opik.domain.ExperimentDAO.getFeedbackScores;
@@ -235,6 +237,7 @@ INSERT INTO optimizations (
                 status,
                 metadata,
                 studio_config,
+                error_info,
                 created_by,
                 last_updated_by,
                 last_updated_at
@@ -249,6 +252,7 @@ INSERT INTO optimizations (
                 :status,
                 :metadata,
                 :studio_config,
+                :error_info,
                 :created_by,
                 :last_updated_by,
                 COALESCE(parseDateTime64BestEffortOrNull(:last_updated_at, 6), now64(6))
@@ -557,7 +561,7 @@ ORDER BY (workspace_id, dataset_id, id) DESC, last_updated_at DESC
 
     private static final String UPDATE_BY_ID = """
             INSERT INTO optimizations (
-            	id, dataset_id, name, workspace_id, project_id, objective_name, status, metadata, created_at, created_by, last_updated_by, studio_config
+            	id, dataset_id, name, workspace_id, project_id, objective_name, status, metadata, created_at, created_by, last_updated_by, studio_config, error_info
             )
             SELECT
                 id,
@@ -571,7 +575,8 @@ INSERT INTO optimizations (
                 created_at,
                 created_by,
                 :user_name as last_updated_by,
-                studio_config
+                studio_config,
+                <if(error_info)> :error_info <else> error_info <endif> as error_info
             FROM optimizations
             WHERE id = :id
             AND workspace_id = :workspace_id
@@ -582,7 +587,7 @@ INSERT INTO optimizations (
 
     private static final String SET_DATASET_DELETED_TO_TRUE_BY_DATASET_ID = """
             INSERT INTO optimizations (
-            	id, dataset_id, name, workspace_id, project_id, objective_name, status, metadata, created_at, created_by, last_updated_at, last_updated_by, dataset_deleted, studio_config
+            	id, dataset_id, name, workspace_id, project_id, objective_name, status, metadata, created_at, created_by, last_updated_at, last_updated_by, dataset_deleted, studio_config, error_info
             )
             SELECT
                 id,
@@ -598,7 +603,8 @@ INSERT INTO optimizations (
                 last_updated_at,
                 last_updated_by,
                 true as dataset_deleted,
-                studio_config
+                studio_config,
+                error_info
             FROM optimizations
             WHERE workspace_id = :workspace_id
             AND dataset_id IN :dataset_ids
@@ -884,7 +890,9 @@ private Publisher<? extends Result> upsert(Optimization optimization, Connection
                 .bind("project_id", optimization.projectId() != null ? optimization.projectId().toString() : "")
                 .bind("objective_name", optimization.objectiveName())
                 .bind("status", optimization.status().getValue())
-                .bind("metadata", getStringOrDefault(optimization.metadata()));
+                .bind("metadata", getStringOrDefault(optimization.metadata()))
+                .bind("error_info",
+                        optimization.errorInfo() != null ? JsonUtils.writeValueAsString(optimization.errorInfo()) : "");
 
         if (optimization.studioConfig() != null) {
             try {
@@ -933,6 +941,17 @@ private Publisher<Optimization> mapToDto(Result result) {
                 }
             }
 
+            ErrorInfo errorInfo = null;
+            String errorInfoJson = row.get("error_info", String.class);
+            if (StringUtils.isNotBlank(errorInfoJson)) {
+                try {
+                    errorInfo = JsonUtils.readValue(errorInfoJson, ERROR_INFO_TYPE);
+                } catch (Exception e) {
+                    log.error("Failed to deserialize error_info for optimization: '{}'",
+                            row.get("id", UUID.class), e);
+                }
+            }
+
             String projectIdStr = row.get("project_id", String.class);
             UUID projectId = StringUtils.isNotBlank(projectIdStr) ? UUID.fromString(projectIdStr) : null;
 
@@ -945,6 +964,7 @@ private Publisher<Optimization> mapToDto(Result result) {
                     .status(OptimizationStatus.fromString(row.get("status", String.class)))
                     .metadata(getJsonNodeOrDefault(row.get("metadata", String.class)))
                     .studioConfig(studioConfig)
+                    .errorInfo(errorInfo)
                     .createdAt(row.get("created_at", Instant.class))
                     .lastUpdatedAt(row.get("last_updated_at", Instant.class))
                     .createdBy(row.get("created_by", String.class))
@@ -999,6 +1019,9 @@ private ST buildUpdateTemplate(OptimizationUpdate update) {
         Optional.ofNullable(update.status())
                 .ifPresent(status -> template.add("status", status.getValue()));
 
+        Optional.ofNullable(update.errorInfo())
+                .ifPresent(errorInfo -> template.add("error_info", errorInfo));
+
         return template;
     }
 
@@ -1011,6 +1034,9 @@ private Statement createUpdateStatement(UUID id, OptimizationUpdate update, Conn
         Optional.ofNullable(update.status())
                 .ifPresent(status -> statement.bind("status", status.getValue()));
 
+        Optional.ofNullable(update.errorInfo())
+                .ifPresent(errorInfo -> statement.bind("error_info", JsonUtils.writeValueAsString(errorInfo)));
+
         statement.bind("id", id);
 
         return statement;

apps/opik-backend/src/main/java/com/comet/opik/domain/OptimizationService.java

@@ -197,6 +197,15 @@ public Mono<UUID> upsert(@NonNull Optimization optimization) {
                                         builder.studioConfig(existing.studioConfig());
                                     }
 
+                                    // Preserve the persisted failure reason if not provided in update
+                                    // (upsert does a full-row replace; the SDK re-upserts with a null
+                                    // errorInfo and would otherwise clobber a previously recorded failure).
+                                    // errorInfo is normally set through the PATCH/update path.
+                                    if (optimization.errorInfo() == null
+                                            && existing.errorInfo() != null) {
+                                        builder.errorInfo(existing.errorInfo());
+                                    }
+
                                     // Preserve original name only if incoming name is blank
                                     // (SDK sends blank name, but explicit updates should be honored)
                                     if (StringUtils.isBlank(optimization.name())) {
@@ -310,7 +319,7 @@ public Flux<DatasetLastOptimizationCreated> getMostRecentCreatedOptimizationFrom
 
     @Override
     public Mono<Long> update(@NonNull UUID id, @NonNull OptimizationUpdate update) {
-        if (update.name() == null && update.status() == null) {
+        if (update.name() == null && update.status() == null && update.errorInfo() == null) {
             return Mono.empty();
         }
 

apps/opik-backend/src/main/resources/liquibase/db-app-analytics/migrations/000106_add_error_info_to_optimizations.sql

@@ -0,0 +1,8 @@
+--liquibase formatted sql
+--changeset admin:000106_add_error_info_to_optimizations
+--comment: Add error_info column to optimizations table to persist the failure reason surfaced in Optimization Studio
+
+ALTER TABLE ${ANALYTICS_DB_DATABASE_NAME}.optimizations ON CLUSTER '{cluster}'
+ADD COLUMN IF NOT EXISTS error_info String DEFAULT '';
+
+--rollback ALTER TABLE ${ANALYTICS_DB_DATABASE_NAME}.optimizations ON CLUSTER '{cluster}' DROP COLUMN IF EXISTS error_info;

apps/opik-backend/src/test/java/com/comet/opik/api/resources/v1/priv/OptimizationsResourceTest.java

@@ -3,6 +3,7 @@
 import com.comet.opik.api.Dataset;
 import com.comet.opik.api.DatasetItem;
 import com.comet.opik.api.DatasetItemBatch;
+import com.comet.opik.api.ErrorInfo;
 import com.comet.opik.api.Experiment;
 import com.comet.opik.api.ExperimentItem;
 import com.comet.opik.api.ExperimentScore;
@@ -875,6 +876,7 @@ void updateById(OptimizationUpdate update) {
         optimization = optimization.toBuilder().id(id)
                 .name(update.name() != null ? update.name() : optimization.name())
                 .status(update.status() != null ? update.status() : optimization.status())
+                .errorInfo(update.errorInfo() != null ? update.errorInfo() : optimization.errorInfo())
                 .build();
 
         var actualOptimization = optimizationResourceClient.get(id, API_KEY, TEST_WORKSPACE_NAME, 200);
@@ -886,7 +888,11 @@ private Stream<Arguments> updateById() {
         return Stream.of(
                 arguments(podamFactory.manufacturePojo(OptimizationUpdate.class)),
                 arguments(podamFactory.manufacturePojo(OptimizationUpdate.class).toBuilder().name(null).build()),
-                arguments(podamFactory.manufacturePojo(OptimizationUpdate.class).toBuilder().status(null).build()));
+                arguments(podamFactory.manufacturePojo(OptimizationUpdate.class).toBuilder().status(null).build()),
+                // errorInfo-only update: exercises the branch that persists a failure reason without
+                // name/status (previously short-circuited to Mono.empty() before this behavior was added)
+                arguments(podamFactory.manufacturePojo(OptimizationUpdate.class).toBuilder()
+                        .name(null).status(null).build()));
     }
 
     @Nested
@@ -1466,6 +1472,40 @@ void studioConfigPreservedAfterStatusUpdate() {
             assertThat(completedOptimization.studioConfig()).isEqualTo(studioConfig);
         }
 
+        @Test
+        @DisplayName("error_info is preserved when SDK re-upserts with a null errorInfo")
+        void errorInfoPreservedOnReUpsertWithNullErrorInfo() {
+            // Create a Studio optimization (upsert full-row replace path)
+            var studioConfig = createStudioConfig();
+            var optimization = optimizationResourceClient.createPartialOptimization()
+                    .studioConfig(studioConfig)
+                    .errorInfo(null)
+                    .build();
+            var id = optimizationResourceClient.create(optimization, API_KEY, TEST_WORKSPACE_NAME);
+
+            // Record a failure reason through the PATCH/update path (as the worker does)
+            var errorInfo = podamFactory.manufacturePojo(ErrorInfo.class);
+            optimizationResourceClient.update(id,
+                    OptimizationUpdate.builder().status(OptimizationStatus.CANCELLED).errorInfo(errorInfo).build(),
+                    API_KEY, TEST_WORKSPACE_NAME, 204);
+
+            var afterFailure = optimizationResourceClient.get(id, API_KEY, TEST_WORKSPACE_NAME, 200);
+            assertThat(afterFailure.errorInfo()).isEqualTo(errorInfo);
+
+            // Re-upsert the same optimization with a null errorInfo (SDK behavior): the persisted
+            // failure reason must survive the full-row replace instead of being clobbered to blank.
+            optimizationResourceClient.upsert(optimization.toBuilder().id(id).errorInfo(null).build(),
+                    API_KEY, TEST_WORKSPACE_NAME);
+
+            var afterReUpsert = optimizationResourceClient.get(id, API_KEY, TEST_WORKSPACE_NAME, 200);
+            // The re-upsert with a null errorInfo must not drop the persisted failure reason
+            // nor the sibling studioConfig (both preserved through the upsert path). Status
+            // ordering across the update/upsert rows is governed by last_updated_at, so it is
+            // not asserted here.
+            assertThat(afterReUpsert.errorInfo()).isEqualTo(errorInfo);
+            assertThat(afterReUpsert.studioConfig()).isEqualTo(studioConfig);
+        }
+
         @Test
         @DisplayName("Cancel Studio optimization returns NOT_IMPLEMENTED")
         void cancelStudioOptimization__returnsNotImplemented() {

apps/opik-frontend/src/constants/optimizations.ts

@@ -177,6 +177,11 @@ export const OPTIMIZATION_METRIC_OPTIONS = [
     description:
       "Compares numeric output against a reference value. Closer values score higher.",
   },
+  {
+    value: METRIC_TYPE.CODE,
+    label: "Custom code",
+    description: "Score outputs with a custom Python metric.",
+  },
 ];
 
 export type IconConfig = { icon: LucideIcon; color: string };