[issue-2572] [FE] Update experiment name metadata in UI #3136

riturajFi · 2025-08-29T06:24:26Z

Details

Summary

Introduced a new API for updating an experiment’s name and metadata.

Changes

Added API support for updating experiment details (name & metadata).
Integrated the feature into the front-end.
Extended the Python SDK to support updates.
Extended the TypeScript SDK to support updates.

Screencast.from.2025-09-01.20-23-22.webm

Change checklist

User facing
Documentation update

Issues

Resolves [FR]: Add support for updating experiments #2572
OPIK-

Testing

Documentation

…hub.com/riturajFi/opik into feature/update-experiment-name-metadata

riturajFi · 2025-09-02T03:24:27Z

Hi @yaricom @Lothiraldan @dsblank @vincentkoc , would like this PR to be reviewd

vincentkoc · 2025-09-02T03:49:38Z

@riturajFi can you please address the linter and test failures please before team can review. Thanks for your contribution.

Copilot

Pull Request Overview

This PR introduces functionality to update experiment names and metadata across all Opik applications. The feature enables users to modify existing experiments through API endpoints, frontend UI, and SDK methods.

Key changes:

Added API endpoint for updating experiment name and metadata with validation and change detection
Created interactive frontend dialog with Monaco editor for JSON metadata editing
Extended both Python and TypeScript SDKs with update methods

