feat: I guess it's esm #37535

MarshallOfSound · 2023-03-08T21:14:09Z

This PR is a little chonky and it fixes a lot of things and changes some things under the hood. In theory though this PR contains zero breaking changes and it should be fully backwards compatible with existing applications. However due to the scope of the changes this change will not be backported.

Things that were fixed

Loading ESM files from within an asar file now actually works instead of throwing ENOTDIR
Using an ESM file type: module or index.mjs as the entrypoint to your Electron app now works
Using an ESM file as a preload script when sandbox is disabled now works
Using dynamic ESM import() calls from within a non-sandboxed context isolated preload script now correctly uses node's ESM loader instead of always using blinks

Things that were changed

Preload scripts with the extension .mjs are now always loaded via the ESM loader, when node is enabled. This could result in some interesting side-effects but so far testing seems to show it's ok. Existing preload scripts that have the .js extension will continue to operate exactly how they used to, ESM preload scripts have some gotchas that have been documented.
The main process now has its event loop manually pumped until the initial script load / evaluate is complete. This allows node's internal ESM implementation to be async without impacting Electron's core assumptions about synchronous startup hooks provided by Chromium
- This technically allows apps to hang themselves by for instance doing a top level await app.whenReady() which result in effectively a spinlock
Preload scripts now "defer" loading of the page until the preload script load / evaluate is complete. This allows node's internal ESM implementation to be async without impacting the "preload runs first" part of Electron's preload scripts
The default_app is now ESM, partially to support additional ESM entrypoints from end-user apps but also to prove that this all works 😅

Known Limitations / Things that can't be fixed

Check the docs/tutorial/esm-limitations.md in this PR

TODO

Test the performance implications of these changes, they're cool but I have a feeling that startup time with ESM vs CJS might be slower. Would be good to know for sure
Tests, so many tests...

Notes: Enabled ESM support. For more details, see the ESM limitations document

clavin

Pretty small changes. 😄 This PR is impressive in how much ESM functionality it opens up for only doing a few tiny patches.

Not a big fan with some bits of how default_app/main.ts is written, but those exist prior to this PR so I'll leave that for the future.
I do want to see a test on this PR, even if it's just a smoke test.

P.S. I agree w/ your theory that these could probably impact startup time of an ESM app minorly, possibly even negligibly, mostly stemming from awaits and microtasks and stuff like that.

default_app/preload.ts

docs/tutorial/esm-limitations.md

lib/renderer/init.ts

patches/node/chore_expose_importmoduledynamically_and.patch

shell/common/node_bindings.h

Blink has it's own event loop so pumping the uv loop in the renderer is not enough, luckily in blink we can suspend the loading of the frame while we do additional work.

default_app/main.ts

docs/tutorial/esm-limitations.md

patches/node/fix_lazyload_fs_in_esm_loaders_to_apply_asar_patches.patch

shell/common/node_bindings.cc

Co-authored-by: Jeremy Rose <jeremya@chromium.org>

shell/common/node_bindings.h

docs/tutorial/esm-limitations.md

This reverts commit 0de8252.

This reverts commit ff86b12.

release-clerk · 2023-08-31T00:38:13Z

Release Notes Persisted

Added ESM support. For more details, see the ESM limitations document

mahnunchik · 2023-09-04T19:43:55Z

When is the release planned?

martpie · 2023-09-04T21:48:37Z

Electron 28, which is in nightly right now. Cf. #21457

Wow, can't believe this day has finally come! You can essentially write most of your Electron code in pure ESM now! The only holdup is that preload scripts must be CommonJS still. But you can just add the `.cjs/.cts` extension for that one module, so that works out really well. This was what made me come back to work on this project a little bit again. Rather than starting fresh with a new Electron project, I thought it would be a better idea to update this one to use my more recent tooling (TS, ESM in this case), and I want to try some Electron-specific things out too, like Accelerators, things like that. Ooh, I want to get Vite/live reload working with this too, I didn't end up getting that set up when I started this, Node projects were still above my head at that time. electron/electron#21457 electron/electron#37535 https://github.com/electron/electron/blob/main/docs/tutorial/esm.md This was a placeholder I set up for the reference to resolve the preload script, since `__dirname` isn't an available global from within ESM. https://blog.logrocket.com/alternatives-dirname-node-js-es-modules/ Sevendust Next is definitely one of my favorite albums of theirs for me, looking back on it more recently the last year or so.

