Merge pull request #202 from bizob2828/fix-mark-sweep-node-18

updated GC mapping to account for new enum types in node 18(v8 10)

Author: bizob2828

THIRD_PARTY_NOTICES.md

@@ -102,7 +102,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ### @newrelic/eslint-config
 
-This product includes source derived from [@newrelic/eslint-config](https://github.com/newrelic/eslint-config-newrelic) ([v0.0.2](https://github.com/newrelic/eslint-config-newrelic/tree/v0.0.2)), distributed under the [Apache-2.0 License](https://github.com/newrelic/eslint-config-newrelic/blob/v0.0.2/LICENSE):
+This product includes source derived from [@newrelic/eslint-config](https://github.com/newrelic/eslint-config-newrelic) ([v0.0.4](https://github.com/newrelic/eslint-config-newrelic/tree/v0.0.4)), distributed under the [Apache-2.0 License](https://github.com/newrelic/eslint-config-newrelic/blob/v0.0.4/LICENSE):
 
 ```
                                  Apache License

index.js

@@ -5,20 +5,36 @@
 
 'use strict'
 
-var EventEmitter = require('events').EventEmitter
-var util = require('util')
-var preBuild = require('./lib/pre-build')
-var natives = preBuild.load('native_metrics')
-
-var DEFAULT_TIMEOUT = 15 * 1000 // 15 seconds
-var GC_TYPE_NAMES = {
-  1: 'Scavenge',
-  2: 'MarkSweepCompact',
-  4: 'IncrementalMarking',
-  8: 'ProcessWeakCallbacks',
-
-  3: 'All', // Node v4 and earlier only have Scavenge and MarkSweepCompact.
-  15: 'All'
+const EventEmitter = require('events').EventEmitter
+const util = require('util')
+const preBuild = require('./lib/pre-build')
+const natives = preBuild.load('native_metrics')
+const semver = require('semver')
+
+const DEFAULT_TIMEOUT = 15 * 1000 // 15 seconds
+let GC_TYPE_NAMES = null
+
+// In Node 18(v8 10) the GCType enum added `MinorMarkCompact`
+// we have to update our mapping to properly account for this
+if (semver.satisfies(process.version, '>=18')) {
+  GC_TYPE_NAMES = {
+    1: 'Scavenge',
+    2: 'MinorMarkCompact',
+    4: 'MarkSweepCompact',
+    8: 'IncrementalMarking',
+    16: 'ProcessWeakCallbacks',
+    31: 'All'
+  }
+} else {
+  GC_TYPE_NAMES = {
+    1: 'Scavenge',
+    2: 'MarkSweepCompact',
+    4: 'IncrementalMarking',
+    8: 'ProcessWeakCallbacks',
+
+    3: 'All', // Node v4 and earlier only have Scavenge and MarkSweepCompact.
+    15: 'All'
+  }
 }
 
 /**
@@ -135,11 +151,11 @@ NativeMetricEmitter.prototype.getLoopMetrics = function getLoopMetrics() {
  *  information on the GC events that happened.
  */
 NativeMetricEmitter.prototype.getGCMetrics = function getGCMetrics() {
-  var gcMetrics = this._gcBinder.read()
-  var results = Object.create(null)
-  for (var typeId in gcMetrics) {
+  const gcMetrics = this._gcBinder.read()
+  const results = Object.create(null)
+  for (const typeId in gcMetrics) {
     if (gcMetrics.hasOwnProperty(typeId) && gcMetrics[typeId].count > 0) {
-      var typeName = GC_TYPE_NAMES[String(typeId)]
+      const typeName = GC_TYPE_NAMES[String(typeId)]
       results[typeName] = {
         typeId: parseInt(typeId, 10),
         type: typeName,
@@ -151,7 +167,7 @@ NativeMetricEmitter.prototype.getGCMetrics = function getGCMetrics() {
   return results
 }
 
-var emitter = null
+let emitter = null
 
 /**
  * Retrieves the {@link NativeMetricEmitter} singleton instance.

lib/pre-build.js

@@ -237,8 +237,8 @@ function download(target, cb) {
       return cb(new Error('Failed to download ' + url + ': code ' + res.statusCode))
     }
 
-    var unzip = zlib.createGunzip()
-    var buffers = []
+    const unzip = zlib.createGunzip()
+    const buffers = []
     let size = 0
     res.pipe(unzip).on('data', function onResData(data) {
       buffers.push(data)

lib/upload.js

@@ -23,7 +23,7 @@ const path = require('path')
 // XXX AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY must be set in the environment.
 const AWS = require('aws-sdk')
 const s3 = new AWS.S3()
-var S3_BUCKET = 'nr-downloads-main'
+const S3_BUCKET = 'nr-downloads-main'
 const CMD = 'upload'
 
 if (require.main === module) {

package-lock.json

@@ -77,7 +77,7 @@
     "npm": ">=6"
   },
   "devDependencies": {
-    "@newrelic/eslint-config": "^0.0.2",
+    "@newrelic/eslint-config": "^0.0.4",
     "@newrelic/newrelic-oss-cli": "^0.1.2",
     "@newrelic/proxy": "^2.0.0",
     "async": "^3.2.2",

package.json

@@ -5,14 +5,14 @@
 
 'use strict'
 
-var tap = require('tap')
+const tap = require('tap')
 
-var TEST_DURATION = 30 * 1000
+const TEST_DURATION = 30 * 1000
 
 tap.test('loop performance test', { timeout: 2 * TEST_DURATION + 1000 }, function (t) {
-  var timeout = null
-  var callCount = 0
-  var natives = null
+  let timeout = null
+  let callCount = 0
+  let natives = null
 
   t.teardown(function () {
     if (natives) {
@@ -23,19 +23,19 @@ tap.test('loop performance test', { timeout: 2 * TEST_DURATION + 1000 }, functio
   t.comment('measuring without loop counter')
   setTimeoutCount()
   setTimeout(function () {
-    var noMetricsCount = callCount
+    const noMetricsCount = callCount
     callCount = 0
     clearTimeout(timeout)
 
     natives = require('../../')()
-    var readInterval = setInterval(function () {
+    const readInterval = setInterval(function () {
       natives.getLoopMetrics() // To reset the metrics
     }, 1000)
 
     t.comment('measuring with loop counter')
     setTimeoutCount()
     setTimeout(function () {
-      var withMetricsCount = callCount
+      const withMetricsCount = callCount
       callCount = 0
       clearTimeout(timeout)
       clearInterval(readInterval)

tests/integration/loop-performance.tap.js

@@ -5,23 +5,23 @@
 
 'use strict'
 
-var tap = require('tap')
+const tap = require('tap')
 
 tap.test('GC Metrics', function (t) {
   t.plan(17)
-  var metricEmitter = require('../../')()
+  const metricEmitter = require('../../')()
 
   global.gc()
 
-  var gcs = metricEmitter.getGCMetrics()
-  var keys = Object.keys(gcs)
+  const gcs = metricEmitter.getGCMetrics()
+  const keys = Object.keys(gcs)
   if (!t.ok(keys.length > 0, 'should notice at least one GC')) {
     return t.end()
   }
   t.type(keys[0], 'string', 'should have strings as keys')
 
   t.comment('GC stats objects')
-  var stats = gcs[keys[0]]
+  const stats = gcs[keys[0]]
   t.type(stats, 'object', 'should have stats objects')
   t.type(stats.typeId, 'number', 'should have the type ID')
   t.type(stats.type, 'string', 'should have the type name')
@@ -30,7 +30,7 @@ tap.test('GC Metrics', function (t) {
   }
 
   t.comment('GC stats metrics')
-  var metrics = stats.metrics
+  const metrics = stats.metrics
   t.type(metrics.total, 'number', 'should have total field')
   t.type(metrics.min, 'number', 'should have min field')
   t.type(metrics.max, 'number', 'should have max field')

tests/unit/gc-metrics.tap.js

@@ -5,21 +5,21 @@
 
 'use strict'
 
-var a = require('async')
-var fs = require('fs')
-var path = require('path')
-var pkg = require('../../package')
-var tap = require('tap')
+const a = require('async')
+const fs = require('fs')
+const path = require('path')
+const pkg = require('../../package')
+const tap = require('tap')
 
-var MODULE_DIR = path.resolve(__dirname, '../../node_modules')
-var LICENSES = {
+const MODULE_DIR = path.resolve(__dirname, '../../node_modules')
+const LICENSES = {
   'nan': 'MIT',
   'https-proxy-agent': 'MIT',
   'semver': 'ISC'
 }
 
 tap.test('Dependency licenses', function (t) {
-  var deps = Object.keys(pkg.dependencies || {})
+  const deps = Object.keys(pkg.dependencies || {})
   deps.push.apply(deps, Object.keys(pkg.optionalDependencies || {}))
   a.map(
     deps,
@@ -35,8 +35,8 @@ tap.test('Dependency licenses', function (t) {
           },
           function parsePkg(depPackage, parsePkgCb) {
             try {
-              var parsedPackage = JSON.parse(depPackage)
-              var license = parsedPackage.license || parsedPackage.licenses
+              const parsedPackage = JSON.parse(depPackage)
+              const license = parsedPackage.license || parsedPackage.licenses
               process.nextTick(function () {
                 parsePkgCb(null, [dep, license])
               })
@@ -50,7 +50,7 @@ tap.test('Dependency licenses', function (t) {
     },
     function (err, depLicensesArray) {
       if (t.error(err, 'should not fail to retrieve licenses')) {
-        var depLicenses = depLicensesArray.reduce(function (obj, dep) {
+        const depLicenses = depLicensesArray.reduce(function (obj, dep) {
           obj[dep[0]] = dep[1]
           return obj
         }, {})

tests/unit/licenses.tap.js

@@ -5,21 +5,21 @@
 
 'use strict'
 
-var tap = require('tap')
+const tap = require('tap')
 
 tap.test('Loop Metrics', function (t) {
-  var MICRO_TO_MILLIS = 1e-3
-  var SPIN_TIME = 2000
-  var CPU_EPSILON = SPIN_TIME * 0.05 // Allowed fudge factor for CPU times in MS
-  var metricEmitter = require('../../')()
-  var testStart = Date.now()
+  const MICRO_TO_MILLIS = 1e-3
+  const SPIN_TIME = 2000
+  const CPU_EPSILON = SPIN_TIME * 0.05 // Allowed fudge factor for CPU times in MS
+  const metricEmitter = require('../../')()
+  const testStart = Date.now()
 
   t.teardown(function () {
     metricEmitter.unbind()
   })
 
   // Check the structure of the metric object.
-  var metric = metricEmitter.getLoopMetrics().usage
+  let metric = metricEmitter.getLoopMetrics().usage
   t.type(metric, Object, 'should provide a metric object')
   t.type(metric.total, 'number', 'should have a total')
   t.type(metric.min, 'number', 'should have a min')
@@ -53,17 +53,17 @@ tap.test('Loop Metrics', function (t) {
   //      the actual loop time because the process isn't doing anything.
   setTimeout(function spinner() {
     t.comment('spinning cpu...')
-    var start = Date.now()
+    const start = Date.now()
     while (Date.now() - start < SPIN_TIME) {} // Spin the CPU for 2 seconds.
 
     // Finally, wait another tick and then check the loop stats.
     setTimeout(function () {
       metric = metricEmitter.getLoopMetrics()
-      var testDuration = Date.now() - testStart + CPU_EPSILON
-      var durationSquare = testDuration * testDuration
-      var usage = metric.usage
+      const testDuration = Date.now() - testStart + CPU_EPSILON
+      const durationSquare = testDuration * testDuration
+      const usage = metric.usage
 
-      var meanTime = usage.total / usage.count
+      const meanTime = usage.total / usage.count
       t.ok(
         usage.total * MICRO_TO_MILLIS > SPIN_TIME - CPU_EPSILON,
         'should have total greater than spin time'