feat: Webhook trigger for experiments #265

mahatoankitkumar · 2024-10-16T05:15:59Z

Problem

Webhook trigger for experiments

Solution

Webhook trigger for experiments (Create, Conclude, ramp, update_overrides)

Tenant Config changes

experiments_webhook_config = { "value" = {}, "schema" = { "type" = "object", properties = {"url" = { "type" = "string" }, "method" = { "enum" = ["Post","Put","Get"], "type" = "string" },"headers" = { "type" = "array", "items" = { "type" = "string", "enum" = ["ConfigVersion"] }}, authorization = {"type" = "object", properties = { "key" = { "type" = "string" }, "value" = { "type" = "string" }}}, "required"= ["url", "method", "headers", "authorization"], "additionalProperties" = false}}}

Post-deployment activity

Tenant Config Changes

crates/experimentation_platform/src/api/experiments/helpers.rs

crates/experimentation_platform/src/api/experiments/handlers.rs

crates/service_utils/src/helpers.rs

crates/superposition_macros/src/lib.rs

crates/superposition_types/src/lib.rs

ayushjain17

few sections' review pending

ayushjain17 · 2024-10-18T12:01:00Z

crates/superposition_types/src/result.rs

@@ -119,6 +122,11 @@ impl error::ResponseError for AppError {
                StatusCode::INTERNAL_SERVER_ERROR,
                "Something went wrong",
            ),
