213 - Allow to send async response using internal HTTP endpoint

[mmacai]

Description

Added new internal POST endpoint /v1/responses to ack pending reverse proxy request. Added new response_from option http_internal to await ack from mentioned endpoint.

Closes #213

What to look out for

• Check docs and swagger
• Check naming - not sure if http_internal is the best choice, but didn't think about anything better, short and clear enough for everyone
• Check implementation and integration test (decided to put it alongside existing http scenario)
• @chadmott verify if following solution fulfils your needs

You can also test it via:

# terminal 1
config="[{\"id\":\"my-service\",\"version_data\":{\"default\":{\"endpoints\":[{\"id\":\"my-endpoint\",\"method\":\"GET\",\"path\":\"\/http\",\"response_from\":\"http_internal\"}]}},\"proxy\":{\"use_env\":true,\"target_url\":\"API_HOST\",\"port\":3000}}]"
# terminal 1
PROXY_CONFIG_FILE="$config" PROXY_HTTP_RESPONSE_TIMEOUT=30000 mix phx.server
# terminal 2
node examples/api-gateway/service.js
# terminal 3
curl "http://localhost:4000/http"
# terminal 4 - copy&paste correlation ID from terminal 2
curl -X POST "http://localhost:4010/v1/responses" -H "accept: application/json" -H "content-type: application/json" -d "{ \"rig\": { \"correlation\": \"g2dkAA1ub25vZGVAbm9ob3N0AAADpgAAAAAA\" }}"

Process

The goal is to improve not only the code in this PR but also our skills! The "rules":

• The review is considered "done" as soon as all reviewers have added their review, and all their comments have been addressed.
• For knowledge-sharing reviews, each reviewer should "approve" the PR after studying its content.
• After the approval, the merge is concluded by the developer.

Have fun!

[kevinbader]

http_internal => what about http_async?

[mmacai]

http_internal => what about http_async?

Might be, my idea was to avoid sync/async since it might be confusing for people.

[kevinbader]

http_internal => what about http_async?

Might be, my idea was to avoid sync/async since it might be confusing for people.

The problem with http_internal is that "internal" refers to how we're used to call RIG's internal API. But I don't think anybody else would relate. At least with async http we would make a statement that it's http, but not the sync response. Not ideal either, I know, but I still it's better than internal, to be honest.