src: add initial support for single executable applications #45038

RaisinTen · 2022-10-17T13:47:10Z

Compile a JavaScript file into a single executable application:

$ echo 'console.log(`Hello, ${process.argv[2]}!`);' > hello.js

$ cp $(command -v node) hello

# On systems other than macOS:
$ npx postject hello NODE_JS_CODE hello.js \
    --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2

# On macOS:
$ npx postject hello NODE_JS_CODE hello.js \
    --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2 \
    --macho-segment-name NODE_JS

$ ./hello world
Hello, world!

Signed-off-by: Darshan Sen [email protected]

It was decided in the Node.js Collaborator Summit that we want to come up with an MVP that is capable of compiling a single JavaScript file into a single executable application. More features will be added incrementally.

Meeting notes for reference: https://github.com/nodejs/single-executable/blob/c7008ecd67a395c7c902d602f2f116e2c5744bc9/meetings/2022-10-01.md

cc @nodejs/single-executable

nodejs-github-bot · 2022-10-17T13:47:14Z

Review requested:

@nodejs/actions
@nodejs/gyp
@nodejs/startup
@nodejs/tsc

Refs: nodejs/node#45038 Signed-off-by: Darshan Sen <[email protected]>

doc/api/cli.md

lib/internal/main/compile.js

lib/internal/main/single_executable_application.js

tools/update-postject.sh

.github/workflows/tools.yml

jviotti · 2022-10-17T15:33:23Z

@RaisinTen Don't forget to list this PR in https://github.com/nodejs/single-executable's README, for the record :)

kapv89 · 2022-10-17T16:03:18Z

Question: does the executable require node to be installed?

deps/postject/src/package.json

jasnell · 2022-10-17T17:51:15Z

Adding postject really should be done in a separate commit. Also, are we sure it's actually needed here at all? It's a rather sizeable addition on its own.

GeoffreyBooth · 2022-10-17T18:34:50Z

Please make it print the experimental warning if that isn’t happening already.

Fixes the following error I came across while integrating Postject in Node.js: ```console ../deps/postject/src/dist/postject-api.h:30:13: error: unused function 'postject_options_init' [-Werror,-Wunused-function] static void postject_options_init(struct postject_options* options) { ^ 1 error generated. ``` Refs: nodejs/node#45038 Signed-off-by: Darshan Sen <[email protected]>

ovflowd · 2022-10-19T08:51:40Z

Is it just me or the deps/postject/postject.js is obfuscated, or at least very unreadable? Is this intended? Is this the source of the project or a compiled version? (I believe the later one)

ovflowd · 2022-10-19T08:54:32Z

Off-topic: Having the source of postject here means that this is a full copy of the original repository? What would happen with the original repository? Or is this intended to be a snapshot of the project at a given point in time?

ovflowd

Super cool stuff! Super mega hyper excited for this!

deps/postject/src/README.markdown

doc/api/cli.md

src/node.cc

src/util.cc

test/parallel/test-single-executable-application.js

tools/update-postject.sh

RaisinTen · 2022-10-19T09:40:08Z

Question: does the executable require node to be installed?

@kapv89 no it does not. That's one of the main use cases for the single executables applications - so that it is possible to distribute a Node.js application to a user who does not already have Node.js installed on their system.

RaisinTen · 2022-10-19T09:50:04Z

Adding postject really should be done in a separate commit. Also, are we sure it's actually needed here at all? It's a rather sizeable addition on its own.

@jasnell sure, moved it to its own PR - #45066. And yes, it is needed for the resource injection part.

RaisinTen · 2022-10-19T09:52:54Z

Is it just me or the deps/postject/postject.js is obfuscated, or at least very unreadable? Is this intended? Is this the source of the project or a compiled version? (I believe the later one)

@ovflowd it is the compiled version :)

ovflowd · 2022-10-19T10:57:38Z

@ovflowd it is the compiled version :)

Do we need the compiled version? As node-gyp seems to actually build the source?

RaisinTen · 2022-10-19T11:13:32Z

@ovflowd as mentioned in #45066 (comment), that is the webassembly code which is precompiled in postject. It's built using the emsdk, not node-gyp.

RaisinTen · 2023-04-10T11:38:45Z

@danielleadams done - #47495!

danielleadams · 2023-04-11T13:02:38Z

@RaisinTen If you have some time, would you mind putting together a small summary for the v18.16.0 release notes? Thanks!

RaisinTen · 2023-04-11T13:45:19Z

@danielleadams sure! Does this work?

Add initial support for single executable applications

Compile a JavaScript file into a single executable application:

$ echo 'console.log(`Hello, ${process.argv[2]}!`);' > hello.js

$ cp $(command -v node) hello

# On systems other than macOS:
$ npx postject hello NODE_JS_CODE hello.js \
    --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2

# On macOS:
$ npx postject hello NODE_JS_CODE hello.js \
    --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2 \
    --macho-segment-name NODE_JS

$ ./hello world
Hello, world!

Contributed by Darshan Sen in #45038

danielleadams · 2023-04-12T03:13:03Z

@RaisinTen perfect - thanks!

waitingsong · 2023-04-13T03:14:01Z

something wrong?

[admin tmp]$ npx postject hello NODE_JS_CODE hello.js \
>     --sentinel-fuse NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2

