gatsby-plugin-newrelic 2.0.2 → 2.2.2

package/.github/workflows/release.yml

@@ -49,7 +49,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 10.x
+          node-version: 16.x
 
       - name: Cache node_modules
         id: cache-node-modules
@@ -90,7 +90,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 10.x
+          node-version: 16.x
 
       - name: Download Cached Deps
         id: cache-node-modules
@@ -211,7 +211,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 10.x
+          node-version: 16.x
 
       - name: Download Cached Deps
         id: cache-node-modules

package/CONTRIBUTING.md

@@ -18,6 +18,19 @@ Before submitting an Issue, please search for similar ones in the
 2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
 3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
 
+## Publishing next versions to NPM
+
+ A [Github workflow](https://github.com/newrelic/gatsby-plugin-newrelic/blob/main/.github/workflows/release.yml) which uses NPX [semantic-release](https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches) exists to assist in publishing next versions of this plugin to NPM.
+
+ > If you wish to publish a latest version to NPM follow these steps but ensure you change the tag in [package.json](package.json) to latest
+
+ 1. Make your changes on a local branch from main.
+ 2. After pulling down the code, run `git fetch && git pull` to ensure you have the latest code for main.
+ 3. Commit your changes and submit a PR to the `next` branch.
+ 4. Ensure that you [bump the version of the package](https://cloudfour.com/thinks/how-to-publish-an-updated-version-of-an-npm-package/#the-standard-release-process) by using semantic versioning using the `NPM version` command.
+ 5. This will kick off the workflow to publish a next version to NPM.
+ 6. Go to [NPM](https://www.npmjs.com/package/gatsby-plugin-newrelic) to view the next branch.
+
 ## Contributor License Agreement
 
 Keep in mind that when you submit your Pull Request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com.

package/README.md

@@ -1,6 +1,7 @@
 [![Community Project header](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Project.png)](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#community-project)
 
 # New Relic Gatsby Plugin
+
 [![Known Vulnerabilities][3]][4]
 [![npm status badge][1]][2]
 
@@ -8,12 +9,12 @@ The New Relic Gatsby Plugin provides a simple to use configuration option for in
 
 ## Installation
 
-1. If you don't already have a New Relic account, [sign-up for our free forever tier - no credit-card required!](https://newrelic.com/signup)
-1. Go to [https://rpm.newrelic.com](https://rpm.newrelic.com)
-1. Select the "Browser" product from the navigation
-1. Click on "Add more" to add your website
+1. If you don't already have a New Relic account, [sign-up for our free forever tier - no credit-card required!](https://trynewrelic.com/gatsby)
+1. Go to [https://one.newrelic.com](https://one.newrelic.com)
+1. Click on "Add more data" to add your website
+1. In the "Browser metrics" section, select "New Relic Browser"
 1. Select "Copy/Paste Javascript code" and copy the code
-1. Under "Choose your instrumentation" select Lite, Pro, or Pro + SPA
+1. Follow the steps to configure your instrumentation
 1. Enter your app name
 1. Click "Enable"
 1. Paste the JS snippet provided into a text editor
@@ -27,32 +28,11 @@ The New Relic Gatsby Plugin provides a simple to use configuration option for in
 
     and turn it into a `gatsby-config`, adding it to `gatsby-config.js` as a plugin
 
-    ```js
+     ```js
     {
       resolve: 'gatsby-plugin-newrelic',
       options: {
-        configs: {
-          dev: {
-            instrumentationType: 'proAndSPA',
-            accountId: '<some integer>',
-            trustKey: '<some integer>',
-            agentID: '<some integer>',
-            licenseKey: '<the license key>',
-            applicationID: '<some integer>',
-            beacon: 'bam.nr-data.net',
-            errorBeacon: 'bam.nr-data.net'
-          },
-          staging: {
-            instrumentationType: 'proAndSPA',
-            accountId: '<some integer>',
-            trustKey: '<some integer>',
-            agentID: '<some integer>',
-            licenseKey: '<the license key>',
-            applicationID: '<some integer>',
-            beacon: 'bam.nr-data.net',
-            errorBeacon: 'bam.nr-data.net'
-          },
-          production: {
+        config: {
             instrumentationType: 'proAndSPA',
             accountId: '<some integer>',
             trustKey: '<some integer>',
@@ -61,25 +41,24 @@ The New Relic Gatsby Plugin provides a simple to use configuration option for in
             applicationID: '<some integer>',
             beacon: 'bam.nr-data.net',
             errorBeacon: 'bam.nr-data.net'
-          }
         }
       }
     }
     ```
 
-    If you have no need for multiple environments, you can simply pass a single object like:
+    If you have a need for multiple environments, you can configure this like:
 
     ```js
     {
       resolve: 'gatsby-plugin-newrelic',
       options: {
-        configs: {
-          instrumentationType: 'proAndSPA',
+        config: {
+            instrumentationType: 'proAndSPA',
             accountId: '<some integer>',
             trustKey: '<some integer>',
             agentID: '<some integer>',
             licenseKey: '<the license key>',
-            applicationID: '<some integer>',
+            applicationID: process.env.YOUR_ENVIRONMENT_KEY === "production" ? '<some integer>' : '<some other integer>',
             beacon: 'bam.nr-data.net',
             errorBeacon: 'bam.nr-data.net'
         }
@@ -87,18 +66,6 @@ The New Relic Gatsby Plugin provides a simple to use configuration option for in
     }
     ```
 
-    Note - `instrumentationType` can be `lite`, `pro`, `proAndSPA`, corresponding with levels of our browser agent.
-
-1. Set the `GATSBY_NEWRELIC_ENV` to point at the appropriate config. For local dev you would add `GATSBY_NEWRELIC_ENV=dev` to the front of your "develop" script in your project's `package.json`. For "production" you would add `GATSBY_NEWRELIC_ENV=production` to the front of the Gatsby "build" command.
-    Ex. `package.json`:
-
-    ```js
-      "scripts": {
-        "build": "GATSBY_NEWRELIC_ENV=production gatsby build",
-        "build:dev": "GATSBY_NEWRELIC_ENV=dev npm run build",
-      }
-    ```
-
 ## Getting Started
 
 Navigate to [https://one.newrelic.com](https://one.newrelic.com), select the _Entity Explorer_ and then select your browser application to monitor metrics of your site.

package/THIRD_PARTY_NOTICES.md

@@ -32,7 +32,7 @@ code, the source code can be found at [https://github.com/newrelic/gatsby-plugin
 
 ### @babel/runtime
 
-This product includes source derived from [@babel/runtime](https://github.com/babel/babel) ([v7.13.10](https://github.com/babel/babel/tree/v7.13.10)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.13.10/LICENSE):
+This product includes source derived from [@babel/runtime](https://github.com/babel/babel) ([v7.16.7](https://github.com/babel/babel/tree/v7.16.7)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.16.7/LICENSE):
 
 ```
 MIT License
@@ -95,7 +95,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @babel/core
 
-This product includes source derived from [@babel/core](https://github.com/babel/babel) ([v7.13.15](https://github.com/babel/babel/tree/v7.13.15)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.13.15/LICENSE):
+This product includes source derived from [@babel/core](https://github.com/babel/babel) ([v7.16.7](https://github.com/babel/babel/tree/v7.16.7)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.16.7/LICENSE):
 
 ```
 MIT License
@@ -125,7 +125,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @babel/plugin-proposal-private-methods
 
-This product includes source derived from [@babel/plugin-proposal-private-methods](https://github.com/babel/babel) ([v7.13.0](https://github.com/babel/babel/tree/v7.13.0)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.13.0/LICENSE):
+This product includes source derived from [@babel/plugin-proposal-private-methods](https://github.com/babel/babel) ([v7.16.7](https://github.com/babel/babel/tree/v7.16.7)), distributed under the [MIT License](https://github.com/babel/babel/blob/v7.16.7/LICENSE):
 
 ```
 MIT License

package/docs/CHANGELOG.md

@@ -1,3 +1,44 @@
+## [2.2.2](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.2.1...v2.2.2) (2022-02-09)
+
+
+### Bug Fixes
+
+* publishes a latest version ([c2e68bb](https://github.com/newrelic/gatsby-plugin-newrelic/commit/c2e68bbe191c1ee4ea7657ecd44f953bc7213a2b))
+
+## [2.2.1](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.2.0...v2.2.1) (2022-02-08)
+
+
+### Bug Fixes
+
+* bumps release ([c33fc1b](https://github.com/newrelic/gatsby-plugin-newrelic/commit/c33fc1b490f0ed45ff079f695cd4d0e784bfc810))
+
+# [2.2.0](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.1.1...v2.2.0) (2022-01-14)
+
+
+### Features
+
+* Update package.json ([055d741](https://github.com/newrelic/gatsby-plugin-newrelic/commit/055d741013585b1cec6d6f5441104cfca8170ff5))
+
+## [2.1.1](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.1.0...v2.1.1) (2022-01-10)
+
+
+### Bug Fixes
+
+* updated contributing guide ([af6aa1c](https://github.com/newrelic/gatsby-plugin-newrelic/commit/af6aa1c48603a36641099b7ab6c2612e31fa11bc))
+
+# [2.1.0](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.0.2...v2.1.0) (2022-01-06)
+
+
+### Bug Fixes
+
+* bumped the node version ([bc7f7ee](https://github.com/newrelic/gatsby-plugin-newrelic/commit/bc7f7ee43f68a07a6381fded83195786783399a6))
+* update ci node version ([7fec128](https://github.com/newrelic/gatsby-plugin-newrelic/commit/7fec128c63852a78f8be23a3bb06cb65c7322c65))
+
+
+### Features
+
+* adds support for gatsby 4 ([a7b5ba3](https://github.com/newrelic/gatsby-plugin-newrelic/commit/a7b5ba3c21aa772e7c300af167f894cf5019dd45))
+
 ## [2.0.2](https://github.com/newrelic/gatsby-plugin-newrelic/compare/v2.0.1...v2.0.2) (2021-08-06)
 
 

package/gatsby/on-render-body.js

@@ -13,8 +13,9 @@ var _latest = require("../browser-agents/latest");
 
 var _default = function _default(_ref, pluginOptions) {
   var setHeadComponents = _ref.setHeadComponents;
-  var userConfigs = pluginOptions.configs;
-  var requiredConfigs = {
+  var userConfigs = pluginOptions.configs,
+      userConfig = pluginOptions.config;
+  var requiredConfig = {
     accountId: '',
     trustKey: '',
     agentID: '',
@@ -26,19 +27,15 @@ var _default = function _default(_ref, pluginOptions) {
 
   };
   var env = process.env.GATSBY_NEWRELIC_ENV;
+  var userEnvConfig = env ? userConfigs[env] : userConfig;
 
-  if (!env) {
-    // TO DO - Error/Warn about envVariable not being set
-    console.warn('GATSBY_NEWRELIC_ENV env variable is not set');
+  if (!userEnvConfig) {
+    console.warn("gatsby-plugin-newrelic is missing the configuration" + (env ? " for the " + env + " environment" : ''));
     return;
   }
 
-  var userEnvConfig = userConfigs[env] ? userConfigs[env] : userConfigs;
-
-  if (!userEnvConfig) {
-    // TO DO - Error/Warn about missing config option for a given env
-    console.warn('gatsby-plugin-newrelic is missing the configuration for the ' + env + ' environment');
-    return;
+  if (env) {
+    console.warn('gatsby-plugin-newrelic has deprecated using GATSBY_NEWRELIC_ENV for multiple environments');
   }
 
   var allowedInstrumentationTypes = ['lite', 'pro', 'proAndSPA'];
@@ -49,7 +46,7 @@ var _default = function _default(_ref, pluginOptions) {
   if (!itExists) {// TO DO - Error/Warn about wrong instrumentation type
   }
 
-  var options = (0, _extends2["default"])({}, requiredConfigs, userEnvConfig);
+  var options = (0, _extends2["default"])({}, requiredConfig, userEnvConfig);
   var instrumentationType = options.instrumentationType;
   var emptyOptions = Object.entries(options).filter(function (_ref2) {
     var v = _ref2[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gatsby-plugin-newrelic",
-  "version": "2.0.2",
+  "version": "2.2.2",
   "description": "Gatsby plugin for implementing the New Relic Browser agent",
   "main": "index.js",
   "scripts": {
@@ -19,7 +19,7 @@
   },
   "homepage": "https://opensource.newrelic.com/projects/newrelic/gatsby-plugin-newrelic",
   "peerDependencies": {
-    "gatsby": "^3.0.0",
+    "gatsby": "3.x || 4.x",
     "react": "^17.0.0",
     "react-dom": "^17.0.0"
   },
@@ -42,7 +42,7 @@
     "cross-env": "^5.2.1"
   },
   "engines": {
-    "node": ">=10.13.0"
+    "node": ">=16.3.1"
   },
   "private": false,
   "publishConfig": {

package/src/gatsby/on-render-body.js

@@ -3,10 +3,11 @@ import { liteAgent, proAgent, proAndSpaAgent } from '../browser-agents/latest';
 
 export default ({ setHeadComponents }, pluginOptions) => {
   const {
-    configs: userConfigs
+    configs: userConfigs,
+    config: userConfig
   } = pluginOptions;
 
-  const requiredConfigs = {
+  const requiredConfig = {
     accountId: '',
     trustKey: '',
     agentID: '',
@@ -19,17 +20,14 @@ export default ({ setHeadComponents }, pluginOptions) => {
 
   const env = process.env.GATSBY_NEWRELIC_ENV;
 
-  if (!env) {
-    // TO DO - Error/Warn about envVariable not being set
-    console.warn('GATSBY_NEWRELIC_ENV env variable is not set');
+  const userEnvConfig = env ? userConfigs[env] : userConfig;
+  if (!userEnvConfig) {
+    console.warn(`gatsby-plugin-newrelic is missing the configuration${env ? ` for the ${env} environment` : ''}`);
     return;
   }
 
-  const userEnvConfig = userConfigs[env] ? userConfigs[env] : userConfigs;
-  if (!userEnvConfig) {
-    // TO DO - Error/Warn about missing config option for a given env
-    console.warn('gatsby-plugin-newrelic is missing the configuration for the ' + env + ' environment');
-    return;
+  if (env) {
+    console.warn('gatsby-plugin-newrelic has deprecated using GATSBY_NEWRELIC_ENV for multiple environments');
   }
 
   const allowedInstrumentationTypes = ['lite', 'pro', 'proAndSPA'];
@@ -40,7 +38,7 @@ export default ({ setHeadComponents }, pluginOptions) => {
     // TO DO - Error/Warn about wrong instrumentation type
   }
 
-  const options = { ...requiredConfigs, ...userEnvConfig };
+  const options = { ...requiredConfig, ...userEnvConfig };
   const instrumentationType = options.instrumentationType;
 
   const emptyOptions = Object.entries(options).filter(([, v]) => v === '');
@@ -66,7 +64,7 @@ export default ({ setHeadComponents }, pluginOptions) => {
     ;NREUM.info={beacon:"${options.beacon}",errorBeacon:"${options.errorBeacon}",licenseKey:"${options.licenseKey}",applicationID:"${options.applicationID}",sa:1}
   `;
 
-  if (agent && configs) { 
+  if (agent && configs) {
     setHeadComponents([
       <script
         key="gatsby-plugin-newrelic"

package/third_party_manifest.json

@@ -1,22 +1,22 @@
 {
-  "lastUpdated": "Fri Aug 06 2021 21:07:45 GMT+0000 (Coordinated Universal Time)",
+  "lastUpdated": "Fri Jan 14 2022 22:34:47 GMT+0000 (Coordinated Universal Time)",
   "projectName": "gatsby-plugin-newrelic",
   "projectUrl": "https://github.com/newrelic/gatsby-plugin-newrelic",
-  "includeDev": true,
   "includeOptDeps": false,
+  "includeDev": true,
   "dependencies": {
-    "@babel/runtime@7.13.10": {
+    "@babel/runtime@7.16.7": {
       "name": "@babel/runtime",
-      "version": "7.13.10",
+      "version": "7.16.7",
       "range": "^7.12.5",
       "licenses": "MIT",
       "repoUrl": "https://github.com/babel/babel",
-      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.13.10",
+      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.16.7",
       "licenseFile": "node_modules/@babel/runtime/LICENSE",
-      "licenseUrl": "https://github.com/babel/babel/blob/v7.13.10/LICENSE",
+      "licenseUrl": "https://github.com/babel/babel/blob/v7.16.7/LICENSE",
       "licenseTextSource": "file",
-      "publisher": "Sebastian McKenzie",
-      "email": "sebmck@gmail.com"
+      "publisher": "The Babel Team",
+      "url": "https://babel.dev/team"
     }
   },
   "devDependencies": {
@@ -33,29 +33,31 @@
       "publisher": "The Babel Team",
       "url": "https://babel.dev/team"
     },
-    "@babel/core@7.13.15": {
+    "@babel/core@7.16.7": {
       "name": "@babel/core",
-      "version": "7.13.15",
+      "version": "7.16.7",
       "range": "^7.0.0",
       "licenses": "MIT",
       "repoUrl": "https://github.com/babel/babel",
-      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.13.15",
+      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.16.7",
       "licenseFile": "node_modules/@babel/core/LICENSE",
-      "licenseUrl": "https://github.com/babel/babel/blob/v7.13.15/LICENSE",
+      "licenseUrl": "https://github.com/babel/babel/blob/v7.16.7/LICENSE",
       "licenseTextSource": "file",
-      "publisher": "Sebastian McKenzie",
-      "email": "sebmck@gmail.com"
+      "publisher": "The Babel Team",
+      "url": "https://babel.dev/team"
     },
-    "@babel/plugin-proposal-private-methods@7.13.0": {
+    "@babel/plugin-proposal-private-methods@7.16.7": {
       "name": "@babel/plugin-proposal-private-methods",
-      "version": "7.13.0",
+      "version": "7.16.7",
       "range": "^7.8.3",
       "licenses": "MIT",
       "repoUrl": "https://github.com/babel/babel",
-      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.13.0",
+      "versionedRepoUrl": "https://github.com/babel/babel/tree/v7.16.7",
       "licenseFile": "node_modules/@babel/plugin-proposal-private-methods/LICENSE",
-      "licenseUrl": "https://github.com/babel/babel/blob/v7.13.0/LICENSE",
-      "licenseTextSource": "file"
+      "licenseUrl": "https://github.com/babel/babel/blob/v7.16.7/LICENSE",
+      "licenseTextSource": "file",
+      "publisher": "The Babel Team",
+      "url": "https://babel.dev/team"
     },
     "@semantic-release/changelog@5.0.1": {
       "name": "@semantic-release/changelog",