Skip to content

Add backend for conversation descriptions #4587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickvergessen merged 13 commits into from
Dec 8, 2020
Merged

Add backend for conversation descriptions #4587

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b64f891
Add description field to conversations
danxuliu Nov 11, 2020
c5cf6be
Add endpoint to set the description of a conversation
danxuliu Nov 11, 2020
e8e4acc
Return description with the rest of the conversation data
danxuliu Nov 12, 2020
38bc918
Add integration test for getting room data when lobby is enabled
danxuliu Nov 12, 2020
d259efd
Add integration tests for getting and setting the room description
danxuliu Nov 13, 2020
f52aa0c
Notify external signaling server when description changes
danxuliu Nov 13, 2020
6b9cca2
Add documentation for the description endpoint
danxuliu Nov 19, 2020
0c1a7bd
Return raw description also when getting the conversation list
danxuliu Nov 19, 2020
803766d
Add support for conversation descriptions to occ commands
danxuliu Nov 19, 2020
2ae3abf
Add integration tests for description in occ commands
danxuliu Nov 19, 2020
d4249ab
Add system message when the description of a conversation is changed
danxuliu Nov 19, 2020
72168dd
Fix typo in scenario names
danxuliu Nov 27, 2020
4667b1a
Increase maximum description length to 500 characters
danxuliu Dec 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Notify external signaling server when description changes 
Signed-off-by: Daniel Calviño Sánchez <[email protected]>
  • Loading branch information
@danxuliu @nickvergessen
danxuliu authored and nickvergessen committed Dec 8, 2020
commit f52aa0cf47f134d50824f0afbecd7374dadb5ba2
9 changes: 8 additions & 1 deletion lib/Room.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,9 +336,10 @@ public function setParticipant(?string $userId, Participant $participant): void
* Return the room properties to send to the signaling server.
*
* @param string $userId
* @param bool $roomModified
* @return array
*/
public function getPropertiesForSignaling(string $userId): array {
public function getPropertiesForSignaling(string $userId, bool $roomModified = true): array {
$properties = [
'name' => $this->getDisplayName($userId),
'type' => $this->getType(),
Expand All @@ -349,6 +350,12 @@ public function getPropertiesForSignaling(string $userId): array {
'sip-enabled' => $this->getSIPEnabled(),
];

if ($roomModified) {
$properties = array_merge($properties, [
'description' => $this->getDescription(),
]);
Comment on lines +354 to +356
Copy link
Member

@nickvergessen nickvergessen Nov 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not changing anything on the signaling?

Copy link
Member Author

@danxuliu danxuliu Nov 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean?

Copy link
Member

@nickvergessen nickvergessen Nov 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is getPropertiesForSignaling but the data is not used in signaling, so we don't need to expose it?

Copy link
Member Author

@danxuliu danxuliu Nov 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new description will be relayed by the signaling server to the clients in the roomlist->update message. Currently we are not using the updated properties from the message, though, but I think it is better to send it for consistency with the rest of the update messages.

}

$event = new SignalingRoomPropertiesEvent($this, $userId, $properties);
$this->dispatcher->dispatch(self::EVENT_BEFORE_SIGNALING_PROPERTIES, $event);
return $event->getProperties();
Expand Down
6 changes: 3 additions & 3 deletions lib/Signaling/BackendNotifier.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public function roomInvited(Room $room, array $users): void {
// TODO(fancycode): We should try to get rid of 'alluserids' and
// find a better way to notify existing users to update the room.
'alluserids' => $this->participantService->getParticipantUserIds($room),
'properties' => $room->getPropertiesForSignaling(''),
'properties' => $room->getPropertiesForSignaling('', false),
],
]);
}
Expand All @@ -180,7 +180,7 @@ public function roomsDisinvited(Room $room, array $userIds): void {
// TODO(fancycode): We should try to get rid of 'alluserids' and
// find a better way to notify existing users to update the room.
'alluserids' => $this->participantService->getParticipantUserIds($room),
'properties' => $room->getPropertiesForSignaling(''),
'properties' => $room->getPropertiesForSignaling('', false),
],
]);
}
Expand All @@ -201,7 +201,7 @@ public function roomSessionsRemoved(Room $room, array $sessionIds): void {
// TODO(fancycode): We should try to get rid of 'alluserids' and
// find a better way to notify existing users to update the room.
'alluserids' => $this->participantService->getParticipantUserIds($room),
'properties' => $room->getPropertiesForSignaling(''),
'properties' => $room->getPropertiesForSignaling('', false),
],
]);
}
Expand Down
1 change: 1 addition & 0 deletions lib/Signaling/Listener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ protected static function registerExternalSignaling(IEventDispatcher $dispatcher
$notifier->roomModified($event->getRoom());
};
$dispatcher->addListener(Room::EVENT_AFTER_NAME_SET, $listener);
$dispatcher->addListener(Room::EVENT_AFTER_DESCRIPTION_SET, $listener);
$dispatcher->addListener(Room::EVENT_AFTER_PASSWORD_SET, $listener);
$dispatcher->addListener(Room::EVENT_AFTER_TYPE_SET, $listener);
$dispatcher->addListener(Room::EVENT_AFTER_READONLY_SET, $listener);
Expand Down
29 changes: 29 additions & 0 deletions tests/php/Signaling/BackendNotifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,30 @@ public function testRoomNameChanged() {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
'read-only' => Room::READ_WRITE,
'active-since' => null,
'sip-enabled' => 0,
],
],
]);
}

public function testRoomDescriptionChanged() {
$room = $this->manager->createRoom(Room::PUBLIC_CALL);
$room->setDescription('The description');

$this->assertMessageWasSent($room, [
'type' => 'update',
'update' => [
'userids' => [
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => 'The description',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
Expand All @@ -327,6 +351,7 @@ public function testRoomPasswordChanged() {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
Expand All @@ -349,6 +374,7 @@ public function testRoomTypeChanged() {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
Expand All @@ -371,6 +397,7 @@ public function testRoomReadOnlyChanged() {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
Expand All @@ -393,6 +420,7 @@ public function testRoomLobbyStateChanged() {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NON_MODERATORS,
'lobby-timer' => null,
Expand Down Expand Up @@ -551,6 +579,7 @@ public function testRoomPropertiesEvent(): void {
],
'properties' => [
'name' => $room->getDisplayName(''),
'description' => '',
'type' => $room->getType(),
'lobby-state' => Webinary::LOBBY_NONE,
'lobby-timer' => null,
Expand Down