Create prebuilt binaries using `prebuild` #47

Abrahamic-God · 2017-11-11T01:54:10Z

Closes #40.

This PR should provide almost everything needed to immediately start getting pre-built binaries automatically created and uploaded to GitHub for the following platforms:

Before merging, you'll want to set up this project on both AppVeyor and TravisCI. This should be just a few mouse clicks, all you're doing is telling these services that yes, you would like to build this project. You don't need to do any configuration at this time.

Once that's done, you'll need to replace my encrypted GitHub token (the prebuild_upload environment variable) with your own:

Follow the steps outlined in the prebuild docs for creating a GitHub token with the appropriate scope permissions.
Use the AppVeyor "Encrypt Data" page to encrypt your token. Then, paste it over my encrypted token in line 4 of appveyor.yml.
Install the TravisCI CLI.
From your local node-usb-detection directory, run the following command to get your encrypted prebuild_upload env var with your token:
```
travis encrypt prebuild_upload=YOUR_GITHUB_TOKEN_HERE
```
Copy the resulting output and paste it over mine in line 22 of .travis.yml.
Commit/push your changes, then merge this PR! 🎉 If I've done everything right, tagged commits will trigger a build, and automatically publish their artifacts to the GitHub release. The release will also be created if it does not already exist.

Caveats:

Travis' OSX build infrastructure is pretty overwhelmed at this point. On bad days it can take upwards of 5 hours for an OSX build to start. At night it settles down and you can usually get your build started immediately. You can look at the graphs on https://www.traviscistatus.com/ to get a feel for the patterns of when their infrastructure is completely slammed.

Credits:

I used pretty much all of the CI configs from node-serialport as a base. I made very few modifications to them.

[skip appveyor]

[ci skip]

Abrahamic-God · 2017-11-11T01:56:21Z

Oh, this also includes a pretty comprehensive testing matrix for once we actually have tests that are okay for CI. In the meantime, this matrix just ensures that everything at least compiles on all the various platforms, architectures, and a few versions of Node.

lovell · 2017-11-11T09:17:45Z

@lange You should be able to simplify the Travis CI config by by switching to an Ubuntu 14.04 image and removing the manual g++-4.8 boilerplate - see https://docs.travis-ci.com/user/reference/trusty/

Abrahamic-God · 2017-11-11T17:04:10Z

@lovell Good call! I've gone ahead and made that simplification. I'm not very knowledgable on C/C++ in general, but I think I did the correct thing by leaving the g++-4.8-multilib and gcc-multilib packages in the apt config?

Abrahamic-God · 2017-11-11T17:31:10Z

I was able to further simplify the build config and get away with installing fewer apt packages. The build times are now wicked fast on Linux:

Fix #40 PR, #47

MadLittleMods · 2017-11-11T23:38:23Z

Thanks for the contribution @lange ❤️

Merged via b49c568 🚀

First set of built binaries on a tagged release here, https://github.com/MadLittleMods/node-usb-detection/releases/tag/v1.4.1 😎

We should add some documentation to the README around our new binary builds and how to use them. Is there a popular pattern for downloading, requiring and using prebuilt binaries? (best way to skip native addon compilation for that particular dependency and download/unzip the binary in the right place instead)

Abrahamic-God · 2017-11-12T04:39:38Z

@MadLittleMods All the installation is handled automatically by prebuild-install, which is already set up in the npm scripts. No further user action should be necessary if I've set everything up correctly.

MadLittleMods · 2017-11-12T05:02:33Z

@lange 😮 Fancy!

I'm noticing that the install just hangs after it prints the Successfully installed prebuilt binary! message. Are things installing correctly for you?

$ npm install usb-detection --save

> usb-detection@1.4.1 install C:\Users\MLM\Downloads\usb-detection-install-test3\node_modules\usb-detection
> prebuild-install || node-gyp rebuild

prebuild-install info begin Prebuild-install version 2.3.0
prebuild-install info looking for local prebuild @ prebuilds\usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install info looking for cached prebuild @ C:\Users\MLM\AppData\Roaming\npm-cache\_prebuilds\https-github.com-MadLittleMods-node-usb-detection-releases-download-v1.4.1-usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install http request GET https://github.com/MadLittleMods/node-usb-detection/releases/download/v1.4.1/usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install http 200 https://github.com/MadLittleMods/node-usb-detection/releases/download/v1.4.1/usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install info downloading to @ C:\Users\MLM\AppData\Roaming\npm-cache\_prebuilds\https-github.com-MadLittleMods-node-usb-detection-releases-download-v1.4.1-usb-detection-v1.4.1-node-v48-win32-x64.tar.gz.20984-0d339e9b36bc3.tmp
prebuild-install info renaming to @ C:\Users\MLM\AppData\Roaming\npm-cache\_prebuilds\https-github.com-MadLittleMods-node-usb-detection-releases-download-v1.4.1-usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install info unpacking @ C:\Users\MLM\AppData\Roaming\npm-cache\_prebuilds\https-github.com-MadLittleMods-node-usb-detection-releases-download-v1.4.1-usb-detection-v1.4.1-node-v48-win32-x64.tar.gz
prebuild-install info unpack resolved to C:\Users\MLM\Downloads\usb-detection-install-test3\node_modules\usb-detection\build\Release\detection.node
prebuild-install info unpack required C:\Users\MLM\Downloads\usb-detection-install-test3\node_modules\usb-detection\build\Release\detection.node successfully
prebuild-install info install Successfully installed prebuilt binary!

