Remove atom-renderer #27021

ioannakok · 2024-04-04T12:07:14Z

Closes #26997

What does this change?

It removes the deprecated atom-renderer

What is the value of this and can you measure success?

Unblocks the Play 3 upgrade:

Switch to Play 3 and go all in Pekko #26755

Removes deprecated code

Impact

1. Articles rendered by frontend will no longer render audio, chart, explainer, guide, Q & A, quiz and timeline atoms. Only interactive and media atoms will be rendered

This has a very low impact on users. Over the past 2 weeks we've can't see any articles published after 2017 rendered by frontend in Kibana (unless the user requests for ?dcr=false).

The reason why the majority of these old articles are still rendered by frontend is because they are old liveblogs. Here's what happens if we filter those out.

This issue will be resolved in:

Some old liveblogs are still served by frontend (amp and regular) #25309

2. `embed/atom` endpoint will stop rendering audio atoms

It looks like only the Google Bot is hitting the endpoint embed/atom/audio

3. Editions and AMP still request some atoms by hitting `embed/atom`. What about those?

Editions and AMP hit embed/atom endpoint to request:

media atoms (editions)
interactive and chart atoms (AMP)

This change won't have any impact to the above requests because these atoms are already rendered by client-side code that lives in frontend and atom-renderer code is not used.

frontend/applications/app/controllers/AtomPageController.scala

Lines 136 to 145 in c354525

    
           case Right(atom: ChartAtom) => 
        
             renderAtom(ChartAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar)) 
        
           case Right(atom: GuideAtom) => 
        
             renderAtom(GuideAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar)) 
        
           case Right(atom: InteractiveAtom) => 
        
             renderAtom( 
        
               InteractiveAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar), 
        
             ) 
        
           case Right(atom: MediaAtom) => 
        
             renderAtom(MediaAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar))

frontend/applications/app/controllers/AtomPageController.scala

Lines 196 to 197 in c354525

    
           private def renderAtom(page: AtomPage)(implicit request: RequestHeader): Result = { 
        
             Cached(600)(RevalidatableResult.Ok(views.html.atomEmbed(page)))

frontend/applications/app/views/atomEmbed.scala.html

Lines 30 to 33 in c354525

    
           <body> 
        
               @page.body 
        
               @fragments.atomPageFoot(page) 
        
           </body>

Twirl templates for:

4. How do we know Editions only requests media and AMP only requests chart and interactive atoms?

Editions

Only for media atoms Editions request the image from the poster image url. No other reference to any other type of atom exists in the editions repo.

Tested in CODE

Media

AMP

Tested in CODE

Chart
Interactive

Also, using https://atomworkshop.gutools.co.uk/ I found articles with different types of atoms, requested them and verified via Kibana that nothing hits embed/atom endpoint to request those atoms.

github-actions · 2024-04-04T12:33:47Z

Deploy build 1506 of `dotcom:frontend-all` to CODE

All deployment options

From guardian/actions-riff-raff.

applications/app/controllers/AtomPageController.scala

It is not used anywhere

prout-bot · 2024-04-09T09:59:34Z

Seen on FRONTS-PROD, ADMIN-PROD (merged by @ioannakok 26 minutes and 13 seconds ago)

Check your changes on www.theguardian.com ✔️
Keep an eye on the deploy dashboard 📉

ioannakok force-pushed the remove-atom-renderer-lib branch 2 times, most recently from 2293a2f to 21468ee Compare April 4, 2024 12:23

Remove atom-renderer

3975cc5

ioannakok force-pushed the remove-atom-renderer-lib branch from 21468ee to 3975cc5 Compare April 8, 2024 14:20

ioannakok marked this pull request as ready for review April 8, 2024 14:53

ioannakok requested a review from a team as a code owner April 8, 2024 14:53

ioannakok mentioned this pull request Apr 8, 2024

Stop supporting some atoms on AMP guardian/dotcom-rendering#11045

Closed

mxdvl reviewed Apr 8, 2024

View reviewed changes

applications/app/controllers/AtomPageController.scala Show resolved Hide resolved

Delete audio.scala.html

573c59a

It is not used anywhere

mxdvl approved these changes Apr 8, 2024

View reviewed changes

ioannakok merged commit d704aef into main Apr 9, 2024

ioannakok deleted the remove-atom-renderer-lib branch April 9, 2024 09:33

prout-bot added Pending-on-ADMIN-PROD Pending-on-FRONTS-PROD Seen-on-ADMIN-PROD Seen-on-FRONTS-PROD and removed Pending-on-ADMIN-PROD Pending-on-FRONTS-PROD labels Apr 9, 2024

ioannakok mentioned this pull request Apr 9, 2024

Switch to Play 3 and go all in Pekko #26755

Merged

1 task

ioannakok added the Play 3 label Apr 9, 2024

ioannakok mentioned this pull request Apr 10, 2024

Move audio atom client side code #27001

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove atom-renderer #27021

Remove atom-renderer #27021

Uh oh!

ioannakok commented Apr 4, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Apr 4, 2024 •

edited

Loading

Uh oh!

Uh oh!

prout-bot commented Apr 9, 2024

Uh oh!

Uh oh!

	case Right(atom: ChartAtom) =>
	renderAtom(ChartAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar))
	case Right(atom: GuideAtom) =>
	renderAtom(GuideAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar))
	case Right(atom: InteractiveAtom) =>
	renderAtom(
	InteractiveAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar),
	)
	case Right(atom: MediaAtom) =>
	renderAtom(MediaAtomPage(atom, withJavaScript = isJsEnabled, withVerticalScrollbar = hasVerticalScrollbar))

	private def renderAtom(page: AtomPage)(implicit request: RequestHeader): Result = {
	Cached(600)(RevalidatableResult.Ok(views.html.atomEmbed(page)))

Remove atom-renderer #27021

Remove atom-renderer #27021

Uh oh!

Conversation

ioannakok commented Apr 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this change?

What is the value of this and can you measure success?

Impact

1. Articles rendered by frontend will no longer render audio, chart, explainer, guide, Q & A, quiz and timeline atoms. Only interactive and media atoms will be rendered

2. embed/atom endpoint will stop rendering audio atoms

3. Editions and AMP still request some atoms by hitting embed/atom. What about those?

4. How do we know Editions only requests media and AMP only requests chart and interactive atoms?

Editions

AMP

Uh oh!

github-actions bot commented Apr 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploy build 1506 of dotcom:frontend-all to CODE

Uh oh!

Uh oh!

prout-bot commented Apr 9, 2024

Uh oh!

Uh oh!

ioannakok commented Apr 4, 2024 •

edited

Loading

2. `embed/atom` endpoint will stop rendering audio atoms

3. Editions and AMP still request some atoms by hitting `embed/atom`. What about those?

github-actions bot commented Apr 4, 2024 •

edited

Loading

Deploy build 1506 of `dotcom:frontend-all` to CODE