Initial http reaction

[danielgerlag]

Description

Initial implementation of an Http reaction. This enables the user to craft Http calls that will be invoked when query result set changes occur.

The URL of the request and the payload can be constructed from a handlebars template.

For example, the following configuration will post to https://api.github.com/repos/{{repo}}/issues/{{issue_number}}/comments, where the variables are sourced from the result set item that was added. The JSON body of the request is also constructed using handlebars.

kind: Reaction
apiVersion: v1
name: test-http
spec:
  kind: Http
  properties:
    baseUrl: "https://api.github.com"
    token: xxxx
  queries:
    issue-comments: >
      added:
        url: "/repos/{{after.repo}}/issues/{{after.issue_number}}/comments"
        method: "POST"
        body: > 
          {
            "body": "Hello! @{{after.creator}}"
          }
        headers:
          X-GitHub-Api-Version: "2022-11-28"
      updated: 
            ....
      deleted: 
            ....

Configuration Schema

Reaction-Level configuration

• baseUrl: The base URL to use for all Http requests that will be made. eg. https://api.github.com. Query specific requests will build on this URL by adding a path,
• token (optional): The bearer token to use for authentication.

Per-Query Configuration

The following 3 sections can be included per query

• added (optional): Describes the Http request for items added to the result set.
• updated (optional): Describes the Http request for items updated the result set.
• deleted (optional): Describes the Http request for items deleted from the result set.

Each of these will describe the Http request to make for added, updated, and deleted changes respectively.
The configuration for each of these is as follows:

• url: The path to append to the baseUrl for the request. This can be a handlebars template, where you can merge data from the result set diff. Added results will have an after field that contains an object that is the added item, updated results will have before and after objects, and deleted results will only have a before object. For example: /repos/{{after.repo}}/issues/{{after.issue_number}}/comments
• method: The Http method to use, PUT, POST, GET, DELETE, etc.
• body: The body of the request. This can be a handlebars template, where you can merge data from the result set diff. Added results will have an after field that contains an object that is the added item, updated results will have before and after objects, and deleted results will only have a before object.
• headers: An object containing any additional custom headers to include in the Http request.

What is missing

• Currently, we do not have support for resilience/retry strategies.
• Currently, we only support bearer token auth for the target endpoint.

[amansinghoriginal]

Can you create an issue for this with various config options supported?

[danielgerlag]

Can you create an issue for this with various config options supported?

Added to the PR description.

[amansinghoriginal]

Can you create an issue for this with various config options supported?

Added to the PR description.

Yes, thanks for adding it. Can we please also create issue - as anyways for major changes we require the PR to link to an issue.
An added benefit is that OSS community can easily track what's going on in the project - and we can also create a board from issues - so better tracking?

[danielgerlag]

Can you create an issue for this with various config options supported?

Added to the PR description.

Yes, thanks for adding it. Can we please also create issue - as anyways for major changes we require the PR to link to an issue. An added benefit is that OSS community can easily track what's going on in the project - and we can also create a board from issues - so better tracking?

#260

[amansinghoriginal]

LGTM