feat: support functions within type=module packages (Closes #3394) #3445

netlify-team-account-1 · 2021-10-04T11:59:11Z

- Summary

#3394 is about a project with type=module in its main "package.json". This PR adds detection for that, makes sure that we build using esbuild in that case (which will transpile from ESM to CJS), and also emit a package.json with type="commonjs" into the functions-serve directory (to override the main package.json's directive, which isn't applicable to CLI's compiled files).

- Test plan

added a reproduction test

- A picture of a cute animal (not mandatory but encouraged)

github-actions · 2021-10-04T11:59:43Z

📊 Benchmark results

Comparing with 7f85116

Package size: 357 MB

(no change)

^  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  352 MB  357 MB 
│   ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (7f85116): 357 MB
T-29 (0ab6390): 357 MB
T-28 (5f1bf32): 357 MB
T-27 (10d053d): 357 MB
T-26 (a24dc84): 358 MB
T-25 (1aef852): 358 MB
T-24 (558d6ed): 358 MB
T-23 (6d6022e): 353 MB
T-22 (532a040): 353 MB
T-21 (82bd008): 353 MB
T-20 (8192dba): 353 MB
T-19 (95890b2): 353 MB
T-18 (0208c89): 353 MB
T-17 (7815bbb): 352 MB
T-16 (68fd362): 352 MB
T-15 (b6446af): 352 MB
T-14 (3e3c80a): 352 MB
T-13 (adae111): 352 MB
T-12 (76a9aa6): 352 MB
T-11 (e406f33): 352 MB
T-10 (4289e60): 352 MB
T-9 (1ebb1e7): 352 MB
T-8 (414bd99): 352 MB
T-7 (0ae6e5a): 352 MB
T-6 (2e1a50c): 352 MB
T-5 (a1cb1ab): 352 MB
T-4 (db1fd6c): 352 MB
T-3 (ebbe72a): 352 MB
T-2 (9cddb74): 352 MB
T-1 (33a6660): 352 MB
T (current commit): 357 MB

netlify-team-account-1 · 2021-10-04T12:01:57Z

I spiked at a PR to lambda-local for this, but it's not as easy as I'd have hoped.

@eduardoboucas

trying to use "import" was surprisingly hard. I learned from @eduardoboucas that we use esbuild (via ZISI) to transpile ESM to CJS. This commit improves detection for that, and makes sure that any upper-level "package.json: type=module" directive is overriden.

package.json

src/lib/functions/runtimes/js/builders/zisi.js

tests/utils/site-builder.js

feat: write reproduction test for #3394

40c144f

netlify-team-account-1 added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Oct 4, 2021

netlify-team-account-1 linked an issue Oct 4, 2021 that may be closed by this pull request

Netlify Dev functions 500 error with package.json type="module" #3394

Closed

netlify-team-account-1 and others added 10 commits October 4, 2021 16:32

Update serving-functions.test.js

9053c6c

feat: fix by using import() for lambda funcs

01bd7dd

chore: use esm: true for another test

3e429dc

Merge branch 'main' into 3394-import-module

cbdbaaa

feat: switch import/require based on Node version

ed1e445

chore: don't cache dynamic imports

8b73038

Merge branch 'main' into 3394-import-module

d625a4d

fix: different approach

508bbdd

trying to use "import" was surprisingly hard. I learned from @eduardoboucas that we use esbuild (via ZISI) to transpile ESM to CJS. This commit improves detection for that, and makes sure that any upper-level "package.json: type=module" directive is overriden.

fix: optional chaining syntax unsupported

72ab99c

Merge branch 'main' into 3394-import-module

a646388

netlify-team-account-1 marked this pull request as ready for review October 12, 2021 09:55

netlify-team-account-1 requested a review from eduardoboucas October 12, 2021 09:55

eduardoboucas reviewed Oct 12, 2021

View reviewed changes

netlify-team-account-1 added 3 commits October 12, 2021 15:14

chore: use existing fs abstraction

1063515

chore: add explanatory comment

09a8a3a

chore: rename variable

cef0db3

netlify-team-account-1 mentioned this pull request Oct 12, 2021

chore: add eslint-plugin-sort-destructure-keys #3483

Merged

eduardoboucas approved these changes Oct 12, 2021

View reviewed changes

Merge branch 'main' into 3394-import-module

296b58b

netlify-team-account-1 added the automerge Add to Kodiak auto merge queue label Oct 13, 2021

This was referenced Oct 13, 2021

chore: remove read pkg up #3490

Closed

chore: replace @ungap/from-entries with own helper #3491

Closed

Merge branch 'main' into 3394-import-module

e95d585

kodiakhq bot merged commit a32da85 into main Oct 14, 2021

kodiakhq bot deleted the 3394-import-module branch October 14, 2021 08:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support functions within type=module packages (Closes #3394) #3445

feat: support functions within type=module packages (Closes #3394) #3445

netlify-team-account-1 commented Oct 4, 2021 •

edited

Loading

github-actions bot commented Oct 4, 2021 •

edited

Loading

netlify-team-account-1 commented Oct 4, 2021

feat: support functions within type=module packages (Closes #3394) #3445

feat: support functions within type=module packages (Closes #3394) #3445

Conversation

netlify-team-account-1 commented Oct 4, 2021 • edited Loading

github-actions bot commented Oct 4, 2021 • edited Loading

📊 Benchmark results

Package size: 357 MB

netlify-team-account-1 commented Oct 4, 2021

netlify-team-account-1 commented Oct 4, 2021 •

edited

Loading

github-actions bot commented Oct 4, 2021 •

edited

Loading