Skip to content

fix: backward-compat for ESM etherpad #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SamTV12345 merged 1 commit into from
May 25, 2026
Merged

fix: backward-compat for ESM etherpad #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ const ChatMessage = (() => {
}
})();
const assert = require('assert').strict;
const log4js = require('ep_etherpad-lite/node_modules/log4js');
const {createLogger} = require('ep_plugin_helpers/logger');
const padMessageHandler = require('ep_etherpad-lite/node/handler/PadMessageHandler');

const logger = log4js.getLogger('ep_chat_log_join_leave');
const logger = createLogger('ep_chat_log_join_leave');
Comment on lines +16 to +19
Copy link
Copy Markdown

@qodo-free-for-open-source-projects qodo-free-for-open-source-projects Bot May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. No regression test for logger 📘 Rule violation ☼ Reliability

This PR changes the logging implementation to fix ESM/CJS compatibility, but it does not add or
update any automated regression test to validate the fix. This increases the risk of the
compatibility issue reoccurring unnoticed in future changes.
Agent Prompt 
## Issue description
A bug-fix change was made (logger import migration for ESM/CJS compatibility), but the PR does not include a regression test that would fail before the fix and pass after.

## Issue Context
The change migrates logging from `log4js` to `ep_plugin_helpers/logger`, intended to be backward-compatible while also working with the upcoming ESM Etherpad branch.

## Fix Focus Areas
- index.js[16-19]
- static/tests/frontend-new/specs/smoke.spec.ts[1-24]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


if (ChatMessage == null) {
logger.error('This version of Etherpad is unsupported. ' +
Expand Down
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ep_chat_log_join_leave",
"version": "1.0.53",
"version": "1.0.54",
"description": "Etherpad plugin to log user joins and leaves in the chat history",
"main": "index.js",
"scripts": {
Expand Down Expand Up @@ -33,5 +33,8 @@
"funding": {
"type": "individual",
"url": "https://etherpad.org/"
},
"dependencies": {
"ep_plugin_helpers": "^0.6.7"
}
Comment on lines +37 to 39
Copy link
Copy Markdown

@qodo-free-for-open-source-projects qodo-free-for-open-source-projects Bot May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Lockfile missing new dependency 🐞 Bug ☼ Reliability

package.json adds ep_plugin_helpers but pnpm-lock.yaml is not updated, so pnpm i --frozen-lockfile
will fail. This breaks the automated release/version-bump workflow and blocks publishing.
Agent Prompt 
## Issue description
`package.json` adds a new dependency (`ep_plugin_helpers`), but `pnpm-lock.yaml` was not updated. The repo’s release workflow runs `pnpm i --frozen-lockfile`, which fails when the lockfile does not match `package.json`.

## Issue Context
The release pipeline uses frozen lockfiles for reproducible installs, so dependency changes must be accompanied by a lockfile update.

## Fix
1. Run `pnpm install` (or `pnpm i`) in the repo root.
2. Commit the resulting `pnpm-lock.yaml` changes.

## Fix Focus Areas
- package.json[33-40]
- pnpm-lock.yaml[7-20]
- .github/workflows/npmpublish.yml[66-73]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

}
Loading