upgrade to Node 12 (#576)

Upgrade to support Node 12
Remove support for Node 6 
Set Travis to test on Windows, Mac & Linux
Update package.json version number to 5.0.0
Update README.md with new version details

Author: rwalle61

.travis.yml

@@ -3,10 +3,30 @@ language: node_js
 before_install:
   - git submodule update --init --recursive
 node_js:
-  - "6"
   - "8"
   - "10"
+  - "12"
 os:
+  - osx
   - linux
+
+matrix:
+  include:
+    - os: windows
+      node_js: "8"
+    - os: windows
+      node_js: "10"
+    - os: windows
+      node_js: "12"
+  allow_failures:
+    - os: windows
+      node_js: "8"
+    - os: windows
+      node_js: "10"
+    - os: windows
+      node_js: "12"
+  fast_finish: true
+
+
 script: npm run-script travis
 

AUTHORS.md

@@ -20,3 +20,4 @@ Authors ordered by first contribution:
  - Vladislav Botvin (https://github.com/darky)
  - John Barboza (https://github.com/jbarz)
  - Abdirahim Musse (https://github.com/ab-m)
+ - Richard Waller (https://github.com/rwalle61)

README.md

@@ -42,7 +42,7 @@ Node Application Metrics provides the following built-in data collection sources
  Redis              | Redis commands issued by the application
  Riak               | Riak methods called by the application
  Request tracking   | A tree of application requests, events and optionally trace (disabled by default)
- Function trace     | Tracing of application function calls that occur during a request (disabled by default)  
+ Function trace     | Tracing of application function calls that occur during a request (disabled by default)
 
 ## Performance overhead
 
@@ -140,7 +140,7 @@ Sets various properties on the appmetrics monitoring agent. If the agent has alr
 
 Property name        | Property value type      | Property description
 :--------------------|:-------------------------|:-----------------------------
- `applicationID`     | `string`                 | Specifies a unique identifier for the mqtt connection             
+ `applicationID`     | `string`                 | Specifies a unique identifier for the mqtt connection
  `mqtt`              | `string['off'\|'on']`    | Specifies whether the monitoring agent sends data to the mqtt broker. The default value is `'on'`
  `mqttHost`          | `string`                 | Specifies the host name of the mqtt broker
  `mqttPort`          | `string['[0-9]*']`       | Specifies the port number of the mqtt broker
@@ -418,14 +418,7 @@ Requests are a special type of event emitted by appmetrics.  All the probes name
 
 The Node Application Metrics agent supports the following runtime environments where a Node.js runtime is available:
 
-* **Node.js v4** on:
-  * 64-bit or 32-bit Windows (x64 or x86)
-  * 64-bit or 32-bit Linux (x64, x86, ppc64, ppc64le, s390, s390x)
-  * 64-bit AIX (ppc64)
-  * 64-bit macOS (x64)
-* **Node.js v6** on all of the above, plus:
-  * 64-bit runtime on z/OS (os390)
-* **Node.js v8** on:
+* **Node.js v8, 10, 12** on:
   * 64-bit Windows (x64)
   * 64-bit Linux (x64, ppc64, ppc64le, s390x)
   * 64-bit AIX (ppc64)
@@ -472,7 +465,7 @@ If a task uses the Node.js thread exclusively then shuts down the Node.js runtim
 The source code for Node Application Metrics is available in the [appmetrics project][6]. Information on working with the source code -- installing from source, developing, contributing -- is available on the [appmetrics wiki][3].
 
 ## License
-This project is released under an Apache 2.0 open source license.  
+This project is released under an Apache 2.0 open source license.
 
 ## Versioning scheme
 The npm package for this project uses a semver-parsable X.0.Z version number for releases, where X is incremented for breaking changes to the public API described in this document and Z is incremented for bug fixes **and** for non-breaking changes to the public API that provide new function.
@@ -484,41 +477,43 @@ Non-release versions of this project (for example on github.com/RuntimeTools/app
 
 This module adopts the [Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy, with the following End Of Life (EOL) dates:
 
-| Module Version   | Release Date | Minimum EOL | EOL With     | Status  |
-|------------------|--------------|-------------|--------------|---------|
-| V4.x.x	         | Jan 2018     | Dec 2019    |              | Current |
+| Module Version   | Release Date | Minimum EOL | EOL With     | Status      |
+|------------------|--------------|-------------|--------------|-------------|
+| V4.x.x           | Jan 2018     | Dec 2019    |              | Maintenance |
+| V5.x.x           | May 2019     | Dec 2020    |              | Current     |
 
 ## Version
-4.0.1
+5.0.0
 
 ## Release History
-`4.0.1` - Bug fix release including adding Node 10 support on Windows (Unix already working).  
-`4.0.0` - Remove node-hc and add support for preloading.  
-`3.1.3` - Packaging fix.  
-`3.1.2` - Bug fixes.  
-`3.1.1` - Node v6 on z/OS support.  
-`3.1.0` - HTTPS probe added. Remove support for Node v7.    
-`3.0.2` - Probe defect for Node 8 support.  
-`3.0.1` - Packaging bug fix to allow build from source if binary not present.  
-`3.0.0` - Remove express probe. Additional data available in http and request events. Code improvements.  
-`2.0.1` - Remove support for Node.js 0.10, 0.12, 5.  Add heapdump api call.  
-`1.2.0` - Add file data collection capability and option configuration via api.  
-`1.1.2` - Update agent core to 3.0.10, support Node.js v7.  
-`1.1.1` - Fix node-gyp rebuild failure and don't force MQTT broker to on  
-`1.1.0` - Bug fixes, improved MongoDB data, updated dependencies, CPU watchdog feature  
-`1.0.13` - Express probe, strong-supervisor integration  
-`1.0.12` - Appmetrics now fully open sourced under Apache 2.0 license  
-`1.0.11` - Bug fixes    
-`1.0.10` - Bug fixes  
-`1.0.9` - Loopback and Riak support, bug fixes and update to agent core 3.0.9.  
-`1.0.8` - Oracle support, bug fixes and api tests runnable using 'npm test'.  
-`1.0.7` - StrongOracle support, support for installing with a proxy, expose MongoDB, MQLight and MySQL events to connectors.  
-`1.0.6` - OracleDB support and bug fixes.  
-`1.0.5` - Expose HTTP events to connectors (including MQTT).  
-`1.0.4` - Redis, Leveldown, Postgresql, Memcached, MQLight and MQTT support, higher precision timings, and improved performance.  
-`1.0.3` - Node.js v4 support.  
-`1.0.2` - HTTP, MySQL, MongoDB, request tracking and function tracing support.  
-`1.0.1` - Mac OS X support, io.js v2 support.  
+`5.0.0` - Add Node 12 support, remove Node 6 support.
+`4.0.1` - Bug fix release including adding Node 10 support on Windows (Unix already working).
+`4.0.0` - Remove node-hc and add support for preloading.
+`3.1.3` - Packaging fix.
+`3.1.2` - Bug fixes.
+`3.1.1` - Node v6 on z/OS support.
+`3.1.0` - HTTPS probe added. Remove support for Node v7.
+`3.0.2` - Probe defect for Node 8 support.
+`3.0.1` - Packaging bug fix to allow build from source if binary not present.
+`3.0.0` - Remove express probe. Additional data available in http and request events. Code improvements.
+`2.0.1` - Remove support for Node.js 0.10, 0.12, 5.  Add heapdump api call.
+`1.2.0` - Add file data collection capability and option configuration via api.
+`1.1.2` - Update agent core to 3.0.10, support Node.js v7.
+`1.1.1` - Fix node-gyp rebuild failure and don't force MQTT broker to on
+`1.1.0` - Bug fixes, improved MongoDB data, updated dependencies, CPU watchdog feature
+`1.0.13` - Express probe, strong-supervisor integration
+`1.0.12` - Appmetrics now fully open sourced under Apache 2.0 license
+`1.0.11` - Bug fixes
+`1.0.10` - Bug fixes
+`1.0.9` - Loopback and Riak support, bug fixes and update to agent core 3.0.9.
+`1.0.8` - Oracle support, bug fixes and api tests runnable using 'npm test'.
+`1.0.7` - StrongOracle support, support for installing with a proxy, expose MongoDB, MQLight and MySQL events to connectors.
+`1.0.6` - OracleDB support and bug fixes.
+`1.0.5` - Expose HTTP events to connectors (including MQTT).
+`1.0.4` - Redis, Leveldown, Postgresql, Memcached, MQLight and MQTT support, higher precision timings, and improved performance.
+`1.0.3` - Node.js v4 support.
+`1.0.2` - HTTP, MySQL, MongoDB, request tracking and function tracing support.
+`1.0.1` - Mac OS X support, io.js v2 support.
 `1.0.0` - First release.
 
 [1]:https://marketplace.eclipse.org/content/ibm-monitoring-and-diagnostic-tools-health-center

package.json

@@ -1,6 +1,6 @@
 {
   "name": "appmetrics",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "engines": {
     "node": ">=6"
   },
@@ -19,7 +19,7 @@
     "codecov": "^3.1.0",
     "eslint": "^4.0.0",
     "eslint-config-strongloop": "^2.1.0",
-    "node-gyp": "3.x",
+    "node-gyp": "4.x",
     "prettier": "^1.4.4",
     "tap": "^12.0.1"
   },

src/appmetrics.cpp

@@ -87,7 +87,12 @@ namespace monitorApi {
 
 static std::string toStdString(Local<String> s) {
     char *buf = new char[s->Length() + 1];
+#if NODE_VERSION_AT_LEAST(10, 0, 0)
+    Isolate* isolate = v8::Isolate::GetCurrent();
+    s->WriteUtf8(isolate, buf);
+#else
     s->WriteUtf8(buf);
+#endif
 #if defined(_ZOS)
     __atoe(buf);
 #endif
@@ -184,18 +189,29 @@ static std::string fileJoin(const std::string& path, const std::string& filename
 }
 
 static std::string* getModuleDir(Local<Object> module) {
-    std::string moduleFilename(toStdString(module->Get(Nan::New<String>(asciiString("filename")).ToLocalChecked())->ToString()));
+    Local<String> filenameKey = Nan::New<String>(asciiString("filename")).ToLocalChecked();
+    Local<Value> filenameValue = Nan::Get(module, filenameKey).ToLocalChecked();
+    Local<String> filenameString = Nan::To<String>(filenameValue).ToLocalChecked();
+    std::string moduleFilename(toStdString(filenameString));
     return new std::string(portDirname(moduleFilename));
 }
 
+static Local<Object> getSubObject(Local<Object> parentObj, Local<String> subObjectName) {
+  Local<Value> subObjectValue = Nan::Get(parentObj, subObjectName).ToLocalChecked();
+  return Nan::To<Object>(subObjectValue).ToLocalChecked();
+}
+
 static Local<Object> getProcessObject() {
-    return Nan::GetCurrentContext()->Global()->Get(Nan::New<String>(asciiString("process")).ToLocalChecked())->ToObject();
+    Local<String> processString = Nan::New<String>(asciiString("process")).ToLocalChecked();
+    Local<Object> processObj = getSubObject(Nan::GetCurrentContext()->Global(), processString);
+    return processObj;
 }
 
 static std::string* findApplicationDir() {
-    Local<Value> mainModule = getProcessObject()->Get(Nan::New<String>(asciiString("mainModule")).ToLocalChecked());
-    if (!mainModule->IsUndefined()) {
-        return getModuleDir(mainModule->ToObject());
+    Local<String> mainModuleString = Nan::New<String>(asciiString("mainModule")).ToLocalChecked();
+    Local<Value> mainModuleValue = Nan::Get(getProcessObject(), mainModuleString).ToLocalChecked();
+    if (!mainModuleValue->IsUndefined()) {
+        return getModuleDir(Nan::To<Object>(mainModuleValue).ToLocalChecked());
     }
     return NULL;
 }
@@ -330,28 +346,28 @@ static bool initLoaderApi() {
 // set the property to given value (called from index.js)
 NAN_METHOD(setOption) {
   if (info.Length() > 1) {
-		Local<String> value = info[0]->ToString();
-    Local<String> value1 = info[1]->ToString();
-    loaderApi->setProperty(toStdString(value).c_str(),toStdString(value1).c_str());
+    Local<String> value0 = Nan::To<String>(info[0]).ToLocalChecked();
+    Local<String> value1 = Nan::To<String>(info[1]).ToLocalChecked();
+    loaderApi->setProperty(toStdString(value0).c_str(),toStdString(value1).c_str());
     } else {
         loaderApi->logMessage(warning, "Incorrect number of parameters passed to setOption");
     }
 }
 
 // get property
 NAN_METHOD(getOption) {
-	if (info.Length() > 0) {
-		Local<String> value = info[0]->ToString();
-    std::string property = loaderApi->getProperty(toStdString(value).c_str());
+    if (info.Length() > 0) {
+        Local<String> value = Nan::To<String>(info[0]).ToLocalChecked();
+        std::string property = loaderApi->getProperty(toStdString(value).c_str());
 #if NODE_VERSION_AT_LEAST(0, 11, 0) // > v0.11+
-		v8::Local<v8::String> v8str = v8::String::NewFromUtf8(v8::Isolate::GetCurrent(), property.c_str());
+        v8::Local<v8::String> v8str = v8::String::NewFromUtf8(v8::Isolate::GetCurrent(), property.c_str());
 #else
-		v8::Local<v8::String> v8str = v8::String::New(property.c_str(), strlen(property.c_str()));
+        v8::Local<v8::String> v8str = v8::String::New(property.c_str(), strlen(property.c_str()));
 #endif
-		info.GetReturnValue().Set<v8::String>(v8str);
-	} else {
-		loaderApi->logMessage(warning, "Incorrect number of parameters passed to getOption");
-	}
+        info.GetReturnValue().Set<v8::String>(v8str);
+    } else {
+        loaderApi->logMessage(warning, "Incorrect number of parameters passed to getOption");
+    }
 }
 
 NAN_METHOD(start) {
@@ -380,7 +396,7 @@ NAN_METHOD(stop) {
 }
 
 NAN_METHOD(spath) {
-  Local<String> value = info[0]->ToString();
+  Local<String> value = Nan::To<String>(info[0]).ToLocalChecked();
   loaderApi->setProperty("com.ibm.diagnostics.healthcenter.plugin.path", toStdString(value).c_str());
 }
 
@@ -492,7 +508,7 @@ NAN_METHOD(nativeEmit) {
 
     std::stringstream contentss;
     if (info[0]->IsString()) {
-        String::Utf8Value str(info[0]->ToString());
+        Nan::Utf8String str(info[0]);
         char *c_arg = *str;
         contentss << c_arg << ":";
     } else {
@@ -502,7 +518,7 @@ NAN_METHOD(nativeEmit) {
         return Nan::ThrowError(asciiString("First argument must a event name string").c_str());
     }
     if (info[1]->IsString()) {
-        String::Utf8Value str(info[1]->ToString());
+        Nan::Utf8String str(info[1]);
         char *c_arg = *str;
         contentss << c_arg;
 
@@ -528,8 +544,8 @@ NAN_METHOD(sendControlCommand) {
     }
 
     if (info[0]->IsString() && info[1]->IsString()) {
-        String::Utf8Value topicArg(info[0]->ToString());
-        String::Utf8Value commandArg(info[1]->ToString());
+        Nan::Utf8String topicArg(info[0]);
+        Nan::Utf8String commandArg(info[1]);
         std::string topic = std::string(*topicArg);
         std::string command = std::string(*commandArg);
         unsigned int length = command.length();
@@ -657,13 +673,20 @@ static bool isAppMetricsFile(std::string expected, std::string potentialMatch) {
 
 static bool isGlobalAgent(Local<Object> module) {
     Nan::HandleScope scope;
-    Local<Value> parent = module->Get(Nan::New<String>(asciiString("parent")).ToLocalChecked());
-    if (parent->IsObject()) {
-        Local<Value> filename = parent->ToObject()->Get(Nan::New<String>(asciiString("filename")).ToLocalChecked());
-        if (filename->IsString() && isAppMetricsFile("index.js", toStdString(filename->ToString()))) {
-            Local<Value> grandparent = parent->ToObject()->Get(Nan::New<String>(asciiString("parent")).ToLocalChecked());
-            Local<Value> gpfilename = grandparent->ToObject()->Get(Nan::New<String>(asciiString("filename")).ToLocalChecked());
-            if (gpfilename->IsString() && isAppMetricsFile("launcher.js", toStdString(gpfilename->ToString()))) {
+    Local<String> parentString = Nan::New<String>(asciiString("parent")).ToLocalChecked();
+    Local<Value> parentValue = Nan::Get(module, parentString).ToLocalChecked();
+    if (parentValue->IsObject()) {
+        Local<Object> parentObj = Nan::To<Object>(parentValue).ToLocalChecked();
+        Local<String> filenameString = Nan::New<String>(asciiString("filename")).ToLocalChecked();
+        Local<Value> filenameValue = Nan::Get(parentObj, filenameString).ToLocalChecked();
+        if (
+            filenameValue->IsString()
+            && isAppMetricsFile("index.js", toStdString(Nan::To<String>(filenameValue).ToLocalChecked()))
+        ) {
+            Local<Object> grandparentObj = getSubObject(parentObj, parentString);
+            Local<Value> gpfilenameValue = Nan::Get(grandparentObj, filenameString).ToLocalChecked();
+            Local<String> gpfilenameString = Nan::To<String>(gpfilenameValue).ToLocalChecked();
+            if (gpfilenameValue->IsString() && isAppMetricsFile("launcher.js", toStdString(gpfilenameString))) {
                 return true;
             }
         }
@@ -677,11 +700,12 @@ static bool isGlobalAgent(Local<Object> module) {
 static bool isGlobalAgentAlreadyLoaded(Local<Object> module) {
     Nan::HandleScope scope;
     Local<Object> cache = getRequireCache(module);
-    Local<Array> props = cache->GetOwnPropertyNames();
+    Local<Array> props = Nan::GetOwnPropertyNames(cache).ToLocalChecked();
     if (props->Length() > 0) {
         for (uint32_t i=0; i<props->Length(); i++) {
-            Local<Value> entry = props->Get(i);
-            if (entry->IsString() && isAppMetricsFile("launcher.js", toStdString(entry->ToString()))) {
+            Local<Value> entry = Nan::Get(props, i).ToLocalChecked();
+            Local<String> entryString = Nan::To<String>(entry).ToLocalChecked();
+            if (entry->IsString() && isAppMetricsFile("launcher.js", toStdString(entryString))) {
                 return true;
             }
         }
@@ -714,22 +738,22 @@ void init(Local<Object> exports, Local<Object> module) {
     /*
      * Set exported functions
      */
-    exports->Set(Nan::New<String>(asciiString("getOption")).ToLocalChecked(), Nan::New<FunctionTemplate>(getOption)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("setOption")).ToLocalChecked(), Nan::New<FunctionTemplate>(setOption)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("start")).ToLocalChecked(), Nan::New<FunctionTemplate>(start)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("spath")).ToLocalChecked(), Nan::New<FunctionTemplate>(spath)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("stop")).ToLocalChecked(), Nan::New<FunctionTemplate>(stop)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("localConnect")).ToLocalChecked(), Nan::New<FunctionTemplate>(localConnect)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("nativeEmit")).ToLocalChecked(), Nan::New<FunctionTemplate>(nativeEmit)->GetFunction());
-    exports->Set(Nan::New<String>(asciiString("sendControlCommand")).ToLocalChecked(), Nan::New<FunctionTemplate>(sendControlCommand)->GetFunction());
+    Nan::SetMethod(exports, asciiString("getOption").c_str(), getOption);
+    Nan::SetMethod(exports, asciiString("setOption").c_str(), setOption);
+    Nan::SetMethod(exports, asciiString("start").c_str(), start);
+    Nan::SetMethod(exports, asciiString("spath").c_str(), spath);
+    Nan::SetMethod(exports, asciiString("stop").c_str(), stop);
+    Nan::SetMethod(exports, asciiString("localConnect").c_str(), localConnect);
+    Nan::SetMethod(exports, asciiString("nativeEmit").c_str(), nativeEmit);
+    Nan::SetMethod(exports, asciiString("sendControlCommand").c_str(), sendControlCommand);
 #if !defined(_ZOS)
-    exports->Set(Nan::New<String>(asciiString("setHeadlessZipFunction")).ToLocalChecked(), Nan::New<FunctionTemplate>(setHeadlessZipFunction)->GetFunction());
+    Nan::SetMethod(exports, asciiString("setHeadlessZipFunction").c_str(), setHeadlessZipFunction);
 #endif
 #if defined(_LINUX)
-    exports->Set(Nan::New<String>("lrtime").ToLocalChecked(), Nan::New<FunctionTemplate>(lrtime)->GetFunction());
+    Nan::SetMethod(exports, asciiString("lrtime").c_str(), lrtime);
 #endif
 #if NODE_VERSION_AT_LEAST(0, 11, 0) // > v0.11+
-    exports->Set(Nan::New<String>(asciiString("getObjectHistogram")).ToLocalChecked(), Nan::New<FunctionTemplate>(getObjectHistogram)->GetFunction());
+    Nan::SetMethod(exports, asciiString("getObjectHistogram").c_str(), getObjectHistogram);
 #endif
     /*
      * Initialize healthcenter core library