ep_chat_log_join_leave 1.0.2 → 1.0.6

package/.github/workflows/npmpublish.yml

@@ -85,3 +85,7 @@ jobs:
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - name: Add package to etherpad organization
+        run: npm access grant read-write etherpad:developers
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -1,3 +1,5 @@
+![Publish Status](https://github.com/ether/ep_chat_log_join_leave/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/ep_chat_log_join_leave/workflows/Backend%20tests/badge.svg)
+
 # ep_chat_log_join_leave
 
 Etherpad plugin to log user joins and leaves in the chat history.

package/index.js

@@ -7,11 +7,17 @@ const ChatMessage = (() => {
     return null;
   }
 })();
+const assert = require('assert').strict;
 const log4js = require('ep_etherpad-lite/node_modules/log4js');
 const padMessageHandler = require('ep_etherpad-lite/node/handler/PadMessageHandler');
 
 const logger = log4js.getLogger('ep_chat_log_join_leave');
 
+if (ChatMessage == null) {
+  logger.error('This version of Etherpad is unsupported. ' +
+               'Please upgrade to Etherpad v1.8.15 or later to use this plugin.');
+}
+
 /**
  * How long to wait until a disconnected user is declared gone. (Network flakiness could cause a
  * user to briefly disconnect and reconnect. Those shouldn't appear in the chat history.)
@@ -21,56 +27,76 @@ const logger = log4js.getLogger('ep_chat_log_join_leave');
 const timeout = 10000;
 
 /**
- * Maps a pad ID to another map that maps an author ID to null (if the user is currently connected)
- * or to a timeout ID for a timeout that will fire when the user has been gone long enough to inform
- * users (if the user recently disconnected).
- *
- * @type {Map<string, Map<string, number>>}
+ * Maps a {padId, authorId} pair to null (if the user is currently connected) or to an ID for a
+ * timeout that will fire when the recently disconnected user has been gone long enough to inform
+ * users about the departure.
  */
-const activeUsersPerPad = new Map();
+const activeUsers = new class {
+  constructor() {
+    /**
+     * Maps a pad ID to another map that maps an author ID to null or a timeout ID.
+     *
+     * @type {Map<string, Map<string, number>>}
+     */
+    this._users = new Map();
+  }
+
+  has(padId, authorId) {
+    return this._users.has(padId) && this._users.get(padId).has(authorId);
+  }
+
+  get(padId, authorId) {
+    const m = this._users.get(padId);
+    return m && m.get(authorId);
+  }
+
+  set(padId, authorId, value) {
+    if (!this._users.has(padId)) this._users.set(padId, new Map());
+    this._users.get(padId).set(authorId, value);
+  }
+
+  delete(padId, authorId) {
+    const m = this._users.get(padId);
+    if (m == null) return;
+    m.delete(authorId);
+    if (m.size === 0) this._users.delete(padId);
+  }
+}();
 
 exports.eejsBlock_styles = (hookName, context) => {
+  if (ChatMessage == null) return;
   const css = 'ep_chat_log_join_leave/static/css/index.css';
   context.content += `<link href="../static/plugins/${css}" rel="stylesheet">`;
 };
 
 exports.userJoin = async (hookName, {authorId, padId}) => {
-  if (!activeUsersPerPad.has(padId)) activeUsersPerPad.set(padId, new Map());
-  const activeUsers = activeUsersPerPad.get(padId);
-  if (activeUsers.has(authorId)) {
+  if (ChatMessage == null) return;
+  assert.equal(typeof authorId, 'string');
+  assert.equal(typeof padId, 'string');
+  const timeout = activeUsers.get(padId, authorId);
+  if (timeout) {
     clearTimeout(activeUsers.get(authorId));
-  } else if (ChatMessage != null) {
-    // Etherpad >= v1.8.15.
+  } else {
     const msg = new ChatMessage('', authorId, Date.now());
     msg.ep_chat_log_join_leave = 'join';
     await padMessageHandler.sendChatMessageToPadClients(msg, padId);
-  } else {
-    // Etherpad <= v1.8.14.
-    logger.warn('This version of Etherpad does not support custom chat message rendering. ' +
-                'Please upgrade to Etherpad v1.8.15 or later.');
-    const txt = 'joined the pad'; // User must upgrade Etherpad to >= v1.8.15 to localize this.
-    await padMessageHandler.sendChatMessageToPadClients(Date.now(), authorId, txt, padId);
   }
-  activeUsers.set(authorId, null);
+  activeUsers.set(padId, authorId, null);
 };
 
 exports.userLeave = async (hookName, {authorId, padId}) => {
-  // TODO: l10n
-  const activeUsers = activeUsersPerPad.get(padId);
-  clearTimeout(activeUsers.get(authorId));
-  activeUsers.set(authorId, setTimeout(async () => {
-    activeUsers.delete(authorId);
-    if (activeUsers.size === 0) activeUsersPerPad.delete(padId);
+  if (ChatMessage == null) return;
+  // With Etherpad <= v1.8.14, the userLeave event can fire with a nullish padId if the user
+  // disconnected before sending a CLIENT_READY message.
+  if (padId == null) return;
+  assert.equal(typeof authorId, 'string');
+  assert.equal(typeof padId, 'string');
+  clearTimeout(activeUsers.get(padId, authorId));
+  activeUsers.set(padId, authorId, setTimeout(async () => {
+    activeUsers.delete(padId, authorId);
     const when = Date.now() - timeout;
-    if (ChatMessage != null) {
-      // Etherpad >= v1.8.15.
-      const msg = new ChatMessage('', authorId, when);
-      msg.ep_chat_log_join_leave = 'leave';
-      await padMessageHandler.sendChatMessageToPadClients(msg, padId);
-    } else {
-      // Etherpad <= v1.8.14. Warning was logged when the user joined, no need to repeat it.
-      const txt = 'left the pad'; // User must upgrade Etherpad to >= v1.8.15 to localize this.
-      await padMessageHandler.sendChatMessageToPadClients(when, authorId, txt, padId);
-    }
+    const msg = new ChatMessage('', authorId, when);
+    msg.ep_chat_log_join_leave = 'leave';
+    await padMessageHandler.sendChatMessageToPadClients(msg, padId);
   }, timeout));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_chat_log_join_leave",
-  "version": "1.0.2",
+  "version": "1.0.6",
   "description": "Etherpad plugin to log user joins and leaves in the chat history",
   "main": "index.js",
   "scripts": {
@@ -23,14 +23,14 @@
   },
   "homepage": "https://github.com/ether/ep_chat_log_join_leave#readme",
   "devDependencies": {
-    "eslint": "^7.28.0",
-    "eslint-config-etherpad": "^2.0.0",
-    "eslint-plugin-cypress": "^2.11.3",
+    "eslint": "^7.32.0",
+    "eslint-config-etherpad": "^2.0.2",
+    "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-promise": "^5.1.1",
     "eslint-plugin-you-dont-need-lodash-underscore": "^6.12.0"
   },
   "peerDependencies": {

package/static/js/index.js

@@ -8,8 +8,6 @@ const defaultMsg = {
   leave: 'left the pad',
 };
 
-exports.aceEditorCSS = (hookName, context) => ['ep_chat_log_join_leave/static/css/index.css'];
-
 exports.chatNewMessage = async (hookName, context) => {
   if (context.message == null) {
     // Etherpad <= v1.8.14 doesn't support custom message rendering. A warning was logged on the