feat(installMethod): add installMethod to inline config (#82)

Allows better triage of issues that may arise within this library

fix #81

Author: coreylight

src/__snapshots__/index.test.js.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Can create iopipe handler file 1`] = `
-"const iopipe = require('iopipe')({\\"token\\":\\"TEST_TOKEN\\"});
+"const iopipe = require('iopipe')({\\"token\\":\\"TEST_TOKEN\\",\\"installMethod\\":\\"[email protected]\\"});
 
 let handler, handlerError;
 // The following is an automatically generated require statement by the plugin,

src/index.js

@@ -5,6 +5,7 @@ import fs from 'fs-extra';
 import debugLib from 'debug';
 import cosmiconfig from 'cosmiconfig';
 
+import thisPkg from '../package';
 import { getVisitor, track } from './util/track';
 import hrMillis from './util/hrMillis';
 import handlerCode from './handlerCode';
@@ -351,7 +352,7 @@ class ServerlessIOpipePlugin {
       throw new Error(err);
     }
   }
-  getConfigFromCosmi() {
+  getConfig() {
     const { token } = this.getOptions();
     const { config: cosmi = {} } =
       cosmiconfig('iopipe', {
@@ -364,10 +365,13 @@ class ServerlessIOpipePlugin {
       .join('')
       .defaultTo('')
       .value();
-    const inlineConfigObject = _.pickBy(_.assign({}, cosmi, { token }));
-    const inlineConfig = _.isEmpty(inlineConfigObject)
-      ? ''
-      : JSON.stringify(inlineConfigObject);
+    const inlineConfigObject = _.pickBy(
+      _.assign({}, cosmi, {
+        token,
+        installMethod: `${thisPkg.name}@${thisPkg.version}`
+      })
+    );
+    const inlineConfig = JSON.stringify(inlineConfigObject);
     return {
       requireLines,
       inlineConfig
@@ -376,7 +380,7 @@ class ServerlessIOpipePlugin {
   createFiles() {
     const debug = createDebugger('createFiles');
     debug('Creating file');
-    const { inlineConfig, requireLines } = this.getConfigFromCosmi();
+    const { inlineConfig, requireLines } = this.getConfig();
     const { handlerDir } = this.getOptions();
     const iopipeInclude = `${requireLines}const iopipe = require('${this.getInstalledPackageName()}')(${inlineConfig});`;
     this.funcs.forEach((func, index) => {

src/index.test.js

@@ -237,15 +237,17 @@ test('Can create iopipe handler file', () => {
   expect(file).toMatchSnapshot();
 });
 
-test('Agent instantiation is blank if no iopipeToken in custom section of serverless.yml', () => {
+test('Agent instantiation only includes installMethod if no iopipeToken in custom section of serverless.yml', () => {
   Plugin.getOptions({ token: '' });
   Plugin.createFiles();
   const file = readFileSync(
     path.join(prefix, 'iopipe_handlers/simple-0-iopipe.js'),
     'utf8'
   );
   expect(file).toBeDefined();
-  expect(file.split('\n')[0]).toEqual("const iopipe = require('iopipe')();");
+  expect(file.split('\n')[0]).toEqual(
+    'const iopipe = require(\'iopipe\')({"installMethod":"[email protected]"});'
+  );
 });
 
 test('Cleans up', () => {

testProjects/cosmi/__snapshots__/index.test.js.snap

@@ -3,7 +3,7 @@
 exports[`Generated files requires plugin and includes plugin inline 1`] = `
 "require('@iopipe/event-info');
 require('@iopipe/trace');
-const iopipe = require('@iopipe/core')({\\"plugins\\":[\\"@iopipe/event-info\\",\\"@iopipe/trace\\"],\\"token\\":\\"test-token\\"});
+const iopipe = require('@iopipe/core')({\\"plugins\\":[\\"@iopipe/event-info\\",\\"@iopipe/trace\\"],\\"token\\":\\"test-token\\",\\"installMethod\\":\\"[email protected]\\"});
 
 let handler, handlerError;
 // The following is an automatically generated require statement by the plugin,

testProjects/default/__snapshots__/index.test.js.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Generated files require plugin, include plugin inline, and export original handler 1`] = `
-"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\"});
+"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\",\\"installMethod\\":\\"[email protected]\\"});
 
 let handler, handlerError;
 // The following is an automatically generated require statement by the plugin,
@@ -29,7 +29,7 @@ exports['simple'] = function attemptSimple(event, context, callback) {
 `;
 
 exports[`Generated files require plugin, include plugin inline, and export original handler 2`] = `
-"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\"});
+"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\",\\"installMethod\\":\\"[email protected]\\"});
 
 let handler, handlerError;
 // The following is an automatically generated require statement by the plugin,
@@ -57,7 +57,7 @@ exports['nameMismatch'] = function attemptNameMismatch(event, context, callback)
 `;
 
 exports[`Generated files require plugin, include plugin inline, and export original handler 3`] = `
-"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\"});
+"const iopipe = require('iopipe')({\\"token\\":\\"test-token\\",\\"installMethod\\":\\"[email protected]\\"});
 
 let handler, handlerError;
 // The following is an automatically generated require statement by the plugin,

testProjects/offline/serverless.yml

@@ -19,4 +19,5 @@ functions:
 custom:
   serverless-offline:
     port: 4982
+    host: 127.0.0.1
   iopipeHandlerDir: iopipe_handlers

testProjects/offline/test.js

@@ -2,7 +2,7 @@ const gotLib = require('got');
 const spawn = require('cross-spawn');
 
 const got = str => gotLib(str, { json: true });
-const BASE = `http://localhost:4982`;
+const BASE = `http://127.0.0.1:4982`;
 
 async function run() {
   // make sure that the error state works too