gatsby-plugin-newrelic 2.2.0 → 2.2.1

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]
 
@@ -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,17 +66,6 @@ The New Relic Gatsby Plugin provides a simple to use configuration option for in
     }
     ```
 
-
-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/docs/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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)
 
 

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.2.0",
+  "version": "2.2.1",
   "description": "Gatsby plugin for implementing the New Relic Browser agent",
   "main": "index.js",
   "scripts": {

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"