Reviewed Changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/ExperimentsResource.java`	REST endpoint for experiment updates with change detection
`apps/opik-backend/src/main/java/com/comet/opik/domain/ExperimentService.java`	Business logic for planning and applying experiment updates
`apps/opik-backend/src/main/java/com/comet/opik/domain/ExperimentDAO.java`	Database operations for updating experiment name and metadata
`apps/opik-frontend/src/components/shared/UpdateExperimentDialog/UpdateExperimentDialog.tsx`	React dialog component with Monaco editor for experiment editing
`apps/opik-frontend/src/api/datasets/useExperimentUpdate.ts`	Frontend mutation hook for experiment updates
`sdks/python/src/opik/api_objects/opik_client.py`	Python SDK method for updating experiments
`sdks/typescript/src/opik/client/Client.ts`	TypeScript SDK method for updating experiments
`sdks/typescript/tests/experiment/client-experiment.test.ts`	Unit and integration tests for TypeScript SDK

Files not reviewed (1)

apps/opik-frontend/package-lock.json: Language not supported

Copilot · 2025-09-02T03:50:23Z

sdks/typescript/tests/experiment/client-experiment.test.ts

+      datasetName: "test-dataset",
+    });
+
+    console.log(JSON.stringify(created))


Debug console.log statement should be removed from test code. Use proper test logging or assertions instead.

Suggested change

console.log(JSON.stringify(created))

Copilot · 2025-09-02T03:50:23Z

apps/opik-frontend/src/components/shared/UpdateExperimentDialog/UpdateExperimentDialog.tsx

+              try {
+                parsedMetadata = metadata ? JSON.parse(metadata) : {};
+              } catch (e) {
+                alert("Invalid JSON in metadata");


Using browser alert() for error messages is not consistent with the application's UI patterns. Use the toast notification system instead, similar to other components in the codebase.

Copilot · 2025-09-02T03:50:24Z

apps/opik-frontend/src/components/shared/UpdateExperimentDialog/UpdateExperimentDialog.tsx

+export function UpdateExperimentDialog({
+  open,
+  setOpen,
+  onConfirm,
+  latestName,
+  latestMetadata
+}) {


Function parameters lack TypeScript type definitions. Define an interface for the props to ensure type safety and better developer experience.

Suggested change

export function UpdateExperimentDialog({

open,

setOpen,

onConfirm,

latestName,

latestMetadata

}) {

interface UpdateExperimentDialogProps {

open: boolean;

setOpen: (open: boolean) => void;

onConfirm: () => void;

latestName: string;

latestMetadata: any;

}

export function UpdateExperimentDialog({

open,

setOpen,

onConfirm,

latestName,

latestMetadata

}: UpdateExperimentDialogProps) {

Copilot · 2025-09-02T03:50:24Z

sdks/python/src/opik/rest_api/experiments/client.py

+        -------------------
+        id:  str
+        newName: Optional[str]
+        newMetadata: Optional[str]


The docstring parameter type annotation is incorrect. newMetadata should be Optional[Dict[str, Any]] not Optional[str] to match the actual parameter type.

Suggested change

newMetadata: Optional[str]

newMetadata: Optional[Dict[str, Any]]

Copilot · 2025-09-02T03:50:24Z

apps/opik-frontend/src/components/pages/ExperimentsPage/ExperimentRowActionsCell.tsx

@@ -43,9 +53,17 @@ const ExperimentRowActionsCell: React.FunctionComponent<
        onConfirm={deleteExperimentsHandler}
        title="Delete experiment"
        description="Deleting an experiment will remove all samples in the experiment. Related traces won’t be affected. This action can’t be undone. Are you sure you want to continue?"
-        confirmText="Delete experiment"
+        confirmText="Delete experiments"


The confirm text should be "Delete experiment" (singular) since the action deletes only one experiment, not multiple experiments.

Suggested change

confirmText="Delete experiments"

confirmText="Delete experiment"

Copilot · 2025-09-02T03:50:24Z

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

+            ObjectMapper mapper = new ObjectMapper();
+            JsonNode meta;
+
+            try {
+                meta = mapper.readTree(plan.targetMetadata());
+            } catch (JsonProcessingException e) {
+                log.error("Invalid metadata JSON stored for experiment {}: {}", id, plan.targetMetadata(), e);
+                meta = mapper.createObjectNode().put("raw", plan.targetMetadata());
+            }


Inconsistent indentation after the blocking call. The ObjectMapper instantiation should be aligned with the surrounding code block.

Suggested change

ObjectMapper mapper = new ObjectMapper();

JsonNode meta;

try {

meta = mapper.readTree(plan.targetMetadata());

} catch (JsonProcessingException e) {

log.error("Invalid metadata JSON stored for experiment {}: {}", id, plan.targetMetadata(), e);

meta = mapper.createObjectNode().put("raw", plan.targetMetadata());

}

ObjectMapper mapper = new ObjectMapper();

JsonNode meta;

try {

meta = mapper.readTree(plan.targetMetadata());

} catch (JsonProcessingException e) {

log.error("Invalid metadata JSON stored for experiment {}: {}", id, plan.targetMetadata(), e);

meta = mapper.createObjectNode().put("raw", plan.targetMetadata());

}

andrescrz

Hi @riturajFi

Thanks a lot for your contribution.

I left a review on the backend part, with the general guidelines to follow in this service.

The main question here is how to handle the ClickHouse updates, which isn't straight forward and probably one of the reasons why we haven't implemented this ourselves yet.

I'll discuss and double check the approach with the team for that, but for now, the best option is to handle the update with a INSERT + SELECT query (see examples in this DAO already) and document that the endpoint is only meant for the UI and doesn't handle concurrent scenarios for the SDK (already the case).

Other members of the team will review the FE and SDK parts. In the meantime, please remove changes on the auto-generated code.

Thank you very much for all this work!

andrescrz · 2025-09-02T08:05:10Z

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

+    private static final String UPDATE_BY_ID = """
+            ALTER TABLE experiments
+            UPDATE
+                name = :name,
+                metadata = :metadata,
+                last_updated_by = :last_updated_by
+            WHERE id = :id
+            AND workspace_id = :workspace_id
+            ;
+            """;


Per architectural reasons, we don't do mutations in ClickHouse, as they're not performant:

https://clickhouse.com/docs/guides/developer/mutations

Regarding entities stored in CH, only spans and traces are PATCHED. The approach is to query and re-insert only the data that changes, in this case it'd be name and metadata. In this approach is tricky to keep data consistency for concurrent SDK flows. But maybe is reasonable to just document that this endpoint is for UI purposes only.

Another alternative is lightweight updates:

https://clickhouse.com/docs/sql-reference/statements/update

But considering that is a Beta feature, has some performance implications, and it'd have the same concurrency issues, I'd go with the previous approach.

andrescrz · 2025-09-02T08:07:50Z

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

@@ -484,4 +488,59 @@ public Response findFeedbackScoreNames(@QueryParam("experiment_ids") String expe

        return Response.ok(feedbackScoreNames).build();
    }
+
+    @POST


This should be a PATCH operation.

andrescrz · 2025-09-02T08:08:17Z

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

You need tests for this new endpoint. Please follow the conventions in the code base.

andrescrz · 2025-09-02T08:09:05Z

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

@@ -484,4 +488,59 @@ public Response findFeedbackScoreNames(@QueryParam("experiment_ids") String expe

        return Response.ok(feedbackScoreNames).build();
    }
+
+    @POST
+    @Path("/update/{id}")


After updating to PATCH, the verb should be removed from the path. It isn't a good REST practice.

andrescrz · 2025-09-02T08:10:29Z

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

+
+    @POST
+    @Path("/update/{id}")
+    public Response updateExperimentById(


Minor: let's rename the method to update.

andrescrz · 2025-09-02T08:30:41Z

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

@@ -0,0 +1,13 @@
+package com.comet.opik.domain;


Move to package com.comet.opik.api;

andrescrz · 2025-09-02T08:30:50Z

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

+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)


Add @Builder(toBuilder = true).

andrescrz · 2025-09-02T08:31:40Z

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

+
+import io.reactivex.rxjava3.annotations.Nullable;
+
+public record ExperimentUpdatePlan(


This won't be needed.

andrescrz · 2025-09-02T08:36:45Z

sdks/python/src/opik/rest_api/experiments/client.py

We have an automation for everything under sdks/python/src/opik/rest_api/ folder, please remove these changes. They'll be auto-generated.

andrescrz · 2025-09-02T08:37:27Z

sdks/typescript/src/opik/rest_api/api/resources/experiments/client/Client.ts

Same for the typescript SDK, we have an automation for everything under rest_api folder, please remove these changes. They'll be auto-generated.

riturajFi · 2025-09-02T14:04:45Z

Great insights @andrescrz ! Will do the changes right away!

riturajFi added 22 commits August 21, 2025 09:29

feat:implemented update api

a82f21f

feat: Frontend implementation of update experiment

1f3fb6e

feat: implemented in the Python SDK

dbeab95

feat: integrated update experiment feature in ts sdk

ccdd777

feat: return the latest state of the updated expt

b6c669d

fix: frontend metadata fix

b1a5cca

minor fix

a1c38c3

minor fixes

0670414

minor change

6aa3a35

fix import

fc753eb

fix: minor

65009ff

feat:implemented update api

33893bb

feat: Frontend implementation of update experiment

0a9e6f9

feat: implemented in the Python SDK

69f3741

feat: integrated update experiment feature in ts sdk

e33b0c7

feat: return the latest state of the updated expt

cf43cf5

fix: frontend metadata fix

39a1589

minor fix

f42ff6e

minor fixes

a4e7862

minor change

f216bb5

fix import

1bed0df

fix: minor

b65ebef

riturajFi requested a review from a team as a code owner August 29, 2025 06:24

Merge branch 'feature/update-experiment-name-metadata' of https://git…

e13aede

…hub.com/riturajFi/opik into feature/update-experiment-name-metadata

riturajFi marked this pull request as draft August 29, 2025 06:29

riturajFi added 5 commits September 1, 2025 18:59

Merge branch 'main' into feature/update-experiment-name-metadata

151bbd1

better json editor for metadata

1d89fe4

add the monaco package

acb6377

Merge branch 'feature/update-experiment-name-metadata' of https://git…

ae89d96

…hub.com/riturajFi/opik into feature/update-experiment-name-metadata

Merge branch 'main' into feature/update-experiment-name-metadata

72096cf

Merge branch 'main' into feature/update-experiment-name-metadata

a72c317

riturajFi marked this pull request as ready for review September 1, 2025 17:19

riturajFi mentioned this pull request Sep 1, 2025

[FR]: Add support for updating experiments #2572

Open

vincentkoc requested a review from Copilot September 2, 2025 03:49

vincentkoc changed the title ~~Feature/update experiment name metadata~~ [issue-2572] [FE] Update experiment name metadata in UI Sep 2, 2025

Copilot AI reviewed Sep 2, 2025

View reviewed changes

andrescrz reviewed Sep 2, 2025

View reviewed changes

	newMetadata: Optional[str]
	newMetadata: Optional[Dict[str, Any]]

	confirmText="Delete experiments"
	confirmText="Delete experiment"


		import io.reactivex.rxjava3.annotations.Nullable;

		public record ExperimentUpdatePlan(

[issue-2572] [FE] Update experiment name metadata in UI #3136

Are you sure you want to change the base?

[issue-2572] [FE] Update experiment name metadata in UI #3136

Uh oh!

Conversation

riturajFi commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Summary

Changes

Change checklist

Issues

Testing

Documentation

Uh oh!

riturajFi commented Sep 2, 2025

Uh oh!

vincentkoc commented Sep 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

andrescrz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

riturajFi commented Sep 2, 2025

Uh oh!

Uh oh!

riturajFi commented Aug 29, 2025 •

edited

Loading

andrescrz left a comment •

edited

Loading