notifications-node-client 5.1.0 → 5.1.2

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 5.1.2 - 2022-09-23
+
+Remove underscore.js dependency
+
+## 5.1.1 - 2022-01-18
+
+Upgrade axios version from ^0.21.1 to ^0.25.0
+
 ## 5.1.0 - 2020-12-30
 
 ### Changed

package/CONTRIBUTING.md

@@ -2,52 +2,58 @@
 
 Pull requests welcome.
 
-## Working on the client locally
+## Setting Up
 
-`npm install --save notifications-node-client`
+### Docker container
 
-## Tests
+This app uses dependencies that are difficult to install locally. In order to make local development easy, we run app commands through a Docker container. Run the following to set this up:
 
-There are unit and integration tests that can be run to test functionality of the client.
+```shell
+make bootstrap-with-docker
+```
 
-To run the unit tests:
+### `environment.sh`
+
+In the root directory of the repo, run:
+
+```
+notify-pass credentials/client-integration-tests > environment.sh
+```
+
+Unless you're part of the GOV.UK Notify team, you won't be able to run this command or the Integration Tests. However, the file still needs to exist - run `touch environment.sh` instead.
+
+## Tests
 
-`make test`
+There are unit and integration tests that can be run to test functionality of the client.
 
-## Integration Tests
+### Unit tests
 
-Before running the integration tests, please ensure that the environment variables are set up.
+To run the unit tests:
 
 ```
-export NOTIFY_API_URL="https://example.notify-api.url"
-export API_KEY="example_API_test_key"
-export FUNCTIONAL_TEST_NUMBER="valid mobile number"
-export FUNCTIONAL_TEST_EMAIL="valid email address"
-export EMAIL_TEMPLATE_ID="valid email_template_id"
-export SMS_TEMPLATE_ID="valid sms_template_id"
-export LETTER_TEMPLATE_ID="valid letter_template_id"
-export EMAIL_REPLY_TO_ID="valid email reply to id"
-export SMS_SENDER_ID="valid sms_sender_id - to test sending to a receiving number, so needs to be a valid number"
-export API_SENDING_KEY="API_team_key for sending a SMS to a receiving number"
-export INBOUND_SMS_QUERY_KEY="API_test_key to get received text messages - leave blank for local development as cannot test locally"
+make test-with-docker
 ```
 
+### Integration Tests
 
 To run the integration tests:
 
-`make integration-test`
-
-The integration tests are used to test the contract of the response to all the api calls, ensuring the latest version of notifications-api do not break the contract of the notifications-node-client.
+```
+make integration-test-with-docker
+```
 
-## Testing JavaScript examples in Markdown
+## Working on the client locally
 
