darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2025-12-13 08:34:33 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
1d64fd692378343dcad1e9628023f0a5f4b8839c
notifications-admin/app/config.py

202 lines
7.4 KiB
Python
Raw Normal View History

108537814: Implementation of 3 factor authentication. The post register endpoint will send a random 5 digit code via sms and another via email. If either code fails to send, the user will not be created and the person can register again. The codes are saved to the session cookie, and expire in 1 hour. Another iteration of this story will save the codes to a database.
2015-12-04 14:40:16 +00:00
import os
Use VCAP_APPLICATION to detect CloudFoundry environment VCAP_SERVICES is not set on PaaS if no services are bound to the application, so we need to check for VCAP_APPLICATION to parse the application name and environment.
2018-01-09 14:41:36 +00:00
if os.environ.get('VCAP_APPLICATION'):
# on cloudfoundry, config is a json blob in VCAP_APPLICATION - unpack it, and populate
Run on Paas
2016-12-08 16:50:37 +00:00
# standard environment variables from it
from app.cloudfoundry_config import extract_cloudfoundry_config
extract_cloudfoundry_config()
Introduce config file for application
2015-11-24 09:40:14 +00:00
class Config(object):
hardcode some development values this'll ensure that you won't get your dev secret keys out of sync between api and admin
2018-02-27 15:32:13 +00:00
ADMIN_CLIENT_SECRET = os.environ.get('ADMIN_CLIENT_SECRET')
API_HOST_NAME = os.environ.get('API_HOST_NAME')
SECRET_KEY = os.environ.get('SECRET_KEY')
DANGEROUS_SALT = os.environ.get('DANGEROUS_SALT')
send zendesk rather than deskpro tickets
2018-04-24 17:37:15 +01:00
ZENDESK_API_KEY = os.environ.get('ZENDESK_API_KEY')
Run on Paas
2016-12-08 16:50:37 +00:00
bump utils to 13.10.0 pass in the base URL - if not set in the environment this is set to localhost, but on paas we can pull this out of vcap_services so that letters render properly on paas
2017-03-27 17:59:06 +01:00
# if we're not on cloudfoundry, we can get to this app from localhost. but on cloudfoundry its different
Don’t use https for localhost We set a URL for the app to use to access itself. On PaaS this is configurable, locally we default to `localhost`. `localhost` doesn’t (easily?) support HTTPS, so this default wasn’t working.
2017-04-03 13:47:39 +01:00
ADMIN_BASE_URL = os.environ.get('ADMIN_BASE_URL', 'http://localhost:6012')
bump utils to 13.10.0 pass in the base URL - if not set in the environment this is set to localhost, but on paas we can pull this out of vcap_services so that letters render properly on paas
2017-03-27 17:59:06 +01:00
Add cloudfoundry config values also added tests
2017-04-10 18:12:00 +01:00
TEMPLATE_PREVIEW_API_HOST = os.environ.get('TEMPLATE_PREVIEW_API_HOST', 'http://localhost:6013')
TEMPLATE_PREVIEW_API_KEY = os.environ.get('TEMPLATE_PREVIEW_API_KEY', 'my-secret-key')
Generate letter previews in the new notifications-template-preview service by calling through to this, we no longer require admin app to ship with binary dependencies (imagemagick/cairo/etc)
2017-04-10 15:10:34 +01:00
bump utils to 13.1.0 brings in changes to allow logging json to sdout on cloudfoundry boxes
2017-01-09 19:14:04 +00:00
# Logging
Run on Paas
2016-12-08 16:50:37 +00:00
DEBUG = False
make sure log path is set
2017-08-09 16:53:56 +01:00
NOTIFY_LOG_PATH = os.getenv('NOTIFY_LOG_PATH')
Run on Paas
2016-12-08 16:50:37 +00:00
Simplified the config files for admin.
2016-09-07 10:31:33 +01:00
ADMIN_CLIENT_USER_NAME = 'notify-admin'
Add antivirus scan to letter validation preview view
2018-10-03 17:59:14 +01:00
ANTIVIRUS_API_HOST = os.environ.get('ANTIVIRUS_API_HOST')
ANTIVIRUS_API_KEY = os.environ.get('ANTIVIRUS_API_KEY')
Introduce config file for application
2015-11-24 09:40:14 +00:00
ASSETS_DEBUG = False
Clean up config a bit. Get values for config from environment. Removed some old redundant config.
2016-03-23 14:09:07 +00:00
AWS_REGION = 'eu-west-1'
DEFAULT_SERVICE_LIMIT = 50
Set free SMS limit depending on organisation type Different parts of government get billed slightly differently, and there’s differences in how much money we’re allowed to give them. Think these numbers are right, but should be double checked.
2017-10-05 10:46:55 +01:00
DEFAULT_FREE_SMS_FRAGMENT_LIMITS = {
Remove 2020/21 free allowance data 🚨 Do not merge until after 1 April 2020 🚨 Once this date has past we no longer need to give any services the previous allowances, so we can remove them from the codebase to avoid confusion. It’s possible we change the allowance structure again, but it might change in a way that this config-based logic doesn’t account for (what if we did a per-organisation allowance for example). Having both years’ allowances in the config was a quick fix, not a foundation to build on.
2021-03-10 14:51:40 +00:00
'central': 150_000,
'local': 25_000,
'nhs_central': 150_000,
'nhs_local': 25_000,
'nhs_gp': 10_000,
'emergency_service': 25_000,
'school_or_college': 10_000,
'other': 10_000,
Set free SMS limit depending on organisation type Different parts of government get billed slightly differently, and there’s differences in how much money we’re allowed to give them. Think these numbers are right, but should be double checked.
2017-10-05 10:46:55 +01:00
}
don't hit API when checking new account email-token we currently store new account email verify tokens in the database, and check against that to work out if they've expired. But we don't need to do that, tokens have their own timing mechanism. So lets just use that, and free up the database to do other things. Also, standardised the forgot password, change email, and new account email verification timeouts to all be an hour, from the config val 'EMAIL_EXPIRY_SECONDS'
2017-11-01 14:39:14 +00:00
EMAIL_EXPIRY_SECONDS = 3600 # 1 hour
make sure old invites get the proper message we were accidentally covering up the expiry message with a more generic one
2017-11-02 13:49:24 +00:00
INVITATION_EXPIRY_SECONDS = 3600 * 24 * 2 # 2 days - also set on api
alter login flow to allow for email auth login
2017-11-07 16:11:31 +00:00
EMAIL_2FA_EXPIRY_SECONDS = 1800 # 30 Minutes
Don’t use $yellow to indicate local environment It clashes with the new `$govuk-focus-colour` now. This commit changes it to half way between `govuk-colour("dark-grey")` (`#505a5f`) and `govuk-colour("mid-grey")` (`#b1b4b6`) from the Design System. Dark was too dark and mid was too light. It also adds a line of JS to let us easily switch the header to blue by clicking on it, which is useful for taking screenshots etc.
2020-09-23 10:16:38 +01:00
HEADER_COLOUR = '#81878b' # mix(govuk-colour("dark-grey"), govuk-colour("mid-grey"))
Clean up config a bit. Get values for config from environment. Removed some old redundant config.
2016-03-23 14:09:07 +00:00
HTTP_PROTOCOL = 'http'
Live was set to debug mode
2016-01-07 16:24:10 +00:00
NOTIFY_APP_NAME = 'admin'
Clean up config a bit. Get values for config from environment. Removed some old redundant config.
2016-03-23 14:09:07 +00:00
NOTIFY_LOG_LEVEL = 'DEBUG'
set session timeout to 20 hours this way if someone does some work in the evening, when they come in next morning they'll still be logged in. but if someone does stuff in the morning and then leaves notify, they'll be kicked out by the next day unless they have an auto-refreshing page like the dashboard open
2017-02-20 11:31:41 +00:00
PERMANENT_SESSION_LIFETIME = 20 * 60 * 60 # 20 hours
Clean up config a bit. Get values for config from environment. Removed some old redundant config.
2016-03-23 14:09:07 +00:00
SEND_FILE_MAX_AGE_DEFAULT = 365 * 24 * 60 * 60 # 1 year
SESSION_COOKIE_HTTPONLY = True
SESSION_COOKIE_NAME = 'notify_admin_session'
SESSION_COOKIE_SECURE = True
add no_cookie blueprint we have a hunch that some session related issues that we've seen over the last few weeks might be related to weird race conditions where cookies set by subresources (image previews of letters on the send flow) arrive just as the img request is cancelled because the user has clicked on a button to navigate to a new page, but still manage to set the cookie? We're not entirely sure what's going on, but we've got a hunch that not setting cookies on image fetches sounds sensible. Images are always loaded as a subresource (ie: through a `src` tag in an html element), so they should never need to change the cookies, so this seems sensible. We've done this by creating a new blueprint that doesn't set session.permanent, and doesn't call `save_serivce_or_org_after_request` either. cookies are sent back to the browser if: `sesion.modified or (session.permanent and 'REFRESH_EVERY_REQUEST')` (where the latter is a config setting). Turning off REFRESH_EVERY_REQUEST (which is True by default) means that we will only update the sesion if it's been modified. In practice, literally every request is modified in the after_request handler `save_service_or_org_after_request`. This is accidentally convenient, as it guarantees that we'll still send back the cookie normally even though refresh_every_request is disabled. Sending back the cookie updates the expiry time (20 hours), so we need to keep doing this to preserve existing session timeout behaviour.
2019-11-28 14:39:30 +00:00
# don't send back the cookie if it hasn't been modified by the request. this means that the expiry time won't be
# updated unless the session is changed - but it's generally refreshed by `save_service_or_org_after_request`
# every time anyway, except for specific endpoints (png/pdfs generally) where we've disabled that handler.
SESSION_REFRESH_EACH_REQUEST = False
Clean up config a bit. Get values for config from environment. Removed some old redundant config.
2016-03-23 14:09:07 +00:00
WTF_CSRF_ENABLED = True
Make CSRF tokens last as long as the session If you’re filling out a form then it should be possible to submit it for as long as you’re logged in. We keep you logged in for quite a long time now. This is partly for people using assistive tech, who might be slower to fill in forms, and partly for people who get distracted in the middle of a task and come back to it later. The expiry on our CSRF tokens was more aggressive (3600 seconds – 1 hour) than our sessions. This commit sets the CSRF tokens to not expire, so in effect they last as long as the session. Also tweaks the config to have CSRF on locally (to replicate production more closely) and only disable it for tests (because it’s a pain to grab the tokens in tests).
2017-03-15 11:16:58 +00:00
WTF_CSRF_TIME_LIMIT = None
Update config. All tests passing.
2016-04-07 17:33:30 +01:00
CSV_UPLOAD_BUCKET_NAME = 'local-notifications-csv-upload'
Use the correct bucket for storing contact lists We don’t want to muddy them up with the normal CSV uploads. I’ve tried to reuse the existing S3 code where possible because it’s well tested. Buckets have already been created.
2020-03-13 13:53:18 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'local-contact-list'
Change activity to view to request 7 days data. Cleaned up filters a bit so that if you want both templates email and sms is passed. Added mock assertion to test.
2016-04-28 15:50:05 +01:00
ACTIVITY_STATS_LIMIT_DAYS = 7
Rename the feature to ‘send to one recipient’ ‘One-off’ is a bit wooly. Feels like our name for the thing. ‘Send to one recipient’ matches ‘Upload recipients’. This also means making the `<h1>` on job page ‘Report’ for one-off messages. It doesn’t make sense to call the feature ‘send to one recipient’ when we’re not using the language of one-off any more.
2017-06-01 13:03:22 +01:00
TEST_MESSAGE_FILENAME = 'Report'
Don’t show styleguide on live environment Its audience is people working on the product, not the end users.
2016-02-15 11:47:54 +00:00
increase reply to address validation timeout on preview Celery/SQS underperforms in low-traffic environments. Tasks will sit on celery queues for several seconds before getting picked up if they're the only thing on the queue. This is observable in our test environments like preview and staging, but we've got enough load on production that this isn't an issue. When we validate reply to email addresses, we expect a delivery receipt to have been processed within 45 seconds of the button being pressed. On preview, we often observe times over that, possibly due to the several queues involved in sending an email and processing its receipt. So, to ensure that functional tests can pass (when we don't really care how fast things are, just that the flow doesn't break), bump this timeout up to 120 seconds on preview. The functional tests were waiting for 120 seconds for the reply to address to be validated anyway.
2020-01-07 11:57:38 +00:00
REPLY_TO_EMAIL_ADDRESS_VALIDATION_TIMEOUT = 45
Adds statsd to the application - statsd client from utils - adds to logger an get same method based reporting as we do for the API.
2016-12-01 17:21:06 +00:00
NOTIFY_ENVIRONMENT = 'development'
Update config to new s3 bucket names
2017-08-02 11:05:17 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-local'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'local-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'local-transient-uploaded-letters'
Load route_secret config
2017-11-15 12:05:05 +00:00
ROUTE_SECRET_KEY_1 = os.environ.get('ROUTE_SECRET_KEY_1', '')
ROUTE_SECRET_KEY_2 = os.environ.get('ROUTE_SECRET_KEY_2', '')
Add CHECK_PROXY_HEADER flag and bump utils
2017-11-16 16:33:21 +00:00
CHECK_PROXY_HEADER = False
Antivirus off for development by default I have copied the approach we use in the API for this
2019-12-05 11:18:48 +00:00
ANTIVIRUS_ENABLED = True
Update emails to use logos cdn
2017-07-24 15:20:40 +01:00
Add Redis cache between admin and API Most of the time spent by the admin app to generate a page is spent waiting for the API. This is slow for three reasons: 1. Talking to the API means going out to the internet, then through nginx, the Flask app, SQLAlchemy, down to the database, and then serialising the result to JSON and making it into a HTTP response 2. Each call to the API is synchronous, therefore if a page needs 3 API calls to render then the second API call won’t be made until the first has finished, and the third won’t start until the second has finished 3. Every request for a service page in the admin app makes a minimum of two requests to the API (`GET /service/…` and `GET /user/…`) Hitting the database will always be the slowest part of an app like Notify. But this slowness is exacerbated by 2. and 3. Conversely every speedup made to 1. is multiplied by 2. and 3. So this pull request aims to make 1. a _lot_ faster by taking nginx, Flask, SQLAlchemy and the database out of the equation. It replaces them with Redis, which as an in-memory key/value store is a lot faster than Postgres. There is still the overhead of going across the network to talk to Redis, but the net improvement is vast. This commit only caches the `GET /service` response, but is written in such a way that we can easily expand to caching other responses down the line. The tradeoff here is that our code is more complex, and we risk introducing edge cases where a cache becomes stale. The mitigations against this are: - invalidating all caches after 24h so a stale cache doesn’t remain around indefinitely - being careful when we add new stuff to the service response --- Some indicative numbers, based on: - `GET http://localhost:6012/services/<service_id>/template/<template_id>` - with the admin app running locally - talking to Redis running locally - also talking to the API running locally, itself talking to a local Postgres instance - times measured with Chrome web inspector, average of 10 requests ╲ | No cache | Cache service | Cache service and user | Cache service, user and template -- | -- | -- | -- | -- **Request time** | 136ms | 97ms | 73ms | 37ms **Improvement** | 0% | 41% | 88% | 265% --- Estimates of how much storage this requires: - Services: 1,942 on production × 2kb = 4Mb - Users: 4,534 on production × 2kb = 9Mb - Templates: 7,079 on production × 4kb = 28Mb
2018-04-06 13:37:49 +01:00
REDIS_URL = os.environ.get('REDIS_URL')
Turn redis back on
2020-08-11 09:58:34 +01:00
REDIS_ENABLED = os.environ.get('REDIS_ENABLED') == '1'
Add Redis cache between admin and API Most of the time spent by the admin app to generate a page is spent waiting for the API. This is slow for three reasons: 1. Talking to the API means going out to the internet, then through nginx, the Flask app, SQLAlchemy, down to the database, and then serialising the result to JSON and making it into a HTTP response 2. Each call to the API is synchronous, therefore if a page needs 3 API calls to render then the second API call won’t be made until the first has finished, and the third won’t start until the second has finished 3. Every request for a service page in the admin app makes a minimum of two requests to the API (`GET /service/…` and `GET /user/…`) Hitting the database will always be the slowest part of an app like Notify. But this slowness is exacerbated by 2. and 3. Conversely every speedup made to 1. is multiplied by 2. and 3. So this pull request aims to make 1. a _lot_ faster by taking nginx, Flask, SQLAlchemy and the database out of the equation. It replaces them with Redis, which as an in-memory key/value store is a lot faster than Postgres. There is still the overhead of going across the network to talk to Redis, but the net improvement is vast. This commit only caches the `GET /service` response, but is written in such a way that we can easily expand to caching other responses down the line. The tradeoff here is that our code is more complex, and we risk introducing edge cases where a cache becomes stale. The mitigations against this are: - invalidating all caches after 24h so a stale cache doesn’t remain around indefinitely - being careful when we add new stuff to the service response --- Some indicative numbers, based on: - `GET http://localhost:6012/services/<service_id>/template/<template_id>` - with the admin app running locally - talking to Redis running locally - also talking to the API running locally, itself talking to a local Postgres instance - times measured with Chrome web inspector, average of 10 requests ╲ | No cache | Cache service | Cache service and user | Cache service, user and template -- | -- | -- | -- | -- **Request time** | 136ms | 97ms | 73ms | 37ms **Improvement** | 0% | 41% | 88% | 265% --- Estimates of how much storage this requires: - Services: 1,942 on production × 2kb = 4Mb - Users: 4,534 on production × 2kb = 9Mb - Templates: 7,079 on production × 4kb = 28Mb
2018-04-06 13:37:49 +01:00
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_DOMAIN = ''
Since moving to putting the admin app on Cloudfront anything on the `www.notifications.service.gov.uk` domain is: - not gzipped The PaaS proxy used to GZip and set headers for anything served from a path starting with `/static/`: https://github.com/alphagov/notifications-aws/blob/76dd511a8aaa2e4f8ffec17662bbe08841c52455/ansible/roles/paas-proxy/templates/admin.conf.j2#L53-L64 Anything served from `static.notifications.service.gov.uk` is: - GZipped - and as a bonus, cached by Cloudfront where possible (meaning the requests won’t ever hit our app) This commit moves to serving static asset from `/static/` to `static.notifications.service.gov.uk`, to get the above listed benefits. *** We could do even better by setting long cache expiry headers on the static subdomain (currently they’re only set to cache for 60 seconds). But that’s out of scope for this commit.
2018-11-28 15:39:08 +00:00
ASSET_PATH = '/static/'
enable broadcast org in all environments This organisation is defined in the config file. It's hard coded to a UUID as defined in the api db migration 0331_add_broadcast_org.
2020-09-22 18:18:00 +01:00
# as defined in api db migration 0331_add_broadcast_org.py
BROADCAST_ORGANISATION_ID = '38e4bf69-93b0-445d-acee-53ea53fe02df'
move service to broadcast org when broadcasting is enabled we want to keep track of all broadcast services across govt easily. As such, when broadcasting is enabled for a service, we've decided we're going to add the service to a special broadcasting organisation. This organisation is defined in the config file. It's hard coded for production, if you want to test locally, you should set BROADCAST_ORGANISATION_ID in your local environment.
2020-09-22 18:18:00 +01:00
Waiting page shows correct messages
2019-05-13 10:17:20 +01:00
NOTIFY_SERVICE_ID = 'd6aa2c68-a2d9-4437-ab19-3ae8eb202553'
Introduce config file for application
2015-11-24 09:40:14 +00:00
class Development(Config):
don't capture logs directly from stdout previously in run_app_paas.sh, we captured stdout from the app and piped that into the log file. However, this came up with a bunch of problems, mainly that exceptions with stack traces often weren't formatted properly, and kibana could not parse them instead, with the updated utils library, we can use that to log json straight to the appropriate directory directly.
2017-08-09 15:30:24 +01:00
NOTIFY_LOG_PATH = 'application.log'
Introduce config file for application
2015-11-24 09:40:14 +00:00
DEBUG = True
Remember me functionality added and tested. Merge extra. Fixed comment.
2016-02-23 15:45:19 +00:00
SESSION_COOKIE_SECURE = False
Updated flask-login to version 0.3.2
2016-05-04 13:01:55 +01:00
SESSION_PROTECTION = None
Update config. All tests passing.
2016-04-07 17:33:30 +01:00
CSV_UPLOAD_BUCKET_NAME = 'development-notifications-csv-upload'
Use the correct bucket for storing contact lists We don’t want to muddy them up with the normal CSV uploads. I’ve tried to reuse the existing S3 code where possible because it’s well tested. Buckets have already been created.
2020-03-13 13:53:18 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'development-contact-list'
Add org select and manage pages
2017-07-28 15:17:50 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-tools'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'notify.tools-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'development-transient-uploaded-letters'
Introduce config file for application
2015-11-24 09:40:14 +00:00
hardcode some development values this'll ensure that you won't get your dev secret keys out of sync between api and admin
2018-02-27 15:32:13 +00:00
ADMIN_CLIENT_SECRET = 'dev-notify-secret-key'
API_HOST_NAME = 'http://localhost:6011'
DANGEROUS_SALT = 'dev-notify-salt'
SECRET_KEY = 'dev-notify-secret-key'
Add antivirus scan to letter validation preview view
2018-10-03 17:59:14 +01:00
ANTIVIRUS_API_HOST = 'http://localhost:6016'
ANTIVIRUS_API_KEY = 'test-key'
Antivirus off for development by default I have copied the approach we use in the API for this
2019-12-05 11:18:48 +00:00
ANTIVIRUS_ENABLED = os.getenv('ANTIVIRUS_ENABLED') == '1'
hardcode some development values this'll ensure that you won't get your dev secret keys out of sync between api and admin
2018-02-27 15:32:13 +00:00
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_PATH = '/static/'
bump utils to bring in redis changes also set redis url locally to be localhost. redis is disabled by default so this won't do anything unless you set REDIS_ENABLED=1 as an environment variable
2019-02-15 10:26:56 +00:00
REDIS_URL = 'redis://localhost:6379/0'
Introduce config file for application
2015-11-24 09:40:14 +00:00
Add user via api Leave original user object in for this slice. Remove on next
2016-01-19 15:50:31 +00:00
class Test(Development):
Set debug for test
2016-03-23 15:06:17 +00:00
DEBUG = True
Change client_request so its kwargs look more like url_for
2017-06-19 12:31:14 +01:00
TESTING = True
Make CSRF tokens last as long as the session If you’re filling out a form then it should be possible to submit it for as long as you’re logged in. We keep you logged in for quite a long time now. This is partly for people using assistive tech, who might be slower to fill in forms, and partly for people who get distracted in the middle of a task and come back to it later. The expiry on our CSRF tokens was more aggressive (3600 seconds – 1 hour) than our sessions. This commit sets the CSRF tokens to not expire, so in effect they last as long as the session. Also tweaks the config to have CSRF on locally (to replicate production more closely) and only disable it for tests (because it’s a pain to grab the tokens in tests).
2017-03-15 11:16:58 +00:00
WTF_CSRF_ENABLED = False
Update config. All tests passing.
2016-04-07 17:33:30 +01:00
CSV_UPLOAD_BUCKET_NAME = 'test-notifications-csv-upload'
Use the correct bucket for storing contact lists We don’t want to muddy them up with the normal CSV uploads. I’ve tried to reuse the existing S3 code where possible because it’s well tested. Buckets have already been created.
2020-03-13 13:53:18 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'test-contact-list'
Update config to new s3 bucket names
2017-08-02 11:05:17 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-test'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'test-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'test-transient-uploaded-letters'
Adds statsd to the application - statsd client from utils - adds to logger an get same method based reporting as we do for the API.
2016-12-01 17:21:06 +00:00
NOTIFY_ENVIRONMENT = 'test'
raise 503 if you dont mock api properly in your tests otherwise they'll return unexpected things (eg 404) if you have api running locally (as you often do in dev)
2018-03-08 16:10:49 +00:00
API_HOST_NAME = 'http://you-forgot-to-mock-an-api-call-to'
Don’t hit template preview app when running tests It’s annoying for tests to pass locally because the template preview app is running locally, but fail on Jenkins because the template preview app doesn’t exist. This commit changes it’s hostname to use a dummy port in tests.
2017-05-25 15:03:49 +01:00
TEMPLATE_PREVIEW_API_HOST = 'http://localhost:9999'
Add antivirus scan to letter validation preview view
2018-10-03 17:59:14 +01:00
ANTIVIRUS_API_HOST = 'https://test-antivirus'
ANTIVIRUS_API_KEY = 'test-antivirus-secret'
Antivirus off for development by default I have copied the approach we use in the API for this
2019-12-05 11:18:48 +00:00
ANTIVIRUS_ENABLED = True
Introduce config file for application
2015-11-24 09:40:14 +00:00
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_DOMAIN = 'static.example.com'
Fix asset path in asset fingeprinter The asset fingerprinter was hard coded to always point to `/static`. It needs to change depending on which environment the app is running in.
2018-11-29 13:06:10 +00:00
ASSET_PATH = 'https://static.example.com/'
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
108536490: add the proxy_fix
2015-11-30 14:32:58 +00:00
Use different colours for each environment https://www.pivotaltracker.com/story/show/112786779 > There's an emerging convention on admin apps, to have a red strip atop the > page, also to have a different colour for preview environment... so let's > adopt that and see how it feels. Red for prod and gold for preview. This commit adds config so that: - yellow locally - orange on preview and staging - red on live It will not actually work until each AWS environment uses the right config, but can be tested locally by setting the environment variable manually, eg: `export HEADER_COLOUR='#F47738'`
2016-02-01 14:46:12 +00:00
class Preview(Config):
108536490: add the proxy_fix
2015-11-30 14:32:58 +00:00
HTTP_PROTOCOL = 'https'
Remove the red header meaning signed in to admin > Make the header bar red > > Red for admin is a good reckon. – 286fc308d9a64ab8effa3b9a575591b2f2f942da (part of https://github.com/alphagov/notifications-admin/pull/130) Starting to think it’s not such a good reckon. Users could take a guess at what it meant, but they often guessed wrong. However, changing the colour of the header bar _is_ useful for us internally to see which environment we’re in. So this commit makes three changes: 1. On live, the header bar is always standard GOV.UK blue 2. On other environments, the header bar is some other colour (local is very different, staging and preview are related colours) 3. If an enviroment has a different header colour, it has it even when you’re not logged in.
2016-11-25 17:05:35 +00:00
HEADER_COLOUR = '#F499BE' # $baby-pink
Update config. All tests passing.
2016-04-07 17:33:30 +01:00
CSV_UPLOAD_BUCKET_NAME = 'preview-notifications-csv-upload'
Use the correct bucket for storing contact lists We don’t want to muddy them up with the normal CSV uploads. I’ve tried to reuse the existing S3 code where possible because it’s well tested. Buckets have already been created.
2020-03-13 13:53:18 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'preview-contact-list'
Update config to new s3 bucket names
2017-08-02 11:05:17 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-preview'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'notify.works-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'preview-transient-uploaded-letters'
Adds statsd to the application - statsd client from utils - adds to logger an get same method based reporting as we do for the API.
2016-12-01 17:21:06 +00:00
NOTIFY_ENVIRONMENT = 'preview'
Disable paas-proxy header check on preview See: https://github.com/alphagov/notifications-api/pull/2052
2018-08-28 13:58:31 +01:00
CHECK_PROXY_HEADER = False
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_DOMAIN = 'static.notify.works'
Since moving to putting the admin app on Cloudfront anything on the `www.notifications.service.gov.uk` domain is: - not gzipped The PaaS proxy used to GZip and set headers for anything served from a path starting with `/static/`: https://github.com/alphagov/notifications-aws/blob/76dd511a8aaa2e4f8ffec17662bbe08841c52455/ansible/roles/paas-proxy/templates/admin.conf.j2#L53-L64 Anything served from `static.notifications.service.gov.uk` is: - GZipped - and as a bonus, cached by Cloudfront where possible (meaning the requests won’t ever hit our app) This commit moves to serving static asset from `/static/` to `static.notifications.service.gov.uk`, to get the above listed benefits. *** We could do even better by setting long cache expiry headers on the static subdomain (currently they’re only set to cache for 60 seconds). But that’s out of scope for this commit.
2018-11-28 15:39:08 +00:00
ASSET_PATH = 'https://static.notify.works/'
Use different colours for each environment https://www.pivotaltracker.com/story/show/112786779 > There's an emerging convention on admin apps, to have a red strip atop the > page, also to have a different colour for preview environment... so let's > adopt that and see how it feels. Red for prod and gold for preview. This commit adds config so that: - yellow locally - orange on preview and staging - red on live It will not actually work until each AWS environment uses the right config, but can be tested locally by setting the environment variable manually, eg: `export HEADER_COLOUR='#F47738'`
2016-02-01 14:46:12 +00:00
increase reply to address validation timeout on preview Celery/SQS underperforms in low-traffic environments. Tasks will sit on celery queues for several seconds before getting picked up if they're the only thing on the queue. This is observable in our test environments like preview and staging, but we've got enough load on production that this isn't an issue. When we validate reply to email addresses, we expect a delivery receipt to have been processed within 45 seconds of the button being pressed. On preview, we often observe times over that, possibly due to the several queues involved in sending an email and processing its receipt. So, to ensure that functional tests can pass (when we don't really care how fast things are, just that the flow doesn't break), bump this timeout up to 120 seconds on preview. The functional tests were waiting for 120 seconds for the reply to address to be validated anyway.
2020-01-07 11:57:38 +00:00
# On preview, extend the validation timeout to allow more leniency when running functional tests
REPLY_TO_EMAIL_ADDRESS_VALIDATION_TIMEOUT = 120
Use different colours for each environment https://www.pivotaltracker.com/story/show/112786779 > There's an emerging convention on admin apps, to have a red strip atop the > page, also to have a different colour for preview environment... so let's > adopt that and see how it feels. Red for prod and gold for preview. This commit adds config so that: - yellow locally - orange on preview and staging - red on live It will not actually work until each AWS environment uses the right config, but can be tested locally by setting the environment variable manually, eg: `export HEADER_COLOUR='#F47738'`
2016-02-01 14:46:12 +00:00
Updated start scripts to not look up envrionemnt
2016-07-04 17:21:08 +01:00
class Staging(Config):
HTTP_PROTOCOL = 'https'
Remove the red header meaning signed in to admin > Make the header bar red > > Red for admin is a good reckon. – 286fc308d9a64ab8effa3b9a575591b2f2f942da (part of https://github.com/alphagov/notifications-admin/pull/130) Starting to think it’s not such a good reckon. Users could take a guess at what it meant, but they often guessed wrong. However, changing the colour of the header bar _is_ useful for us internally to see which environment we’re in. So this commit makes three changes: 1. On live, the header bar is always standard GOV.UK blue 2. On other environments, the header bar is some other colour (local is very different, staging and preview are related colours) 3. If an enviroment has a different header colour, it has it even when you’re not logged in.
2016-11-25 17:05:35 +00:00
HEADER_COLOUR = '#6F72AF' # $mauve
Rename staging CSV uploads bucket to match other environments
2018-11-20 16:39:23 +00:00
CSV_UPLOAD_BUCKET_NAME = 'staging-notifications-csv-upload'
Use the correct bucket for storing contact lists We don’t want to muddy them up with the normal CSV uploads. I’ve tried to reuse the existing S3 code where possible because it’s well tested. Buckets have already been created.
2020-03-13 13:53:18 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'staging-contact-list'
Update config to new s3 bucket names
2017-08-02 11:05:17 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-staging'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'staging-notify.works-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'staging-transient-uploaded-letters'
Adds statsd to the application - statsd client from utils - adds to logger an get same method based reporting as we do for the API.
2016-12-01 17:21:06 +00:00
NOTIFY_ENVIRONMENT = 'staging'
Disable paas-proxy header check on staging See: alphagov/notifications-api#2052
2018-09-03 11:10:53 +01:00
CHECK_PROXY_HEADER = False
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_DOMAIN = 'static.staging-notify.works'
Since moving to putting the admin app on Cloudfront anything on the `www.notifications.service.gov.uk` domain is: - not gzipped The PaaS proxy used to GZip and set headers for anything served from a path starting with `/static/`: https://github.com/alphagov/notifications-aws/blob/76dd511a8aaa2e4f8ffec17662bbe08841c52455/ansible/roles/paas-proxy/templates/admin.conf.j2#L53-L64 Anything served from `static.notifications.service.gov.uk` is: - GZipped - and as a bonus, cached by Cloudfront where possible (meaning the requests won’t ever hit our app) This commit moves to serving static asset from `/static/` to `static.notifications.service.gov.uk`, to get the above listed benefits. *** We could do even better by setting long cache expiry headers on the static subdomain (currently they’re only set to cache for 60 seconds). But that’s out of scope for this commit.
2018-11-28 15:39:08 +00:00
ASSET_PATH = 'https://static.staging-notify.works/'
Updated start scripts to not look up envrionemnt
2016-07-04 17:21:08 +01:00
class Live(Config):
Remove the red header meaning signed in to admin > Make the header bar red > > Red for admin is a good reckon. – 286fc308d9a64ab8effa3b9a575591b2f2f942da (part of https://github.com/alphagov/notifications-admin/pull/130) Starting to think it’s not such a good reckon. Users could take a guess at what it meant, but they often guessed wrong. However, changing the colour of the header bar _is_ useful for us internally to see which environment we’re in. So this commit makes three changes: 1. On live, the header bar is always standard GOV.UK blue 2. On other environments, the header bar is some other colour (local is very different, staging and preview are related colours) 3. If an enviroment has a different header colour, it has it even when you’re not logged in.
2016-11-25 17:05:35 +00:00
HEADER_COLOUR = '#005EA5' # $govuk-blue
Updated start scripts to not look up envrionemnt
2016-07-04 17:21:08 +01:00
HTTP_PROTOCOL = 'https'
Changed bucket name
2016-07-05 17:00:29 +01:00
CSV_UPLOAD_BUCKET_NAME = 'live-notifications-csv-upload'
Use the correct name for the contact list bucket Everything else is production. The bucket is currently called production. The fact that the CSV bucket is called `live-` is a legacy thing that’s hard to change.
2020-03-16 16:10:25 +00:00
CONTACT_LIST_UPLOAD_BUCKET_NAME = 'production-contact-list'
Fix logo bucket name The app was uploading into ...live but then looking for the logos in ...production. The existing logos are in ...production
2017-08-09 15:13:36 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-production'
Add endpoints to serve the agreement Rather than making users contact us to get the agreement, we should just let them download it, when we know which version to send them. This commit adds two endpoints: - one to serve a page which links to the agreement - one to serve the agreement itself These pages are not linked to anywhere because the underlying files don’t exist yet. So I haven’t bothered putting real content on the page yet either. I imagine the deploy sequence will be: 1. Upload the files to the buckets in each environment 2. Deploy this code through each enviroment, checking the links work 3. Make another PR to start linking to the endpoints added by this commit
2018-03-16 17:27:47 +00:00
MOU_BUCKET_NAME = 'notifications.service.gov.uk-mou'
Sanitise uploaded letters and store in S3 This sanitises uploaded letters and stores the sanitised result in S3 with if it passes validation or the original PDF in S3 if validation fails. A metadata value of 'status' is set to either 'valid' or 'invalid'.
2019-09-06 17:10:48 +01:00
TRANSIENT_UPLOADED_LETTERS = 'production-transient-uploaded-letters'
Adds statsd to the application - statsd client from utils - adds to logger an get same method based reporting as we do for the API.
2016-12-01 17:21:06 +00:00
NOTIFY_ENVIRONMENT = 'live'
Add CHECK_PROXY_HEADER flag and bump utils
2017-11-16 16:33:21 +00:00
CHECK_PROXY_HEADER = False
Fix content security policy for the CDN The CDN URLs aren’t in included in the content security policy. So browsers will refuse to load them. This commit: - adds each of the CDN URLs to the - only prepend URLs in CSS files with `/static/` if we’re running locally (because the CDN URLs are like `static.example.com` not `example.com/static`)
2018-11-29 11:29:52 +00:00
ASSET_DOMAIN = 'static.notifications.service.gov.uk'
Since moving to putting the admin app on Cloudfront anything on the `www.notifications.service.gov.uk` domain is: - not gzipped The PaaS proxy used to GZip and set headers for anything served from a path starting with `/static/`: https://github.com/alphagov/notifications-aws/blob/76dd511a8aaa2e4f8ffec17662bbe08841c52455/ansible/roles/paas-proxy/templates/admin.conf.j2#L53-L64 Anything served from `static.notifications.service.gov.uk` is: - GZipped - and as a bonus, cached by Cloudfront where possible (meaning the requests won’t ever hit our app) This commit moves to serving static asset from `/static/` to `static.notifications.service.gov.uk`, to get the above listed benefits. *** We could do even better by setting long cache expiry headers on the static subdomain (currently they’re only set to cache for 60 seconds). But that’s out of scope for this commit.
2018-11-28 15:39:08 +00:00
ASSET_PATH = 'https://static.notifications.service.gov.uk/'
Updated start scripts to not look up envrionemnt
2016-07-04 17:21:08 +01:00
Run on Paas
2016-12-08 16:50:37 +00:00
class CloudFoundryConfig(Config):
bump utils to 13.1.0 brings in changes to allow logging json to sdout on cloudfoundry boxes
2017-01-09 19:14:04 +00:00
pass
Run on Paas
2016-12-08 16:50:37 +00:00
# CloudFoundry sandbox
class Sandbox(CloudFoundryConfig):
HTTP_PROTOCOL = 'https'
HEADER_COLOUR = '#F499BE' # $baby-pink
CSV_UPLOAD_BUCKET_NAME = 'cf-sandbox-notifications-csv-upload'
Update emails to use logos cdn
2017-07-24 15:20:40 +01:00
LOGO_UPLOAD_BUCKET_NAME = 'cf-sandbox-notifications-logo-upload'
Run on Paas
2016-12-08 16:50:37 +00:00
NOTIFY_ENVIRONMENT = 'sandbox'
Introduce config file for application
2015-11-24 09:40:14 +00:00
configs = {
Updated config to be string based not class based and removed old style live/staging files.
2016-07-05 14:26:02 +01:00
'development': Development,
'test': Test,
'preview': Preview,
'staging': Staging,
Run on Paas
2016-12-08 16:50:37 +00:00
'live': Live,
Add 'production' alias for live environment
2017-03-21 14:44:20 +00:00
'production': Live,
Run on Paas
2016-12-08 16:50:37 +00:00
'sandbox': Sandbox
Introduce config file for application
2015-11-24 09:40:14 +00:00
}
Reference in New Issue Copy Permalink