newrelic 9.0.1 → 9.0.2

package/NEWS.md

@@ -1,3 +1,17 @@
+### v9.0.2 (2022-08-23)
+
+* Added unit test suite for `lib/logger.js`.
+
+* Added destructive integration test for Configuration instantiation.
+
+* Added a special case to serialize BigInts when sending them to New Relic. BigInts can appear in log data that our customers may be trying to forward.
+
+* Exposed  `compressed_content_encoding` configuration and defaulted it to "gzip".
+
+* Fixed public jsdoc generation.
+
+* Added`minami` back as a dev dependency for use with `jsdoc-conf.js`.
+
 ### v9.0.1 (2022-08-18)
 
 * Fixed properly setting logging metrics when using custom levels with winston.

package/THIRD_PARTY_NOTICES.md

@@ -53,6 +53,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [jsdoc](#jsdoc)
 * [lint-staged](#lint-staged)
 * [memcached](#memcached)
+* [minami](#minami)
 * [nock](#nock)
 * [prettier](#prettier)
 * [proxyquire](#proxyquire)
@@ -2613,6 +2614,75 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
+### minami
+
+This product includes source derived from [minami](https://github.com/Nijikokun/minami) ([v1.2.3](https://github.com/Nijikokun/minami/tree/v1.2.3)), distributed under the [Apache-2.0 License](https://github.com/Nijikokun/minami/blob/v1.2.3/LICENSE):
+
+```
+# License
+
+Minami is free software, licensed under the Apache License, Version 2.0 (the
+"License"). Commercial and non-commercial use are permitted in compliance with
+the License.
+
+Copyright (c) 2014-2015 Nijiko Yonskai <nijikokun@gmail.com> and the
+[contributors to Minami](https://github.com/Nijikokun/minami/graphs/contributors).
+All rights reserved.
+
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+In addition, a copy of the License is included with this distribution.
+
+As stated in Section 7, "Disclaimer of Warranty," of the License:
+
+> Licensor provides the Work (and each Contributor provides its Contributions)
+> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+> express or implied, including, without limitation, any warranties or
+> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+> PARTICULAR PURPOSE. You are solely responsible for determining the
+> appropriateness of using or redistributing the Work and assume any risks
+> associated with Your exercise of permissions under this License.
+
+The source code for JSDoc 3 is available at:
+https://github.com/Nijikokun/minami
+
+# Third-Party Software
+
+Minami includes or depends upon the following third-party software, either in
+whole or in part. Each third-party software package is provided under its own
+license.
+
+## JSDoc 3
+
+JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
+"License"). Commercial and non-commercial use are permitted in compliance with
+the License.
+
+Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
+[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
+All rights reserved.
+
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+In addition, a copy of the License is included with this distribution.
+
+As stated in Section 7, "Disclaimer of Warranty," of the License:
+
+> Licensor provides the Work (and each Contributor provides its Contributions)
+> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+> express or implied, including, without limitation, any warranties or
+> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+> PARTICULAR PURPOSE. You are solely responsible for determining the
+> appropriateness of using or redistributing the Work and assume any risks
+> associated with Your exercise of permissions under this License.
+
+The source code for JSDoc 3 is available at:
+https://github.com/jsdoc3/jsdoc
+
+```
+
 ### nock
 
 This product includes source derived from [nock](https://github.com/nock/nock) ([v11.8.0](https://github.com/nock/nock/tree/v11.8.0)), distributed under the [MIT License](https://github.com/nock/nock/blob/v11.8.0/LICENSE):

package/lib/collector/api.js

@@ -525,7 +525,7 @@ function transactionSampleData(traces, callback) {
  * @param logRecords
  * @param {Function} callback      The continuation / error handler.
  */
-CollectorAPI.prototype.log_event_data = function errorData(logRecords, callback) {
+CollectorAPI.prototype.log_event_data = function logEventData(logRecords, callback) {
   if (!callback) {
     throw new TypeError('callback is required')
   }

package/lib/collector/remote-method.js

@@ -60,7 +60,7 @@ RemoteMethod.prototype.updateEndpoint = function updateEndpoint(endpoint) {
 RemoteMethod.prototype.serialize = function serialize(payload, callback) {
   let res
   try {
-    res = stringify(payload)
+    res = stringify(payload, (key, value) => (typeof value === 'bigint' ? value.toString() : value))
   } catch (error) {
     logger.error(error, 'Unable to serialize payload for method %s.', this.name)
     return process.nextTick(function onNextTick() {
@@ -152,8 +152,8 @@ RemoteMethod.prototype._post = function _post(data, nrHeaders, callback) {
   if (options.compressed) {
     // NOTE: gzip and deflate throw immediately in Node 14+ with an invalid argument
     try {
-      const useGzip = this._config.compressed_content_encoding === 'gzip'
-      const compressor = useGzip ? zlib.gzip : zlib.deflate
+      const useDeflate = this._config.compressed_content_encoding === 'deflate'
+      const compressor = useDeflate ? zlib.deflate : zlib.gzip
       compressor(data, function onCompress(err, compressed) {
         if (err) {
           logger.warn(err, 'Error compressing JSON for delivery. Not sending.')

package/lib/config/default.js

@@ -139,6 +139,16 @@ exports.config = () => ({
    */
   allow_all_headers: false,
 
+  /**
+   * If the data compression threshold is reached in the payload, the
+   * agent compresses data, using gzip compression by default. The
+   * config option `compressed_content_encoding` can be set to 'deflate'
+   * to use deflate compression.
+   *
+   * @env NEW_RELIC_COMPRESSED_CONTENT_ENCODING
+   */
+  compressed_content_encoding: 'gzip',
+
   /**
    * Attributes are key-value pairs containing information that determines
    * the properties of an event or transaction.

package/lib/config/env.js

@@ -22,6 +22,7 @@ const ENV_MAPPING = {
   proxy_pass: 'NEW_RELIC_PROXY_PASS',
   agent_enabled: 'NEW_RELIC_ENABLED',
   allow_all_headers: 'NEW_RELIC_ALLOW_ALL_HEADERS',
+  compressed_content_encoding: 'NEW_RELIC_COMPRESSED_CONTENT_ENCODING',
   attributes: {
     enabled: 'NEW_RELIC_ATTRIBUTES_ENABLED',
     exclude: 'NEW_RELIC_ATTRIBUTES_EXCLUDE',

package/lib/config/index.js

@@ -154,7 +154,6 @@ function Config(config) {
   this.browser_monitoring.loader_version = ''
 
   // Settings to play nice with DLPs (see NODE-1044).
-  this.compressed_content_encoding = 'deflate' // Deflate or gzip
   this.simple_compression = false // Disables subcomponent compression
   this.put_for_data_send = false // Changes http verb for harvest
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.0.1",
+  "version": "9.0.2",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -204,6 +204,7 @@
     "jsdoc": "^3.6.3",
     "lint-staged": "^11.0.0",
     "memcached": ">=0.2.8",
+    "minami": "^1.2.3",
     "nock": "11.8.0",
     "prettier": "^2.3.2",
     "proxyquire": "^1.8.0",