Choosing a marker to customize default exports returned by `require(esm)` #1622

github-actions · 2024-09-20T19:55:08Z

When a user have an existing CommonJS package like this:

// foo package:
module.exports = function foo () { };

// ESM users get...
import foo from 'foo';
// CommmonJS users get..
const foo = require('foo');

Now that require(esm) is possible and they can ship ESM to their CommonJS users without breaking them, they would try something like this:

// foo package
export default function foo () { };

// ESM users get...
import foo from 'foo';
// CommmonJS users get..
const foo = require('foo').default;   // <--- This is now different!

As you can see, for CommonJS consumers this will not be exactly equivalent. Since in ESM the default exports is a property of the name space, they need to access .default from the result returned by
require(esm). So the idea is that Node.js can take a marker from package authors to directly customize what require(esm) returns in this case.
To keep const foo = require('foo') working, the two proposed markers are:

export default function foo () { };
export const __cjsUnwrapDefault = true;

or

export default function foo () { };
export { foo as "module.exports" };

Further to this vote, there is a follow-on proposal to reuse this marker on namespaces representing CJS modules imported into ESM, where attaching this marker would effectively define a scheme for converting CJS into ESM that would retain full transitive interop semantics allowing arbitrary CJS to be converted into ESM as a non-breaking change.

Under this follow-on marking, when importing some CJS module bar into ESM:

  module.exports = 'bar';

Users importing with console.log(await import('bar')) would obtain a namespace object either of the form ModuleNamespace { __cjsUnwrapDefault: true, default: 'bar' } or ModuleNamespace { default: 'bar', 'module.exports': 'bar' } depending on which option is chosen for this first PR.

The vote should stay open for 7 days, or until all TSC voting members have cast a ballot.

Vote instructions:

on the web: https://nodejs.github.io/caritat/#https://github.com/nodejs/TSC/pull/1622

on the CLI:

git node vote https://github.com/nodejs/TSC/pull/1622

To close the vote, at least 3 secret holder(s)¹ must run the following command: git node vote https://github.com/nodejs/TSC/pull/1622 --decrypt-key-part --post-comment

/cc @nodejs/tsc

Current estimated participation: 89.47%

secret holders are folks who have access to the private key associated with a public key on hkps://keys.openpgp.org that references an email address listed on the TSC voting member list at the time of the opening of the vote. ↩

…urned by `require(esm)`"

aduh95 · 2024-09-25T13:57:41Z

@nodejs/tsc Friendly ping, there's still half of us who haven't cast a ballot. The vote should close by EOW so there's enough time to implement the winning proposal before the v23.x cutoff.

guybedford · 2024-09-28T20:28:08Z

Can we conclude this vote?

ShogunPanda · 2024-09-28T21:18:08Z

I will try to vote tomorrow. Sorry for the long wait.

joyeecheung · 2024-09-28T21:19:28Z

Oops, started the workflow https://github.com/nodejs/TSC/actions/runs/11087086622/job/30805393578 before I saw #1622 (comment)

joyeecheung · 2024-09-28T21:20:21Z

