@newrelic/native-metrics - npm Package Compare versions

Comparing version 10.0.1 to 10.1.0

CHANGELOG.md

@@ -0,1 +1,9 @@
+### v10.1.0 (2024-03-05)
+
+* Migrated to using prebuildify and node-gyp-install.
+  + Prebuilt binaries are now shipped in the npm package.
+  + Prebuilt binaries are included for Node.js 16, 18, and 20 across Windows x86/x64, Linux amd64/arm64, and macOS arm64.
+  + The environment variables `NR_NATIVE_METRICS_NO_DOWNLOAD`, `NR_NATIVE_METRICS_NO_BUILD`, `NR_NATIVE_METRICS_DOWNLOAD_HOST`, and `NR_NATIVE_METRICS_REMOTE_PATH` have been removed.
+* Bumped [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.22.5 to 7.23.2.
+
 ### v10.0.1 (2023-09-11)
@@ -2,0 +10,0 @@

index.js

@@ -10,4 +10,3 @@ /*
 const util = require('util')
-const preBuild = require('./lib/pre-build')
-const natives = preBuild.load('native_metrics')
+const natives = require('node-gyp-build')(__dirname)
 const semver = require('semver')
@@ -14,0 +13,0 @@

package.json

 {
   "name": "@newrelic/native-metrics",
-  "version": "10.0.1",
+  "version": "10.1.0",
   "description": "A module for generating metrics from V8.",
   "main": "index.js",
   "scripts": {
-    "build": "node ./lib/pre-build build native_metrics",
-    "clean": "node-gyp clean",
-    "rebuild": "node ./lib/pre-build rebuild native_metrics",
-    "upload": "node ./lib/upload native_metrics",
+    "build": "node ./build.js",
     "lint": "eslint .",
@@ -18,4 +15,4 @@ "lint:fix": "eslint . --fix",
     "test": "npm run unit && npm run integration",
-    "install": "node ./lib/pre-build.js install native_metrics",
-    "prepare": "husky install",
+    "install": "node-gyp-build",
+    "prepare": "husky install || true",
     "third-party-updates": "oss third-party manifest && oss third-party notices && git add THIRD_PARTY_NOTICES.md third_party_manifest.json"
@@ -104,4 +101,5 @@ },
   "dependencies": {
-    "https-proxy-agent": "^5.0.1",
-    "nan": "^2.17.0",
+    "nan": "^2.18.0",
+    "node-gyp-build": "^4.8.0",
+    "prebuildify": "^6.0.0",
     "semver": "^7.5.2"
@@ -111,7 +109,6 @@ },
     "index.js",
+    "build.js",
+    "prebuilds/**/*",
     "src/*cpp",
     "src/*.hpp",
-    "lib/common.js",
-    "lib/pre-build.js",
-    "lib/gyp-utils.js",
     "binding.gyp",
@@ -118,0 +115,0 @@ "*.md"

README.md

@@ -25,5 +25,11 @@ <a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>
 Note that this is a native module and thus must be compiled to function.
-Pre-built binaries are provided for Linux servers running supported versions of
-Node. If you are not using Linux or not using a supported version of Node, you
-will need to have a compiler installed on the machine where this is to be
+Pre-built binaries are included in the package for the following platforms, across all LTS versions of Node.js:
+
++ Linux/amd64
++ Linux/arm64
++ macOS/arm64
++ Windows/x64
++ Windows/x86
+
+If your system does not match the above matrix, you will need to have a compiler installed on the machine where this is to be
 deployed. See [node-gyp](https://www.npmjs.com/package/node-gyp#installation)
@@ -37,41 +43,8 @@ for more information on compiling native addons.
 
-During installation, the module will first attempt build from source on the
-target machine. If that fails, it will attempt to download a pre-built binary
-for your system. You can disable the download attempt by setting
-`NR_NATIVE_METRICS_NO_DOWNLOAD` to `true` in your environment before
-installation.
+During installation, the module will first attempt to locate a prebuilt binary for the target machine within its included list of prebuilt binaries. If that fails, it will attempt a standard [node-gyp](https://www.npmjs.com/package/node-gyp#installation) build. If you do not want to use prebuilt binary, or know that it will need to be built, you can force a build:
 
 ```sh
-$ export NR_NATIVE_METRICS_NO_DOWNLOAD=true
-$ npm install @newrelic/native-metrics
+$ npm install @newrelic/native-metrics --build-from-source
 ```
 
-If you would like to skip the build step and only attempt to download a
-pre-build binary, set `NR_NATIVE_METRICS_NO_BUILD` to `true`.
-
-```sh
-$ export NR_NATIVE_METRICS_NO_BUILD=true
-$ npm install @newrelic/native-metrics
-```
-
-If both env vars are set, `NO_BUILD` will override `NO_DOWNLOAD`.
-
-If you are working behind a firewall and want to cache the downloads internally
-you can set the value of the download host and remote path instead of forcing a
-build:
-
-```sh
-$ export NR_NATIVE_METRICS_DOWNLOAD_HOST=http://your-internal-cache/
-$ export NR_NATIVE_METRICS_REMOTE_PATH=path/to/download/folder/
-$ npm install @newrelic/native-metrics
-```
-
-You can also specify a proxy host to route requests through using the `NR_NATIVE_METRICS_PROXY_HOST` environment variable:
-
-```sh
-$ export NR_NATIVE_METRICS_NO_BUILD=true
-$ export NR_NATIVE_METRICS_PROXY_HOST=http://your-proxy-host/
-$ npm install @newrelic/native-metrics
-```
-
 For more information, please see the agent [installation guide][install-node] and [compatibility and requirements][compatibility].
@@ -189,2 +162,2 @@
 [3]: https://codecov.io/gh/newrelic/node-native-metrics/branch/main/graph/badge.svg
-[4]: https://codecov.io/gh/newrelic/node-native-metrics
+[4]: https://codecov.io/gh/newrelic/node-native-metrics

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 3 instances in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 8 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1809900

increased by315%

Number of package files

32

increased by68.42%

Number of high supply chain risk alerts

0

decreased by-100%

Number of low supply chain risk alerts

1

decreased by-91.67%

Number of medium supply chain risk alerts

3

decreased by-40%

Worsened metrics

Dependency count

4

increased by33.33%

Lines of code

214

decreased by-57.46%

Number of lines in readme file

161

decreased by-13.9%

Dependency changes

• + Addednode-gyp-build@^4.8.0

• + Addedprebuildify@^6.0.0

• + Addedbase64-js@1.5.1(transitive)

• + Addedbl@4.1.0(transitive)

• + Addedbuffer@5.7.1(transitive)

• + Addedchownr@1.1.4(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedfs-constants@1.0.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp-classic@0.5.3(transitive)

• + Addednode-abi@3.62.0(transitive)

• + Addednode-gyp-build@4.8.1(transitive)

• + Addednpm-run-path@3.1.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpath-key@3.1.1(transitive)

• + Addedprebuildify@6.0.1(transitive)

• + Addedpump@3.0.0(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedtar-fs@2.1.1(transitive)

• + Addedtar-stream@2.2.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwrappy@1.0.2(transitive)

• - Removedhttps-proxy-agent@^5.0.1

• - Removedagent-base@6.0.2(transitive)

• - Removeddebug@4.3.4(transitive)

• - Removedhttps-proxy-agent@5.0.1(transitive)

• - Removedms@2.1.2(transitive)

• Updatednan@^2.18.0