Page MenuHomePhabricator

[MPIC] Creating an instrument with underscore name returns on data on UI
Closed, ResolvedPublic3 Estimated Story PointsBUG REPORT

Description

Steps to replicate the issue (include links if applicable):

  • Create an instrument with an underscore name as below ( Launch new instrument):
  • Instrument name : to_be_modified
  • Description: this instrument is created to be modifiedfor test purposes
  • Schema type: App based
  • Phabricator Ticket: https://phabricator.wikimedia.org/T000111
  • Team : Growth Team
  • Contact Email: content.email@mpic.com
  • Purpose: SDS 1.1
  • Specification Type: Baseline
  • Contextual Attribute: agent_client_platform_family
  • Default sample rate: 0.5
  • Location : cdowiki
  • Location sample rate : 0.5
  • Sample unite: Pageview
  • Duration amount: 2
  • Duration time: Weeks
  • From Date: 10/31/2024
  • Security and legal
  • Check the checkbox and launch instrument.
  • Click the instrument

What happens?:
The instrument launches but the data does not display on the UI. The data is available in the backend.

What should have happened instead?:
Data should be available both on the UI and backend

Software version (on Special:Version page; skip for WMF-hosted wikis like Wikipedia):
MPIC Frontend

Screenshot 2024-09-19 at 11.02.36 AM.png (1,392×842 px, 75 KB)

Screenshot 2024-09-19 at 11.04.25 AM.png (1,090×826 px, 151 KB)

Event Timeline

It seems slug validator is much stricter than the function we use to generate the slug for instruments. At this time "spaces" are the only restriction we have to build the slug and all special characters are included while the user types the human readable one, but validator doesn't allow punctuation marks (? ! , . . . .). Should they be allowed? Should we be more restrictive and remove punctuation marks when building the slug?

Sfaci removed Sfaci as the assignee of this task.Oct 10 2024, 6:01 PM

It seems slug validator is much stricter than the function we use to generate the slug for instruments. At this time "spaces" are the only restriction we have to build the slug and all special characters are included while the user types the human readable one, but validator doesn't allow punctuation marks (? ! , . . . .). Should they be allowed? Should we be more restrictive and remove punctuation marks when building the slug?

I'm inclined to be more restrictive and remove punctuation when building the slug to match the validator - is this a product/design decision or can we just err on the side of doing it?

cc @VirginiaPoundstone @Sarai-WMF @Sfaci

@cjming Fully agree! I think that punctuation marks don't provide any value here so we could disallow them easily. I would say we only need dashes to represent "spaces"

cc @SGupta-WMF

Milimetric set the point value for this task to 3.Oct 16 2024, 10:37 PM

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

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

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

Change #1082230 merged by jenkins-bot:

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

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

Change #1082234 merged by jenkins-bot:

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

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