Page MenuHomePhabricator

Set a default Instrument End date
Closed, ResolvedPublic

Description

Problem

In T392898: xLab: Add validation to the Duration field, we defined that the fields Start date and End date should both be required, and should be validated as such on submit when configuring experiments and instruments.

Following the principles of data minimization we should not collect data indefinitely.

Requiring an end date for an instrument reminds data collectors about this key principle. However, we want to reduce uncertainty and provide recommendations where possible, and make clear the implications of this end date.

Solution

Default the instrument's end date to the start of the next Fiscal Year.
(Why? Most data collection initiatives are linked to objectives and key results as part of our APP. Having a single date to review data collection activity end date means users will be able to plan that review and make the decision on a clear cadence, rather than having to set reminders.)

Acceptance criteria
  • End date field defaults to July 1 of the next fiscal year: if on or after July 1, add two years; if before July 1, add one year Examples:
  • If I create an instrument on May 4 2026, the data collection should default to end July 1 2027.
  • If I create an instrument on July 2 2026, the data collection should default to end July 1 2028
  • Users can set a different end date if they so choose
  • Add copy to TKUI: Defaults to the end of the next complete fiscal year. Set a shorter date if your data collection should conclude sooner.
  • End date (utc_end_dt column) should remain mandatory in the database (defined as NOT NULL)

Details

Related Changes in Gerrit:
Related Changes in GitLab:
TitleReferenceAuthorSource BranchDest Branch
Set a default Instrument End daterepos/data-engineering/test-kitchen!315kengkongT397016-instrument-end-date-should-be-optionalmain
Customize query in GitLab

Event Timeline

Sarai-WMF renamed this task from xLab: Instrument end date shouldn't be required to xLab: Instruments' End date should be optional.Jun 16 2025, 10:52 AM
Milimetric moved this task from Incoming to READY TO GROOM on the Test Kitchen board.
Milimetric subscribed.

How our instruments work might change. If they don't, this should probably be a medium. But it's good to think about either way.

mpopov renamed this task from xLab: Instruments' End date should be optional to Instruments' End date should be optional.Feb 10 2026, 3:35 PM
phuedx added subscribers: JVanderhoop-WMF, phuedx.

Pending a decision from @JVanderhoop-WMF as to whether instrument end dates should be optional.

JVanderhoop-WMF renamed this task from Instruments' End date should be optional to Set a default Instrument End date.May 4 2026, 3:35 PM
JVanderhoop-WMF updated the task description. (Show Details)

I've updated the task description to reflect discussion amongst the team.

End dates are important to ensure we follow our principles of minimizing data collection. We do recognize that many folks have reached out about "what's an appropriate end date" as well as "I forgot that my end date was set, and data collection stopped unexpectedly".

As such, we will provide a default value, anchored to our fiscal year. By linking end dates to the APP/OKR cadence, teams will be able to review all instrument end dates at once and be in a planning mindset. This also forces one annual review, rather than many reviews on various cadences, and out of context. This is a consistent, predictable event rather than staggered expiry dates that become really hard to manage and audit.

@JVanderhoop-WMF. Okay thanks. The new changes have been understood. This may require 2-3 weeks.

hi @JVanderhoop-WMF . I am almost done the task. I just had a question about " Add copy to TKUI: " under the acceptance criteria. Is there something seperate that needs to be done for that? Thanks

question about " Add copy to TKUI: " under the acceptance criteria. Is there something seperate that needs to be done for that?

hi @Kengkong1 ! this copy ("Defaults to the end of the next complete fiscal year. Set a shorter date if your data collection should conclude sooner.") can be added to the relevant component (Duration.vue) - feel free to ping us on the MR and we can advise/review - i would probably add it to the <template #description> tag

tysm for contributing 🙌

Hi @cjming!. Thanks for the clarification. Ive pushed the changes to my fork and its ready for review. Thanks!!

Change #1290803 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[operations/deployment-charts@master] Test Kitchen UI: Deploy v1.3.5 release to production

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

Change #1290803 merged by jenkins-bot:

[operations/deployment-charts@master] Test Kitchen UI: Deploy v1.3.5 release to staging

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

Change #1290916 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[operations/deployment-charts@master] test-kitchen chart: Updated to support growthbook specific configuration

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

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

[operations/deployment-charts@master] Test Kitchen UI: Deploy v1.3.6 release to production

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

Change #1290932 merged by jenkins-bot:

[operations/deployment-charts@master] Test Kitchen UI: Deploy v1.3.6 release to production

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