fix: missing institution fields from feedbacks

Institution fields are missing for feedbacks other than the first one
submitted in a session. That is caused by cleaning session info from
Redis earlier than necessary (after the first feedback for a meeting is
submitted).

Only clear Redis info for a session once the session ends via a
meeting-ended webhook event. This fix includes a refactor in the Redis
cleanup util so that user/session entries can be removed separately.

Author: prlanzarin

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+### UNRELEASED
+
+* fix: missing institution fields from feedbacks
+
 ### v1.7.0
 
 * feat: add support for 'ask_for_feedback_on_logout' parameter

backend/server.js

@@ -182,6 +182,11 @@ app.post('/feedback/webhook', async (req, res) => {
             `${KEY_PREFIX}:session:${meeting['internal-meeting-id']}`,
             sessionData,
           );
+        } else if (eventType === 'meeting-ended') {
+          const meeting = evt.data.attributes.meeting;
+          const sessionId = meeting['internal-meeting-id'];
+
+          await Utils.redisStaleKeysCleanup(redisClient, sessionId);
         } else if (eventType === 'user-joined') {
           const user = evt.data.attributes.user;
           const userRedirectUrl = user.userdata?.['bbb_feedback_redirect_url'];
@@ -306,11 +311,11 @@ app.post('/feedback/submit', async (req, res) => {
       logger.debug('No FEEDBACK_URL set, logging feedback to syslog only.');
     }
 
-    await Utils.redisStaleKeysCleanup(redisClient, user.userId, session.sessionId);
+    await Utils.redisStaleKeysCleanup(redisClient, user.userId);
     res.json({ status: 'success', data: completeFeedback });
   } catch (error) {
     logger.error('Error submitting feedback:', error);
-    await Utils.redisStaleKeysCleanup(redisClient, user.userId, session.sessionId);
+    await Utils.redisStaleKeysCleanup(redisClient, user.userId);
     res.status(500).send();
   }
 });

backend/utils.js

@@ -183,18 +183,20 @@ const hSetWithExpiration = async (redisClient, key, field, expire_seconds=REDIS_
 }
 
 /**
- * redisStaleKeysCleanup - Removes keys from the hash table for that given userId and sessionId.
+ * redisStaleKeysCleanup - Removes keys from the hash table for a given keyId.
  * @param {import("redis").RedisClientType} redisClient - A connected Redis client instance
- * @param {string} userId - the userId present on the stale keys to be removed
- * @param {string} sessionId  - the sessionId on the stale keys to be removed
+ * @param {string} keyId - The keyId to be removed. A keyId is a unique identifier
+ *                         present at the end of keys (e.g. `feedback:<key>:<keyId>`).
  */
-const redisStaleKeysCleanup = async (redisClient, userId, sessionId) => {
+const redisStaleKeysCleanup = async (redisClient, keyId) => {
+  if (!keyId) return;
+
   const { keysToDelete, keysToKeep } = activeKeys.reduce((acc, key) => {
-    // searches for the keys containing userId or sessionId 
+    // searches for the keys containing the keyId
     // Keys have the following format:
-    // - feedback:session:<sessionId>
-    // - feedback:user:<userId>
-    if (key.includes(userId) || key.includes(sessionId)) {
+    // - feedback:session:<keyId>
+    // - feedback:user:<keyId>
+    if (key.includes(keyId)) {
       acc.keysToDelete.push(key);
     } else {
       acc.keysToKeep.push(key);
@@ -215,4 +217,4 @@ export default {
   sortBy,
   hSetWithExpiration,
   redisStaleKeysCleanup,
-};
+};