refactor, address feedback

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
apache · yadvr · Jun 10, 2024 · Jan 16, 2024 · Feb 12, 2024 · Feb 13, 2024
commit 819eb47c4a630f6a868bc97464139635b43edfac
diff --git a/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java b/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
@@ -209,6 +209,7 @@ public class ApiConstants {
     public static final String HA_PROVIDER = "haprovider";
     public static final String HA_STATE = "hastate";
     public static final String HEALTH = "health";
+    public static final String HEADERS = "headers";
     public static final String HIDE_IP_ADDRESS_USAGE = "hideipaddressusage";
     public static final String HOST_ID = "hostid";
     public static final String HOST_IDS = "hostids";
@@ -1103,8 +1104,8 @@ public class ApiConstants {
 
     public static final String PARAMETER_DESCRIPTION_IS_TAG_A_RULE = "Whether the informed tag is a JS interpretable rule or not.";
 
-    public static final String WEBHOOK_RULE_ID = "webhookruleid";
-    public static final String WEBHOOK_RULE_NAME = "webhookrulename";
+    public static final String WEBHOOK_ID = "webhookid";
+    public static final String WEBHOOK_NAME = "webhookname";
 
     /**
      * This enum specifies IO Drivers, each option controls specific policies on I/O.

diff --git a/engine/schema/src/main/resources/META-INF/db/schema-41900to42000.sql b/engine/schema/src/main/resources/META-INF/db/schema-41900to42000.sql
@@ -56,18 +56,19 @@ CREATE TABLE `cloud`.`webhook` (
   CONSTRAINT `fk_webhook__account_id` FOREIGN KEY (`account_id`) REFERENCES `account`(`id`) ON DELETE CASCADE
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
-DROP TABLE IF EXISTS `cloud`.`webhook_dispatch`;
-CREATE TABLE `cloud`.`webhook_dispatch` (
-  `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the webhook dispatch',
+DROP TABLE IF EXISTS `cloud`.`webhook_delivery`;
+CREATE TABLE `cloud`.`webhook_delivery` (
+  `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'id of the webhook delivery',
   `uuid` varchar(255) COMMENT 'uuid of the webhook',
   `event_id` bigint unsigned NOT NULL COMMENT 'id of the event',
-  `webhook_id` bigint unsigned NOT NULL COMMENT 'id of the webhook rule',
+  `webhook_id` bigint unsigned NOT NULL COMMENT 'id of the webhook',
   `mshost_msid` bigint unsigned NOT NULL COMMENT 'msid of the management server',
-  `payload` TEXT COMMENT 'payload for the webhook dispatch',
-  `success` boolean COMMENT 'webhook dispatch succeeded or not',
-  `response` TEXT COMMENT 'response of the webhook dispatch',
-  `start_time` datetime COMMENT 'start timestamp of the webhook dispatch',
-  `end_time` datetime COMMENT 'end timestamp of the webhook dispatch',
+  `headers` TEXT COMMENT 'headers for the webhook delivery',
+  `payload` TEXT COMMENT 'payload for the webhook delivery',
+  `success` boolean COMMENT 'webhook delivery succeeded or not',
+  `response` TEXT COMMENT 'response of the webhook delivery',
+  `start_time` datetime COMMENT 'start timestamp of the webhook delivery',
+  `end_time` datetime COMMENT 'end timestamp of the webhook delivery',
   PRIMARY KEY(`id`),
   INDEX `i_webhook__event_id`(`event_id`),
   INDEX `i_webhook__webhook_id`(`webhook_id`),

diff --git a/.../db/views/cloud.webhook_dispatch_view.sql → .../db/views/cloud.webhook_delivery_view.sql b/.../db/views/cloud.webhook_dispatch_view.sql → .../db/views/cloud.webhook_delivery_view.sql
@@ -15,18 +15,19 @@
 -- specific language governing permissions and limitations
 -- under the License.
 
--- VIEW `cloud`.`webhook_dispatch_view`;
+-- VIEW `cloud`.`webhook_delivery_view`;
 
-DROP VIEW IF EXISTS `cloud`.`webhook_dispatch_view`;
-CREATE VIEW `cloud`.`webhook_dispatch_view` AS
+DROP VIEW IF EXISTS `cloud`.`webhook_delivery_view`;
+CREATE VIEW `cloud`.`webhook_delivery_view` AS
     SELECT
-        webhook_dispatch.id,
-        webhook_dispatch.uuid,
-        webhook_dispatch.payload,
-        webhook_dispatch.success,
-        webhook_dispatch.response,
-        webhook_dispatch.start_time,
-        webhook_dispatch.end_time,
+        webhook_delivery.id,
+        webhook_delivery.uuid,
+        webhook_delivery.headers,
+        webhook_delivery.payload,
+        webhook_delivery.success,
+        webhook_delivery.response,
+        webhook_delivery.start_time,
+        webhook_delivery.end_time,
         event.id event_id,
         event.uuid event_uuid,
         event.type event_type,
@@ -38,10 +39,10 @@ CREATE VIEW `cloud`.`webhook_dispatch_view` AS
         mshost.msid mshost_msid,
         mshost.name mshost_name
     FROM
-        `cloud`.`webhook_dispatch`
+        `cloud`.`webhook_delivery`
             INNER JOIN
-        `cloud`.`event` ON webhook_dispatch.event_id = event.id
+        `cloud`.`event` ON webhook_delivery.event_id = event.id
             INNER JOIN
-        `cloud`.`webhook` ON webhook_dispatch.webhook_id = webhook.id
+        `cloud`.`webhook` ON webhook_delivery.webhook_id = webhook.id
             LEFT JOIN
-        `cloud`.`mshost` ON mshost.msid = webhook_dispatch.mshost_msid;
+        `cloud`.`mshost` ON mshost.msid = webhook_delivery.mshost_msid;
diff --git a/...e/cloudstack/mom/webhook/WebhookRule.java → ...pache/cloudstack/mom/webhook/Webhook.java b/...e/cloudstack/mom/webhook/WebhookRule.java → ...pache/cloudstack/mom/webhook/Webhook.java
@@ -23,9 +23,9 @@
 import org.apache.cloudstack.api.Identity;
 import org.apache.cloudstack.api.InternalIdentity;
 
-public interface WebhookRule extends ControlledEntity, Identity, InternalIdentity {
-    public static final long ID_DUMMY_RULE = 0L;
-    public static final String NAME_DUMMY_RULE = "Test";
+public interface Webhook extends ControlledEntity, Identity, InternalIdentity {
+    public static final long ID_DUMMY = 0L;
+    public static final String NAME_DUMMY = "Test";
     enum State {
         Enabled, Disabled;
     };

diff --git a/.../event-bus/webhook/src/main/java/org/apache/cloudstack/mom/webhook/WebhookApiService.java b/.../event-bus/webhook/src/main/java/org/apache/cloudstack/mom/webhook/WebhookApiService.java
@@ -18,27 +18,27 @@
 package org.apache.cloudstack.mom.webhook;
 
 import org.apache.cloudstack.api.response.ListResponse;
-import org.apache.cloudstack.mom.webhook.api.command.user.CreateWebhookRuleCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.DeleteWebhookDispatchHistoryCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.DeleteWebhookRuleCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.ListWebhookDispatchHistoryCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.ListWebhookRulesCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.TestWebhookDispatchCmd;
-import org.apache.cloudstack.mom.webhook.api.command.user.UpdateWebhookRuleCmd;
-import org.apache.cloudstack.mom.webhook.api.response.WebhookDispatchResponse;
-import org.apache.cloudstack.mom.webhook.api.response.WebhookRuleResponse;
+import org.apache.cloudstack.mom.webhook.api.command.user.CreateWebhookCmd;
+import org.apache.cloudstack.mom.webhook.api.command.user.DeleteRuleCmd;
+import org.apache.cloudstack.mom.webhook.api.command.user.DeleteWebhookDeliveryCmd;
+import org.apache.cloudstack.mom.webhook.api.command.user.ExecuteWebhookDeliveryCmd;
+import org.apache.cloudstack.mom.webhook.api.command.user.ListWebhookDeliveries;
+import org.apache.cloudstack.mom.webhook.api.command.user.ListWebhooksCmd;
+import org.apache.cloudstack.mom.webhook.api.command.user.UpdateWebhookCmd;
+import org.apache.cloudstack.mom.webhook.api.response.WebhookDeliveryResponse;
+import org.apache.cloudstack.mom.webhook.api.response.WebhookResponse;
 
 import com.cloud.utils.component.PluggableService;
 import com.cloud.utils.exception.CloudRuntimeException;
 
 public interface WebhookApiService extends PluggableService {
 
-    ListResponse<WebhookRuleResponse> listWebhookRules(ListWebhookRulesCmd cmd);
-    WebhookRuleResponse createWebhookRule(CreateWebhookRuleCmd cmd) throws CloudRuntimeException;
-    boolean deleteWebhookRule(DeleteWebhookRuleCmd cmd) throws CloudRuntimeException;
-    WebhookRuleResponse updateWebhookRule(UpdateWebhookRuleCmd cmd) throws CloudRuntimeException;
-    WebhookRuleResponse createWebhookRuleResponse(long webhookRuleId);
-    ListResponse<WebhookDispatchResponse> listWebhookDispatchHistory(ListWebhookDispatchHistoryCmd cmd);
-    boolean deleteWebhookDispatchHistory(DeleteWebhookDispatchHistoryCmd cmd) throws CloudRuntimeException;
-    WebhookDispatchResponse testWebhookDispatch(TestWebhookDispatchCmd cmd) throws CloudRuntimeException;
+    ListResponse<WebhookResponse> listWebhooks(ListWebhooksCmd cmd);
+    WebhookResponse createWebhook(CreateWebhookCmd cmd) throws CloudRuntimeException;
+    boolean deleteWebhook(DeleteRuleCmd cmd) throws CloudRuntimeException;
+    WebhookResponse updateWebhook(UpdateWebhookCmd cmd) throws CloudRuntimeException;
+    WebhookResponse createWebhookResponse(long webhookId);
+    ListResponse<WebhookDeliveryResponse> listWebhookDeliveries(ListWebhookDeliveries cmd);
+    boolean deleteWebhookDelivery(DeleteWebhookDeliveryCmd cmd) throws CloudRuntimeException;
+    WebhookDeliveryResponse executeWebhookDelivery(ExecuteWebhookDeliveryCmd cmd) throws CloudRuntimeException;
 }