ep_headerauth 1.1.48 → 1.1.49

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

@@ -26,7 +26,7 @@ jobs:
         with:
           repository: ether/etherpad-lite
           path: etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10

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

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10

package/.github/workflows/npmpublish.yml

@@ -31,7 +31,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: ether/etherpad-lite
-      - uses: pnpm/action-setup@v5
+      - uses: pnpm/action-setup@v6
         name: Install pnpm
         with:
           version: 10
@@ -59,12 +59,20 @@ jobs:
           [ "${NEW_COMMITS}" -gt 0 ] || exit 0
           git config user.name 'github-actions[bot]'
           git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          pnpm i
+          pnpm i --frozen-lockfile
           # `pnpm version patch` bumps package.json, makes a commit, and creates
           # a `v<new-version>` tag. Capture the new tag name from package.json
           # rather than parsing pnpm's output, which has historically varied.
-          pnpm version patch
-          NEW_TAG="v$(node -p "require('./package.json').version")"
+          # Bump the patch component directly with Node. pnpm/action-setup@v6
+          # sometimes installs pnpm 11 pre-releases even when version: 10.x is
+          # requested (pnpm/action-setup#225); those pre-releases either skip
+          # the git commit/tag or reject --no-git-tag-version as unknown.
+          # Doing the bump in Node sidesteps both failure modes.
+          NEW_VERSION=$(node -e "const fs=require('fs');const p=require('./package.json');const v=p.version.split('.');v[2]=String(Number(v[2])+1);p.version=v.join('.');fs.writeFileSync('./package.json',JSON.stringify(p,null,2)+'\n');console.log(p.version);")
+          NEW_TAG="v${NEW_VERSION}"
+          git add package.json
+          git commit -m "${NEW_TAG}"
+          git tag -a "${NEW_TAG}" -m "${NEW_TAG}"
           # CRITICAL: use --atomic so the branch update and the tag update
           # succeed (or fail) as a single transaction on the server. The old
           # `git push --follow-tags` was non-atomic per ref: if a concurrent

package/README.md

@@ -36,6 +36,23 @@ In your `settings.json`:
 }
 ```
 
+## Installation
+
+Install from the Etherpad admin UI (**Admin → Manage Plugins**,
+search for `ep_headerauth` and click *Install*), or from the Etherpad
+root directory:
+
+```sh
+pnpm run plugins install ep_headerauth
+```
+
+> ⚠️ Don't run `npm i` / `npm install` yourself from the Etherpad
+> source tree — Etherpad tracks installed plugins through its own
+> plugin-manager, and hand-editing `package.json` can leave the
+> server unable to start.
+
+After installing, restart Etherpad.
+
 ## Copyright and License
 
 Copyright © 2020 Richard Hansen <rhansen@rhansen.org>

package/index.js

@@ -50,8 +50,9 @@ exports.authenticate = (hookName, {req}, cb) => {
   return cb([true]);
 };
 
-exports.handleMessage = async (hookName, {client: {client: {request: {session}}}, message}) => {
+exports.handleMessage = async (hookName, {socket, message}) => {
   logger.debug('handleMessage');
+  const {session} = socket.client.request;
   if (session.user == null) {
     logger.debug('handleMessage: User info missing from session');
     return;
@@ -76,7 +77,7 @@ exports.handleMessage = async (hookName, {client: {client: {request: {session}}}
     return;
   }
   logger.debug(`handleMessage: getting author ID for token ${token}`);
-  const authorId = await authorManager.getAuthor4Token(token);
+  const authorId = await authorManager.getAuthorId(token, session.user);
   logger.debug(`handleMessage: Setting name for ${authorId} to ${displayname}`);
   authorManager.setAuthorName(authorId, displayname);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_headerauth",
-  "version": "1.1.48",
+  "version": "1.1.49",
   "description": "Etherpad plugin to use a reverse proxy's HTTP headers for authentication.",
   "keywords": [
     "auth",
@@ -25,8 +25,8 @@
   },
   "devDependencies": {
     "eslint": "^8.57.1",
-    "eslint-config-etherpad": "^4.0.4",
-    "typescript": "^6.0.2"
+    "eslint-config-etherpad": "^4.0.5",
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "lint": "eslint .",

package/static/tests/backend/specs/handleMessage.js

@@ -0,0 +1,58 @@
+'use strict';
+
+const assert = require('assert').strict;
+const common = require('ep_etherpad-lite/tests/backend/common');
+const authorManager = require('ep_etherpad-lite/node/db/AuthorManager');
+
+// Require the plugin with the loadSettings hook already triggered so that the
+// module's private `settings` reference is initialised.
+const plugin = require('../../../..');
+
+describe(__filename, function () {
+  before(async function () {
+    await common.init();
+    await new Promise((resolve, reject) => {
+      plugin.loadSettings(
+          'loadSettings', {settings: {trustProxy: true, users: {}}}, (err) => err ? reject(err) : resolve());
+    });
+  });
+
+  const makeContext = (message) => ({
+    socket: {client: {request: {session: {user: {displayname: 'Alice'}}}}},
+    message,
+  });
+
+  it('uses context.socket rather than context.client (regression for #60)', async function () {
+    // Calling with context.client would throw TypeError since we destructure
+    // the socket-shaped property. Supplying only `socket` must work.
+    await plugin.handleMessage('handleMessage',
+        makeContext({type: 'COLLABROOM', data: {type: 'USERINFO_UPDATE', userInfo: {name: 'x'}}}));
+  });
+
+  it('calls getAuthorId (not deprecated getAuthor4Token) on CLIENT_READY (regression for #60)',
+      async function () {
+        const calls = {getAuthorId: 0, getAuthor4Token: 0, setAuthorName: []};
+        const origGetAuthorId = authorManager.getAuthorId;
+        const origGetAuthor4Token = authorManager.getAuthor4Token;
+        const origSetAuthorName = authorManager.setAuthorName;
+        authorManager.getAuthorId = async (token, user) => {
+          calls.getAuthorId++;
+          assert.equal(token, 'tk');
+          assert.deepEqual(user, {displayname: 'Alice'});
+          return 'a.123';
+        };
+        authorManager.getAuthor4Token = async () => { calls.getAuthor4Token++; return 'a.old'; };
+        authorManager.setAuthorName = (id, name) => { calls.setAuthorName.push([id, name]); };
+        try {
+          await plugin.handleMessage('handleMessage',
+              makeContext({type: 'CLIENT_READY', token: 'tk'}));
+        } finally {
+          authorManager.getAuthorId = origGetAuthorId;
+          authorManager.getAuthor4Token = origGetAuthor4Token;
+          authorManager.setAuthorName = origSetAuthorName;
+        }
+        assert.equal(calls.getAuthorId, 1);
+        assert.equal(calls.getAuthor4Token, 0);
+        assert.deepEqual(calls.setAuthorName, [['a.123', 'Alice']]);
+      });
+});