Move ArticleFormat Parsing Into DCAR
#10543
Closed
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
|
Size Change: 0 B Total Size: 767 kB ℹ️ View Unchanged
|
|
Hello 👋! When you're ready to run Chromatic, please apply the |
mxdvl
approved these changes
Feb 13, 2024
For now because |
abeddow91
approved these changes
Feb 14, 2024
|
❤️ |
This was referenced Feb 16, 2024
Moves as much of the parsing of `ArticleFormat` as possible into DCAR, so we no longer have to rely on the CAPI client to do this. The current logic duplicates exactly what the CAPI client does, so that we don't change too much at once. Improvements to the parsing logic can be made in a future change, once we've confirmed everything works as before. At the moment, there isn't enough of the CAPI data available from frontend to fully parse `ArticleFormat`. Three further pieces of information are needed: 1. Content type (`content.type` in CAPI) 2. Display hint (`content.fields.displayHint` in CAPI) 3. Whether a blog is currently live (`content.fields.liveBloggingNow` in CAPI) In cases where these items are missing, the parsing logic falls back to the frontend definition of `ArticleFormat`. Once they are made available, in a future change, these fallbacks can be removed. This change also renames `format.ts` to `articleFormat.ts`, to more closely resemble the name of the type.
JamieB-gu
force-pushed
the
move-format-parsing-into-dcar
branch
from
fcdbf24 to
54f4ae3
Compare
|
"This PR is stale because it has been open 30 days with no activity. Unless a comment is added or the “stale” label removed, this will be closed in 3 days" |
|
This PR was closed because it has been stalled for 3 days with no activity. |
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.
Moves as much of the parsing of
ArticleFormatas possible into DCAR, so we no longer have to rely on the CAPI client1 to do this. The current logic duplicates exactly what the CAPI client does2, so that we don't change too much at once. Improvements to the parsing logic can be made in a future change, once we've confirmed everything works as before.At the moment, there isn't enough of the CAPI data available from frontend3 to fully parse
ArticleFormat. Three further pieces of information are needed:content.typein CAPI)content.fields.displayHintin CAPI)content.fields.liveBloggingNowin CAPI)In cases where these items are missing, the parsing logic falls back to the frontend definition of
ArticleFormat. Once they are made available, in a future change, these fallbacks can be removed.This change also renames
format.tstoarticleFormat.ts, to more closely resemble the name of the type.Footnotes
https://github.com/guardian/content-api-scala-client ↩
https://github.com/guardian/content-api-scala-client/blob/ea995d3282281029b9eaedd1e3566aebe6ac7300/client/src/main/scala/com.gu.contentapi.client/utils/CapiModelEnrichment.scala#L94 ↩
https://github.com/guardian/dotcom-rendering/blob/89b180e31d73cc11d31e7562624bd46364e28f7b/dotcom-rendering/src/types/frontend.ts#L20 ↩