* fix: allow ESM loads from within ASAR files * fix: ensure that ESM entry points finish loading before app ready * fix: allow loading ESM entrypoints via default_app * fix: allow ESM loading for renderer preloads * docs: document current known limitations of esm * chore: add patches to support blending esm handlers * refactor: use SetDefersLoading instead of JoinAppCode in renderers Blink has it's own event loop so pumping the uv loop in the renderer is not enough, luckily in blink we can suspend the loading of the frame while we do additional work. * chore: add patch to expose SetDefersLoading * fix: use fileURLToPath instead of pathname * chore: update per PR feedback * fix: fs.exists/existsSync should never throw * fix: convert path to file url before importing * fix: oops * fix: oops * Update docs/tutorial/esm-limitations.md Co-authored-by: Jeremy Rose <jeremya@chromium.org> * windows... * windows... * chore: update patches * spec: fix tests and document empty body edge case * Apply suggestions from code review Co-authored-by: Daniel Scalzi <d_scalzi@yahoo.com> Co-authored-by: Jeremy Rose <jeremya@chromium.org> * spec: add tests for esm * spec: windows * chore: update per PR feedback * chore: update patches * Update shell/common/node_bindings.h Co-authored-by: Jeremy Rose <jeremya@chromium.org> * chore: update patches * rebase * use cjs loader by default for preload scripts * chore: fix lint * chore: update patches * chore: update patches * chore: fix patches * build: debug depshash * ? * Revert "build: debug depshash" This reverts commit 0de8252. * chore: allow electron as builtin protocol in esm loader * Revert "Revert "build: debug depshash"" This reverts commit ff86b12. * chore: fix esm doc * chore: update node patches --------- Co-authored-by: Jeremy Rose <jeremya@chromium.org> Co-authored-by: electron-patch-conflict-fixer[bot] <83340002+electron-patch-conflict-fixer[bot]@users.noreply.github.com> Co-authored-by: PatchUp <73610968+patchup[bot]@users.noreply.github.com> Co-authored-by: Daniel Scalzi <d_scalzi@yahoo.com>

yejimeiming · 2024-01-02T01:50:18Z

Hey! 👋 thanks this PR!
Details link is not found!

AlexWayfer · 2024-01-02T09:56:56Z

Hey! 👋 thanks this PR! Details link is not found!

I think, it's not this file: https://github.com/electron/electron/blob/main/docs/tutorial/esm.md

It's always better to attach links with ref to the latest commit, not an alive branch: https://github.com/electron/electron/blob/2085aae/docs/tutorial/esm.md

Anyway, it's easier to read on the official site: https://www.electronjs.org/docs/latest/tutorial/esm