Abrahamic-God · 2017-11-12T05:05:24Z

@MadLittleMods Oh, you're right. That can't be good. At this time I'm unsure what the cause of this could be

Abrahamic-God · 2017-11-12T05:07:47Z

Got it, the problem is that this module doesn't let the node process exit by default, and prebuild-install does a test require of it to verify that it loads: prebuild/prebuild-install#45 (comment)

MadLittleMods · 2017-11-12T05:12:59Z

@lange Ahh, nice catch! We would need to shove a usbDetect.stopMonitoring(); in there somehow but doesn't look very possible.

Because of the side-effects of the module currently when required, I think we should perhaps make a v2 with usbDetect.startMonitoring() added to the API. And make a new usb-detect@1.4.2 release without the prebuild-install. wdyt?

Abrahamic-God · 2017-11-12T05:20:08Z

@MadLittleMods I agree, that seems like the fastest way forward and a reasonable approach.

Abrahamic-God · 2017-11-12T05:20:58Z

Though actually we don't need to make a new 1.4.2, just delete the pre-build binaries from the github release and the existing 1.4.2 release will automatically fallback to building from source, same as usual.

See #47 (comment)

MadLittleMods · 2017-11-12T05:55:52Z

@lange and I chatted a bit more here, ☝️ November 11, 2017 11:25 PM

1.4.2 released without install hook 🚀 Remove install hook to prevent hanging - Prepare 1.4.2 #48
2.x without side-effects Remove side-effects and instead use startMonitoring() #49
- It looks like startMonitoring is already an available function but we also start things in InitDetection which gets called in the constructor init sorta thing which is causing the side-effects.
- I would also like to get Fix 100% CPU usage, use non-blocking IO to exit gracefully (remove side-effects) #46 wrapped up and shipped but that requires a bit more digging (help wanted)

Abrahamic-God added 5 commits November 10, 2017 14:15

chore: add prebuilds folder to .gitignore

efbfbef

feat(package): add prebuild scripts

330d5e5

feat: add appveyor builds

f174d15

feat: add travis (macOS and Linux) builds

7c0b596

[skip appveyor]

fix(package): revert URLs so that this can be merged

be8ab57

[ci skip]

Abrahamic-God mentioned this pull request Nov 11, 2017

Provide pre-built "sharp.node" binary for common platforms and Node versions lovell/sharp#186

Closed

chore: slightly simplify travis builds

fa18ac1

chore: further simplify travis builds

f1e367d

MadLittleMods pushed a commit that referenced this pull request Nov 11, 2017

Create prebuilt binaries on tagged releases

b49c568

Fix #40 PR, #47

MadLittleMods closed this Nov 11, 2017

MadLittleMods added a commit that referenced this pull request Nov 12, 2017

Remove prebuild-install hook to prevent hanging

60977f4

See #47 (comment)

MadLittleMods mentioned this pull request Nov 12, 2017

Remove install hook to prevent hanging - Prepare 1.4.2 #48

Merged

MadLittleMods mentioned this pull request Nov 12, 2017

Remove side-effects and instead use startMonitoring() #49

Merged

3 tasks

Abrahamic-God mentioned this pull request Feb 19, 2018

Move binary publishing to Github and off S3 bucket creationix/node-gamepad#17

Closed

Abrahamic-God mentioned this pull request Mar 6, 2018

Use "prebuild" for creating and publishing binaries creationix/node-gamepad#18

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create prebuilt binaries using `prebuild` #47

Create prebuilt binaries using `prebuild` #47

Abrahamic-God commented Nov 11, 2017 •

edited

Loading

Abrahamic-God commented Nov 11, 2017 •

edited

Loading

lovell commented Nov 11, 2017

Abrahamic-God commented Nov 11, 2017

Abrahamic-God commented Nov 11, 2017

MadLittleMods commented Nov 11, 2017 •

edited

Loading

Abrahamic-God commented Nov 12, 2017 •

edited

Loading

MadLittleMods commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017 •

edited

Loading

MadLittleMods commented Nov 12, 2017 •

edited

Loading

Abrahamic-God commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017

MadLittleMods commented Nov 12, 2017 •

edited

Loading

Create prebuilt binaries using prebuild #47

Create prebuilt binaries using prebuild #47

Conversation

Abrahamic-God commented Nov 11, 2017 • edited Loading

Abrahamic-God commented Nov 11, 2017 • edited Loading

lovell commented Nov 11, 2017

Abrahamic-God commented Nov 11, 2017

Abrahamic-God commented Nov 11, 2017

MadLittleMods commented Nov 11, 2017 • edited Loading

Abrahamic-God commented Nov 12, 2017 • edited Loading

MadLittleMods commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017 • edited Loading

MadLittleMods commented Nov 12, 2017 • edited Loading

Abrahamic-God commented Nov 12, 2017

Abrahamic-God commented Nov 12, 2017

MadLittleMods commented Nov 12, 2017 • edited Loading

Create prebuilt binaries using `prebuild` #47

Create prebuilt binaries using `prebuild` #47

Abrahamic-God commented Nov 11, 2017 •

edited

Loading

Abrahamic-God commented Nov 11, 2017 •

edited

Loading

MadLittleMods commented Nov 11, 2017 •

edited

Loading

Abrahamic-God commented Nov 12, 2017 •

edited

Loading

Abrahamic-God commented Nov 12, 2017 •

edited

Loading

MadLittleMods commented Nov 12, 2017 •

edited

Loading

MadLittleMods commented Nov 12, 2017 •

edited

Loading