Skip to content

fix: backward-compat for ESM etherpad#92

Merged
SamTV12345 merged 1 commit into
mainfrom
fix/esm-compat
May 25, 2026
Merged

fix: backward-compat for ESM etherpad#92
SamTV12345 merged 1 commit into
mainfrom
fix/esm-compat

Conversation

@SamTV12345
Copy link
Copy Markdown
Member

This PR makes the plugin backward-compatible with the upcoming ESM etherpad branch (ether/etherpad#7605).

Change: Remove trailing slash from require("ep_etherpad-lite/node/eejs/")require("ep_etherpad-lite/node/eejs")

The trailing-slash form breaks under Node's strict ESM exports map resolution. This change is backward-compatible with the current CJS etherpad release.

- Drop trailing slash on ep_etherpad-lite/node/eejs/ require

Backward-compatible with current CJS etherpad release; also
compatible with the upcoming ESM etherpad branch which has stricter
exports map resolution.
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

Review Summary by Qodo

Remove trailing slash for ESM etherpad compatibility

🐞 Bug fix

Grey Divider

Walkthroughs

Description
• Remove trailing slash from eejs require path
• Ensures compatibility with upcoming ESM etherpad
• Maintains backward compatibility with current CJS
• Bump version to 11.0.25
Diagram
flowchart LR
  A["require with trailing slash"] -- "remove slash" --> B["require without slash"]
  B -- "compatible with" --> C["ESM etherpad"]
  B -- "compatible with" --> D["CJS etherpad"]

Loading

File Changes

1. eejs.js 🐞 Bug fix +1/-1

Remove trailing slash from eejs require

• Remove trailing slash from require('ep_etherpad-lite/node/eejs/') path
• Change to require('ep_etherpad-lite/node/eejs') for strict ESM exports resolution

eejs.js


2. package.json ⚙️ Configuration changes +1/-1

Bump patch version

• Increment version from 11.0.24 to 11.0.25

package.json


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

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

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1)

Grey Divider


Action required

1. No regression test for eejs require 📘 Rule violation ☼ Reliability
Description
This PR changes module resolution behavior by updating the require('ep_etherpad-lite/node/eejs')
path, but it does not add or update any automated regression test to ensure the ESM exports-map
compatibility issue stays fixed. Without a test, the trailing-slash behavior could be reintroduced
unnoticed.
Code

eejs.js[3]

Evidence
PR Compliance ID 1 requires a regression test for each bug fix. The PR changes runtime behavior in
eejs.js (the require() path), but the project scripts shown in package.json still only include
linting and no test addition/update is present to cover this behavior.

AGENTS.md: Every Bug Fix Must Include a Regression Test
eejs.js[3-3]
package.json[22-25]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
A bug fix was made (changing the `eejs` require path for ESM exports-map compatibility) but no regression test was added/updated in the same PR to prevent the issue from returning.

## Issue Context
The PR changes `require('ep_etherpad-lite/node/eejs/')` to `require('ep_etherpad-lite/node/eejs')`. Add an automated test that would have failed before this change (detecting the trailing-slash import) and passes now.

## Fix Focus Areas
- eejs.js[3-3]
- package.json[22-25]
- test/esm-compat.test.js[1-120]

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


Grey Divider

Qodo Logo

Comment thread eejs.js
'use strict';

const eejs = require('ep_etherpad-lite/node/eejs/');
const eejs = require('ep_etherpad-lite/node/eejs');
Copy link
Copy Markdown

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 eejs require 📘 Rule violation ☼ Reliability

This PR changes module resolution behavior by updating the require('ep_etherpad-lite/node/eejs')
path, but it does not add or update any automated regression test to ensure the ESM exports-map
compatibility issue stays fixed. Without a test, the trailing-slash behavior could be reintroduced
unnoticed.
Agent Prompt
## Issue description
A bug fix was made (changing the `eejs` require path for ESM exports-map compatibility) but no regression test was added/updated in the same PR to prevent the issue from returning.

## Issue Context
The PR changes `require('ep_etherpad-lite/node/eejs/')` to `require('ep_etherpad-lite/node/eejs')`. Add an automated test that would have failed before this change (detecting the trailing-slash import) and passes now.

## Fix Focus Areas
- eejs.js[3-3]
- package.json[22-25]
- test/esm-compat.test.js[1-120]

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

@SamTV12345 SamTV12345 merged commit ec18012 into main May 25, 2026
3 checks passed
@SamTV12345 SamTV12345 deleted the fix/esm-compat branch May 25, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant