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

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

Details

Added support for updating experiment name & config.
Integrated the feature into the:
- Front-end
- Python SDK
- TypeScript SDK
Leveraging the existing Update Experiment backend endpoint.
- Fixed critical bug in this endpoint

experiment_update_demo.mov

Change checklist

User facing
Documentation update

Issues

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

Testing

Manually tested all FE changes locally.
Manually tested all SDKs Python and TypeScript locally.
Added test coverage for both SDKs.
Manually tested BE fix.
Added test coverage to BE fix.
Manually reviewed the new documentation.

Documentation

Documented both SDKs and FE new update experiment name and config functionality.

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

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

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

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

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

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

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!

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

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

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

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

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

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

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

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

andriidudar

Thank you very much for your contribution. I have provided a few comments regarding the frontend implementation for your consideration.

apps/opik-frontend/package.json

apps/opik-frontend/src/api/datasets/useExperimentUpdate.ts

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

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

cursor

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

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

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

apps/opik-frontend/src/api/datasets/useExperimentUpdate.ts

andrescrz · 2025-09-30T09:13:08Z

Hi @riturajFi

We've just added a new experiment update API endpoint which supports your use cases, see: #3263

You don't need to implement that part anymore. You can't simplify this PR and simply use it from the FE (Frontend) and SDK changes.

Feel free to rebase the latest changes from main branch, resolve the conflicts and resume this implementation.

Let me know if any question.
Regards,
Andrés

vincentkoc · 2025-10-30T03:17:34Z

@riturajFi are you still interested in working on this issue?

riturajFi · 2025-10-30T03:30:34Z

Hi @vincentkoc , i think it was solv3d already??

andrescrz · 2025-10-31T09:35:50Z

Hi @riturajFi,

Thank you for your interest in this issue! It’s still open, and we’d be delighted if community contributors like you would like to work on it.

The good news is that the backend endpoint has already been implemented. This means you can focus solely on the frontend changes. Please remember to rebase your branch onto the latest main and resolve any conflicts that may arise.

If you’re interested in resuming work on this, please let us know—we’d love to see your contribution!

Best regards

vincentkoc · 2025-11-10T02:09:19Z

@riturajFi let me know if you are still open to working on this issue?

andrescrz · 2025-11-19T16:57:27Z

Hi @riturajFi,

Thank you for all your work on this PR! I’ll be taking it over from here, including resolving any merge conflicts and addressing the outstanding comments to move it toward completion.

No further action is needed from your end.
Really appreciate your contribution!

Copilot

Pull Request Overview

Copilot reviewed 10 out of 12 changed files in this pull request and generated 3 comments.

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

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

…ve null guard, add TS SDK validation

…ove invalidation to onSuccess, simplify parsing

…uccess and simplified parsing fixes

…experiment

…essary return

…nge while dialog is open

- Both Python and TypeScript SDKs now conditionally include only the parameters that are provided - Python SDK uses OMIT sentinel value to exclude unprovided fields - TypeScript SDK builds payload object dynamically - This prevents clearing name when only updating config, and vice versa - Added comprehensive test coverage for all three scenarios: name-only, config-only, and both

- Add ORDER BY last_updated_at DESC LIMIT 1 to ensure the query selects the most recent row - Prevents bug where partial updates could select old historical rows and overwrite current values with ancient data - Add regression test for multiple partial updates to verify latest values are preserved

- Replace hardcoded strings with RandomStringUtils.secure().nextAlphanumeric() - Replace hardcoded JSON metadata with podamFactory.manufacturePojo(JsonNode.class) - Aligns with existing test patterns in ExperimentsResourceTest - Improves test robustness by using unique random values each run