(Although, apparently I didn't start it right, somehow. Maybe @aduh95 knows how to do it properly)

aduh95 · 2024-09-28T21:41:54Z

(Although, apparently I didn't start it right, somehow. Maybe @aduh95 knows how to do it properly)

Looks like there's a typo in the workflow file: #1624

However, to close the vote, we still need (at least) 3 secret holders to reveal their key part as indicated in the PR description:

To close the vote, at least 3 secret holder(s) must run the following command: git node vote https://github.com/nodejs/TSC/pull/1622 --decrypt-key-part --post-comment.

Waiting for Paolo's vote SGTM (I'm also OK not waiting if the timing is too tight).

aduh95 · 2024-09-29T07:46:35Z

I would like to close this vote, and for this effect, I'm revealing my key part:

-----BEGIN SHAMIR KEY PART-----
twU17ULeSU8PjrJHWFgItCugsSdRj74xMLpfKcuTHasB
-----END SHAMIR KEY PART-----

richardlau · 2024-09-30T10:47:14Z

I would like to close this vote, and for this effect, I'm revealing my key part:

-----BEGIN SHAMIR KEY PART-----
EGv+9rNCzj0LVo0hj4ufrCcTnxOwKQKaO9GukpFejX8O
-----END SHAMIR KEY PART-----

targos · 2024-09-30T11:40:31Z

I would like to close this vote, and for this effect, I'm revealing my key part:

-----BEGIN SHAMIR KEY PART-----
OuDKgiwvqy/K85yMTj0pCMQk2PmiWWENRa3BkPZpvmQS
-----END SHAMIR KEY PART-----

github-actions · 2024-09-30T12:19:46Z

Election results

Subject: Choosing a marker to customize default exports returned by require(esm)
End date: 2024-09-30T12:19:45.128Z
Participation: 84.21%

Results

Winning candidate: export { foo as "module.exports" };

Table of results

Candidate	Number of won duels
`export { foo as "module.exports" };`	1
`export const __cjsUnwrapDefault = true;`	0

Voting data

Participants:

Antoine du Hamel <[email protected]>¹
Benjamin Gruenbaum <[email protected]>²
Chengzhong Wu <[email protected]>³
Gireesh Punathil <[email protected]>⁴
James M Snell <[email protected]>⁵
Joyee Cheung <[email protected]>⁶
Marco Ippolito <[email protected]>⁷
Matteo Collina <[email protected]>⁸
Michael Dawson <[email protected]>⁹
Michaël Zasso <[email protected]>¹⁰
Moshe Atlow <[email protected]>¹¹
Paolo Insogna <[email protected]>¹²
Rafael Gonzaga <[email protected]>¹³
Richard Lau <[email protected]>¹⁴
Ruben Bridgewater <[email protected]>¹⁵
Yagiz Nizipli <[email protected]>¹⁶

Private key to decrypt ballots

Discarded commits

Some commits have not been taken into account when counting the ballots:

[
  {
    "commitInfo": {
      "sha": "f60348115185aaeeec8b14d30d82b8807ddee336",
      "signatureStatus": "E",
      "author": "James M Snell <[email protected]>",
      "files": [
        "votes/76d8966e-bd27-4e30-a13d-48200a34004a/jasnell"
      ]
    },
    "reason": "A more recent vote commit from this author has already been counted."
  }
]

Voted for export { foo as "module.exports" };. ↩
Abstained. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export const __cjsUnwrapDefault = true;. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export const __cjsUnwrapDefault = true;. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export const __cjsUnwrapDefault = true;. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export { foo as "module.exports" };. ↩
Voted for export const __cjsUnwrapDefault = true;. ↩

joyeecheung · 2024-09-30T15:39:54Z

Should it be merged by pushing the merge button or is there a workflow for it?

github-actions bot and others added 11 commits September 20, 2024 19:55

Initiate vote for "Choosing a marker to customize default exports ret…

601b545

…urned by `require(esm)`"

vote from joyeecheung

f49b2f1

Create vote-michael-dawson

beeff40

Create benjamingr.json

ec215c7

vote from marco

a0f892f

vote from mcollina

3df8642

vote from targos

9c63a9f

vote from aduh95

d7d4d9c

vote from ruyadorno

c957e50

Create jasnell

f603481

Rename jasnell to jasnell.json

ae9bf4b

anonrig and others added 4 commits September 25, 2024 10:01

vote from anonrig

8686af1

vote from rafaelgss

6253b94

vote from richardlau

b8a512a

Create legendecas.json

f619d66

vote from MoLow

453a16f

vote from ShogunPanda

05ba751

Create gireeshpunathil.json

1998d91

BridgeAR and others added 2 commits September 30, 2024 14:13

vote from BridgeAR

6d12996

close vote and aggregate results

aaf9f94

aduh95 approved these changes Sep 30, 2024

View reviewed changes

richardlau approved these changes Sep 30, 2024

View reviewed changes

guybedford mentioned this pull request Sep 30, 2024

Naming bikeshed - require(esm) interop flag nodejs/loaders#221

Closed

joyeecheung merged commit f3746de into main Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Choosing a marker to customize default exports returned by `require(esm)` #1622

Choosing a marker to customize default exports returned by `require(esm)` #1622

github-actions bot commented Sep 20, 2024 •

edited

Loading

aduh95 commented Sep 25, 2024

guybedford commented Sep 28, 2024

ShogunPanda commented Sep 28, 2024

joyeecheung commented Sep 28, 2024

joyeecheung commented Sep 28, 2024

aduh95 commented Sep 28, 2024

aduh95 commented Sep 29, 2024

richardlau commented Sep 30, 2024

targos commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

joyeecheung commented Sep 30, 2024

Choosing a marker to customize default exports returned by require(esm) #1622

Choosing a marker to customize default exports returned by require(esm) #1622

Conversation

github-actions bot commented Sep 20, 2024 • edited Loading

Footnotes

aduh95 commented Sep 25, 2024

guybedford commented Sep 28, 2024

ShogunPanda commented Sep 28, 2024

joyeecheung commented Sep 28, 2024

joyeecheung commented Sep 28, 2024

aduh95 commented Sep 28, 2024

aduh95 commented Sep 29, 2024

richardlau commented Sep 30, 2024

targos commented Sep 30, 2024

github-actions bot commented Sep 30, 2024

Election results

Results

Table of results

Voting data

Footnotes

joyeecheung commented Sep 30, 2024

Choosing a marker to customize default exports returned by `require(esm)` #1622

Choosing a marker to customize default exports returned by `require(esm)` #1622

github-actions bot commented Sep 20, 2024 •

edited

Loading