A server that can be run to test against a mocked API endpoint for web push without relying on flaky browser drivers.
npm install web-push-testingThe idea for this was inspired by see, using, and giving up on https://github.com/GoogleChromeLabs/web-push-testing-service.
web-push-testing can be installed directly via npm. It requires node >=20.0.0:
npm install web-push-testing
Usage
#### Starting the server:
web-push-testing start
#### Stopping the server:
web-push-testing stop
Note: web-push-testing will default to port
Note: Multiple instances will require using a different port
#### Setting the port:
web-push-testing --port 8990 start
#### Get all supported command line arguments:
web-push-testing --help
API
See the documentation under Further Reading in regard to input & output formats.
Additional fields are specified in square brackets.#### Status
- URL:
- Input: No input
- Output:
- Status: 200
- No body#### Subscribe
- URL:
- Input:
- Output:
{
data: PushSubscriptionJSON[+clientHash]
}
#### Expire subscription
- URL:
- Input: None (expect for clientHash in URL)
- Output:
- Status:
- 200 for success
- 400 on error e.g. when subscription does not exist
- Body:
- None for success
- Error return on error#### Send push notification
- URL:
(format: http://localhost:8090/notify/[+clientHash])
- Headers: See e.g. RFC 8291 on required headers
- Input: Encrypted payload
- Output:
- Status:
- 201 for success
- 400 on errors
- 410 on expired subscriptions
- Body
- Error:
`
{
error: { message: err.message }
}
- Expired subscription:
{
reason: 'Push subscription has unsubscribed or expired.',
}
#### Get endpoint notifications
- URL:
- Input:
{"clientHash": "YOUR_CLIENT_HASH"}
- Output:
- Status: 200, 400 on invalid
- Body:
{
"data": {
"messages": [
message1,
message2,
...
]
}
}