Skip to content

Latest commit

 

History

History
160 lines (101 loc) · 9.9 KB

README.md

File metadata and controls

160 lines (101 loc) · 9.9 KB
Raw

Facia Tool

The Guardian front pages editor, known as the Fronts tool.

For information on core Fronts concepts, see the glossary.

Fronts Client

You can find the client for the Fronts tool in fronts-client.

Setup (need to be done once)

  1. Install NVM.
  2. Ensure Docker is installed
  3. Get credentials from Janus (cmsFronts, capi & frontend).
  4. Grant code permissions (used for local builds as well). Any engineer on ed tools should be able to give you access. You need:
    1. fronts_access
    2. launch_commercial_fronts
    3. edit_editorial_fronts
    4. edit_editions
    5. launch_editorial_fronts
    6. configure_fronts
  5. From the project root, run ./scripts/setup.sh.

Dev Start

  1. Run Docker locally
  2. To run the application:
    • From the project root, run ./scripts/dev-start.sh
    • From the project root, run without debug ./scripts/dev-start.sh --no-debug
  3. Open https://fronts.local.dev-gutools.co.uk.

Unit tests

  • Running server side tests: sbt test

Client side tests for V1

Client side tests for V2

Run yarn test in fronts-client folder. See fronts-client for more details.

IT tests with Database

sbt test database-int:test

Pressing fronts

  • Before fronts can appear on site, they have to be pressed by Facia-Press which lives on the frontend account.

  • The fronts tool sends events to an SNS topic, which is subscribed to by a queue (in frontend account) to which Facia-Press listens. You can read more about Facia-Press here.

  • If you are adding a new kind of content to a front or changing the front configuration, you should check that the front can still be pressed.

  • To check this, check that a piece of content still appears on frontend. Edit the articles appearing on a front, launch the front and check that your changes are appearing here: http://m.code.dev-theguardian.com/{name-of-front}

  • If the front that you are trying to view cannot be found, it is probably because the front is hidden.

  • You can remove this property from the front in the fronts config page.

  • Select the front your are trying to view on the config page, click on the edit-metadata link, and deselect the is hidden-property.

  • Since the SNS topic lives in the fronts account, CODE fronts should be pressed automatically when running locally.

Different tools in this codebase

The Fronts Tool

The most important part of this app is the Fronts Tool, used to curate the web and app front pages of the Guardian. Additionally it is used to manually curate emails.

In the UI, users can move stories from the Content API feed into different front pages or emails. These fronts can then be launched or published.

The Fronts Tool uses the most up-to-date front end, a React-Redux app located in fronts-client

Useful things to know:

  • An api call to Ophan pulls in page view data to allow users to understand at a glance that story's performance in the context of the front it is in

  • Containers can be shared between fronts. An update to a container in one place updates it everywhere

  • Certain containers have geolocation properties. This means they can only be seen by users in the location specified

  • Interactive atoms can be pasted into a front as CAPI links. This allows designers and the interactives team to create special content eg banners showing election results. Apart from articles, interactive atoms are the only other type of CAPI content allowed on Fronts

  • In the Email editor only - free text boxes can be created. This allows email editors to add introductions to their emails by hijacking the headline field. Rich text editing is enabled for this using Prosemirror.

The Editions creator

The Editions creator is used to curate content on both the Editions app (currently known as The Daily on iOS and Android), and the Feast recipes app. Editions creator also uses the fronts-client front end, and can be accessed from the Manage Editions menu on the homepage.

Curation works in the same way as the main fronts tool. But there are these differences:

  • Fronts are part of Issues (normally one issue per day). You need to create or open a valid issue to make changes

  • Editions are published once instead of being continually updated and launched

  • The publication process for Editions is different to the main fronts. We push the json we produce to a lambda - the backend of the Editions app, and this combines fronts data with CAPI calls etc to produce the Edition.

For the specific, technical, definitions of the terms Edition, CuratedPlatform etc. please refer to the Glossary.

For more information about how specific Editions are built from Templates, see the technical docs at docs/EditionsTemplating.md

Full Editions codebase and documentation here.

The Config Tool

Fronts and collections are configured in the config tool. This allows for the name, geolocation and visual properties of collections to be set. The types and order of collections in a Front is set here too. This tool uses the "old" front end client. Each "type of fronts" has its own config url eg: https://fronts.gutools.co.uk/email/config

The Breaking News Tool

This enables breaking news notifications to be sent to app users who have signed up. This tool also uses the "old" front end client. You need permission from Central Production to access this tool in PROD. https://fronts.gutools.co.uk/breaking-news

In CODE the breaking news tool sends notifications to the "debug version" of the Android/iOS App.

Breaking News is represented by a front called breaking-news which is considered to be a special case. It has a Send Alert button rather than a Launch button. Only one thing can be added to a collection at a given time. You cannot send the same alert twice, and snap links cannot be added / alerted on. Different collections represent different audience groups (eg by location or by subscription to different topics.) To add a new one, just create a container. New breaking news containers need to have the layout breaking-news/not-for-other-fronts.

Client-side vulnerabilities: Synk and JSPM

The older client side tools (those with source code at /public/src - not the Fronts-tool) are bundled using JSPM. Instead of dependencies for the application being listed in the package.json file in the normal way, they are listed under "jspm" and compiled by JSPM using an import map.

A side effect of this is that the vulnerabilities are not surfaced by Synk. To address this, there is a workaround to construct a "regular" package.json file out real one, and a custom action so that Synk can report on vulnerabilities (see PR#1521).

To audit vulernabilities locally:

  • cd v1_jsmp_synk_workaround
  • npm run preinstall - generates the package.json file in the gitignored '/result' subfolder
  • npm run audit - generates a lockfile in '/result' and runs the npm audit command - note you can append parameters for pn audit - eg npm run audit --production > ./result/audit.txt

Troubleshooting

Postgres

  • If you wish to delete everything in the database you can use docker compose down -v which will delete the container's persistent volumes.

  • If you wish to connect to the local database you can run ./scripts/local-psql.sh which has the user, database and password preconfigured and ready to go.

  • If you need the master passwords for the production postgres instances they are stored as SSM parameters and can be found at:

    • CODE: facia-tool/cms-fronts/CODE/db/password
    • PROD: facia-tool/cms-fronts/PROD/db/password To fetch these can be fetched using the aws cli like so:

    aws ssm get-parameter --name /facia-tool/cms-fronts/CODE/db/password --with-decryption --profile cmsFronts --region eu-west-1

Linting

Eslint

Fronts tool uses eslint to ensure consistent style. Run eslint with

grunt eslint

More detailed instructions of how to develop fronts tool available here

Scalafmt

This project uses scalafmt to format Scala code: the formatter is run in CI, and will fail if any files need formatting. There is also a pre-commit hook in ./git-hooks/pre-commit which runs scalafmt and fails if files need formatting, letting you catch them before pushing to CI. This can be enabled by setting the git config option core.hooksPath to git-hooks for this repository (or by running ./scripts/git-config.sh, which does it for you.)

For the best experience, we recommend configuring your text editor to run scalafmt, as described in the scalafmt docs.

Get Fronts Editors

There is a script to get a list of the fronts editors in the get-editors-script. See the script README for more details.