…l/opik into vk/optimizer-bm25-hotpot * 'vk/optimizer-bm25-hotpot' of https://github.com/comet-ml/opik: [NA] [BE] Performant ClickHouse bulk update queries to ensure latest row selection (#4206) [issue-1239] [DOCS] Improve console logging level documentation (#4201) [OPIK-3110] [BE/FE] Add threshold support for trace and thread feedback score alerts (#4168) [NA] [DOCS] Fix Update experiment docs (#4199) [issue-2572] [FE] Update experiment name metadata in UI (#3136) Bump opentelmetry.version from 2.21.0 to 2.22.0 in /apps/opik-backend (#4194) [NA][SDK] Optimizer Benchmarks Modal Timeout (#4197) Bump org.apache.maven.plugins:maven-jar-plugin in /apps/opik-backend (#4190) [OPIK-3116][FE] user friendly error message for duplicate dataset name (#4188) [NA][BE] Cursor rules update for BE java code (#4155) Bump software.amazon.awssdk:bom in /apps/opik-backend (#4192) Bump com.diffplug.spotless:spotless-maven-plugin in /apps/opik-backend (#4193) [NA] [BE] Update model prices file (#4189)

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

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

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

Closed

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

andriidudar requested changes Sep 12, 2025

View reviewed changes

cursor bot reviewed Sep 15, 2025

View reviewed changes

sdks/typescript/src/opik/rest_api/api/resources/experiments/client/Client.ts Outdated Show resolved Hide resolved

sdks/typescript/tests/experiment/client-experiment.test.ts Show resolved Hide resolved

apps/opik-frontend/src/api/datasets/useExperimentUpdate.ts Outdated Show resolved Hide resolved

andrescrz added the Pending user response label Oct 9, 2025

andrescrz force-pushed the feature/update-experiment-name-metadata branch from 0c1fb3d to 3014e8d Compare November 19, 2025 16:56

andrescrz force-pushed the feature/update-experiment-name-metadata branch 4 times, most recently from 7231dfc to 21e416c Compare November 20, 2025 12:12

andrescrz requested a review from a team as a code owner November 20, 2025 12:12

andrescrz requested a review from Copilot November 20, 2025 12:22

Copilot AI reviewed Nov 20, 2025

View reviewed changes

andrescrz force-pushed the feature/update-experiment-name-metadata branch from b4832c9 to a6a6f41 Compare November 20, 2025 13:55

andrescrz requested a review from Copilot November 20, 2025 13:56

andrescrz added 13 commits November 21, 2025 16:49

Revision 14: configuration validation

3ffadc9

Revision 17: Address Copilot review - fix useEffect deps, add defensi…

32c39af

…ve null guard, add TS SDK validation

Revision 19: Address Copilot review - update state on prop changes, m…

aa2ec4e

…ove invalidation to onSuccess, simplify parsing

Revision 20: Revert dialog state initialization change, keep only onS…

e1f73f3

…uccess and simplified parsing fixes

Revision 22: Add Python SDK parameter validation and test for update_…

7d8b851

…experiment

Revision 23: Complete JSDoc for TypeScript SDK updateExperiment method

0732e4c

Revision 24: Clear validation errors on dialog reset and remove unnec…

58bd7c1

…essary return

Revision 25: Fix useEffect deps to prevent state reset when props cha…

a196684

…nge while dialog is open

Updated docs images

6d92478

Updated TS signature

4e028d0

andrescrz force-pushed the feature/update-experiment-name-metadata branch from d319408 to 68445fc Compare November 21, 2025 15:51

andrescrz assigned andrescrz and riturajFi Nov 21, 2025

andrescrz approved these changes Nov 24, 2025

View reviewed changes

andrescrz merged commit d52b4ac into comet-ml:main Nov 24, 2025
58 of 146 checks passed

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

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

Uh oh!

Conversation

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

Uh oh!

Details

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riturajFi commented Sep 2, 2025

Uh oh!

andriidudar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

This PR is being reviewed by Cursor Bugbot

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrescrz commented Sep 30, 2025 • edited by vincentkoc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vincentkoc commented Oct 30, 2025

Uh oh!

riturajFi commented Oct 30, 2025

Uh oh!

andrescrz commented Oct 31, 2025

Uh oh!

vincentkoc commented Nov 10, 2025

Uh oh!

andrescrz commented Nov 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riturajFi commented Aug 29, 2025 •

edited by andrescrz

Loading

andrescrz left a comment •

edited

Loading

andrescrz commented Sep 30, 2025 •

edited by vincentkoc

Loading