feat: introduce config file functionality (#15) (#38)

* feat: introduce config file functionality (#15)

With this change we are starting to allow .twilio-functions for more than just storing some build outcomes. It supports grouping configs by environment, command or project or nested combinations of these.

Very extended config:

```json
{
	"startConfig": {
		"ngrok": "dom",
		"inspect": ""
	},
	"environments": {
		"dev": {
			"deployConfig": {
				"env": ".env"
			}
		},
		"prod": {
			"deployConfig": {
				"env": ".env.prod"
			}
		}
	},
	"projects": {
		"ACc2bdaa19578061b45a518axxxxxxxxxx": {
			"serviceSid": "ZSd6e3037c5710c8e8c979f5xxxxxxxxxx",
			"latestBuild": "ZBdf824389570e3ee2ebcec7xxxxxxxxxx",
			"deployConfig": {
				"environment": "prod"
			}
		}
	},
	"serviceSid": "ZSd6e3037c5710c8e8c979fxxxxxxxxxx",
	"latestBuild": "ZBdf824389570e3ee2ebcec7xxxxxxxxxx"
}
```

fix: #15

* feat: add config support for list,activate,deploy (#15)

This commit adds config file support for the list, activate and deploy
command.

It also deprecates the --functions-env flag

BREAKING CHANGE: Deprecating --functions-env as an option

fix: #15, fix: #27

* refactor(config): factor out common code for testability

* fix(config): write serviceSid to config

This creates compatibility of config files for twilio-run

* test(config): add basic test for list config

* feat(runtime): handle invalid account sid & new error page

This change will check for valid Account SIDs in local development mode and create an appropriate
error message. It also introduces a new Error response page

BREAKING CHANGE: Error page layout changed

fix #45

* chore(release): 2.0.0-beta.13

* fix: update code for new version of severless-api (#46)

* fix: update code for new version of severless-api

re twilio-labs/serverless-api#8

* chore(npm): upgrade @twilio-labs/serverless-api

* fix(tests): fix integration tests

Remove the reliance on stacktraces in the error integration tests

* chore(release): 2.0.0-rc.0

* chore(npm): upgrade serverless-api library

* chore(release): 2.0.0-rc.1

* feat(new): change from prompts to inquirer (#36)

Prompts has a bug for screens that are smaller than the content. This fix hasn't been launched yet
so we are switching to inquirer.

fixes #36

* fix(templates): switch template list endpoint to next branch

The templates are currently pulled from the next branch but the list was from master, causing some
templates to crash

* feat: introduce config file functionality (#15)

With this change we are starting to allow .twilio-functions for more than just storing some build
outcomes. It supprts grouping configs by environment, command or project or nested combinations of
these

fix: #15

* feat: add config support for list,activate,deploy (#15)

This commit adds config file support for the list, activate and deploy
command.

It also deprecates the --functions-env flag

BREAKING CHANGE: Deprecating --functions-env as an option

fix: #15, fix: #27

* refactor(config): factor out common code for testability

* fix(config): write serviceSid to config

This creates compatibility of config files for twilio-run

* test(config): add basic test for list config

* feat(config): accept external config options

* test(config): add more tests for configs

* fix(config): store under accountSid not API key

Author: dkundel

__mocks__/twilio.js renamed to __mocks__/twilio.ts

@@ -0,0 +1,4 @@
+export default {
+  width: 100,
+  height: 200,
+};

__mocks__/window-size.ts

@@ -0,0 +1,42 @@
+import { getConfigFromFlags, ListCliFlags } from '../../src/config/list';
+
+jest.mock('../../src/config/global');
+jest.mock('../../src/config/utils/mergeFlagsAndConfig');
+jest.mock('../../src/config/utils');
+
+const baseFlags = {
+  types: 'services',
+  extendedOutput: false,
+  environment: 'dev',
+} as ListCliFlags;
+
+describe('getConfigFromFlags', () => {
+  test('should return a config', async () => {
+    const flags = { ...baseFlags };
+    const config = await getConfigFromFlags(flags);
+    expect(config).toBeDefined();
+  });
+
+  describe('handle types', () => {
+    test('should split types into an array', async () => {
+      const flags = { ...baseFlags };
+      const config = await getConfigFromFlags(flags);
+      expect(config.types).toEqual(['services']);
+    });
+
+    test('should split types by comma and trim', async () => {
+      const flags = { ...baseFlags, types: 'environments, functions' };
+      const config = await getConfigFromFlags(flags);
+      expect(config.types).toEqual(['environments', 'functions']);
+    });
+  });
+
+  test('should call the right functions', async () => {
+    const globalMod = require('../../src/config/global');
+    const utilMod = require('../../src/config/utils');
+    const config = await getConfigFromFlags({ ...baseFlags });
+    expect(globalMod.readSpecializedConfig).toHaveBeenCalled();
+    expect(utilMod.getServiceNameFromFlags).toHaveBeenCalled();
+    expect(utilMod.getCredentialsFromFlags).toHaveBeenCalled();
+  });
+});

__tests__/config/list.test.ts

@@ -3,8 +3,9 @@ import {
   getInspectInfo,
   getPort,
   getUrl,
-  WrappedStartCliFlags,
-} from '../../../src/runtime/cli/config';
+  StartCliConfig,
+  StartCliFlags,
+} from '../../src/config/start';
 
 jest.mock('ngrok', () => {
   return {
@@ -20,32 +21,26 @@ jest.mock('ngrok', () => {
 describe('getUrl', () => {
   test('returns localhost if ngrok is not passed', async () => {
     const config = ({
-      flags: {
-        ngrok: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: undefined,
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('http://localhost:3000');
   });
 
   test('calls ngrok if ngrok is defined', async () => {
     const config = ({
-      flags: {
-        ngrok: '',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: '',
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('https://random.ngrok.io');
   });
 
   test('calls ngrok with custom subdomain if passed', async () => {
     const config = ({
-      flags: {
-        ngrok: 'dom',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      ngrok: 'dom',
+    } as unknown) as StartCliFlags;
 
     const url = await getUrl(config, 3000);
     expect(url).toBe('https://dom.ngrok.io');
@@ -69,10 +64,8 @@ describe('getPort', () => {
 
   test('returns default 3000 if nothing is passed', () => {
     const config = ({
-      flags: {
-        port: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: undefined,
+    } as unknown) as StartCliFlags;
 
     delete process.env.PORT;
     const port = getPort(config);
@@ -81,10 +74,8 @@ describe('getPort', () => {
 
   test('checks for process.env.PORT and returns number', () => {
     const config = ({
-      flags: {
-        port: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: undefined,
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -94,10 +85,8 @@ describe('getPort', () => {
 
   test('port passed via flag takes preference', () => {
     const config = ({
-      flags: {
-        port: 1234,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: 1234,
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -107,10 +96,8 @@ describe('getPort', () => {
 
   test('handles strings and returns number', () => {
     const config = ({
-      flags: {
-        port: '8080',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      port: '8080',
+    } as unknown) as StartCliFlags;
 
     process.env.PORT = '9999';
     const port = getPort(config);
@@ -138,79 +125,65 @@ describe('getBaseDirectory', () => {
 
   test('handles current working directory if none is passed', () => {
     const config = ({
-      flags: {
-        dir: undefined,
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/home');
   });
 
   test('supports dir argument', () => {
     const config = ({
-      flags: {
-        dir: '/usr/local',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '/usr/local',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/usr/local');
   });
 
   test('prefers cwd over dir argument', () => {
     const config = ({
-      flags: {
-        dir: '/usr/local',
-        cwd: '/usr/bin',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '/usr/local',
+      cwd: '/usr/bin',
+    } as unknown) as StartCliFlags;
 
     const result = getBaseDirectory(config);
     expect(result).toBe('/usr/bin');
   });
 
   test('handles relative path for dir', () => {
     let config = ({
-      flags: {
-        dir: 'demo',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: 'demo',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     let result = getBaseDirectory(config);
     expect(result).toBe('/home/demo');
 
     config = ({
-      flags: {
-        dir: '../demo',
-        cwd: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: '../demo',
+      cwd: undefined,
+    } as unknown) as StartCliFlags;
 
     result = getBaseDirectory(config);
     expect(result).toBe('/demo');
   });
 
   test('handles relative path for cwd', () => {
     let config = ({
-      flags: {
-        dir: undefined,
-        cwd: 'demo',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: 'demo',
+    } as unknown) as StartCliFlags;
 
     let result = getBaseDirectory(config);
     expect(result).toBe('/home/demo');
 
     config = ({
-      flags: {
-        dir: undefined,
-        cwd: '../demo',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      dir: undefined,
+      cwd: '../demo',
+    } as unknown) as StartCliFlags;
 
     result = getBaseDirectory(config);
     expect(result).toBe('/demo');
@@ -220,59 +193,49 @@ describe('getBaseDirectory', () => {
 describe('getInspectInfo', () => {
   test('returns undefined if nothing is passed', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toBeUndefined();
   });
 
   test('handles present but empty inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: '',
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: '',
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '', break: false });
   });
 
   test('handles present but empty inspectBrk flag', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: '',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: '',
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '', break: true });
   });
 
   test('handles passed port in inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: '9999',
-        inspectBrk: undefined,
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: '9999',
+      inspectBrk: undefined,
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '9999', break: false });
   });
 
   test('handles passed port in inspect flag', () => {
     const config = ({
-      flags: {
-        inspect: undefined,
-        inspectBrk: '1234',
-      },
-    } as unknown) as WrappedStartCliFlags;
+      inspect: undefined,
+      inspectBrk: '1234',
+    } as unknown) as StartCliFlags;
 
     const result = getInspectInfo(config);
     expect(result).toEqual({ hostPort: '1234', break: true });

__tests__/runtime/cli/config.test.ts renamed to __tests__/config/start.test.ts

@@ -0,0 +1,5 @@
+describe('getServiceNameFromFlags', () => {
+  test('TODO', () => {
+    expect(true).toBeTruthy();
+  });
+});