Giter Club home page Giter Club logo

alphagov.notifications-email-provider-stub's Introduction

notifications-email-provider-stub

What this does

During load testing, instead of sending requests to AWS SES to send emails we want to stub them out so that we don't incur unnecessary costs.

When the API tries to send an email, instead of using Boto and talking to AWS SES, you can use the AwsSesStubClient to send an HTTP POST request to this stub app to mimic the behaviour of SES.

When this stub app receives a POST request from the API to send an email, it will

  • put a task on the ses-callback queue with a fake SES callback
  • respond with a fake messageID to be used as the reference from SES

Set up

To run locally

pip install -r requirements.txt
NOTIFICATION_QUEUE_PREFIX=<your-queue-prefix> make run

Then visit http://localhost:6301/ to see it running

Deploy

To deploy:

make preview cf-push

How to make the API use this email provider stub

You will need to set the environment variable SES_STUB_URL for API apps in your chosen environment, for example:

cf set-env APP-NAME SES_STUB_URL https://notify-email-provider-stub-staging.cloudapps.digital/ses
cf restage APP-NAME

It is suggested to turn it on for minimum the notify-api, notify-delivery-worker-sender and notify-delivery-worker-retry-tasks. By not turning it on for notify-delivery-worker-internal, which is responsible for delivering MFA codes, it will mean you can still log into the environment.

Scaling

You may need to scale up the number of instances to handle the load you point at this stub. Initial testing using Vegeta shows that to handle 400 requests per second with a 50th percentile response time under 100ms you need about 10-20 instances.

cf scale notify-email-provider-stub -i 10

alphagov.notifications-email-provider-stub's People

Contributors

idavidmcdonald avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.