Add A Model For Timeline Elements #11011
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
First, renamed the `TimelineEvent` type used by timeline atoms to `TimelineAtomEvent` to avoid confusion. Then removed the now-unused `TimelineBlockElement` and replaced it with `FETimelineBlockElement`, to represent the new element coming from frontend, and `DCRTimelineBlockElement`, to represent the parsed/enhanced version in DCR. The DCR version is stricter than the one coming from frontend, enforcing the following rules: - Timeline events must have a date - Timeline sections must have a title - Timelines with one section should be flattened into a single list of events Finally, added an enhancer module for timelines to convert from the frontend type to the DCR one.
|
Hello 👋! When you're ready to run Chromatic, please apply the You will need to reapply the label each time you want to run Chromatic. |
|
Size Change: +371 B (0%) Total Size: 762 kB
ℹ️ View Unchanged
|
mxdvl
approved these changes
Mar 25, 2024
Comment on lines
+746
to
+747
| | FETimelineBlockElement | ||
| | DCRTimelineBlockElement |
There was a problem hiding this comment.
Can it really be either? Once an FETimelineBlockElement is enhanced, it will either result in nothing or a DCRTimelineBlockElement…
There was a problem hiding this comment.
No, it can't. There are several elements in this model that can only exist in DCR, and replace the frontend elements that they're enhanced from. We should really split it into two models: one for frontend data, and one for DCR data once it's been parsed/enhanced.
alinaboghiu
approved these changes
Mar 27, 2024
github-actions
bot
removed
the
run_chromatic
|
Seen on PROD (merged by @JamieB-gu 8 minutes and 47 seconds ago) Please check your changes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First, renamed the
TimelineEventtype used by timeline atoms toTimelineAtomEventto avoid confusion.Then removed the now-unused
TimelineBlockElementand replaced it withFETimelineBlockElement, to represent the new element coming from frontend, andDCRTimelineBlockElement, to represent the parsed/enhanced version in DCR. The DCR version is stricter than the one coming from frontend, enforcing the following rules:Finally, added an enhancer module for timelines to convert from the frontend type to the DCR one.
Part of #10869. See guardian/content-api-models#245 for the proposed CAPI model.