Skip to content

fix: backward-compat for ESM etherpad #101

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 #101

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
@@ -1,8 +1,8 @@
'use strict';

const log4js = require('ep_etherpad-lite/node_modules/log4js');
const {createLogger} = require('ep_plugin_helpers/logger');

const logger = log4js.getLogger('ep_button_link');
const logger = createLogger('ep_button_link');
Comment on lines +3 to +5
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 logger import to fix ESM compatibility but does not add or update any automated
regression test in the same change. Without test coverage, the compatibility fix could regress
without being detected by CI.
Agent Prompt 
## Issue description
The PR introduces a backward-compatibility bug fix but does not include a new/updated automated regression test that fails before the fix and passes after.

## Issue Context
The logger import was changed from `ep_etherpad-lite/node_modules/log4js` to `ep_plugin_helpers/logger` to be compatible with Etherpad's upcoming ESM work. Compliance requires adding regression test coverage as part of the bug fix.

## Fix Focus Areas
- static/tests/backend/specs/logger-compat.spec.js[1-120]

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

let settings = null;

exports.clientVars = async (hookName, context) => ({ep_button_link: settings});
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,7 +1,7 @@
{
"name": "ep_button_link",
"description": "Adds a button to the toolbar that links out to a new window",
"version": "1.0.49",
"version": "1.0.50",
"author": "johnyma22 (John McLear) <john@mclear.co.uk>",
"engines": {
"node": ">=18.0.0"
Expand All @@ -22,5 +22,8 @@
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint --fix ."
},
"dependencies": {
"ep_plugin_helpers": "^0.6.7"
}
Comment on lines +26 to 28
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. Outdated pnpm lockfile 🐞 Bug ☼ Reliability

package.json adds the new runtime dependency ep_plugin_helpers, but pnpm-lock.yaml is not updated to
include it, so pnpm i --frozen-lockfile will fail. This will block the npm publish workflow (and
any CI step that installs with a frozen lockfile).
Agent Prompt 
## Issue description
`package.json` adds a new dependency (`ep_plugin_helpers`) but `pnpm-lock.yaml` does not reflect it. Because the release workflow runs `pnpm i --frozen-lockfile`, the workflow will error out due to an outdated lockfile.

## Issue Context
The repository includes a committed `pnpm-lock.yaml` and the publish workflow explicitly uses frozen-lockfile installs.

## Fix Focus Areas
- package.json[26-28]
- pnpm-lock.yaml[7-20]

## Fix
1. Run `pnpm install` (or `pnpm i`) in the repo root to regenerate/update `pnpm-lock.yaml`.
2. Verify `pnpm-lock.yaml` now contains `ep_plugin_helpers` in the importer dependencies and package resolution entries.
3. Commit the updated lockfile.

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

}
Loading