ep_chat_log_join_leave 1.0.47 → 1.0.48

package/.github/workflows/backend-tests.yml

@@ -26,6 +26,10 @@ jobs:
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
+      - uses: actions/setup-node@v4
+        name: Install Node.js
+        with:
+          node-version: 22
       - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:

package/.github/workflows/frontend-tests.yml

@@ -15,6 +15,11 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
+          path: etherpad-lite
+      - uses: actions/setup-node@v4
+        name: Install Node.js
+        with:
+          node-version: 22
       - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
@@ -32,63 +37,36 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
       -
-        name: Check out the plugin
+        name: Checkout plugin repository
         uses: actions/checkout@v6
         with:
-          path: ./node_modules/__tmp
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: |
-          cd ./node_modules/__tmp
-          echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Determine plugin name
-        id: plugin_name
-        run: |
-          cd ./node_modules/__tmp
-          npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
-      -
-        name: Rename plugin directory
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
-      -
-        name: Install plugin dependencies
-        env:
-          PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
-        run: |
-          cd ./node_modules/"${PLUGIN_NAME}"
-          pnpm i
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
+          path: plugin
       -
         name: Install Etherpad core dependencies
+        working-directory: ./etherpad-lite
         run: bin/installDeps.sh
+      - name: Install plugin
+        working-directory: ./etherpad-lite
+        run: |
+          pnpm run plugins i --path ../../plugin
       - name: Create settings.json
+        working-directory: ./etherpad-lite
         run: cp ./src/tests/settings.json settings.json
       - name: Run the frontend tests
+        working-directory: ./etherpad-lite
         shell: bash
         run: |
           pnpm run dev &
           connected=false
           can_connect() {
-          curl -sSfo /dev/null http://localhost:9001/ || return 1
-          connected=true
+            curl -sSfo /dev/null http://localhost:9001/ || return 1
+            connected=true
           }
           now() { date +%s; }
           start=$(now)
-          while [ $(($(now) - $start)) -le 15 ] && ! can_connect; do
-          sleep 1
+          while [ $(($(now) - $start)) -le 30 ] && ! can_connect; do
+            sleep 1
           done
           cd src
-          pnpm exec playwright install chromium  --with-deps
+          pnpm exec playwright install chromium --with-deps
           pnpm run test-ui --project=chromium

package/index.js

@@ -2,7 +2,12 @@
 
 const ChatMessage = (() => {
   try {
-    return require('ep_etherpad-lite/static/js/ChatMessage');
+    // ChatMessage was migrated to TypeScript and is now exported as a
+    // named export; require() returns the whole module object, so pick
+    // the class out of it. Fall back to the legacy default export shape
+    // for older Etherpad releases.
+    const mod = require('ep_etherpad-lite/static/js/ChatMessage');
+    return mod.ChatMessage || mod.default || mod;
   } catch (err) {
     return null;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_chat_log_join_leave",
-  "version": "1.0.47",
+  "version": "1.0.48",
   "description": "Etherpad plugin to log user joins and leaves in the chat history",
   "main": "index.js",
   "scripts": {

package/static/css/index.css

@@ -1,5 +1,17 @@
+/*
+ * The join/leave entries are rendered as <div> rather than <p> so test
+ * locators that target real chat (`#chattext p`) don't trip on them.
+ * Core (pad/chat.css) and the colibris skin both style `#chattext p`
+ * directly though — mirror those rules here so the entries still look
+ * flush with regular chat lines. Padding matches the colibris override
+ * (4px 10px) since that's the default shipped skin.
+ */
 #chattext .ep_chat_log_join_leave-join,
 #chattext .ep_chat_log_join_leave-leave {
+  padding: 4px 10px;
+  overflow-x: hidden;
+  white-space: pre-wrap;
+  word-wrap: break-word;
   font-size: smaller;
   font-style: italic;
 }

package/static/js/index.js

@@ -1,6 +1,11 @@
 'use strict';
 
-const {padutils} = require('ep_etherpad-lite/static/js/pad_utils');
+// pad_utils was migrated to TypeScript; the PadUtils singleton is now
+// the default export rather than a named `padutils` property. Pull the
+// default with a fallback to the legacy named export for older
+// Etherpad releases.
+const padUtilsMod = require('ep_etherpad-lite/static/js/pad_utils');
+const padutils = padUtilsMod.default || padUtilsMod.padutils;
 
 // In case a translation is missing.
 const defaultMsg = {
@@ -19,13 +24,15 @@ exports.chatNewMessage = async (hookName, context) => {
   if (!['join', 'leave'].includes(type)) throw new Error(`Unexpected message type: ${type}`);
   const typeId = `ep_chat_log_join_leave-${type}`; // Used for classes and html10n.
 
-  // Because the default rendering is overridden below, context.text and context.authorName are
-  // ignored except for the gritter pop-up.
   if (!context.authorName) context.authorName = context.author;
-  const msgForGritter = document.createElement('span');
-  msgForGritter.dataset.l10nId = typeId;
-  msgForGritter.append(defaultMsg[type]);
-  context.text = msgForGritter.outerHTML;
+  // Suppress core's "new chat message" gritter (chat.ts triggers it whenever
+  // chat is closed and ctx.duration > 0). Join/leave events are not chat
+  // messages users sent, and surfacing them as gritters has surprising
+  // side-effects: the popup is often the first .gritter-item in the DOM, so
+  // unrelated tests that wait for a gritter (e.g. core's
+  // error_sanitization.spec) grab "unnamedjoined the pad" instead of the
+  // gritter they actually triggered.
+  context.duration = 0;
 
   // Override the default rendering.
   const timeElt = document.createElement('span');
@@ -38,7 +45,11 @@ exports.chatNewMessage = async (hookName, context) => {
   msgElt.classList.add('ep_chat_log_join_leave-message');
   msgElt.dataset.l10nId = typeId;
   msgElt.append(defaultMsg[type]);
-  context.rendered = document.createElement('p');
+  // Etherpad core appends real chat messages to #chattext as <p>. Tests
+  // (and other plugins) often locate them with `#chattext p` in strict
+  // mode, which then trips on these synthetic join/leave entries.
+  // Render them as <div> so plain `p` selectors only match real chat.
+  context.rendered = document.createElement('div');
   context.rendered.classList.add(typeId);
   context.rendered.append(timeElt, nameElt, ' ', msgElt);
 

package/static/tests/frontend-new/specs/smoke.spec.ts

@@ -0,0 +1,24 @@
+import {expect, test} from '@playwright/test';
+import {getPadBody, goToNewPad} from 'ep_etherpad-lite/tests/frontend-new/helper/padHelper';
+
+test.beforeEach(async ({page}) => {
+  await goToNewPad(page);
+});
+
+test.describe('ep_chat_log_join_leave', () => {
+  test('pad loads with plugin installed', async ({page}) => {
+    const padBody = await getPadBody(page);
+    await expect(padBody).toBeVisible();
+  });
+
+  // The join message should not be a <p>, so core / other-plugin tests
+  // that strict-mode-locate `#chattext p` (the user's actual chat) don't
+  // collide with the synthetic join entry. See change_user_color.spec.ts
+  // upstream for the failure mode. Chat is collapsed by default, so the
+  // entry isn't "visible" — assert presence instead.
+  test('join entry is rendered as a <div>, not a <p>', async ({page}) => {
+    await expect(page.locator('#chattext > div.ep_chat_log_join_leave-join'))
+        .toHaveCount(1, {timeout: 30_000});
+    await expect(page.locator('#chattext > p.ep_chat_log_join_leave-join')).toHaveCount(0);
+  });
+});