electron + windows issue; aka `win_delay_load_hook` issue

[usagi]

Issue

It will be happen if we want to use electron with node-bindgen on Windows:

error: linking with `link.exe` failed: exit code: 1181
  |
(...abbr...)
  = note: LINK : fatal error LNK1181: cannot open input file 'win_delay_load_hook.obj'

Reference

• https://www.electronjs.org/docs/tutorial/using-native-node-modules
  • https://www.electronjs.org/docs/tutorial/using-native-node-modules#a-note-about-win_delay_load_hook

Coping method in neon

• Windows electron neon-bindings/neon#435

Note

Using dherman/electron-build-env makes it easy to prepare a workspace for repro.

1. In the ./native directory, prepare a cdylib project use node-bindgen.
2. In the ./ directory, prepare a package.json with electron-build-env and nj-cli in the devDependencies. And prepare "electron-build-env nj-cli build" in scripts such as experiment0.
3. Run yarn experiment0.

[timfish]

Was this already fixed here?

[sehz]

@usagi Is the bug still there?

[usagi]

// Wait a minutes please, I'll test in my Windows machine, and then report current status.

[usagi]

Unfortunatelly, I cannot try to the testing because #46 is blocking.

[sehz]

Can you try this again now since #46 is resolved?

[usagi]

// Wait a days please, I'll make a time.

[usagi]

Sadly, this issue is not solved yet.

Repro:

1. Prepare a project using node-bindgen ( In easily, just use the example/function project )
2. Run yarn init && yarn add electron && yarn add electron-build-env nj-cli -D in the project root dir.
3. Run yarn electron-build-env nj-cli build.

  = note: "C:\\(...abbr...)\link.exe" "/NOLOGO" (...abbr...) "userenv.lib" "msvcrt.lib" "win_delay_load_hook.obj" "delayimp.lib" "/DELAYLOAD:node.exe"
  = note: LINK : fatal error LNK1181: cannot open input file 'win_delay_load_hook.obj'

The full log: https://gist.github.com/usagi/659dd478c0eda47297bcebc10ff9e1fe

Reason why?:

• nj-cli and node-bindgen build ecosystem is not preparing the win_delay_load_hook.obj, thus the linker cannot open the file then it failed.
  • Need tricks for build the win_delay_load_hook.obj in the build ecosystem of node-bindgen.
  • node-gyp has the https://github.com/nodejs/node-gyp/blob/master/src/win_delay_load_hook.cc. (The neon's build ecosystem is using it.)

Hints: neon's case

$ git clone git@github.com:neon-bindings/neon.git
$ cd neon
$ ack "node-gyp" ## or `grep`

[master]
appveyor.yml
35:  # Workaround until https://github.com/nodejs/node-gyp/issues/1933 is fixed.

crates/neon-sys/build.rs
32:        // 2. Build the object file from source using node-gyp.
92:    // The node-gyp build output includes platform information in a string
102:    // The node-gyp output includes the root directory of shared resources
105:    //     '-Dnode_root_dir=C:\\Users\\dherman\\.node-gyp\\8.3.0'
111:            .expect("Couldn't find node_root_dir in node-gyp output.");
116:    // The node-gyp output includes the name of the shared Node library file.
124:    //     '-Dnode_lib_file=C:\\Users\\dherman\\.node-gyp\\8.3.0\\<(target_arch)\\node.lib'
133:            .expect("Couldn't find node_lib_file in node-gyp output.");
140:            // Downcase all the npm environment variables to ensure they are read by node-gyp.
152:        // Run `node-gyp configure` in verbose mode to read node_root_dir on Windows.
156:            .expect("Failed to run \"node-gyp configure\" for neon-sys!");
160:                "Failed to run \"node-gyp configure\" for neon-sys!\n Out: {}\n Err: {}",
172:        // Run `node-gyp build`.
177:            .expect("Failed to run \"node-gyp build\" for neon-sys!");

crates/neon-sys/native/package-lock.json
400:    "node-gyp": {
402:      "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-3.6.2.tgz",

crates/neon-sys/native/package.json
4:    "preinstall": "echo 'Skipping node-gyp installation as part of npm install.'",
5:    "configure-release": "node-gyp configure --verbose",
6:    "configure-debug": "node-gyp configure --verbose --debug",
7:    "build-release": "node-gyp build --verbose",
8:    "build-debug": "node-gyp build --verbose --debug"
12:    "node-gyp": "^3.5.0",

RELEASES.md
15:* Workaround for nodejs/node-gyp#1933

What's the win_delay_load_hook.obj?

• https://www.electronjs.org/docs/tutorial/using-native-node-modules#a-note-about-win_delay_load_hook

Appendix: Run the app with Electron if it solved

1. yarn electron-build-env nj-cli build ( -> succeeded )
2. Add index.html, index.js, preload.js
   • Eg. https://gist.github.com/usagi/913f6ae1c9905c77508f9864d469d835; See also https://github.com/electron/electron-quick-start
3. yarn electron .

[sehz]

Thanks for detailed explanation.