2052973 - [FxMS Infra] No shared, maintained catalog of screen content properties (Spotlight/Feature Callout)

Status: RESOLVED FIXED

(Firefox :: Messaging System, task, P1)

Description

[Mimi Jung]

Messaging System renders Spotlight and Feature Callout messages from a content.screens[] model that is shared with about:welcome onboarding. this screen model exposes a large/growing set of content properties, but there is currently no discoverable, authoritative catalog of what those properties are. The closest being feature-callout.md which is thorough but covers only the FC surface and is hand maintained (so it can drift and doesn't document the Spotlight/about:welcome split-screen properties like layout, split_content_justify_content, hide_secondary_section, reverse_split, ..)

• nimbus mega schema (MessagingExperiment.schema.json) validates messages against Spotlight.schema.json, but that schema declares screens as an untyped array ({ "type": "array" }) with additionalProperties: true, so no screen/tile property is documented or validated (which I believe is deliberate choice and not what this bug is proposing to change)
• There are no PropTypes on the screen renderer components in MultiStageProtonScreen.jsx, MultiStageAboutWelcome.jsx

As a result, the only practical sources of truth are the renderer JSX and copy pasting from existing messages. Because there is no index, naming is sometimes inconsistent (snake_case vs camelCase, like no_rdm vs no-rdm). I've found myself adding a new property that already existed and I was unaware of and I suspect this will get worse with the additional squad split, as more people author screens without shared context.

Opening this up for discussion/feedback, but some options:

• Add PropTypes to the screen renderer components, documenting each prop in place and surfacing dev-time warnings when messages use unknown or malformed properties. This is the more durable fix.
• Optionally maintain a non-enforcing "documentation" screen schema

Comment 1

[Sarah Chung [:sachung]]

Attachment: Bug 2052973 - add propTypes to screen renderer components

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/b3ec05da6ac3
https://hg.mozilla.org/integration/autoland/rev/1a7c49b80c01
add propTypes to screen renderer components r=mimi,omc-reviewers,yazan

Comment 3

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/1a7c49b80c01

Comment 4

[rperta]

https://hg.mozilla.org/mozilla-central/rev/1a7c49b80c01