feat: support all sam local cli options

b6pzeusbc54tvhw5jgpyw8pwz2x6gs · b6pzeusbc54tvhw5jgpyw8pwz2x6gs · commit bfee1ca12ddf · 2021-03-15T02:29:28.000+09:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,14 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
diff --git a/lib/SAMLocal.ts b/lib/SAMLocal.ts
@@ -6,35 +6,27 @@
 
 import { spawn } from 'child_process';
 
+import { getCLIOptionArgs } from './SamLocalCLIOptions';
+import { SAMLocalCLIOptions, SAMLocalType } from './types';
 import { createDeferred } from './utils';
 
-interface SAMLocalOptions {
-  // https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-local-start-api.html
-  warmContainers?: 'EAGER' | 'LAZY';
+export interface SAMLocalOptions {
   onData?: (data: any) => void;
   onError?: (data: any) => void;
+  cliOptions: SAMLocalCLIOptions;
 }
 export interface SAMLocal {
   kill: () => void;
 }
 
 export async function createSAMLocal(
-  type: 'sdk' | 'api',
+  type: SAMLocalType,
   cwd: string,
-  port: number,
-  options: SAMLocalOptions = {}
+  options: SAMLocalOptions = {cliOptions: {}},
 ): Promise<SAMLocal> {
-  const {warmContainers, onData, onError} = options
-  const sdkSpawnArgs = [
-    'local', 'start-lambda',
-    '--port', `${port}`,
-    '--region', 'local',
-  ];
-  const apiSpawnArgs = [
-    'local', 'start-api',
-    '--port', `${port}`,
-    ...(warmContainers ? ['--warm-containers',warmContainers] : []),
-  ];
+  const {onData, onError, cliOptions} = options;
+  const typeArg = type === 'sdk' ? 'start-lambda' : 'start-api';
+  const spawnArgs = ['local', typeArg, ...getCLIOptionArgs(type, cliOptions)];
   const defer = createDeferred();
   let started = false;
 
@@ -46,9 +38,7 @@ export async function createSAMLocal(
     }
   }
 
-  const process = spawn('sam', type === 'sdk' ? sdkSpawnArgs : apiSpawnArgs, {
-    cwd,
-  });
+  const process = spawn('sam', spawnArgs, { cwd });
 
   process.on('exit', () => {
     defer.resolve();
diff --git a/lib/SAMLocalCLIOptions.ts b/lib/SAMLocalCLIOptions.ts
@@ -0,0 +1,43 @@
+import {paramCase} from 'change-case'
+import { SAMLocalCLIOptions, SAMLocalType } from "./types"
+import { isNotEmptyString, isFinite} from "./utils"
+
+const cliOptionKeys = [
+  'host', 'port', 'template', 'envVars', 'parameterOverrides',
+  'debugPort', 'debuggerPath', 'debugArgs', 'warmContainers',
+  'debugFunction', 'dockerVolumeBasedir', 'dockerNetwork',
+  'containerEnvVars', 'logFile', 'layerCacheBasedir',
+  'skipPullImage', 'forceImageBuild', 'profile',
+  'region', 'configFile', 'configEnv', 'debug',
+]
+
+const isLocalStartLambdaCLIArgKey = (key: string) => {
+  return cliOptionKeys.indexOf(key) > -1
+}
+const isLocalStartAPICLIArgKey = (key: string) => {
+  return [...cliOptionKeys, 'staticDir'].indexOf(key) > -1
+}
+
+export const getCLIOptionArgs = (
+  type: SAMLocalType,
+  options: SAMLocalCLIOptions,
+): string[] => {
+  const args = Object.keys(options).reduce((prev, key) => {
+    const validKey = type === 'api'
+      ? isLocalStartAPICLIArgKey(key)
+      : isLocalStartLambdaCLIArgKey(key)
+    if (!validKey) {
+      console.warn(`Unknown option: ${key}. It is ignored.`)
+      return prev
+    }
+
+    const value = options[key as keyof SAMLocalCLIOptions]
+    const paramArgs =
+        isNotEmptyString(value)     ? [`--${paramCase(key)}`, value]
+      : isFinite(value)             ? [`--${paramCase(key)}`, value+'']
+      :/*typeof value === 'boolean'*/ [`--${paramCase(key)}`]
+    return [...prev, ...paramArgs]
+  }, [] as string[])
+
+  return args
+}
diff --git a/lib/generateAppModel.ts b/lib/generateAppModel.ts
@@ -14,7 +14,7 @@ import {
   unzipToLocation,
 } from './utils';
 import { createSAMLocal, SAMLocal } from './SAMLocal';
-import { ConfigLambda, SAMTemplate } from './types';
+import { ConfigLambda, SAMLocalAPICLIOptions, SAMTemplate } from './types';
 
 /**
  * Wrapper that generates a serverless application model (SAM) for lambda inputs
@@ -50,13 +50,15 @@ interface Props {
   cwd: string;
   onData?: (data: any) => void;
   onError?: (data: any) => void;
+  cliOptions?: SAMLocalAPICLIOptions;
 }
 
 export async function generateSAM({
   lambdas,
   cwd,
   onData,
   onError,
+  cliOptions={},
 }: Props): Promise<SAM> {
   const _tmpDir = tmpDir({ unsafeCleanup: true });
   const workdir = _tmpDir.name;
@@ -111,20 +113,21 @@ export async function generateSAM({
   fs.writeFileSync(path.join(workdir, 'template.yml'), yaml(SAMTemplate));
 
   let SAM: SAMLocal;
+  let host: string;
   let port: number;
   let client: AWSLambda;
+  let region: string;
 
   async function start() {
-    // Get free port
-    port = await getPort();
-    SAM = await createSAMLocal('api', workdir, port, {
+    port = cliOptions.port || await getPort();
+    host = cliOptions.host || '127.0.0.1'
+    region = cliOptions.region || 'local'
+    SAM = await createSAMLocal('api', workdir, {
       onData,
       onError,
+      cliOptions: { ...cliOptions, port, host, region },
     });
-    client = new AWSLambda({
-      endpoint: `http://localhost:${port}`,
-      region: 'local',
-    });
+    client = new AWSLambda({ endpoint: `http://${host}:${port}`, region });
   }
 
   async function stop() {
@@ -176,7 +179,7 @@ export async function generateSAM({
     path: string,
     { headers } = {}
   ) => {
-    return fetch(`http://localhost:${port}${path}`, { headers });
+    return fetch(`http://${host}:${port}${path}`, { headers });
   };
 
   return {
diff --git a/lib/generateProxyModel.ts b/lib/generateProxyModel.ts
@@ -12,7 +12,7 @@ import getPort from 'get-port';
 import http from 'http';
 import { URL } from 'url';
 
-import { SAMTemplate } from './types';
+import { SAMLocalLambadCLIOptions, SAMTemplate } from './types';
 import { getLocalIpAddressFromHost, unzipToLocation } from './utils';
 import { createSAMLocal, SAMLocal } from './SAMLocal';
 
@@ -28,6 +28,7 @@ interface Props {
   runtime?: 'nodejs12.x' | 'nodejs14.x';
   onData?: (data: any) => void;
   onError?: (data: any) => void;
+  cliOptions?: SAMLocalLambadCLIOptions;
 }
 
 interface SendRequestEventProps {
@@ -48,6 +49,7 @@ export async function generateProxySAM({
   runtime = 'nodejs12.x',
   onData,
   onError,
+  cliOptions={},
 }: Props): Promise<SAM> {
   const _tmpDir = tmpDir({ unsafeCleanup: true });
   const workdir = _tmpDir.name;
@@ -82,8 +84,10 @@ export async function generateProxySAM({
   fs.writeFileSync(path.join(workdir, 'template.yml'), yaml(SAMTemplate));
 
   let SAM: SAMLocal;
+  let host: string;
   let port: number;
   let client: AWSLambda;
+  let region: string;
   let portProxyConfig: number;
   // Simple HTTP server to serve the proxy config
   // https://stackoverflow.com/a/44188852/831465
@@ -95,14 +99,14 @@ export async function generateProxySAM({
   async function start() {
     // Initialize SAM
     port = await getPort();
-    SAM = await createSAMLocal('sdk', workdir, port, {
+    host = cliOptions.host || '127.0.0.1'
+    region = cliOptions.region || 'local'
+    SAM = await createSAMLocal('sdk', workdir, {
       onData,
       onError,
+      cliOptions: { ...cliOptions, port, host, region },
     });
-    client = new AWSLambda({
-      endpoint: `http://localhost:${port}`,
-      region: 'local',
-    });
+    client = new AWSLambda({ endpoint: `http://${host}:${port}`, region });
 
     // Initialize Proxy Config Server
     portProxyConfig = await getPort();
diff --git a/lib/types.ts b/lib/types.ts
@@ -41,3 +41,47 @@ export interface ConfigLambda {
   environment?: Record<string, string>;
   memorySize?: number;
 }
+
+export type SAMLocalType = 'sdk' | 'api'
+
+type WarmContainersOptions = 'EAGER' | 'LAZY'
+
+export interface SAMLocalCLICommonOptions {
+  host?: string
+  port?: number
+  template?: string
+  envVars?: string
+  parameterOverrides?: string
+  debugPort?: string
+  debuggerPath?: string
+  debugArgs?: string
+  warmContainers?: WarmContainersOptions
+  debugFunction?: string
+  dockerVolumeBasedir?: string
+  dockerNetwork?: string
+  containerEnvVars?: string
+  logFile?: string
+  layerCacheBasedir?: string
+  skipPullImage?: boolean
+  forceImageBuild?: boolean
+  profile?: string
+  region?: string
+  configFile?: string
+  configEnv?: string
+  debug?: boolean
+  // help?: boolean
+}
+
+export interface SAMLocalLambadCLIOptions extends SAMLocalCLICommonOptions {
+  // https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-local-start-lambda.html
+  // This type is the same as SAMLocalCLICommonOptions
+}
+
+export interface SAMLocalAPICLIOptions extends SAMLocalCLICommonOptions {
+  // https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-local-start-api.html
+  staticDir?: string
+}
+
+export type SAMLocalCLIOptions =
+  | SAMLocalLambadCLIOptions
+  | SAMLocalAPICLIOptions
diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -139,4 +139,12 @@ export function normalizeCloudFrontHeaders(
   return result;
 }
 
+export const isNotEmptyString = (a: any): a is string => {
+  return typeof a === 'string' && !!a
+}
+
+export const isFinite = (a: any): a is number => {
+  return Number.isFinite(a)
+}
+
 export { Deferred, createDeferred } from './deferred';
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
   },
   "dependencies": {
     "aws-sdk": "^2.771.0",
+    "change-case": "^4.1.2",
     "get-port": "^5.1.1",
     "node-fetch": "^2.6.1",
     "tmp": "^0.2.1",
diff --git a/yarn.lock b/yarn.lock
