Skip to content

fix(plugin-runtime): fix document CLI compatibility with ESM lib format#8692

Open
imhele wants to merge 1 commit into
web-infra-dev:mainfrom
imhele:fix/plugin-runtime-document-esm-imports
Open

fix(plugin-runtime): fix document CLI compatibility with ESM lib format#8692
imhele wants to merge 1 commit into
web-infra-dev:mainfrom
imhele:fix/plugin-runtime-document-esm-imports

Conversation

@imhele

@imhele imhele commented Jun 15, 2026

Copy link
Copy Markdown

Summary

Problem

The document plugin's CLI helpers (requireFromString and generateEntryCode) relied on CJS-only Node.js APIs that are unavailable or incorrect when the package is built and consumed as an ES module:

  1. module.parent in requireFromString: In ESM context, the CommonJS module global does not exist, so passing module.parent as the parent to new Module.Module() throws a ReferenceError at runtime.

  2. require.resolve('../') in generateEntryCode: createRequire().resolve('../') cannot resolve to index file in an ESM module context.

Solution

Both helpers are now guarded by a process.env.MODERN_LIB_FORMAT === 'esm' check so they use the appropriate API depending on the module format:

  • requireFromString: passes undefined as the parent module when in ESM mode, which is a safe no-op for Module.Module and avoids the CJS module.parent reference.
  • generateEntryCode: uses import.meta.resolve('../index.mjs') to resolve the runtime API path in ESM mode (the .mjs entry is already the correct target), falling back to require.resolve('../') in CJS mode.

Affected package

  • @modern-js/runtime (patch)

Related Links

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@changeset-bot

changeset-bot Bot commented Jun 15, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 79d9795

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 118 packages
Name Type
@modern-js/runtime Patch
@modern-js/plugin-bff Patch
@modern-js/plugin-styled-components Patch
@modern-js/plugin-i18n Patch
@integration-test/alias-set Patch
app-document Patch
async-entry-test Patch
tmp Patch
bff-api-app Patch
bff-client-app Patch
bff-indep-client-app Patch
bff-hono Patch
integration-clean-dist-path Patch
integration-compatibility Patch
integration-custom-dist-path Patch
custom-file-system-entry Patch
integration-custom-template Patch
deploy Patch
deploy-server Patch
dev-server Patch
integration-disable-html Patch
app-custom-entries Patch
app-custom-routes-runtime Patch
app-custom Patch
app-entry Patch
app-route Patch
app-entry-server Patch
i18n-app-csr-html-lang Patch
i18n-app Patch
i18n-app-ssr-html-lang Patch
i18n-app-ssr Patch
i18n-custom-i18n-wrapper Patch
i18n-mf-app-provider Patch
i18n-mf-component-provider Patch
i18n-mf-consumer Patch
i18n-routes Patch
i18n-routes-ssr Patch
@integration-test/image-component Patch
main-entry-name Patch
nonce Patch
pure-esm-project Patch
routes-match Patch
routes Patch
app-rsbuild-hooks Patch
rsc-csr-app Patch
rsc-csr-routes Patch
rsc-ssr-app Patch
rsc-ssr-routes Patch
basic-app-rstest-browser Patch
basic-app-rstest Patch
runtime-custom-plugin Patch
runtime-custom-config-plugin Patch
select-mul-entry-test Patch
select-one-entry-test Patch
server-config Patch
server-json-script Patch
server-monitors Patch
server-prod Patch
server-routes Patch
@source-code-build/app Patch
ssg-fixtures-mega-list-routes Patch
ssg-fixtures-nested-routes Patch
ssg-fixtures-simple Patch
ssg-fixtures-web-server Patch
ssr-base-async-entry-test Patch
ssr-base-async-pre-entry-test Patch
ssr-base-json-test Patch
ssr-base-test Patch
ssr-base-fallback-test Patch
init Patch
ssr-base-loadable Patch
ssr-partial-test Patch
rsc-closing-tags-test Patch
ssr-script-loading Patch
ssr-useid-test Patch
ssr-streaming-inline-test Patch
ssr-streaming-lazy-test Patch
ssr-streaming-test Patch
integration-storybook Patch
styled-components-stream Patch
styled-components-string Patch
integration-tailwindcss-v2 Patch
integration-tailwindcss-v3 Patch
integration-tailwindcss-v4-tools Patch
integration-tailwindcss-v4 Patch
tmp-dir Patch
write-to-dist Patch
@modern-js/bundle-diff-benchmark Patch
@modern-js/main-doc Patch
@modern-js/tsconfig Patch
@modern-js/adapter-rstest Patch
@modern-js/builder Patch
@modern-js/plugin-data-loader Patch
@modern-js/plugin-ssg Patch
@modern-js/image Patch
@modern-js/render Patch
@modern-js/bff-core Patch
@modern-js/bff-runtime Patch
@modern-js/server-core Patch
@modern-js/create-request Patch
@modern-js/plugin-polyfill Patch
@modern-js/prod-server Patch
@modern-js/server-runtime Patch
@modern-js/server Patch
@modern-js/server-utils Patch
@modern-js/app-tools Patch
@modern-js/create Patch
@modern-js/i18n-utils Patch
@modern-js/plugin Patch
@modern-js/runtime-utils Patch
@modern-js/sandpack-react Patch
@modern-js/types Patch
@modern-js/utils Patch
@modern-js/rslib Patch
@scripts/prebundle Patch
@scripts/rstest-config Patch
entries-app-builder Patch
@scripts/release-node Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@netlify

netlify Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploy Preview for modernjs-byted ready!

Name Link
🔨 Latest commit 79d9795
🔍 Latest deploy log https://app.netlify.com/projects/modernjs-byted/deploys/6a2fbc4702380300086c1a73
😎 Deploy Preview https://deploy-preview-8692--modernjs-byted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🔴 down 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@zllkjc

zllkjc commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Thanks for contribute~ Can you add a Chinese version changeset ?

@imhele imhele force-pushed the fix/plugin-runtime-document-esm-imports branch from 980c9db to 79d9795 Compare June 15, 2026 08:48
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.

2 participants