-We automatically test that the JavaScript in the documentation examples matched [our linting standards](https://gds-way.cloudapps.digital/manuals/programming-languages/nodejs/#source-formatting-and-linting),
-this also catches some issues that could stop an example from running when copied.
+```
+npm install --save notifications-node-client
+```
 
-To test the JavaScript for syntax and linting errors run:
+## Testing JavaScript examples in Markdown
 
-`make markdown-standard-test`
+We automatically test that the JavaScript in the documentation examples matches [our linting standards](https://gds-way.cloudapps.digital/manuals/programming-languages/nodejs/#source-formatting-and-linting). This also catches some issues that could stop an example from running when copied.
 
-You can then fix some issues automatically by running:
+You can fix issues automatically by running:
 
-`make markdown-standard-test-fix`
+```
+npm run test:markdown:standard -- --fix
+```

package/DOCUMENTATION.md

@@ -289,6 +289,8 @@ If the request is not successful, the promise fails with an `err`.
 
 To send a file by email, add a placeholder to the template then upload a file. The placeholder will contain a secure link to download the file.
 
+The file will be available for the recipient to download for 18 months.
+
 The links are unique and unguessable. GOV.UK Notify cannot access or decrypt your file.
 
 #### Add contact details to the file download page
@@ -309,7 +311,7 @@ The links are unique and unguessable. GOV.UK Notify cannot access or decrypt you
 
 #### Upload your file
 
-You can upload PDF, CSV, .odt, .txt, .rtf and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
+You can upload PDF, CSV, .odt, .txt, .rtf, .xlsx and MS Word Document files. Your file must be smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
 
 Pass the file object as a value into the `personalisation` argument. For example:
 
@@ -382,9 +384,10 @@ If the request is not successful, the promise fails with an `err`.
 |:---|:---|:---|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`}]`|Use the correct type of [API key](#api-keys)|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
-|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Unsupported file type '(FILE TYPE)'. Supported types are: '(ALLOWED TYPES)'"`<br>`}]`|Wrong file type. You can only upload .pdf, .csv, .txt, .doc, .docx, .rtf or .odt files|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Unsupported file type '(FILE TYPE)'. Supported types are: '(ALLOWED TYPES)'"`<br>`}]`|Wrong file type. You can only upload .pdf, .csv, .txt, .doc, .docx, .xlsx, .rtf or .odt files|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "File did not pass the virus scan"`<br>`}]`|The file contains a virus|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Send files by email has not been set up - add contact details for your service at https://www.notifications.service.gov.uk/services/(SERVICE ID)/service-settings/send-files-by-email"`<br>`}]`|See how to [add contact details to the file download page](#add-contact-details-to-the-file-download-page)|
+|`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Can only send a file by email"`<br>`}]`|Make sure you are using an email template|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
 |`429`|`[{`<br>`"error": "RateLimitError",`<br>`"message": "Exceeded rate limit for key type TEAM/TEST/LIVE of 3000 requests per 60 seconds"`<br>`}]`|Refer to [API rate limits](#rate-limits) for more information|
@@ -592,48 +595,11 @@ If the request is not successful, the promise fails with an `err`.
 
 ## Get message status
 
-Message status depends on the type of message you have sent.
-
-You can only get the status of messages that are 7 days old or newer.
-
-### Status - email
-
-|Status|Information|
-|:---|:---|
-|Created|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
-|Sending|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
-|Delivered|The message was successfully delivered.|
-|Failed|This covers all failure statuses:<br>- `permanent-failure` - "The provider could not deliver the message because the email address was wrong. You should remove these email addresses from your database."<br>- `temporary-failure` - "The provider could not deliver the message. This can happen when the recipient’s inbox is full. You can try to send the message again."<br>- `technical-failure` - "Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again."|
-
-### Status - text message
-
-|Status|Information|
-|:---|:---|
-|Created|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
-|Sending|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
-|Pending|GOV.UK Notify is waiting for more delivery information.<br>GOV.UK Notify received a callback from the provider but the recipient’s device has not yet responded. Another callback from the provider determines the final status of the notification.|
-|Sent / Sent internationally|The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify client API returns this status as `sent`. The GOV.UK Notify client app returns this status as `Sent to an international number`.|
-|Delivered|The message was successfully delivered.|
-|Failed|This covers all failure statuses:<br>- `permanent-failure` - "The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should [contact GOV.UK Notify support](https://www.notifications.service.gov.uk/support). If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered."<br>- `temporary-failure` - "The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages."<br>- `technical-failure` - "Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure."|
-
-### Status - letter
-
-|Status|information|
-|:---|:---|
-|Failed|The only failure status that applies to letters is `technical-failure`. GOV.UK Notify had an unexpected error while sending to our printing provider.|
-|Accepted|GOV.UK Notify has sent the letter to the provider to be printed.|
-|Received|The provider has printed and dispatched the letter.|
-
-### Status - precompiled letter
-
-|Status|information|
-|:---|:---|
-|Pending virus check|GOV.UK Notify has not completed a virus scan of the precompiled letter file.|
-|Virus scan failed|GOV.UK Notify found a potential virus in the precompiled letter file.|
-|Validation failed|Content in the precompiled letter file is outside the printable area. [See the GOV.UK Notify letter specification](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information. |
 
 ### Get the status of one message
 
+You can only get the status of messages sent within the retention period. The default retention period is 7 days.
+
 #### Method
 
 ```javascript
@@ -734,10 +700,10 @@ You can pass in empty arguments or `null` to ignore these filters.
 
 You can filter by each:
 
-* [email status](#status-email)
-* [text message status](#status-text-message)
-* [letter status](#status-letter)
-* [precompiled letter status](#status-precompiled-letter)
+* [email status](#email-status-descriptions)
+* [text message status](#text-message-status-descriptions)
+* [letter status](#letter-status-descriptions)
+* [precompiled letter status](#precompiled-letter-status-descriptions)
 
 You can leave out this argument to ignore this filter.
 
@@ -818,6 +784,52 @@ If the request is not successful, the promise fails with an `err`.
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: API key not found"`<br>`}]`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
 
+### Email status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`created`|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
+|#`sending`|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
+|#`delivered`|The message was successfully delivered.|
+|#`permanent-failure`|The provider could not deliver the message because the email address was wrong. You should remove these email addresses from your database.|
+|#`temporary-failure`|The provider could not deliver the message. This can happen when the recipient’s inbox is full or their anti-spam filter rejects your email. [Check your content does not look like spam](https://www.gov.uk/service-manual/design/sending-emails-and-text-messages#protect-your-users-from-spam-and-phishing) before you try to send the message again.|
+|#`technical-failure`|Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again.|
+
+### Text message status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`created`|GOV.UK Notify has placed the message in a queue, ready to be sent to the provider. It should only remain in this state for a few seconds.|
+|#`sending`|GOV.UK Notify has sent the message to the provider. The provider will try to deliver the message to the recipient for up to 72 hours. GOV.UK Notify is waiting for delivery information.|
+|#`pending`|GOV.UK Notify is waiting for more delivery information.<br>GOV.UK Notify received a callback from the provider but the recipient’s device has not yet responded. Another callback from the provider determines the final status of the text message.|
+|#`sent`|The message was sent to an international number. The mobile networks in some countries do not provide any more delivery information. The GOV.UK Notify website displays this status as 'Sent to an international number'.|
+|#`delivered`|The message was successfully delivered.|
+|#`permanent-failure`|The provider could not deliver the message. This can happen if the phone number was wrong or if the network operator rejects the message. If you’re sure that these phone numbers are correct, you should [contact GOV.UK Notify support](https://www.notifications.service.gov.uk/support). If not, you should remove them from your database. You’ll still be charged for text messages that cannot be delivered.
+|#`temporary-failure`|The provider could not deliver the message. This can happen when the recipient’s phone is off, has no signal, or their text message inbox is full. You can try to send the message again. You’ll still be charged for text messages to phones that are not accepting messages.|
+|#`technical-failure`|Your message was not sent because there was a problem between Notify and the provider.<br>You’ll have to try sending your messages again. You will not be charged for text messages that are affected by a technical failure.|
+
+### Letter status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.|
+|#`received`|The provider has printed and dispatched the letter.|
+|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.|
+|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.|
+|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.|
+
+### Precompiled letter status descriptions
+
+|Status|Description|
+|:---|:---|
+|#`accepted`|GOV.UK Notify has sent the letter to the provider to be printed.|
+|#`received`|The provider has printed and dispatched the letter.|
+|#`cancelled`|Sending cancelled. The letter will not be printed or dispatched.|
+|#`pending-virus-check`|GOV.UK Notify has not completed a virus scan of the precompiled letter file.|
+|#`virus-scan-failed`|GOV.UK Notify found a potential virus in the precompiled letter file.|
+|#`validation-failed`|Content in the precompiled letter file is outside the printable area. See the [GOV.UK Notify letter specification](https://www.notifications.service.gov.uk/using-notify/guidance/letter-specification) for more information.|
+|#`technical-failure`|GOV.UK Notify had an unexpected error while sending the letter to our printing provider.|
+|#`permanent-failure`|The provider cannot print the letter. Your letter will not be dispatched.|
 
 ### Get a PDF for a letter notification
 

package/Makefile

@@ -1,22 +1,16 @@
 .DEFAULT_GOAL := help
 SHELL := /bin/bash
 
-DOCKER_BUILDER_IMAGE_NAME = govuk/notify-nodejs-client-runner
-
-BUILD_TAG ?= notifications-nodejs-client-manual
-
-DOCKER_CONTAINER_PREFIX = ${USER}-${BUILD_TAG}
-
 .PHONY: help
 help:
 	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: dependencies
-dependencies:  ## Install build dependencies
-	npm install
+.PHONY: bootstrap
+bootstrap:  ## Install build dependencies
+	npm ci
 
 .PHONY: build
-build: dependencies ## Build project
+build: bootstrap ## Build project (dummy task for CI)
 
 .PHONY: test
 test: ## Run tests
@@ -26,70 +20,22 @@ test: ## Run tests
 integration-test: ## Run integration tests
 	npm test --integration
 
-.PHONY: markdown-standard-test
-markdown-standard-test: ## Run linting on JavaScript examples in markdown using StandardJS
-	npm run test:markdown:standard
-
-.PHONY: markdown-standard-test-fix
-markdown-standard-test-fix: ## Fix errors found from linting
-	npm run test:markdown:standard -- --fix
-
-.PHONY: generate-env-file
-generate-env-file: ## Generate the environment file for running the tests inside a Docker container
-	script/generate_docker_env.sh
-
-.PHONY: prepare-docker-runner-image
-prepare-docker-runner-image: ## Prepare the Docker builder image
-	make -C docker build
-
-.PHONY: build-with-docker
-build-with-docker: prepare-docker-runner-image ## Build inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-build" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make build
+.PHONY: bootstrap-with-docker
+bootstrap-with-docker: ## Prepare the Docker builder image
+	docker build -t notifications-node-client .
+	./scripts/run_with_docker.sh make bootstrap
 
 .PHONY: test-with-docker
-test-with-docker: prepare-docker-runner-image generate-env-file ## Run tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-test" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make test
+test-with-docker: ## Run tests inside a Docker container
+	./scripts/run_with_docker.sh make test
 
 .PHONY: integration-test-with-docker
-integration-test-with-docker: prepare-docker-runner-image generate-env-file ## Run integration tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-integration-test" \
-		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make integration-test
+integration-test-with-docker: ## Run integration tests inside a Docker container
+	./scripts/run_with_docker.sh make integration-test
 
 .PHONY: get-client-version
 get-client-version: ## Retrieve client version number from source code
 	@node -p "require('./package.json').version"
 
-.PHONY: clean-docker-containers
-clean-docker-containers: ## Clean up any remaining docker containers
-	docker rm -f $(shell docker ps -q -f "name=${DOCKER_CONTAINER_PREFIX}") 2> /dev/null || true
-
 clean:
 	rm -rf .cache venv

package/client/api_client.js

@@ -1,5 +1,4 @@
 var restClient = require('axios').default,
-    _ = require('underscore'),
     createGovukNotifyToken = require('../client/authentication.js'),
     notifyProductionAPI = 'https://api.notifications.service.gov.uk',
     version = require('../package.json').version;
@@ -56,7 +55,7 @@ function createToken(requestMethod, requestPath, apiKeyId, serviceId) {
   return createGovukNotifyToken(requestMethod, requestPath, apiKeyId, serviceId);
 }
 
-_.extend(ApiClient.prototype, {
+Object.assign(ApiClient.prototype, {
 
   /**
    *
@@ -73,7 +72,7 @@ _.extend(ApiClient.prototype, {
         'User-Agent': 'NOTIFY-API-NODE-CLIENT/' + version
       }
     };
-    _.extend(options, additionalOptions)
+    Object.assign(options, additionalOptions)
     if(this.proxy !== null) options.proxy = this.proxy;
 
     return restClient(options);

package/client/notification.js

@@ -1,5 +1,4 @@
-var ApiClient = require('./api_client'),
-  _ = require('underscore');
+var ApiClient = require('./api_client');
 
 /**
  *
@@ -119,7 +118,7 @@ function _check_and_encode_file(file, size_limit) {
   return file.toString('base64')
 }
 
-_.extend(NotifyClient.prototype, {
+Object.assign(NotifyClient.prototype, {
   /**
    * Usage:
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notifications-node-client",
-  "version": "5.1.0",
+  "version": "5.1.2",
   "homepage": "https://docs.notifications.service.gov.uk/node.html",
   "repository": {
     "type": "git",
@@ -17,8 +17,7 @@
   "license": "MIT",
   "dependencies": {
     "jsonwebtoken": "^8.2.1",
-    "axios": "^0.21.1",
-    "underscore": "^1.9.0"
+    "axios": "^0.25.0"
   },
   "devDependencies": {
     "chai": "4.1.2",

package/scripts/run_with_docker.sh

@@ -0,0 +1,21 @@
+DOCKER_IMAGE_NAME=notifications-node-client
+
+source environment.sh
+
+docker run \
+  --rm \
+  -v "`pwd`:/var/project" \
+  -e NOTIFY_API_URL=${NOTIFY_API_URL} \
+  -e API_KEY=${API_KEY} \
+  -e FUNCTIONAL_TEST_NUMBER=${FUNCTIONAL_TEST_NUMBER} \
+  -e FUNCTIONAL_TEST_EMAIL=${FUNCTIONAL_TEST_EMAIL} \
+  -e EMAIL_TEMPLATE_ID=${EMAIL_TEMPLATE_ID} \
+  -e SMS_TEMPLATE_ID=${SMS_TEMPLATE_ID} \
+  -e LETTER_TEMPLATE_ID=${LETTER_TEMPLATE_ID} \
+  -e EMAIL_REPLY_TO_ID=${EMAIL_REPLY_TO_ID} \
+  -e SMS_SENDER_ID=${SMS_SENDER_ID} \
+  -e API_SENDING_KEY=${API_SENDING_KEY} \
+  -e INBOUND_SMS_QUERY_KEY=${INBOUND_SMS_QUERY_KEY} \
+  -it \
+  ${DOCKER_IMAGE_NAME} \
+  ${@}

package/.npmignore

@@ -1,6 +0,0 @@
-node_modules
-.idea/
-environment.sh
-package-lock.json
-.eslintrc.js
-docker.env

package/script/generate_docker_env.sh

@@ -1,28 +0,0 @@
-#!/usr/bin/env bash
-
-set -eo pipefail
-
-function exit_with_msg {
-    echo $1
-    exit $2
-}
-
-echo -n "" > docker.env
-
-env_vars=(
-    NOTIFY_API_URL
-    API_KEY
-    FUNCTIONAL_TEST_EMAIL
-    FUNCTIONAL_TEST_NUMBER
-    EMAIL_TEMPLATE_ID
-    LETTER_TEMPLATE_ID
-    SMS_TEMPLATE_ID
-    EMAIL_REPLY_TO_ID
-    SMS_SENDER_ID
-    API_SENDING_KEY
-    INBOUND_SMS_QUERY_KEY
-)
-
-for env_var in "${env_vars[@]}"; do
-    echo "${env_var}=${!env_var}" >> docker.env
-done