feat(trigger): support registration and deletion triggers in dashboard (#517)

Signed-off-by: Alioune Gaye <alioune.gaye@secomind.com>

Author: AliouneGaye21

cypress/e2e/trigger_builder.cy.js

@@ -1,6 +1,9 @@
 const triggerConditionToLabel = {
   device_connected: 'Device Connected',
   device_disconnected: 'Device Disconnected',
+  device_registered: 'Device Registered',
+  device_deletion_finished: 'Device Deletion Finished',
+  device_deletion_started: 'Device Deletion Started',
   device_error: 'Device Error',
   device_empty_cache_received: 'Empty Cache Received',
   incoming_data: 'Incoming Data',
@@ -462,6 +465,9 @@ describe('Trigger builder tests', () => {
           expect(labels).to.deep.eq([
             'Device Connected',
             'Device Disconnected',
+            'Device Registered',
+            'Device Deletion Finished',
+            'Device Deletion Started',
             'Device Error',
             'Empty Cache Received',
           ]);

src/DeviceStatusPage/DeviceLiveEventsCard.tsx

@@ -24,6 +24,9 @@ import AstarteClient, {
   AstarteDeviceEvent,
   AstarteDeviceConnectedEvent,
   AstarteDeviceDisconnectedEvent,
+  AstarteDeviceRegistrationEvent,
+  AstarteDeviceDeletionFinishedEvent,
+  AstarteDeviceDeletionStartedEvent,
   AstarteDeviceErrorEvent,
   AstarteDeviceIncomingDataEvent,
   AstarteDeviceUnsetPropertyEvent,
@@ -234,6 +237,39 @@ const astarteDeviceEventBody = (event: AstarteDeviceEvent) => {
       </>
     );
   }
+  if (event instanceof AstarteDeviceRegistrationEvent) {
+    return (
+      <>
+        <Badge bg="success" className="me-2">
+          device registered
+        </Badge>
+        <span>Device registered</span>
+      </>
+    );
+  }
+
+  if (event instanceof AstarteDeviceDeletionStartedEvent) {
+    return (
+      <>
+        <Badge bg="success" className="me-2">
+          device deletion started
+        </Badge>
+        <span>Started Device deletion</span>
+      </>
+    );
+  }
+
+  if (event instanceof AstarteDeviceDeletionFinishedEvent) {
+    return (
+      <>
+        <Badge bg="success" className="me-2">
+          device deletion finished
+        </Badge>
+        <span>Device deleted</span>
+      </>
+    );
+  }
+
   if (event instanceof AstarteDeviceIncomingDataEvent) {
     return (
       <>

src/astarte-client/index.ts

@@ -45,6 +45,9 @@ export {
   AstarteDeviceEvent,
   AstarteDeviceConnectedEvent,
   AstarteDeviceDisconnectedEvent,
+  AstarteDeviceRegistrationEvent,
+  AstarteDeviceDeletionFinishedEvent,
+  AstarteDeviceDeletionStartedEvent,
   AstarteDeviceErrorEvent,
   AstarteDeviceIncomingDataEvent,
   AstarteDeviceUnsetPropertyEvent,

src/astarte-client/models/Trigger/index.ts

@@ -51,7 +51,14 @@ interface AstarteTriggerAMQPActionObject {
 
 interface AstarteSimpleDeviceTriggerObject {
   type: 'device_trigger';
-  on: 'device_disconnected' | 'device_connected' | 'device_error' | 'device_empty_cache_received';
+  on:
+    | 'device_disconnected'
+    | 'device_connected'
+    | 'device_registered'
+    | 'device_deletion_finished'
+    | 'device_deletion_started'
+    | 'device_error'
+    | 'device_empty_cache_received';
   deviceId?: string;
   groupName?: string;
 }
@@ -208,6 +215,9 @@ const astarteSimpleDeviceTriggerObjectSchema: yup.ObjectSchema<AstarteSimpleDevi
         .oneOf([
           'device_disconnected',
           'device_connected',
+          'device_registered',
+          'device_deletion_finished',
+          'device_deletion_started',
           'device_error',
           'device_empty_cache_received',
         ])

src/astarte-client/types/dto/trigger.d.ts

@@ -19,7 +19,14 @@
 
 interface AstarteSimpleDeviceTriggerDTO {
   type: 'device_trigger';
-  on: 'device_disconnected' | 'device_connected' | 'device_error' | 'device_empty_cache_received';
+  on:
+    | 'device_disconnected'
+    | 'device_connected'
+    | 'device_registered'
+    | 'device_deletion_finished'
+    | 'device_deletion_started'
+    | 'device_error'
+    | 'device_empty_cache_received';
   device_id?: string;
   group_name?: string;
 }

src/astarte-client/types/events/AstarteDeviceDeletionStartedEvent.ts

@@ -0,0 +1,27 @@
+import _ from 'lodash';
+import * as yup from 'yup';
+
+import { AstarteDeviceEvent, AstarteDeviceEventDTO } from './AstarteDeviceEvent';
+
+type AstarteDeviceDeletionStartedEventDTO = AstarteDeviceEventDTO & {
+  event: {
+    type: 'device_deletion_started';
+  };
+};
+
+const validationSchema: yup.ObjectSchema<AstarteDeviceDeletionStartedEventDTO['event']> = yup
+  .object({
+    type: yup.string().oneOf(['device_deletion_started']).required(),
+  })
+  .required();
+
+export class AstarteDeviceDeletionStartedEvent extends AstarteDeviceEvent {
+  private constructor(arg: unknown) {
+    super(arg);
+    validationSchema.validateSync(_.get(arg, 'event'));
+  }
+
+  static fromJSON(arg: unknown): AstarteDeviceDeletionStartedEvent {
+    return new AstarteDeviceDeletionStartedEvent(arg);
+  }
+}

src/astarte-client/types/events/AstarteDeviceRegistrationEvent.ts

@@ -0,0 +1,27 @@
+import _ from 'lodash';
+import * as yup from 'yup';
+
+import { AstarteDeviceEvent, AstarteDeviceEventDTO } from './AstarteDeviceEvent';
+
+type AstarteDeviceRegistrationEventDTO = AstarteDeviceEventDTO & {
+  event: {
+    type: 'device_registered';
+  };
+};
+
+const validationSchema: yup.ObjectSchema<AstarteDeviceRegistrationEventDTO['event']> = yup
+  .object({
+    type: yup.string().oneOf(['device_registered']).required(),
+  })
+  .required();
+
+export class AstarteDeviceRegistrationEvent extends AstarteDeviceEvent {
+  private constructor(arg: unknown) {
+    super(arg);
+    validationSchema.validateSync(_.get(arg, 'event'));
+  }
+
+  static fromJSON(arg: unknown): AstarteDeviceRegistrationEvent {
+    return new AstarteDeviceRegistrationEvent(arg);
+  }
+}

src/astarte-client/types/events/AstateDeviceDeletionFinishedEvent.ts

@@ -0,0 +1,27 @@
+import _ from 'lodash';
+import * as yup from 'yup';
+
+import { AstarteDeviceEvent, AstarteDeviceEventDTO } from './AstarteDeviceEvent';
+
+type AstarteDeviceDeletionFinishedEventDTO = AstarteDeviceEventDTO & {
+  event: {
+    type: 'device_deletion_finished';
+  };
+};
+
+const validationSchema: yup.ObjectSchema<AstarteDeviceDeletionFinishedEventDTO['event']> = yup
+  .object({
+    type: yup.string().oneOf(['device_deletion_finished']).required(),
+  })
+  .required();
+
+export class AstarteDeviceDeletionFinishedEvent extends AstarteDeviceEvent {
+  private constructor(arg: unknown) {
+    super(arg);
+    validationSchema.validateSync(_.get(arg, 'event'));
+  }
+
+  static fromJSON(arg: unknown): AstarteDeviceDeletionFinishedEvent {
+    return new AstarteDeviceDeletionFinishedEvent(arg);
+  }
+}

src/astarte-client/types/events/index.ts

@@ -22,6 +22,9 @@ import { AstarteDeviceDisconnectedEvent } from './AstarteDeviceDisconnectedEvent
 import { AstarteDeviceErrorEvent } from './AstarteDeviceErrorEvent';
 import { AstarteDeviceIncomingDataEvent } from './AstarteDeviceIncomingDataEvent';
 import { AstarteDeviceUnsetPropertyEvent } from './AstarteDeviceUnsetPropertyEvent';
+import { AstarteDeviceRegistrationEvent } from './AstarteDeviceRegistrationEvent';
+import { AstarteDeviceDeletionFinishedEvent } from './AstateDeviceDeletionFinishedEvent';
+import { AstarteDeviceDeletionStartedEvent } from './AstarteDeviceDeletionStartedEvent';
 
 function decodeEvent(arg: unknown): AstarteDeviceEvent | null {
   return decodeAnyOf(
@@ -31,6 +34,9 @@ function decodeEvent(arg: unknown): AstarteDeviceEvent | null {
       AstarteDeviceErrorEvent.fromJSON,
       AstarteDeviceUnsetPropertyEvent.fromJSON,
       AstarteDeviceIncomingDataEvent.fromJSON,
+      AstarteDeviceRegistrationEvent.fromJSON,
+      AstarteDeviceDeletionFinishedEvent.fromJSON,
+      AstarteDeviceDeletionStartedEvent.fromJSON,
     ],
     arg,
   );
@@ -56,6 +62,9 @@ export {
   AstarteDeviceEvent,
   AstarteDeviceConnectedEvent,
   AstarteDeviceDisconnectedEvent,
+  AstarteDeviceRegistrationEvent,
+  AstarteDeviceDeletionFinishedEvent,
+  AstarteDeviceDeletionStartedEvent,
   AstarteDeviceErrorEvent,
   AstarteDeviceIncomingDataEvent,
   AstarteDeviceUnsetPropertyEvent,

src/components/TriggerEditor/SimpleTriggerForm.tsx

@@ -30,6 +30,9 @@ import _ from 'lodash';
 const triggerConditionToLabel = {
   device_disconnected: 'Device Disconnected',
   device_connected: 'Device Connected',
+  device_registered: 'Device Registered',
+  device_deletion_finished: 'Device Deletion Finished',
+  device_deletion_started: 'Device Deletion Started',
   device_error: 'Device Error',
   device_empty_cache_received: 'Empty Cache Received',
   incoming_data: 'Incoming Data',
@@ -99,30 +102,39 @@ const SimpleTriggerForm = ({
 }: SimpleTriggerFormProps): React.ReactElement => {
   const endpointList =
     simpleTriggerInterface?.mappings.map((mapping: AstarteMapping) => mapping.endpoint) || [];
+
   const isDeviceTrigger = _.get(simpleTrigger, 'type') === 'device_trigger';
   const isDataTrigger = _.get(simpleTrigger, 'type') === 'data_trigger';
   const hasTargetDevice = _.get(simpleTrigger, 'deviceId') != null;
   const hasTargetGroup = _.get(simpleTrigger, 'groupName') != null;
+
   // eslint-disable-next-line no-nested-ternary
   const triggerTargetType = hasTargetDevice ? 'device' : hasTargetGroup ? 'group' : 'all_devices';
+
   const triggerInterfaceName = _.get(simpleTrigger, 'interfaceName') as string | undefined;
   const hasSelectedInterface = triggerInterfaceName != null && triggerInterfaceName !== '*';
+
   const triggerValueMatchOperator: AstarteSimpleDataTrigger['valueMatchOperator'] | undefined =
     _.get(simpleTrigger, 'valueMatchOperator');
+
   const hasSelectedOperator =
     triggerValueMatchOperator != null && triggerValueMatchOperator !== '*';
+
   const triggerMatchPath: AstarteSimpleDataTrigger['matchPath'] | undefined = _.get(
     simpleTrigger,
     'matchPath',
   );
+
   const triggerInterfaceType = useMemo(
     () => (simpleTriggerInterface ? simpleTriggerInterface.type : null),
     [simpleTriggerInterface],
   );
+
   const triggerInterfaceAggregation = useMemo(
     () => (simpleTriggerInterface ? simpleTriggerInterface.aggregation : null),
     [simpleTriggerInterface],
   );
+
   const triggerInterfacePathType = useMemo(() => {
     if (!simpleTriggerInterface || !triggerMatchPath) {
       return null;
@@ -291,6 +303,9 @@ const SimpleTriggerForm = ({
       options = [
         'device_connected',
         'device_disconnected',
+        'device_registered',
+        'device_deletion_finished',
+        'device_deletion_started',
         'device_error',
         'device_empty_cache_received',
       ];