pay-selfservice
GOV.UK Pay Self Service admin tool (Node.js)
Prerequisites
- This requires the Pay CLI, which is not publicly available at present.
- You have set up your local development environment
- Clone this repo locally.
Running locally
Start the backend services locally in docker, using the Pay CLI.
pay local launch admin
Generate the environment variables file. This only needs to be done the first time you run locally.
./scripts/generate-dev-environment.sh local
Build the Selfservice app and start it
npm install && npm run compile
npm run start:dev
Open application in browser:
Log output
When using Docker, you can view log out with the following command:
docker logs -f selfservice
Debug using Visual Studio Code
- You need to make sure the app runs locally first using the steps in the Running section.
- In VSCode, go to the
Debugview (on MacOS, use shortcutCMD + shift + D). - From the Run toolbar, select tne launch config
Self Service. - Add breakpoints to any file you want to debug - click in the left hand column and a red dot will appear.
- Press The
green playbutton (F5MacOS):- This will run the app in debug mode.
- Uses
nodemonso it will automatically restart on code changes.
Watching for changes
You shouldn’t need to restart the app to see changes you make.
We use nodemon which watches for changes to files and restarts the node process.
If you’re making changes to client-side JS or Sass files (anything within /browsered/ or /assets/) then running npm run watch-live-reload will watch for changes and recompile. Nodemon does not do anything here as that’s not necessary. If you install the livereload browser plugin then it will refresh your page once the assets have been compiled to the /public folder.
Running tests
To run mocha tests
npm run compile && npm test
Debug tests using Visual Studio Code
IMPORTANT NOTE - some tests do not work in debug mode
- Some integration tests do not work in debug mode. This is because the tests are dependent on other tests running before hand.
- Nevertheless, it is still useful to debug tests that do work in debug mode.
Run tests in debug mode
- In VSCode, go to the
Debugview (on MacOS, use shortcutCMD + shift + D). - From the Run toolbar, select the launch config you want to run:
Mocha All- runs all tests.Mocha Current File- only run currently open test file.
- Add breakpoints to any file you want to debug - click in the left hand column and a red dot will appear.
- Press The
green playbutton orF5.
To run cypress tests
Run in two separate terminals:
-
npm run cypress:serverThis runs both the Cypress server and Mountebank which is the virtualisation server used for stubbing out external API calls.
-
Either:
npm run cypress:testto run headlessnpm run cypress:test-headedto run headednpm run cypress:test-no-watchto run headless with auto-running of tests when the test file is edited turned off
See About Cypress tests in selfservice for more information about running and writing Cypress tests.
Key environment variables
| Variable | required | default value | Description |
|---|---|---|---|
| PORT | X | 9200 | The port number for the express server to be bound at runtime |
| SESSION_ENCRYPTION_KEY | X | Key to be used by the cookie encryption algorithm. Should be a large unguessable string (More Info). | |
| PUBLIC_AUTH_URL | X | The publicauth endpoint to use when API Tokens. | |
| PUBLIC_AUTH_URL | X | The endpoint to connector base URL. | |
| DISABLE_INTERNAL_HTTPS | false/undefined | To switch off generating secure cookies. Set this to true only if you are running self service in a non HTTPS environment. |
|
| HTTP_PROXY_ENABLED | false/undefined | To enable proxying outbound traffic of HTTP(S) requests. If set to true make sure to set the following 3 variables |
|
| HTTP_PROXY | HTTP proxy url | ||
| HTTPS_PROXY | HTTPS proxy url | ||
| NO_PROXY | host:port(s) that need to be by passed by the proxy. Supports comma separated list | ||
| NODE_WORKER_COUNT | 1 | The number of worker threads started by node cluster when run in production mode |
Architecture Decision Records
We use Architecture Decision Records to keep track of the history of software design decisions on this application. Please see docs/arch.
Licence
Vulnerability Disclosure
GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our vulnerability disclosure policy and our security.txt file for details.