Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to this project will be documented in this file.

### UNRELEASED

* feat(events): add support for user-role-changed

### v3.7.0

* feat: handle post_events_[started|ended]
Expand Down
1 change: 1 addition & 0 deletions example/events/mapped-events.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
{"data":{"type":"event","id":"user-emoji-changed","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom","emoji":"none"}},"event":{"ts":1708381148707}}}
{"data":{"type":"event","id":"user-raise-hand-changed","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom","raise-hand":true}},"event":{"ts":1708381149707}}}
{"data":{"type":"event","id":"user-raise-hand-changed","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom","raise-hand":false}},"event":{"ts":1708381150710}}}
{"data":{"type":"event","id":"user-role-changed","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_uxw0dzhtvk0l","external-user-id":"w_uxw0dzhtvk0l","role":"MODERATOR","changed-by":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom"}}},"event":{"ts":1708381151200}}}
{"data":{"type":"event","id":"poll-started","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom"},"poll":{"id":"2be5820127b5f8efc050fa003e83ef53fa62c356-1698771157729/1/1698771266437","question":"ABCD Poll Test","answers":[{"id":0,"key":"A"},{"id":1,"key":"B"},{"id":2,"key":"C"},{"id":3,"key":"D"}]}},"event":{"ts":1708381151711}}}
{"data":{"type":"event","id":"poll-responded","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_xfsb9gxtlfom","external-user-id":"w_xfsb9gxtlfom"},"poll":{"id":"2be5820127b5f8efc050fa003e83ef53fa62c356-1698771157729/1/1698771266437","answerIds":[0]}},"event":{"ts":1708381152712}}}
{"data":{"type":"event","id":"user-left","attributes":{"meeting":{"internal-meeting-id":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","external-meeting-id":"random-9019868"},"user":{"internal-user-id":"w_uxw0dzhtvk0l","external-user-id":"w_uxw0dzhtvk0l","guest":false}},"event":{"ts":1708381153713}}}
Expand Down
1 change: 1 addition & 0 deletions example/events/raw-events.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
{"envelope":{"name":"UserReactionEmojiChangedEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"timestamp":1698771241767},"core":{"header":{"name":"UserReactionEmojiChangedEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"userId":"w_xfsb9gxtlfom","reactionEmoji":"none"}}}
{"envelope":{"name":"UserRaiseHandChangedEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"timestamp":1698771246539},"core":{"header":{"name":"UserRaiseHandChangedEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"userId":"w_xfsb9gxtlfom","raiseHand":true}}}
{"envelope":{"name":"UserRaiseHandChangedEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"timestamp":1698771251455},"core":{"header":{"name":"UserRaiseHandChangedEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"userId":"w_xfsb9gxtlfom","raiseHand":false}}}
{"envelope":{"name":"UserRoleChangedEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_uxw0dzhtvk0l"},"timestamp":1698771256000},"core":{"header":{"name":"UserRoleChangedEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"userId":"w_uxw0dzhtvk0l","role":"MODERATOR","changedBy":"w_xfsb9gxtlfom"}}}
{"envelope":{"name":"PollStartedEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"timestamp":1698771266447},"core":{"header":{"name":"PollStartedEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"userId":"w_xfsb9gxtlfom","pollId":"2be5820127b5f8efc050fa003e83ef53fa62c356-1698771157729/1/1698771266437","pollType":"A-4","secretPoll":false,"question":"ABCD Poll Test","poll":{"id":"2be5820127b5f8efc050fa003e83ef53fa62c356-1698771157729/1/1698771266437","isMultipleResponse":false,"answers":[{"id":0,"key":"A"},{"id":1,"key":"B"},{"id":2,"key":"C"},{"id":3,"key":"D"}]}}}}
{"envelope":{"name":"UserRespondedToPollRespMsg","routing":{"msgType":"DIRECT","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"timestamp":1698771271169},"core":{"header":{"name":"UserRespondedToPollRespMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_xfsb9gxtlfom"},"body":{"pollId":"2be5820127b5f8efc050fa003e83ef53fa62c356-1698771157729/1/1698771266437","userId":"w_uxw0dzhtvk0l","answerIds":[0]}}}
{"envelope":{"name":"UserLeftMeetingEvtMsg","routing":{"msgType":"BROADCAST_TO_MEETING","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_uxw0dzhtvk0l"},"timestamp":1698771293000},"core":{"header":{"name":"UserLeftMeetingEvtMsg","meetingId":"8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700","userId":"w_uxw0dzhtvk0l"},"body":{"intId":"w_uxw0dzhtvk0l","eject":false,"ejectedBy":"","reason":"","reasonCode":""}}}
Expand Down
14 changes: 14 additions & 0 deletions src/process/event-processor.js
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,20 @@ export default class EventProcessor {
case "user-emoji-changed":
this._handleUserEmojiChangedEvent(outputEvent, rawEvent);
break;
case "user-role-changed":
UserMapping.get().updateWithField(
'internalUserID',
outputEvent.data.attributes.user["internal-user-id"], {
user: {
role: outputEvent.data.attributes.user.role,
},
}
).catch((error) => {
Logger.error('error updating user mapping', error);
}).finally(() => {
this._notifyOutputModules(outputEvent, rawEvent);
});
break;
case "meeting-ended":
this._handleMeetingEndedEvent(outputEvent).finally(() => {
this._notifyOutputModules(outputEvent, rawEvent);
Expand Down
19 changes: 19 additions & 0 deletions src/process/event.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ export default class WebhooksEvent {
"not-used"
];

// Messages whose header.userId is the requester, not the affected user
static BODY_USER_ID_EVENTS = [
"UserRoleChangedEvtMsg",
];

static OUTPUT_EVENTS = [
"meeting-created",
"meeting-ended",
Expand All @@ -32,6 +37,7 @@ export default class WebhooksEvent {
"user-presenter-unassigned",
"user-emoji-changed",
"user-raise-hand-changed",
"user-role-changed",
"transcript-updated",
"chat-group-message-sent",
"rap-published",
Expand Down Expand Up @@ -79,6 +85,7 @@ export default class WebhooksEvent {
"UserBroadcastCamStoppedEvtMsg",
"UserEmojiChangedEvtMsg",
"UserReactionEmojiChangedEvtMsg",
"UserRoleChangedEvtMsg",
// 2.7+
"UserRaiseHandChangedEvtMsg",
],
Expand Down Expand Up @@ -202,6 +209,10 @@ export default class WebhooksEvent {
return uid;
}

if (WebhooksEvent.BODY_USER_ID_EVENTS.includes(message?.core?.header?.name)) {
return safeUserId(message?.core?.body?.userId);
}

// Mapped events
return safeUserId(message?.data?.attributes?.user["internal-user-id"])
// Raw messages from BBB
Expand Down Expand Up @@ -404,6 +415,13 @@ export default class WebhooksEvent {
this.outputEvent.data["attributes"]["user"]["raise-hand"] = msgBody.raiseHand;
break;
}
case "user-role-changed": {
this.outputEvent.data["attributes"]["user"]["changed-by"] = {
"internal-user-id": msgBody.changedBy,
"external-user-id": UserMapping.get().getExternalUserID(msgBody.changedBy) || "",
};
break;
}
case "user-joined":
case "user-left": {
const guest = msgBody.guest ?? UserMapping.get().isGuest(userId);
Expand Down Expand Up @@ -669,6 +687,7 @@ export default class WebhooksEvent {
case "UserEmojiChangedEvtMsg":
case "UserReactionEmojiChangedEvtMsg": return 'user-emoji-changed';
case "UserRaiseHandChangedEvtMsg": return "user-raise-hand-changed";
case "UserRoleChangedEvtMsg": return "user-role-changed";
case "TranscriptUpdatedEvtMsg": return "transcript-updated";
case "GroupChatMessageBroadcastEvtMsg": return "chat-group-message-sent";
case "PublishedRecordingSysMsg": return "rap-published";
Expand Down
23 changes: 23 additions & 0 deletions test/webhooks/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -232,5 +232,28 @@ helpers.rawMessagePostEventsEnded = {
external_meeting_id: 'a77f2e5495fb613ec3fe8d86f933f523d73115aaf4c72653341a198f9bafc77a'
}
};
helpers.rawMessageUserRoleChanged = {
envelope: {
name: 'UserRoleChangedEvtMsg',
routing: {
msgType: 'BROADCAST_TO_MEETING',
meetingId: '8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700',
userId: 'w_xfsb9gxtlfom'
},
timestamp: 1698771264638
},
core: {
header: {
name: 'UserRoleChangedEvtMsg',
meetingId: '8043c8452ae9830aac14c517adff3839dbd9228f-1698771157700',
userId: 'w_moderator0001'
},
body: {
userId: 'w_xfsb9gxtlfom',
role: 'VIEWER',
changedBy: 'w_moderator0001'
}
}
};

export default helpers;
101 changes: 101 additions & 0 deletions test/webhooks/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import sinon from 'sinon';
import Utils from '../../src/out/webhooks/utils.js';
import responses from '../../src/out/webhooks/api/responses.js';
import Hook from '../../src/db/redis/hooks.js';
import UserMapping from '../../src/db/redis/user-mapping.js';
import Helpers from './helpers.js'
import HooksPostCatcher from './hooks-post-catcher.js';

Expand Down Expand Up @@ -297,6 +298,106 @@ export default function suite({
})
});

describe('/POST mapped user-role-changed message', () => {
let catcher;

before((done) => {
catcher = new HooksPostCatcher(WH_CONFIG.permanentURLs[1].url);
const hooks = Hook.get().getAllGlobalHooks();
const hook = hooks[0];
Helpers.flushredis(hook);
catcher.start().then(() => {
done();
});
});

// Flushing Redis leaves the in-memory user mapping cache intact
afterEach(() => {
const { changedBy } = Helpers.rawMessageUserRoleChanged.core.body;
return UserMapping.get().removeMapping(changedBy);
});

after((done) => {
const hooks = Hook.get().getAllGlobalHooks();
const hook = hooks[0];
Helpers.flushredis(hook);
catcher.stop();
done();
})

it('should report the affected user and update its stored role', (done) => {
const { body: roleChange } = Helpers.rawMessageUserRoleChanged.core;
const onCallback = (body) => {
try {
const parsed = JSON.parse(body?.event);
const { id, attributes } = parsed[0].data || {};
// user-joined is only delivered after its user mapping is stored
if (id === 'user-joined') {
redisClient.publish(testChannel, JSON.stringify(Helpers.rawMessageUserRoleChanged));
return;
}

catcher.removeListener('callback', onCallback);
const storedUser = UserMapping.get().getUser(roleChange.userId);
if (id === 'user-role-changed'
&& attributes.user['internal-user-id'] === roleChange.userId
&& attributes.user.role === roleChange.role
&& attributes.user['changed-by']?.['internal-user-id'] === roleChange.changedBy
&& attributes.user['changed-by']?.['external-user-id'] === ''
&& storedUser?.role === roleChange.role) {
done();
} else {
done(new Error("incorrectly mapped user-role-changed message: " + body?.event));
}
} catch (error) {
done(error);
}
};

catcher.on('callback', onCallback);
redisClient.publish(testChannel, JSON.stringify(Helpers.rawMessageUserJoined));
})

it('should resolve the external ID of the user who changed the role', (done) => {
const { body: roleChange } = Helpers.rawMessageUserRoleChanged.core;
// extId differs from intId, so echoing the internal ID fails the test
const changerExtId = 'ext-moderator-0001';
const changerJoined = JSON.parse(JSON.stringify(Helpers.rawMessageUserJoined));
changerJoined.envelope.routing.userId = roleChange.changedBy;
changerJoined.core.header.userId = roleChange.changedBy;
changerJoined.core.body.intId = roleChange.changedBy;
changerJoined.core.body.extId = changerExtId;

const onCallback = (body) => {
try {
const { id, attributes } = JSON.parse(body?.event)[0].data || {};
if (id === 'user-joined') {
const next = attributes.user['internal-user-id'] === roleChange.changedBy
? Helpers.rawMessageUserJoined
: Helpers.rawMessageUserRoleChanged;
redisClient.publish(testChannel, JSON.stringify(next));
return;
}

catcher.removeListener('callback', onCallback);
const changedBy = attributes?.user?.['changed-by'];
if (id === 'user-role-changed'
&& changedBy?.['internal-user-id'] === roleChange.changedBy
&& changedBy?.['external-user-id'] === changerExtId) {
done();
} else {
done(new Error("changed-by not resolved: " + body?.event));
}
} catch (error) {
done(error);
}
};

catcher.on('callback', onCallback);
redisClient.publish(testChannel, JSON.stringify(changerJoined));
})
});

describe('/POST raw message', () => {
let catcher;

Expand Down
Loading