attempt to fix setting of env in build-debug command for cover task + added option to enable debug logging of require script via OPENCV4NODES_DEBUG_REQUIRE env

Author: justadudewhohacks

ci/envs/test.js

@@ -1,5 +1,5 @@
-const cv = require('opencv4nodejs')
+process.env.OPENCV4NODES_DEBUG_REQUIRE = true
 
-if (!cv) {
+if (!require('opencv4nodejs')) {
   throw new Error('failed to require opencv4nodejs')
 }

lib/cv.js

@@ -4,31 +4,57 @@ const { resolvePath } = require('./commons');
 
 const requirePath = path.join(__dirname, process.env.BINDINGS_DEBUG ? '../build/Debug/opencv4nodejs' : '../build/Release/opencv4nodejs')
 
+const logDebug = process.env.OPENCV4NODES_DEBUG_REQUIRE ? require('npmlog').info : () => {}
+
 function tryGetOpencvBinDir() {
-  // if the auto build is disabled via environment do not even attempt
+  if (process.env.OPENCV_BIN_DIR) {
+    logDebug('tryGetOpencvBinDir', 'OPENCV_BIN_DIR environment variable is set')
+    return process.env.OPENCV_BIN_DIR
+  }
+  // if the auto build is not disabled via environment do not even attempt
   // to read package.json
-  if (opencvBuild.isAutoBuildDisabled()) {
+  if (!opencvBuild.isAutoBuildDisabled()) {
+    logDebug('tryGetOpencvBinDir', 'auto build has not been disabled via environment variable, using opencv bin dir of opencv-build')
     return opencvBuild.opencvBinDir
   }
 
+  logDebug('tryGetOpencvBinDir', 'auto build has not been explicitly disabled via environment variable, attempting to read envs from package.json...')
   const envs = opencvBuild.readEnvsFromPackageJson()
-  return envs.disableAutoBuild
-    ? (envs.opencvBinDir || process.env.OPENCV_BIN_DIR)
-    : opencvBuild.opencvBinDir
+
+  if (!envs.disableAutoBuild) {
+    logDebug('tryGetOpencvBinDir', 'auto build has not been disabled via package.json, using opencv bin dir of opencv-build')
+    return opencvBuild.opencvBinDir
+  }
+
+  if (envs.opencvBinDir) {
+    logDebug('tryGetOpencvBinDir', 'found opencv binary environment variable in package.json')
+    return envs.opencvBinDir
+  }
+  logDebug('tryGetOpencvBinDir', 'failed to find opencv binary environment variable in package.json')
+  return null
 }
 
 let cv = null
 try {
+  logDebug('require', 'require path is ' + requirePath)
   cv = require(requirePath);
 } catch (err) {
+  logDebug('require', 'failed to require cv with exception: ' + err.toString())
+  logDebug('require', 'attempting to add opencv binaries to path')
+
+  if (!process.env.path) {
+    logDebug('require', 'there is no path environment variable, skipping...')
+    throw err
+  }
 
-  // TODO: non windows?
   const opencvBinDir = tryGetOpencvBinDir()
+  logDebug('require', 'adding opencv binary dir to path: ' + opencvBinDir)
 
   // ensure binaries are added to path on windows
   if (!process.env.path.includes(opencvBinDir)) {
     process.env.path = `${process.env.path};${opencvBinDir};`
   }
+  logDebug('require', 'process.env.path: ' + process.env.path)
   cv = require(requirePath);
 }
 

package.json

@@ -34,7 +34,7 @@
     "build": "node-gyp configure build --jobs max",
     "rebuild": "node-gyp rebuild --jobs max",
     "clean": "node-gyp clean",
-    "build-debug": "BINDINGS_DEBUG=true && node ./install/install.js"
+    "build-debug": "BINDINGS_DEBUG=true node ./install/install.js"
   },
   "gypfile": true,
   "dependencies": {