newrelic 7.1.3 → 7.3.1

package/bin/prepare-release.js

@@ -1,359 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-
-const {program, Option} = require('commander')
-
-const Github = require('./github')
-const git = require('./git-commands')
-const npm = require('./npm-commands')
-
-const FILE_NAME = 'NEWS.md'
-const PROPOSED_NOTES_HEADER = 'Proposed Release Notes'
-
-const FORCE_RUN_DEAFULT_REMOTE = 'origin'
-
-// Add command line options
-program.addOption(
-  new Option('--release-type <releaseType>', 'release type')
-  .choices(['patch', 'minor', 'major'])
-  .makeOptionMandatory()
-)
-program.option('--major-release', 'create a major release. (release-type option must be set to \'major\')')
-program.option('--remote <remote>', 'remote to push branch to', 'origin')
-program.option('--branch <branch>', 'branch to generate notes from', 'main')
-program.option('--repo-owner <repoOwner>', 'repository owner', 'newrelic')
-program.option('--dry-run', 'generate notes without creating a branch or PR')
-program.option('--no-pr', 'generate notes and branch but do not create PR')
-program.option('-f --force', 'bypass validation')
-
-function stopOnError(err) {
-  if (err) {
-    console.error(err)
-  }
-
-  console.log('Halting execution with exit code: 1')
-  process.exit(1)
-}
-
-function logStep(step) {
-  console.log(`\n ----- [Step]: ${step} -----\n`)
-}
-
-async function prepareReleaseNotes() {
-  // Parse commandline options inputs
-  program.parse()
-
-  const options = program.opts()
-
-  console.log('Script running with following options: ', JSON.stringify(options))
-
-  logStep('Validation')
-
-  if (options.force) {
-    console.log('--force set. Skipping validation logic')
-  }
-
-  const startingBranch = options.branch.replace('refs/heads/', '')
-
-  const isValid = options.force || (
-    await validateReleaseType(options.releaseType, options.majorRelease) &&
-    await validateRemote(options.remote) &&
-    await validateLocalChanges() &&
-    await validateCurrentBranch(startingBranch)
-  )
-
-  if (!isValid) {
-    console.log('Invalid configuration. Halting script.')
-    stopOnError()
-  }
-
-  const remote = options.remote || FORCE_RUN_DEAFULT_REMOTE
-  console.log('Using remote: ', remote)
-
-  try {
-    logStep('Increment Version')
-
-    await npm.version(options.releaseType, false)
-
-    const packagePath = '../package.json'
-    console.log('Extracting new version from package.json here: ', )
-    const packageInfo = require(packagePath)
-
-    const version = `v${packageInfo.version}`
-    console.log('New version is: ', version)
-
-    logStep('Branch Creation')
-
-    const newBranchName = `release/${version}`
-
-    if (options.dryRun) {
-      console.log('Dry run indicated (--dry-run), not creating branch.')
-    } else {
-      console.log('Creating and checking out new branch: ', newBranchName)
-      await git.checkoutNewBranch(newBranchName)
-    }
-
-    logStep('Commit Package Files')
-
-    if (options.dryRun) {
-      console.log('Dry run indicated (--dry-run), not committing package files.')
-    } else {
-      console.log('Adding and committing package files.')
-      await git.addAllFiles()
-      await git.commit(`Setting version to ${version}.`)
-    }
-
-    logStep('Create Release Notes')
-
-    const releaseData = await generateReleaseNotes()
-    await updateReleaseNotesFile(FILE_NAME, version, releaseData.notes)
-
-    if (options.dryRun) {
-      console.log('\nDry run indicated (--dry-run), skipping remaining steps.')
-      return
-    }
-
-    logStep('Commit Release Notes')
-
-    console.log('Adding and committing release notes.')
-    await git.addAllFiles()
-    await git.commit('Adds auto-generated release notes.')
-
-    logStep('Push Branch')
-
-    console.log('Pushing branch to remote: ', remote)
-    await git.pushToRemote(remote, newBranchName)
-
-    logStep('Create Pull Request')
-    if (!options.pr) {
-      console.log('No PR creation indicated (--no-pr), skipping remaining steps.')
-      return
-    }
-
-    if (!process.env.GITHUB_TOKEN) {
-      console.log('GITHUB_TOKEN required to create a pull request (PR)')
-      stopOnError()
-    }
-
-    console.log('Creating draft PR with new release notes for repo owner: ', options.repoOwner)
-    const remoteApi = new Github(options.repoOwner)
-    const title = 'Updates release notes for next release'
-    const body = getFormattedPrBody(releaseData)
-    const prOptions = {
-      head: newBranchName,
-      base: 'main',
-      title,
-      body,
-      draft: true
-    }
-
-    await remoteApi.createPR(prOptions)
-
-    console.log('*** Full Run Successful ***')
-  } catch (err) {
-    stopOnError(err)
-  }
-}
-
-async function validateReleaseType(releaseType, majorFlag) {
-  if (releaseType === 'major' && !majorFlag) {
-    console.log('WARNING: you must set the \'-m\' flag to create a major release.')
-    return false
-  }
-
-  if (majorFlag && releaseType !== 'major') {
-    console.log(`WARNING: ignoring \'-m, --major-release\' option as release type set to ${options.rel}.`)
-    return false
-  }
-
-  return true
-}
-
-async function validateRemote(remote) {
-  try {
-    const remotes = await git.getPushRemotes()
-
-    if (!remote) {
-      console.log('No remote configured. Please execute with --remote.')
-      console.log('Available remotes are: ', remotes)
-      return false
-    }
-
-    if (!remotes[remote]) {
-      console.log(`Configured remote (${remote}) not found in ${JSON.stringify(remotes)}`)
-      return false
-    }
-
-    return true
-  } catch (err) {
-    console.error(err)
-    return false
-  }
-}
-
-async function validateLocalChanges() {
-  try {
-    const localChanges = await git.getLocalChanges()
-    if (localChanges.length > 0) {
-      console.log('Local changes detected: ', localChanges)
-      console.log('Please commit to a feature branch or stash changes and then try again.')
-      return false
-    }
-
-    return true
-  } catch (err) {
-    console.error(err)
-    return false
-  }
-}
-
-async function validateCurrentBranch(branch) {
-  try {
-    const currentBranch = await git.getCurrentBranch()
-
-    if (branch != currentBranch) {
-      console.log(
-        'Current checked-out branch (%s) does not match expected (%s)',
-        currentBranch,
-        branch
-      )
-      return false
-    }
-
-    return true
-  } catch (err) {
-    console.error(err)
-    return false
-  }
-}
-
-async function generateReleaseNotes() {
-  const github = new Github()
-  const latestRelease = await github.getLatestRelease()
-  console.log(`The latest release is: ${latestRelease.name} published: ${latestRelease.published_at}`)
-  console.log(`Tag: ${latestRelease.tag_name}, Target: ${latestRelease.target_commitish}`)
-
-  const tag = await github.getTagByName(latestRelease.tag_name)
-  console.log('The tag commit sha is: ', tag.commit.sha)
-
-  const commit = await github.getCommit(tag.commit.sha)
-  const commitDate = commit.commit.committer.date
-
-  console.log(`Finding merged pull requests since: ${commitDate}`)
-
-  const mergedPullRequests = await github.getMergedPullRequestsSince(commitDate)
-  console.log(`Found ${mergedPullRequests.length}`)
-
-  const releaseNoteData = mergedPullRequests.map((pr) => {
-    const parts = pr.body.split(/(?:^|\n)##\s*/g)
-
-    // If only has one part, not in appropriate format.
-    if (parts.length === 1) {
-      return {
-        notes: generateUnformattedNotes(pr.body),
-        url: pr.html_url
-      }
-    }
-
-    const {1: proposedReleaseNotes} = parts
-
-    const titleRemoved = proposedReleaseNotes.replace(PROPOSED_NOTES_HEADER, '')
-    return {
-      notes: titleRemoved,
-      url: pr.html_url
-    }
-  })
-
-  const finalData = releaseNoteData.reduce((result, currentValue) => {
-    const trimmedNotes = currentValue.notes.trim()
-    if (trimmedNotes) { // avoid adding lines for empty notes
-      result.notes += '\n\n' + trimmedNotes
-    }
-    result.links += `\n* PR: ${currentValue.url}`
-    return result
-  }, {
-    notes: '',
-    links: ''
-  })
-
-  return finalData
-}
-
-function generateUnformattedNotes(originalNotes) {
-  let unformattedNotes = originalNotes
-
-  // Drop extra snyk details and just keep high-level summary.
-  if (originalNotes.indexOf('snyk:metadata') >= 0) {
-    const snykParts = originalNotes.split('<hr/>')
-    const {0: snykDescription} = snykParts
-
-    unformattedNotes = snykDescription.trim()
-  }
-
-  const needsReviewNotes = [
-    '--- NOTES NEEDS REVIEW ---',
-    unformattedNotes,
-    '--------------------------'
-  ].join('\n')
-
-  return needsReviewNotes
-}
-
-function updateReleaseNotesFile(file, version, newNotes) {
-  const promise = new Promise((resolve, reject) => {
-    fs.readFile(file, 'utf8', function (err, data) {
-      if (err) {
-        return reject(err)
-      }
-
-      if (data.startsWith(`### ${version}`)) {
-        const errMessage = [
-          `${file} already contains '${version}'`,
-          `Delete existing ${version} release notes (if desired) and run again`
-        ].join('\n')
-
-        return reject(new Error(errMessage))
-      }
-
-      // toISOString() will always return UTC time
-      const todayFormatted = new Date().toISOString().split('T')[0]
-      const newVersionHeader = `### ${version} (${todayFormatted})`
-
-      const newContent = [
-        newVersionHeader,
-        newNotes,
-        '\n\n',
-        data
-      ].join('')
-
-      fs.writeFile(file, newContent, 'utf8', function (err) {
-        if (err) {
-          return reject(err)
-        }
-
-        console.log(`Added new release notes to ${file} under ${newVersionHeader}`)
-
-        resolve()
-      })
-    })
-  })
-
-  return promise
-}
-
-function getFormattedPrBody(data) {
-  const body = [
-    '## Proposed Release Notes',
-    data.notes,
-    '## Links',
-    data.links,
-    '',
-    '## Details',
-    ''
-  ].join('\n')
-
-  return body
-}
-
-prepareReleaseNotes()

package/bin/publish-docs.sh

@@ -1,16 +0,0 @@
-#! /bin/sh
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-PACKAGE_VERSION=$(node -e 'console.log(require("./package").version)')
-
-git checkout gh-pages
-git pull origin gh-pages
-git merge -
-npm run public-docs
-git rm -r docs
-mv out docs
-git add docs
-git commit -m "docs: update for ${PACKAGE_VERSION}"
-git push origin gh-pages && git push public gh-pages:gh-pages

package/bin/run-bench.js

@@ -1,137 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-'use strict'
-
-var a = require('async')
-var cp = require('child_process')
-var glob = require('glob')
-var path = require('path')
-
-
-var cwd = path.resolve(__dirname, '..')
-var benchpath = path.resolve(cwd, 'test/benchmark')
-
-var tests = []
-var globs = []
-var opts = Object.create(null)
-
-process.argv.slice(2).forEach(function forEachFileArg(file) {
-  if (/^--/.test(file)) {
-    opts[file.substr(2)] = true
-  } else if (/[*]/.test(file)) {
-    globs.push(path.join(benchpath, file))
-  } else if (/\.bench\.js$/.test(file)) {
-    tests.push(path.join(benchpath, file))
-  } else {
-    globs.push(
-      path.join(benchpath, file, '*.bench.js'),
-      path.join(benchpath, file + '*.bench.js'),
-      path.join(benchpath, file, '**/*.bench.js')
-    )
-  }
-})
-
-if (tests.length === 0 && globs.length === 0) {
-  globs.push(
-    path.join(benchpath, '*.bench.js'),
-    path.join(benchpath, '**/*.bench.js')
-  )
-}
-
-class ConsolePrinter {
-  /* eslint-disable no-console */
-  addTest(name, child) {
-    console.log(name)
-    child.stdout.on('data', (d) => process.stdout.write(d))
-    child.stderr.on('data', (d) => process.stderr.write(d))
-    child.once('exit', () => console.log(''))
-  }
-
-  finish() {
-    console.log('')
-  }
-  /* eslint-enable no-console */
-}
-
-class JSONPrinter {
-  constructor() {
-    this._tests = Object.create(null)
-  }
-
-  addTest(name, child) {
-    let output = ''
-    this._tests[name] = null
-    child.stdout.on('data', (d) => output += d.toString())
-    child.stdout.on('end', () => this._tests[name] = JSON.parse(output))
-    child.stderr.on('data', (d) => process.stderr.write(d))
-  }
-
-  finish() {
-    /* eslint-disable no-console */
-    console.log(JSON.stringify(this._tests, null, 2))
-    /* eslint-enable no-console */
-  }
-}
-
-run()
-
-function run() {
-  const printer = opts.json ? new JSONPrinter() : new ConsolePrinter()
-
-  a.series([
-    function resolveGlobs(cb) {
-      if (!globs.length) {
-        return cb()
-      }
-
-      a.map(globs, glob, function afterGlobbing(err, resolved) {
-        if (err) {
-          console.error('Failed to glob:', err)
-          process.exitCode = -1
-          return cb(err)
-        }
-        resolved.forEach(function mergeResolved(files) {
-          files.forEach(function mergeFile(file) {
-            if (tests.indexOf(file) === -1) {
-              tests.push(file)
-            }
-          })
-        })
-        cb()
-      })
-    },
-    function runBenchmarks(cb) {
-      tests.sort()
-      a.eachSeries(tests, function spawnEachFile(file, cb) {
-        var test = path.relative(benchpath, file)
-
-        var args = [file]
-        if (opts.inspect) {
-          args.unshift('--inspect-brk')
-        }
-        var child = cp.spawn('node', args, {cwd: cwd, stdio: 'pipe'})
-        printer.addTest(test, child)
-
-        child.on('error', cb)
-        child.on('exit', function onChildExit(code) {
-          if (code) {
-            return cb(new Error('Benchmark exited with code ' + code))
-          }
-          cb()
-        })
-      }, function afterSpawnEachFile(err) {
-        if (err) {
-          console.error('Spawning failed:', err)
-          process.exitCode = -2
-          return cb(err)
-        }
-        cb()
-      })
-    }
-  ], () => {
-    printer.finish()
-  })
-}

package/bin/run-versioned-tests.sh

@@ -1,24 +0,0 @@
-#! /bin/bash
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-set -x
-
-VERSIONED_MODE="${VERSIONED_MODE:---major}"
-if [[ $TRAVIS_BRANCH == `git describe --tags --always HEAD` ]]; then
-  VERSIONED_MODE=--minor
-fi
-
-set -f
-directories=()
-if [[ "$1" != '' ]]; then
-  directories=(
-    "test/versioned/${1}"
-    "node_modules/@newrelic/${1}/tests/versioned"
-  )
-fi
-
-export AGENT_PATH=`pwd`
-
-time ./node_modules/.bin/versioned-tests $VERSIONED_MODE -i 2 ${directories[@]}

package/bin/smoke.sh

@@ -1,8 +0,0 @@
-#! /bin/sh
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-npm install --production --loglevel warn --no-package-lock
-npm --prefix test/smoke install --no-package-lock
-time node test/smoke/*.tap.js

package/bin/ssl.sh

@@ -1,87 +0,0 @@
-#! /bin/sh
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-# https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
-set -e  # exit if any command fails
-set -x  # be chatty and show the lines we're running
-
-# LibreSSL fails on the openssl ca step for reasons
-# that are mysterious and not understood, so let
-# bail early if we detect that's the case
-ENGINE_OPENSSL=`openssl version | awk '{print $(1)}'`
-if [ "$ENGINE_OPENSSL" = "LibreSSL" ]
-then
-    echo "LibreSSL is not supported, please install a stock openssl and \n"
-    echo "make sure that openssl binary is in your PATH"
-    exit 1
-fi
-
-# CACONFIG is the only non-generated file
-CACONFIG="test/lib/test-ca.conf"
-SSLKEY="test/lib/test-key.key"
-CACERT="test/lib/ca-certificate.crt"
-CAINDEX="test/lib/ca-index"
-CASERIAL="test/lib/ca-serial"
-CERTIFICATE="test/lib/self-signed-test-certificate.crt"
-
-# USAGE: ./bin/ssl.sh clear
-# a sub command to remove all the generated files and start over
-if [ "$1" = "clear" ]
-then
-    rm $SSLKEY
-    rm $CACERT
-    rm $CAINDEX
-    rm $CASERIAL
-    rm $CERTIFICATE
-    exit 0
-fi
-
-# if there's already a certificate, then exit, but
-# exit with a success code so build continue
-if [ -e $CERTIFICATE ]; then
-  exit 0;
-fi
-
-# generates an RSA key
-openssl genrsa -out $SSLKEY 1024
-
-# ca-index is the "certificate authority" database
-# and ca-serial is a file that openssl will read
-# "the next serial number for the ca-index entry"
-# from.
-touch $CAINDEX
-echo 000a > $CASERIAL
-
-# this generates a certificate for the
-# certificate authority
-openssl req \
-  -new \
-  -subj "/O=testsuite/OU=New Relic CA/CN=Node.js test CA" \
-  -key $SSLKEY \
-  -days 3650 \
-  -x509 \
-  -out $CACERT
-
-# this generates a "certificate signing request" file
-openssl req \
-  -new \
-  -subj "/O=testsuite/OU=Node.js agent team/CN=ssl.lvh.me" \
-  -key $SSLKEY \
-  -out server.csr
-
-# using the files generated above, this tells the
-# certificate authority about the request for a certificate,
-# which generates the self-signed-test-certificate.crt file.
-# This is the file used by the web server
-openssl ca \
-  -batch \
-  -cert $CACERT \
-  -config $CACONFIG \
-  -keyfile $SSLKEY \
-  -in server.csr \
-  -out $CERTIFICATE
-
-# remove the signing request now that we're done with it
-rm -f server.csr

package/bin/update-ca-bundle.sh

@@ -1,20 +0,0 @@
-#!/bin/sh
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-set -e
-
-start_dir=`pwd`
-
-# needs to be checked out in the parent directory of the agent
-# (https://github.com/newrelic/SSL_CA_cert_bundle only available to NR staff)
-ca_store="../SSL_CA_cert_bundle"
-bundle_generator="./bin/ca-gen.js"
-
-if [ -d $ca_store ]; then
-    cd $ca_store
-    git pull --rebase origin master
-    cd $start_dir
-    node $bundle_generator
-fi

package/bin/update-cats.sh

@@ -1,8 +0,0 @@
-#! /bin/sh
-
-# Copyright 2020 New Relic Corporation. All rights reserved.
-# SPDX-License-Identifier: Apache-2.0
-
-rm -rf test/lib/cross_agent_tests
-git clone git@source.datanerd.us:newrelic/cross_agent_tests.git test/lib/cross_agent_tests
-rm -rf test/lib/cross_agent_tests/.git

package/jsdoc-conf.json

@@ -1,18 +0,0 @@
-{
-  "opts": {
-    "destination": "out/",
-    "readme": "./README.md",
-    "template": "./node_modules/minami"
-  },
-  "source": {
-    "exclude": ["node_modules", "test"],
-    "includePattern": ".+\\.js(doc)?$"
-  },
-  "plugins": [
-    "plugins/markdown"
-  ],
-  "templates": {
-    "cleverLinks": true,
-    "showInheritedInNav": false
-  }
-}