Need to install the following packages:
  [email protected]
Ok to proceed? (y)
Start injection of NODE_JS_CODE in hello...
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'
warning: Can't find string offset for section name '.note.100'

CentOS 8

[admin tmp]$ uname -a
Linux git 4.18.0-348.7.1.el8_5.x86_64 #1 SMP Wed Dec 22 13:25:12 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux

RaisinTen · 2023-04-13T04:47:34Z

@waitingsong which version of Node.js are you using? Does running ./hello work for you? Also, if you don't mind could you open an issue in https://github.com/nodejs/postject/issues to further discuss this?

waitingsong · 2023-04-13T05:21:45Z

which version of Node.js are you using? Does running ./hello work for you? Also, if you don't mind could you open an issue in https://github.com/nodejs/postject/issues to further discuss this?


[admin tmp]$ node -v
v18.16.0
[admins tmp]$ npm -v
9.5.1

[admin tmp]$ node hello.js
Hello, undefined!

issue: nodejs/postject#83

EDIT:
It works.

RezaErfani67 · 2023-11-06T02:16:44Z

it give me error
Error [ERR_UNKNOWN_BUILTIN_MODULE]: No such built-in module: express
at embedderRequire (node:internal/util/embedding:48:11)
at hello.js:1:17
at embedderRunCjs (node:internal/util/embedding:37:10)
at node:internal/main/embedding:18:8 {
code: 'ERR_UNKNOWN_BUILTIN_MODULE'
}
@RaisinTen

RaisinTen · 2023-11-06T06:09:36Z

@RezaErfani67 could you create an issue in https://github.com/nodejs/single-executable/issues?

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Oct 17, 2022

RaisinTen mentioned this pull request Oct 17, 2022

src,doc: Experimental support for SEA #42334

Closed

RaisinTen added a commit to nodejs/single-executable that referenced this pull request Oct 17, 2022

Add a link to the initial MVP to the status

5903bf8

Refs: nodejs/node#45038 Signed-off-by: Darshan Sen <[email protected]>

RaisinTen mentioned this pull request Oct 17, 2022

Add a link to the initial MVP to the status nodejs/single-executable#52

Merged

aduh95 added semver-minor PRs that contain new features and should be released in the next minor version. notable-change PRs with changes that should be highlighted in changelogs. labels Oct 17, 2022

aduh95 reviewed Oct 17, 2022

View reviewed changes

.github/workflows/tools.yml Outdated Show resolved Hide resolved

ruyadorno reviewed Oct 17, 2022

View reviewed changes

deps/postject/src/package.json Show resolved Hide resolved

RaisinTen mentioned this pull request Oct 19, 2022

fix: make sure that postject-api.h compiles without warnings nodejs/postject#54

Merged

ovflowd reviewed Oct 19, 2022

View reviewed changes

RaisinTen mentioned this pull request Oct 19, 2022

deps: add postject #45066

Closed

RaisinTen mentioned this pull request Oct 20, 2022

Replace commander with parseArgs nodejs/postject#56

Open

RaisinTen mentioned this pull request Apr 10, 2023

[v18.x backport] src: add initial support for single executable applications #47495

Closed

RaisinTen added backport-open-v18.x and removed backport-requested-v18.x labels Apr 10, 2023

danielleadams added backported-to-v18.x and removed backport-open-v18.x labels Apr 11, 2023

danielleadams mentioned this pull request Apr 11, 2023

v18.16.0 release proposal #47502

Merged

RaisinTen added the single-executable Issues and PRs related to single-executable applications label May 5, 2023

Uh oh!

src: add initial support for single executable applications #45038

src: add initial support for single executable applications #45038

Uh oh!

Conversation

RaisinTen commented Oct 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Oct 17, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jviotti commented Oct 17, 2022

Uh oh!

kapv89 commented Oct 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jasnell commented Oct 17, 2022

Uh oh!

GeoffreyBooth commented Oct 17, 2022

Uh oh!

ovflowd commented Oct 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ovflowd commented Oct 19, 2022

Uh oh!

ovflowd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RaisinTen commented Oct 19, 2022

Uh oh!

RaisinTen commented Oct 19, 2022

Uh oh!

RaisinTen commented Oct 19, 2022

Uh oh!

ovflowd commented Oct 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RaisinTen commented Oct 19, 2022

Uh oh!

RaisinTen commented Apr 10, 2023

Uh oh!

danielleadams commented Apr 11, 2023

Uh oh!

RaisinTen commented Apr 11, 2023

Uh oh!

danielleadams commented Apr 12, 2023

Uh oh!

waitingsong commented Apr 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RaisinTen commented Apr 13, 2023

Uh oh!

waitingsong commented Apr 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RezaErfani67 commented Nov 6, 2023

Uh oh!

RaisinTen commented Nov 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

RaisinTen commented Oct 17, 2022 •

edited

Loading

kapv89 commented Oct 17, 2022 •

edited

Loading

ovflowd commented Oct 19, 2022 •

edited

Loading

ovflowd commented Oct 19, 2022 •

edited

Loading

waitingsong commented Apr 13, 2023 •

edited

Loading

waitingsong commented Apr 13, 2023 •

edited

Loading