+
+            AppError::WebhookError(error) => Self::generate_err_response(
+                StatusCode::from_u16(512).unwrap_or(StatusCode::INTERNAL_SERVER_ERROR),


suggestion:
should we make this StatusCode::from_u16(512) a const using lazy_static ?

crates/superposition_types/src/lib.rs

crates/service_utils/src/helpers.rs

crates/experimentation_platform/src/api/experiments/helpers.rs

ayushjain17 · 2024-10-18T12:11:43Z

crates/experimentation_platform/src/api/experiments/handlers.rs

+        tenant_config.experiments_webhook_config,
+        inserted_experiment,
+        &config_version_id,
+        WebhookEvent::ExperimentCreated,


instead of passing these values from the different places from where it is called, shouldn't we just pass the route to this function, and the value of the WebhookEvent here could be auto inferred via an implementation of
WebhookEvent: From<String>

this it keeps the mapping between the routes and EventName in one single, also helping in avoiding situations wherein the dev might send the wrong value from the place of call, for that particular route

I guess this is fine, it would be an overkill i guess.
if the dev sends wrong value, it will be reviewed.

crates/experimentation_platform/src/api/experiments/handlers.rs

crates/superposition/Superposition.cac.toml

ayushjain17

pending comments plus these as all

crates/superposition_types/src/lib.rs

ayushjain17 · 2024-10-21T08:21:26Z

crates/service_utils/src/helpers.rs

+            let mut header_array = webhook
+                .headers
+                .into_iter()
+                .filter_map(|key| match key {


why do we need to do a filter operation over here ?
this is counter intuitive, webhook.headers, is of type Vec<HeadersEnum>, so it does not make sense to filter here

to avoid repetition of keys in the headers (which headers anyways disregards and keeps only one entry as its a map), you can simply add if checks for each value present in the HeadersEnum which makes the handling of each header explicit, as it is supposed to be different behaviour for each

or this could have simply been a map

But config_version_id is optional, so filter_map

yeah, that why is better to individually do if checks for all the enums

How please explain

crates/service_utils/src/helpers.rs

ayushjain17 · 2024-10-21T08:28:49Z

crates/service_utils/src/helpers.rs

+                        Ok(())
+                    }
+                    _ => {
+                        log::error!("Webhook call failed with status code: {:?}, response headers: {:?}", res.status(), res.headers());


shouldn't we log the response body here, instead of the response headers ?

cc: @Datron

Datron

Looks good, few questions

Datron · 2024-10-22T12:05:34Z

crates/experimentation_platform/src/api/experiments/handlers.rs

+        tenant_config.experiments_webhook_config.enabled,
+        tenant_config.experiments_webhook_config.configuration,


I thought we added enabled to avoid parsing configuration?

But this check would be needed right?

ayushjain17

mostly pending comments

ayushjain17 · 2024-10-22T11:03:47Z

crates/superposition_types/src/lib.rs

+        D: Deserializer<'de>,
+    {
+        #[derive(Deserialize)]
+        struct WebhookConfigHelper {


we dont need these, right ?
the type here is still Option<Webhook>, so this does not help much
wherever this data is to be consumed, you can directly check
if webhook.enabled { webhook.configuration.unwrap() }

Isn't it better to throw proper error than unwraping

ayushjain17 · 2024-10-22T11:05:57Z

crates/superposition_types/src/lib.rs

+            (true, None) => Err(serde::de::Error::custom(
+                "Configuration must be provided when enabled is true",
+            )),
+            (false, Some(_)) => Err(serde::de::Error::custom(


you don't need to have this case, because the .toml schema gives the guarantee that it is supposed to be correct

How will the .toml figure this pattern out?

crates/superposition_types/src/lib.rs

ayushjain17 · 2024-10-22T11:14:31Z

crates/service_utils/src/helpers.rs

+            let mut header_array = webhook
+                .headers
+                .into_iter()
+                .filter_map(|key| match key {


yeah, that why is better to individually do if checks for all the enums

ayushjain17 · 2024-10-22T11:26:39Z

crates/service_utils/src/helpers.rs

+        .filter_map(|key| match key {
+            HeadersEnum::ConfigVersion => {
+                if let Some(config_version) = config_version_opt {
+                    Some(("x-config-version".to_string(), config_version.to_string()))


this is pending: #265 (comment)

please explain with code, i didn't get you here.

crates/service_utils/src/helpers.rs

ayushjain17 · 2024-10-22T11:29:35Z

crates/superposition_types/src/lib.rs

+}
+
+#[derive(Serialize, Deserialize)]
+pub enum WebhookEvent {


if the key is going to be experiments_webhook_config then the Enum name should also be renamed to ExperimentWebhookEvent, as these are not re-usable for cac

Why is this not usable for CAC, the webhook object will be similar, it can be reused. If it can't be reused then it can be renamed then. But now i think this is fine

ayushjain17 · 2024-10-22T11:47:17Z

crates/experimentation_platform/src/api/experiments/handlers.rs

-    let response = ExperimentCreateResponse::from(inserted_experiment);
-
+    let response = ExperimentCreateResponse::from(inserted_experiment.clone());
+    if let (true, Some(experiments_webhook_config)) = (


wont it it be better to abstract it out inside execute_webhook_call itself
as this is being repeated in all the places

cc: @Datron

ayushjain17 · 2024-10-22T12:23:06Z

crates/experimentation_platform/src/api/experiments/handlers.rs

@@ -648,6 +660,29 @@ async fn ramp(
        ))
        .get_result(&mut conn)?;

+    let (_, config_version_id) = fetch_cac_config(&tenant, &data).await?;
+
+    let webhook_event = if new_traffic_percentage == 0


if the new ramp is 0 and previous ramp is not 0, but something else like 10 or 20, in that case it should not be ExperimentStarted

But if the previous ramp is not 0, then the previous experimentStatus won't be CREATED, it would be INPROGRESS

mahatoankitkumar requested a review from a team as a code owner October 16, 2024 05:15

mahatoankitkumar force-pushed the feat/experiment-webhook branch 4 times, most recently from 9e4651e to 0e93efa Compare October 16, 2024 10:27

mahatoankitkumar commented Oct 16, 2024

View reviewed changes

crates/experimentation_platform/src/api/experiments/helpers.rs Show resolved Hide resolved

mahatoankitkumar force-pushed the feat/experiment-webhook branch 2 times, most recently from 9b958f5 to de69732 Compare October 17, 2024 06:47

Datron requested changes Oct 17, 2024

View reviewed changes

ayushjain17 requested changes Oct 18, 2024

View reviewed changes

mahatoankitkumar force-pushed the feat/experiment-webhook branch from de69732 to 2ad138a Compare October 21, 2024 06:52

ayushjain17 requested changes Oct 21, 2024

View reviewed changes

mahatoankitkumar force-pushed the feat/experiment-webhook branch 2 times, most recently from 4752a25 to e2b98fc Compare October 22, 2024 10:57

Datron requested review from Datron and ayushjain17 October 22, 2024 11:58

Datron approved these changes Oct 22, 2024

View reviewed changes

ayushjain17 requested changes Oct 22, 2024

View reviewed changes

mahatoankitkumar force-pushed the feat/experiment-webhook branch 2 times, most recently from 80e79d4 to 5754a6d Compare October 23, 2024 06:28

feat: Webhook trigger for experiments

0dbd476

mahatoankitkumar force-pushed the feat/experiment-webhook branch from 5754a6d to 0dbd476 Compare October 23, 2024 06:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Webhook trigger for experiments #265

feat: Webhook trigger for experiments #265

mahatoankitkumar commented Oct 16, 2024 •

edited

Loading

ayushjain17 left a comment

ayushjain17 Oct 18, 2024

ayushjain17 Oct 18, 2024

mahatoankitkumar Oct 22, 2024 •

edited

Loading

ayushjain17 left a comment

ayushjain17 Oct 21, 2024

mahatoankitkumar Oct 22, 2024 •

edited by ayushjain17

Loading

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 23, 2024

ayushjain17 Oct 21, 2024 •

edited

Loading

mahatoankitkumar Oct 22, 2024

Datron left a comment

Datron Oct 22, 2024

mahatoankitkumar Oct 23, 2024

ayushjain17 left a comment

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 23, 2024

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 22, 2024

ayushjain17 Oct 22, 2024

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 23, 2024

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 23, 2024

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 22, 2024

ayushjain17 Oct 22, 2024

mahatoankitkumar Oct 23, 2024

		tenant_config.experiments_webhook_config.enabled,
		tenant_config.experiments_webhook_config.configuration,

feat: Webhook trigger for experiments #265

Are you sure you want to change the base?

feat: Webhook trigger for experiments #265

Conversation

mahatoankitkumar commented Oct 16, 2024 • edited Loading

Problem

Solution

Tenant Config changes

Post-deployment activity

ayushjain17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mahatoankitkumar Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

ayushjain17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mahatoankitkumar Oct 22, 2024 • edited by ayushjain17 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayushjain17 Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Datron left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayushjain17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mahatoankitkumar commented Oct 16, 2024 •

edited

Loading

mahatoankitkumar Oct 22, 2024 •

edited

Loading

mahatoankitkumar Oct 22, 2024 •

edited by ayushjain17

Loading

ayushjain17 Oct 21, 2024 •

edited

Loading