Origami Frontend Components & Services

Readme: origami-image-service active

Optimises and resize images. See the production service for API information.

Build status
MIT licensed

Table Of Contents

Requirements

Running Origami Image Service requires Node.js 6.x and npm.

Running Locally

Before we can run the application, we'll need to install dependencies:

npm install

Run the application in development mode with

make run-dev

Now you can access the app over HTTP on port 8080: http://localhost:8080/

Configuration

We configure Origami Image Service using environment variables. In development, configurations are set in a .env file. In production, these are set through Heroku config. Further documentation on the available options can be found in the Origami Service documentation.

Required everywhere

Required in Heroku

TODO: The options below are required at the moment, but are duplicates of other options above. This will be addressed once all services are using Origami Makefile.

Required in Heroku (QA only)

Required locally

Headers

The service can also be configured by sending HTTP headers, these would normally be set in your CDN config:

Testing

The tests are split into unit tests and integration tests. To run tests on your machine you'll need to install Node.js and run npm install. Then you can run the following commands:

make test              # run all the tests
make test-unit         # run the unit tests
make test-integration  # run the integration tests

You can run the unit tests with coverage reporting, which expects 90% coverage or more:

make test-unit-coverage verify-coverage

The code will also need to pass linting on CI, you can run the linter locally with:

make verify

We run the tests and linter on CI, you can view results on CircleCI. make test and make lint must pass before we merge a pull request.

Deployment

The production (EU/US) and QA applications run on Heroku. We deploy continuously to QA via CircleCI, you should never need to deploy to QA manually. We use a Heroku pipeline to promote QA deployments to production.

You can promote either through the Heroku interface, or by running the following command locally:

make promote

Monitoring

Trouble-Shooting

We've outlined some common issues that can occur in the running of the Image Service:

I need to purge an image

Please read the purging documentation on the website.

I need to purge all images, is this possible?

Please contact origami.support@ft.com - There is a way to purge all images, but this will incur a large cost.

What do I do if memory usage is high?

For now, restart the Heroku dynos:

heroku restart --app origami-image-service-eu
heroku restart --app origami-image-service-us

If this doesn't help, then a temporary measure could be to add more dynos to the production applications, or switch the existing ones to higher performance dynos.

What if I need to deploy manually?

If you really need to deploy manually, you should only do so to QA. Production deploys should always be a promotion from QA.

You'll need to provide an API key for change request logging. You can get this from the Origami LastPass folder in the note named Change Request API Keys. Now deploy to QA using the following:

make deploy

SVGs don't tint locally

SVG tinting is done in a way that makes it near-impossible to run locally. When an SVG image is requested and a tint query parameter is provided, then we rewrite the URL to go route back through the Image Service. It looks something like this:

When you're running locally this won't work because Cloudinary cannot access your localhost. The flow would look like this:

So Cloudinary responds with a 404. You can get around this by manually specifying a hostname in your configuration. You'll need to tell the service to rely on the QA instance for SVG tinting. Add the following to your .env file:

HOSTNAME=origami-image-service-qa.herokuapp.com

License

The Financial Times has published this software under the MIT license.

Switch component view

GitHub Repository

Help & Support

Check the origami-image-service documentation if you haven't already. It's maintained directly by the Origami team so if you have any questions we are happy to help. 😊

Slack: #ft-origami
Email: origami.support@ft.com