(I see /latest in the URL, but don't see any switch on the site)

This commit bumps Electron and related dependencies to their latest versions to leverage native ESM support. It adjusts build configuration to use native ESM support instead of relying on CommonJS bundling. Key changes: - Bump Electron to latest v29. Electron v28 ships with native ESM/ECMAScript modules support. Details on Electron ESM support: - electron/electron#21457 - electron/electron#37535 - Bump `electron-builder` to latest v24.13. `electron-builder` is used to package and publish the application. It supports ESM since 24.10. Details on `electron-builder` ESM support: - electron-userland/electron-builder#7936 - electron-userland/electron-builder#7935 - Bump `electron-log` to latest v5.1. `electron-log` supports ESM since version 5.0.4. Details on `electron-log` ESM support: - megahertz/electron-log#390. - Change `electron-vite` configuration to bundle as ESM instead of CommonJS to leverage Electron's native ESM support. Other supporting changes: - Add type hint for electron-builder configuration file. - Update import statements for `electron-updater` as it still is a CommonJS module and does not support ESM. Details: - electron-userland/electron-builder#7976 - Improve `electron-builder` configuration file to dynamically locate main entry files, supporting various JavaScript file extensions (`.js`, `.mjs` and `.cjs`) to facilitate easier future changes. - Change comment about Electron process-specific module alias registration. This issue has been fixed in `electron-vite`, but subpath module imports for Electron still do not work when building tests (`npm run test:unit`). Details: - alex8088/electron-vite#372 - Add `electron-log` in bundling process instead of externalizing to workaround Electron ESM loader issues with subpath imports (inability to do `electron-log/main`). Details: - alex8088/electron-vite#401 - electron/electron#41241 - Improve desktop runtime error checks' assertion message for better clarity.

MarshallOfSound added 6 commits March 7, 2023 16:27

fix: allow ESM loads from within ASAR files

f356b39

fix: ensure that ESM entry points finish loading before app ready

42773e5

fix: allow loading ESM entrypoints via default_app

42bc762

fix: allow ESM loading for renderer preloads

0b7a829

docs: document current known limitations of esm

8390ab0

chore: add patches to support blending esm handlers

7f0cf87

MarshallOfSound added semver/minor backwards-compatible functionality no-backport labels Mar 8, 2023

MarshallOfSound requested a review from a team as a code owner March 8, 2023 21:14

electron-cation bot added new-pr 🌱 PR opened in the last 24 hours api-review/requested 🗳 labels Mar 8, 2023

MarshallOfSound mentioned this pull request Mar 8, 2023

Support Node's ES Modules #21457

Closed

3 tasks

clavin requested changes Mar 9, 2023

View reviewed changes

MarshallOfSound and others added 5 commits March 9, 2023 01:25

refactor: use SetDefersLoading instead of JoinAppCode in renderers

d89b339

Blink has it's own event loop so pumping the uv loop in the renderer is not enough, luckily in blink we can suspend the loading of the frame while we do additional work.

chore: add patch to expose SetDefersLoading

7d93690

fix: use fileURLToPath instead of pathname

f149167

chore: update per PR feedback

cca34de

fix: fs.exists/existsSync should never throw

acf384c

nornagon reviewed Mar 9, 2023

View reviewed changes

fix: convert path to file url before importing

6f20236

MarshallOfSound force-pushed the engineering-science-magic branch from 6706fe9 to 6f20236 Compare March 9, 2023 19:21

MarshallOfSound and others added 3 commits March 9, 2023 11:46

fix: oops

2b16d4f

fix: oops

e179a92

Update docs/tutorial/esm-limitations.md

d0601a3

Co-authored-by: Jeremy Rose <jeremya@chromium.org>

clavin approved these changes Mar 9, 2023

View reviewed changes

shell/common/node_bindings.h Outdated Show resolved Hide resolved

MarshallOfSound and others added 4 commits March 9, 2023 13:41

windows...

39d87af

windows...

8cf4bf9

Merged in branch 'main' to fix mergability

799ab67

chore: update patches

66a088f

erickzhao reviewed Mar 10, 2023

View reviewed changes

docs/tutorial/esm-limitations.md Show resolved Hide resolved

MarshallOfSound and others added 5 commits August 29, 2023 16:08

Revert "build: debug depshash"

ff86b12

This reverts commit 0de8252.

chore: allow electron as builtin protocol in esm loader

27adf25

Revert "Revert "build: debug depshash""

8a71118

This reverts commit ff86b12.

chore: fix esm doc

c901f38

chore: update node patches

1bfa90c

MarshallOfSound merged commit ac031bf into main Aug 31, 2023
17 checks passed

MarshallOfSound deleted the engineering-science-magic branch August 31, 2023 00:38

timfish mentioned this pull request Sep 3, 2023

Test ESM with main process getsentry/sentry-electron#730

Closed

ForesightImaging mentioned this pull request Sep 6, 2023

webdriverio v > 8.13 breaks wdio-electron-service webdriverio-community/wdio-electron-service#167

Closed

thehenrytsai mentioned this pull request Sep 7, 2023

RFC: Separate SDK into multiple packages by platform TBD54566975/dwn-sdk-js#309

Closed

mahnunchik mentioned this pull request Sep 14, 2023

Support ESM forge.config.js electron/forge#3350

Closed

3 tasks

mahnunchik mentioned this pull request Sep 25, 2023

SDK does not support ESM in main process getsentry/sentry-electron#751

Closed

3 tasks

vlad-iliescu-tallarium mentioned this pull request Oct 11, 2023

Remove dynamic imports tallarium/Baileys#16

Merged

yooouuri mentioned this pull request Oct 30, 2023

Electron is going to support ESM from 28 electron-vite/vite-plugin-electron#172

Closed

sparecycles mentioned this pull request Nov 9, 2023

[Feature Request]: Upgrade nodejs to v20 LTS #40343

Closed

3 tasks

dgozman mentioned this pull request Nov 9, 2023

[BUG] After executing the electron test, the error "Cannot read properties of undefined (reading 'require')" is reported microsoft/playwright#28048

Closed

1 task

mxschmitt mentioned this pull request Nov 10, 2023

[Bug]: Undefined process.mainModule / require.main after 28.0.0-nightly.20230831 #40501

Closed

3 tasks

sunfish-shogi mentioned this pull request Nov 28, 2023

Node.js を ESM へ移行する。 sunfish-shogi/electron-shogi#680

Open

Bargsteen mentioned this pull request Nov 29, 2023

Support generating TypeScript/JavaScript clients using ccd-js-gen Concordium/concordium-smart-contract-tools#140

Merged

5 tasks

codebytere mentioned this pull request Dec 16, 2023

modules (dependencies) don't work: Error: Cannot find module electron/fiddle#1519

Open

Arkellys mentioned this pull request Dec 16, 2023

[Bug]: Unsanboxed preload running after page with content is loaded (ESM) #40777

Open

3 tasks

yvvki mentioned this pull request Dec 20, 2023

Convert to type: module yvvki/cuttlefish#8

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: I guess it's esm #37535

feat: I guess it's esm #37535

MarshallOfSound commented Mar 8, 2023 •

edited by ckerr

clavin left a comment •

edited

release-clerk bot commented Aug 31, 2023 •

edited by ckerr

mahnunchik commented Sep 4, 2023

martpie commented Sep 4, 2023

yejimeiming commented Jan 2, 2024 •

edited

AlexWayfer commented Jan 2, 2024

feat: I guess it's esm #37535

feat: I guess it's esm #37535

Conversation

MarshallOfSound commented Mar 8, 2023 • edited by ckerr

Things that were fixed

Things that were changed

Known Limitations / Things that can't be fixed

TODO

clavin left a comment • edited

Choose a reason for hiding this comment

release-clerk bot commented Aug 31, 2023 • edited by ckerr

mahnunchik commented Sep 4, 2023

martpie commented Sep 4, 2023

yejimeiming commented Jan 2, 2024 • edited

AlexWayfer commented Jan 2, 2024

MarshallOfSound commented Mar 8, 2023 •

edited by ckerr

clavin left a comment •

edited

release-clerk bot commented Aug 31, 2023 •

edited by ckerr

yejimeiming commented Jan 2, 2024 •

edited