Interceptors: Migrate CEL and source control interceptors to a separate server #867

dibyom · 2020-12-16T17:32:47Z

The work for this issue is to migrate the core interceptors (minus webhook) to run on their own deployment. The EL will send HTTP requests using the interface specified in TEP-0026.

Part of TEP-0026

Storing the body as `json.RawMessage` can lead to loss of information about spaces in the incoming body when the InterceptorRequest is marshaled as JSON before sending it over HTTP. This is because Go's `json.Marshal` will encode `[]byte` as a base64 string and base64 does not preserve spaces. Adding a custom `MarshalJSON` does not help here since `MarshalJSON` will return a `[]byte` that will then get compacted as base64 by `json.Marshal`. This loss of spaces can be problematic for some use cases. For instance, the GitHub payload signature validation requires us to compare using the exact body as it was sent. Otherwise, the validation fails. Note that this will only be a problem when we marshal the InterceptorRequest i.e. when we move the core interceptors out to its own server. Using a string means that the string will be quoted e.g. `{\"foo\": \"bar\"}`. Go should take care of unquoting it during the unmarshaling process. However, intercetpor authors using a different language will have to manually unquote the string by parsing it as a JSON object. Part of tektoncd#271, tektoncd#867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

The EventListener will forward events over HTTP to the interceptor. Each core interceptor is available at a different path e.g. /cel for CEL. Fixes tektoncd#867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

Storing the body as `json.RawMessage` can lead to loss of information about spaces in the incoming body when the InterceptorRequest is marshaled as JSON before sending it over HTTP. This is because Go's `json.Marshal` will encode `[]byte` as a base64 string and base64 does not preserve spaces. Adding a custom `MarshalJSON` does not help here since `MarshalJSON` will return a `[]byte` that will then get compacted as base64 by `json.Marshal`. This loss of spaces can be problematic for some use cases. For instance, the GitHub payload signature validation requires us to compare using the exact body as it was sent. Otherwise, the validation fails. Note that this will only be a problem when we marshal the InterceptorRequest i.e. when we move the core interceptors out to its own server. Using a string means that the string will be quoted e.g. `{\"foo\": \"bar\"}`. Go should take care of unquoting it during the unmarshaling process. However, intercetpor authors using a different language will have to manually unquote the string by parsing it as a JSON object. Part of tektoncd#271, tektoncd#867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

Storing the body as `json.RawMessage` can lead to loss of information about spaces in the incoming body when the InterceptorRequest is marshaled as JSON before sending it over HTTP. This is because Go's `json.Marshal` will encode `[]byte` as a base64 string and base64 does not preserve spaces. Adding a custom `MarshalJSON` does not help here since `MarshalJSON` will return a `[]byte` that will then get compacted as base64 by `json.Marshal`. This loss of spaces can be problematic for some use cases. For instance, the GitHub payload signature validation requires us to compare using the exact body as it was sent. Otherwise, the validation fails. Note that this will only be a problem when we marshal the InterceptorRequest i.e. when we move the core interceptors out to its own server. Using a string means that the string will be quoted e.g. `{\"foo\": \"bar\"}`. Go should take care of unquoting it during the unmarshaling process. However, intercetpor authors using a different language will have to manually unquote the string by parsing it as a JSON object. Part of #271, #867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

The EventListener will forward events over HTTP to the interceptor. Each core interceptor is available at a different path e.g. /cel for CEL. Fixes tektoncd#867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

The EventListener will forward events over HTTP to the interceptor. Each core interceptor is available at a different path e.g. /cel for CEL. Fixes #867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

The EventListener will forward events over HTTP to the interceptor. Each core interceptor is available at a different path e.g. /cel for CEL. Fixes tektoncd#867 Signed-off-by: Dibyo Mukherjee <dibyo@google.com>

dibyom added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 16, 2020

dibyom added this to the Triggers v0.11 milestone Dec 16, 2020

dibyom self-assigned this Dec 16, 2020

dibyom mentioned this issue Dec 16, 2020

FR: Core Interceptor plugins #271

Closed

dibyom mentioned this issue Dec 22, 2020

Change InterceptorRequest.Body to string #877

Merged

4 tasks

dibyom mentioned this issue Dec 23, 2020

Move core interceptors to their own server #878

Merged

4 tasks

tekton-robot closed this as completed in #878 Jan 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Interceptors: Migrate CEL and source control interceptors to a separate server #867

Interceptors: Migrate CEL and source control interceptors to a separate server #867

dibyom commented Dec 16, 2020

Interceptors: Migrate CEL and source control interceptors to a separate server #867

Interceptors: Migrate CEL and source control interceptors to a separate server #867

Comments

dibyom commented Dec 16, 2020