From c47798abfa6d40e1c20e445d96224cf6c8435f41 Mon Sep 17 00:00:00 2001 From: nkoporec Date: Wed, 27 Nov 2024 16:07:37 +0100 Subject: [PATCH] PROD-31338 - Implement 'group delete' event for the EDA --- .../social_group_flexible_group/asyncapi.yml | 146 +++++++++++++++++- .../social_group_flexible_group.module | 10 ++ .../src/EdaHandler.php | 11 ++ .../tests/src/Unit/EdaHandlerTest.php | 27 ++++ 4 files changed, 193 insertions(+), 1 deletion(-) diff --git a/modules/social_features/social_group/modules/social_group_flexible_group/asyncapi.yml b/modules/social_features/social_group/modules/social_group_flexible_group/asyncapi.yml index dd05043e37e..9ef6f5a1a91 100644 --- a/modules/social_features/social_group/modules/social_group_flexible_group/asyncapi.yml +++ b/modules/social_features/social_group/modules/social_group_flexible_group/asyncapi.yml @@ -564,7 +564,147 @@ channels: type: string format: uri description: Canonical URL for the actor profile - + groupDelete: + address: com.getopensocial.cms.group.delete + messages: + groupDelete: + payload: + allOf: + - $ref: '#/components/schemas/cloudEventsSchema' + - type: object + properties: + data: + type: object + properties: + id: + type: string + description: Unique group ID (UUIDv4) + created: + type: string + format: date-time + description: Creation time of the group + updated: + type: string + format: date-time + description: Last update time of the group + status: + type: string + description: Status of the group (e.g., published or unpublished) + enum: + - published + - unpublished + label: + type: string + description: Label of the group + visibility: + type: object + properties: + type: + type: string + description: The visibility type. + roles: + type: array + description: The list of roles ids. + contentVisibility: + type: object + properties: + method: + type: string + description: Visibility of content + enum: + - public + - community + - group + membership: + type: object + properties: + method: + type: string + description: Method of membership + enum: + - open + - invite + - request + type: + type: string + nullable: true + description: Type of the group (optional) + address: + type: object + properties: + label: + type: string + nullable: true + description: Label for the address (optional) + countryCode: + type: string + nullable: true + description: Country code (optional) + administrativeArea: + type: string + nullable: true + description: Administrative area (optional) + locality: + type: string + nullable: true + description: Locality (optional) + dependentLocality: + type: string + nullable: true + description: Dependent locality (optional) + postalCode: + type: string + nullable: true + description: Postal code (optional) + sortingCode: + type: string + nullable: true + description: Sorting code (optional) + addressLine1: + type: string + nullable: true + description: Address line 1 (optional) + addressLine2: + type: string + nullable: true + description: Address line 2 (optional) + href: + type: object + properties: + canonical: + type: string + format: uri + description: Canonical URL for the group + actor: + type: object + properties: + application: + type: object + nullable: true + properties: + id: + type: string + description: Application ID (UUIDv4) + name: + type: string + description: Name of the application + user: + type: object + nullable: true + properties: + id: + type: string + description: Actor user ID (UUIDv4) + displayName: + type: string + description: Display name of the actor user + href: + type: object + properties: + canonical: + type: string + format: uri + description: Canonical URL for the actor profile operations: onGroupCreate: action: 'receive' @@ -582,3 +722,7 @@ operations: action: 'receive' channel: $ref: '#/channels/groupUpdate' + onGroupDelete: + action: 'receive' + channel: + $ref: '#/channels/groupDelete' diff --git a/modules/social_features/social_group/modules/social_group_flexible_group/social_group_flexible_group.module b/modules/social_features/social_group/modules/social_group_flexible_group/social_group_flexible_group.module index 1b5d19405f9..de8545ebf43 100644 --- a/modules/social_features/social_group/modules/social_group_flexible_group/social_group_flexible_group.module +++ b/modules/social_features/social_group/modules/social_group_flexible_group/social_group_flexible_group.module @@ -373,6 +373,16 @@ function social_group_flexible_group_social_core_group_published(EntityInterface } } +/** + * Implements hook_entity_delete(). + */ +function social_group_flexible_group_entity_delete(EntityInterface $entity): void { + if ($entity instanceof GroupInterface && $entity->bundle() == "flexible_group") { + \Drupal::service('social_group_flexible_group.eda_handler') + ->groupDelete($entity); + } +} + /** * Implements template_preprocess_form_element(). */ diff --git a/modules/social_features/social_group/modules/social_group_flexible_group/src/EdaHandler.php b/modules/social_features/social_group/modules/social_group_flexible_group/src/EdaHandler.php index 54235a98bb6..83d9dfb93f5 100644 --- a/modules/social_features/social_group/modules/social_group_flexible_group/src/EdaHandler.php +++ b/modules/social_features/social_group/modules/social_group_flexible_group/src/EdaHandler.php @@ -142,6 +142,17 @@ public function groupUpdate(GroupInterface $group): void { ); } + /** + * Delete event handler. + */ + public function groupDelete(GroupInterface $group): void { + $this->dispatch( + topic_name: $this->topicName, + event_type: "{$this->namespace}.cms.group.delete", + group: $group + ); + } + /** * Transforms a GroupInterface into a CloudEvent. * diff --git a/modules/social_features/social_group/modules/social_group_flexible_group/tests/src/Unit/EdaHandlerTest.php b/modules/social_features/social_group/modules/social_group_flexible_group/tests/src/Unit/EdaHandlerTest.php index fc37c5b5acc..7b4c3f9eccd 100644 --- a/modules/social_features/social_group/modules/social_group_flexible_group/tests/src/Unit/EdaHandlerTest.php +++ b/modules/social_features/social_group/modules/social_group_flexible_group/tests/src/Unit/EdaHandlerTest.php @@ -392,6 +392,33 @@ public function testGroupUpdate(): void { $this->assertEquals('com.getopensocial.cms.group.update', $group->getType()); } + /** + * Test the groupDelete() method. + * + * @covers ::groupDelete + */ + public function testGroupDelete(): void { + // Create the handler instance. + $handler = $this->getMockedHandler(); + + // Create the group object. + $group = $handler->fromEntity($this->group, 'com.getopensocial.cms.group.delete'); + + // Expect the dispatch method in the dispatcher to be called. + $this->dispatcher->expects($this->once()) + ->method('dispatch') + ->with( + $this->equalTo('com.getopensocial.cms.group.v1'), + $this->equalTo($group) + ); + + // Call the groupDelete method. + $handler->groupDelete($this->group); + + // Assert that the correct group is dispatched. + $this->assertEquals('com.getopensocial.cms.group.delete', $group->getType()); + } + /** * Returns a mocked handler with dependencies injected. *