Skip to content
This repository has been archived by the owner on Jan 29, 2025. It is now read-only.

Schema Change for adding publishedDate #259

Open
15 of 29 tasks
jeddai opened this issue Nov 21, 2023 · 1 comment
Open
15 of 29 tasks

Schema Change for adding publishedDate #259

jeddai opened this issue Nov 21, 2023 · 1 comment
Assignees

Comments

@jeddai
Copy link
Member

jeddai commented Nov 21, 2023

Proposing Schema Changes

  • Assign this issue to yourself
  • Add a comment below describing the changes at a high level, including all new/deprecated
    fields, their types, and their uses
    • Link to any related proposal documentation
  • Create a PR which introduces the schema changes and includes the following
  • Send an email to the Services RFCs Mailing List with a
    link to the PR requesting feedback
  • Receive feedback, update the PR as necessary, and commit it
  • Create a release including the new
    changes
  • File tickets/epics for all Nimbus clients to implement the changes
  • For deprecated fields, file a ticket in
    Nimbus Engineering
    to add a warning to the Nimbus UI that the field will be deprecated and provide guidance about
    how experiment/feature owners should migrate away from their dependence on the deprecated
    field

When Client Changes Are Complete

  • File tickets/epics for all Nimbus Clients for the new changes to be QAed by supplying the new
    sample data to the relevant (desktop/mobile) client(s) and verifying the intended behaviour

When Client QA is Complete

  • Add a comment below with a QA report that includes
    • Which version of each client application was tested
    • Link to any bugs which were detected in testing

When Bugs Are Resolved and Clients Are Released

  • Comment below indicating which version of each client application includes the changes

    • Hint: this is much easier to do by noting the last version of the client application that didn't
      have the change at the time of making the change
  • File tickets/epics in
    Nimbus Engineering
    to implement the changes in Experimenter and add them in a comment below, including:

    • Changes to relevant APIs
    • Changes to UI
    • Note for deprecated fields
      • First prevent the usage of deprecated fields in experiments targeting versions where those
        fields are no longer supported
      • Then make sure no currently active experiments still depend on them before removing them
        from UI/APIs
      • Leave the fields in the database so that historical data is preserved and the change can be
        easily reverted if necessary
  • File tickets/epics in Jetstream to adapt it
    to any incoming changes that affect its analysis

    • Note changing Jetstream and Experimenter may cause conflicts so try to coordinate both changes
      to go out as close together as possible

When Experimenter Changes Are Complete

  • You're done! Close this ticket.
@jeddai jeddai self-assigned this Nov 21, 2023
@jeddai
Copy link
Member Author

jeddai commented Nov 29, 2023

Change Field Type Description Uses
Add publishedDate date-time The date and time the recipe was first published to Remote Settings Required to order experiments by published date when enrolling

Epic

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant