Page MenuHomePhabricator

MPIC: Set form fields as read-only where appropriate when editing an instrument/experiments
Closed, ResolvedPublic1 Estimated Story Points

Description

Description

As per this Slack discussion and also based on the Editing active experiments documentation, we decided to prevent the edition of the parts of the configuration of experiments and instruments that shouldn't change during their lifetime. To prevent issues, we decided to set the following fields as read-only when users try to edit artifacts once they was activated for the first time (see T379355: MPIC: Register the fact that an instrument/experiment has been activated for the first time for related context):

  • Experiment form: Experiment name, feature variants, location, sample rate, sample unit.
  • Instrument form: Instrument name
  • Modification flow should be simplified by removing the "What would you like to do?" field from the form

In addition to that, through T373907: MPIC: Improve application copy some messages will be added to the UI to let users know when these fields will no longer be modifiable

Acceptance Criteria

  • The fields that define parts of the experiment or instrument configurations that shouldn't change throughout their lifetimes, should be displayed as read only when users try to edit their artifacts
  • A tooltip message is displayed on hover to indicate the reason why the specified fields cannot be edited (copy: "This field cannot be edited after the {artifact} is activated")
  • We remove the "What would you like to do?" field from the modification form

Event Timeline

Sfaci set the point value for this task to 1.Nov 8 2024, 12:17 PM
Sfaci updated the task description. (Show Details)
Sfaci renamed this task from MPIC: Set form fields as read-only where appropriate to MPIC: Set form fields as read-only where appropriate when editing an instrument/experiments.Nov 13 2024, 9:42 PM
Milimetric triaged this task as Medium priority.Nov 15 2024, 4:03 PM
Milimetric raised the priority of this task from Medium to High.
Milimetric moved this task from BACKLOG to MPIC Alpha Scope on the Test Kitchen board.

The related MR was already reviewed and merged: https://gitlab.wikimedia.org/repos/data-engineering/mpic/-/merge_requests/134

Now there is an active follow up MR to fix something related to the tooltips we set for variants fields: https://gitlab.wikimedia.org/repos/data-engineering/mpic/-/merge_requests/136

Change #1100502 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[operations/deployment-charts@master] Metrics Platform Instrument/Experiment Configurator: Deploying to staging

https://gerrit.wikimedia.org/r/1100502

Change #1100504 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[operations/deployment-charts@master] Metrics Platform Instrument/Experiment Configurator: Deploying to production

https://gerrit.wikimedia.org/r/1100504

Change #1100504 merged by jenkins-bot:

[operations/deployment-charts@master] Metrics Platform Instrument/Experiment Configurator: Deploying to production

https://gerrit.wikimedia.org/r/1100504

Change #1100502 merged by jenkins-bot:

[operations/deployment-charts@master] Metrics Platform Instrument/Experiment Configurator: Deploying to staging

https://gerrit.wikimedia.org/r/1100502