Documentation for Notification Module #45
Conversation
docs/BEST_PRACTICES.md
Outdated
| with at least 2 running instances at the same time in order to minimize downtime | ||
| possibility. | ||
|
|
||
| It's also recommended to use HTTPS. |
There was a problem hiding this comment.
Maybe lets make bullet point out of every best practice?
| you have to register it in the Adyen Customer Area in order to receive notifications. | ||
|
|
||
| ## Register the endpoint | ||
| 1. Go to your Adyen Customer Area. |
There was a problem hiding this comment.
Link to the Customer Area would be very friendly :)
|
|
||
| There are 2 different types of tests. Don't forget to provide all required environmental variables: | ||
| 1. [Unit tests](../test/unit) - these tests are mocking all external communications. | ||
| 1. [Integration tests](../test/integration) - these tests interacts with real 3rd party systems. |
There was a problem hiding this comment.
A possibility to IT and unit test separately would be nice.
There was a problem hiding this comment.
Created an issue #47
There was a problem hiding this comment.
Only CTP is real integration. Adyen notification is still a mock. Could be a bit confusing for new devs. You should mention it.
There was a problem hiding this comment.
@lojzatran I removed this explanation. I'll assume that a developer knows the difference between unit and integration tests.
|
Please include in deployment guide an info where docker container can be pulled. |
| PORT | port on which the application will run | NO | 443 | ||
|
|
||
| Check out the deployment [Best Practices documentation](../../docs/BEST_PRACTICES.md) | ||
|
|
There was a problem hiding this comment.
Here should be point called Deployment which describes which docker container is to be used and how to start it.
| @@ -0,0 +1,67 @@ | |||
| # Integration of payment into checkout process | |||
There was a problem hiding this comment.
This file should consist out of two main sections: Deployment (Docker, how to run/setup, env), Configuration (Adyen subscription)
Co-Authored-By: LEQADA <LEQADA@users.noreply.github.com>
| LOG_LEVEL | bunyan log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`)| NO | `info` | ||
| PORT | port on which the application will run | NO | 443 | ||
|
|
||
| After setting all variables, execute command `npm run start` to run the module. |
There was a problem hiding this comment.
| After setting all variables, execute command `npm run start` to run the module. | |
| After setting all environment variables, execute command `npm run start` to run the module. |
| - If you accidentally created a subscription you can edit it and uncheck the **Active** checkbox so Adyen doesn't | ||
| send there notifications. Then you can contact the Adyen support and ask them to remove the subscription. | ||
| - Adyen will queue notifications when the notification service was not reachable or it didn't return a success message | ||
| and will try to send it later. |
There was a problem hiding this comment.
Should you also write sth about how you save the notifications, what the fields means and how they can use it? Also that you don't map some notifications and what happens in that case?
There was a problem hiding this comment.
Added a general readme
19d1373
Co-Authored-By: LEQADA <LEQADA@users.noreply.github.com>
… documentation-notification # Conflicts: # notification/docs/IntegrationGuide.md
Co-Authored-By: ahmetoz <bilmuhahmet@gmail.com>
# Conflicts: # README.md
No description provided.