Increase binary build portability (issue #1129)

Author: Christopher Jones

CHANGELOG.md

@@ -18,6 +18,8 @@
 
 - Fixed a compilation warning seen on Windows.
 
+- Improve portability of buildbinary.js, a package creation script. (#1129)
+
 ## node-oracledb v4.0.0 (25 Jul 2019)
 
 - Refactored the node-oracledb implementation to use

package/README.md

@@ -1,45 +1,51 @@
 # Overview
 
 This directory is used for building the [node-oracledb npm
-package](https://www.npmjs.com/package/oracledb).  The scripts can
-also be used to create custom packages for hosting on a local server.
+package](https://www.npmjs.com/package/oracledb).  The scripts can also be used
+to create a custom package for hosting on a local server.
 
 Most users do not need to use anything in this directory.
 
 # Maintainers
 
 In a clone or copy of the repository:
 
-- `npm run buildbinary` calls `buildbinary.js` to create a
-  node-oracledb binary for the current operating system.
+- Run `npm run buildbinary`.  This calls `buildbinary.js` to create a
+  node-oracledb binary for the current operating system.  Depending how Node.js
+  was installed, you may need to run `npm install node-gyp -g` first.
 
-- `npm run buildpackage` calls `buildpackage.js` to make the
-  node-oracledb package containing the node-oracledb JavaScript files,
-  the available binaries, and a package.json that has an `install`
-  script and a `prune` script.  The package will be created in the top
-  level directory.
+  You can run `npm run buildbinary` on each operating system architecture that
+  you want to include in your package.  Copy the node-oracledb binaries and
+  related build metadata information files to the `package/Staging` directory on
+  one machine.
 
-  Before executing `npm run buildpackage`, all node-oracledb binaries
-  and related build metadata information files from all operating
-  systems should be placed in the `package/Staging` directory.
+- Run `npm run buildpackage`.  This calls `buildpackage.js` to make the
+  node-oracledb package containing the node-oracledb JavaScript files, the
+  available binaries, and a `package.json` that has `install` and `prune` script
+  targets.  The package will be created in the top level directory.  It can be
+  uploaded to npmjs.com, or to your own local server, and then used as a
+  dependency in your projects.
 
 # Package Installation
 
-- As part of an `npm install` that uses the created package, the
-  `package.json` install script runs `install.js` to check a binary
-  module for the current Node.js and operating system is available.
-
-  If a suitable binary is not available, installation will fail.
-  Users must then compile node-oracledb using source code from GitHub.
-  Alternatively a different version of node-oracledb, Node.js, or
-  different operating system may have a suitable pre-built binary
-  available.
-
-- After install, space conscious users can run `npm run prune` which
-  removes pre-built binaries for all other operating systems.
-
-By default the top level `package.json` doesn't have an `install`
-script target.  This means that node-gyp will be invoked to compile
-node-oracledb.  This allows installation from [source
-code](https://oracle.github.io/node-oracledb/INSTALL.html#github) (via
-GitHub) when no suitable pre-built binary is available.
+- As part of an `npm install` that uses the created package, the `package.json`
+  install script runs `install.js` to check the availability of a binary module
+  for the current Node.js version and operating system architecture.
+
+  If a suitable binary is not available, installation will fail.  Users must
+  then compile node-oracledb using source code from GitHub.  Alternatively a
+  different version of node-oracledb, Node.js, or different operating system may
+  have a suitable pre-built binary available.  See
+  https://github.com/oracle/node-oracledb/releases for information about Node.js
+  versions and pre-built node-oracledb binaries.
+
+- After install, space conscious users can run `npm run prune` which removes
+  pre-built binaries for all other architectures.
+
+The
+[`package.json`](https://github.com/oracle/node-oracledb/blob/master/package.json)
+in GitHub doesn't have an `install` script target by default.  This means that
+node-gyp will be invoked to compile node-oracledb.  This allows installation
+from GitHub [source
+code](https://oracle.github.io/node-oracledb/INSTALL.html#github) when no
+suitable pre-built binary is available.

package/buildbinary.js

@@ -66,7 +66,7 @@ function buildBinary() {
     fs.unlink(buildBinaryFile, function(err) {if (err && !err.message.match(/ENOENT/)) throw(err);});
     fs.unlink(binaryStagingFile, function(err) {if (err && !err.message.match(/ENOENT/)) throw(err);});
     fs.unlink(binaryStagingInfoFile, function(err) {if (err && !err.message.match(/ENOENT/)) throw(err);});
-    execSync('npm install');
+    execSync('node-gyp rebuild');
     fs.renameSync(buildBinaryFile, binaryStagingFile);
     fs.appendFileSync(binaryStagingInfoFile, buildInfo + "\n");
   } catch(err) {