Merge pull request #70 from zapier/read-from-env

read from .env by default in inject()

package.json

@@ -31,7 +31,7 @@
   "dependencies": {
     "bluebird": "3.5.0",
     "content-disposition": "0.5.2",
-    "dotenv": "4.0.0",
+    "dotenv": "5.0.1",
     "form-data": "2.2.0",
     "lodash": "4.17.4",
     "node-fetch": "1.7.1",

src/tools/environment.js

@@ -6,6 +6,8 @@ const dotenv = require('dotenv');
 
 const ensurePath = require('./ensure-path');
 
+const { IS_TESTING } = require('../constants');
+
 // Copy bundle environment into process.env, and vice versa,
 // for convenience and compatibility with native environment vars.
 const applyEnvironment = event => {
@@ -31,10 +33,29 @@ const cleanEnvironment = () => {
   }
 };
 
+const localFilepath = filename => {
+  return path.join(process.cwd(), filename || '');
+};
+
 const injectEnvironmentFile = filename => {
-  filename = filename || '.environment';
-  const filepath = path.join(process.cwd(), filename);
-  dotenv.load({ path: filepath });
+  if (filename) {
+    filename = localFilepath(filename);
+  }
+  // reads ".env" if filename is falsy, needs full path otherwise
+  let result = dotenv.load({ path: filename });
+  if (result.error) {
+    // backwards compatibility
+    result = dotenv.load({ path: localFilepath('.environment') });
+    if (result.parsed && !IS_TESTING) {
+      console.log(
+        [
+          '\nWARNING: `.environment` files will no longer be read by default in the next major version.',
+          'Either rename your file to `.env` or explicitly call this function with a filename:',
+          '\n    zapier.tools.env.inject(".environment");\n\n'
+        ].join('\n')
+      );
+    }
+  }
 };
 
 module.exports = {

test/tools/environment.js

@@ -1,30 +1,52 @@
-require('should');
+const should = require('should');
 const mock = require('mock-fs');
 
 const tools = require('../../src/tools/exported');
-const fake_file = 'CITY="boulder"\nNAME="david"\nPIZZA="Blackjack"\n';
+let env;
 
 describe('read env', () => {
   beforeEach(() => {
+    env = Object.assign({}, process.env);
+  });
+
+  it('should should only read .env', () => {
     mock({
-      '.environment': fake_file,
+      '.environment': 'CITY="boulder"\nNAME="david"\n',
+      '.env': 'PIZZA="Blackjack"\n',
       secrets: 'SECRET=very_secret_thing'
     });
-  });
 
-  it('should parse a config', done => {
     tools.env.inject();
     process.env.PIZZA.should.equal('Blackjack');
-    done();
+    should.not.exist(process.env.CITY);
   });
 
-  it('should parse a with filename', done => {
+  // this is temporary in v6, removed for v7
+  it('should read .environment if .env is missing', () => {
+    mock({
+      '.environment': 'CITY="boulder"\nNAME="david"\n'
+    });
+
+    tools.env.inject();
+    process.env.CITY.should.equal('boulder');
+    should.not.exist(process.env.PIZZA);
+  });
+
+  it('should parse a with filename, ignore defaults', () => {
+    mock({
+      '.environment': 'CITY="boulder"\nNAME="david"\n',
+      '.env': 'PIZZA="Blackjack"\n',
+      secrets: 'SECRET=very_secret_thing'
+    });
+
     tools.env.inject('secrets');
     process.env.SECRET.should.equal('very_secret_thing');
-    done();
+    should.not.exist(process.env.CITY);
+    should.not.exist(process.env.PIZZA);
   });
 
   afterEach(() => {
     mock.restore();
+    process.env = env;
   });
 });