fix(create-twilio-function): place runtime-handler in dependencies (#331)

Author: philnash

packages/create-twilio-function/src/create-twilio-function/create-files.js

@@ -22,15 +22,15 @@ async function createFile(fullPath, content) {
   return writeFile(fullPath, content, { flag: 'wx' });
 }
 
-const javaScriptDeps = { twilio: versions.twilio };
+const javaScriptDeps = {
+  twilio: versions.twilio,
+  '@twilio/runtime-handler': versions.twilioRuntimeHandler,
+};
 const typescriptDeps = {
   '@twilio-labs/serverless-runtime-types': versions.serverlessRuntimeTypes,
   ...javaScriptDeps,
 };
-const javaScriptDevDeps = {
-  '@twilio/runtime-handler': versions.twilioRuntimeHandler,
-  'twilio-run': versions.twilioRun,
-};
+const javaScriptDevDeps = { 'twilio-run': versions.twilioRun };
 const typescriptDevDeps = {
   ...javaScriptDevDeps,
   typescript: versions.typescript,

packages/create-twilio-function/tests/create-files.test.js

@@ -79,7 +79,7 @@ describe('create-files', () => {
       expect(packageJSON.devDependencies['twilio-run']).toEqual(
         versions.twilioRun
       );
-      expect(packageJSON.devDependencies['@twilio/runtime-handler']).toEqual(
+      expect(packageJSON.dependencies['@twilio/runtime-handler']).toEqual(
         versions.twilioRuntimeHandler
       );
       expect(packageJSON.dependencies['twilio']).toEqual(versions.twilio);
@@ -105,7 +105,7 @@ describe('create-files', () => {
       expect(packageJSON.devDependencies.typescript).toEqual(
         versions.typescript
       );
-      expect(packageJSON.devDependencies['@twilio/runtime-handler']).toEqual(
+      expect(packageJSON.dependencies['@twilio/runtime-handler']).toEqual(
         versions.twilioRuntimeHandler
       );
       expect(

packages/twilio-run/src/commands/start.ts

@@ -1,6 +1,7 @@
 import { Server } from 'http';
 import inquirer from 'inquirer';
 import { Argv } from 'yargs';
+import { checkForValidRuntimeHandlerVersion } from '../checks/check-runtime-handler';
 import checkLegacyConfig from '../checks/legacy-config';
 import checkNodejsVersion from '../checks/nodejs-version';
 import checkProjectStructure from '../checks/project-structure';
@@ -48,6 +49,11 @@ export async function handler(
 
   const config = await getConfigFromCli(argv, cliInfo, externalCliOptions);
 
+  if (!checkForValidRuntimeHandlerVersion(config.pkgJson)) {
+    process.exitCode = 1;
+    return;
+  }
+
   const command = getFullCommand(argv);
   const directories = {
     assetsDirectories: config.assetsFolderName

packages/twilio-run/src/config/start.ts

@@ -9,8 +9,10 @@ import { AllAvailableFlagTypes, SharedFlagNames } from '../flags';
 import { EnvironmentVariablesWithAuth } from '../types/generic';
 import { fileExists } from '../utils/fs';
 import { getDebugFunction, logger } from '../utils/logger';
+import { readPackageJsonContent } from './utils';
 import { readSpecializedConfig } from './global';
 import { mergeFlagsAndConfig } from './utils/mergeFlagsAndConfig';
+import { PackageJson } from 'type-fest';
 
 const debug = getDebugFunction('twilio-run:cli:config');
 
@@ -38,6 +40,7 @@ export type StartCliConfig = {
   assetsFolderName?: string;
   functionsFolderName?: string;
   forkProcess: boolean;
+  pkgJson: PackageJson;
 };
 
 export type ConfigurableStartCliFlags = Pick<
@@ -160,18 +163,17 @@ export async function getConfigFromCli(
   cliInfo: CliInfo = { options: {} },
   externalCliOptions?: ExternalCliOptions
 ): Promise<StartCliConfig> {
-  const configFlags = readSpecializedConfig(
-    flags.cwd || process.cwd(),
-    flags.config,
-    'start',
-    {
-      username:
-        (externalCliOptions && externalCliOptions.accountSid) || undefined,
-    }
-  ) as StartCliFlags;
+  let cwd = flags.cwd ? path.resolve(flags.cwd) : process.cwd();
+  flags.cwd = cwd;
+  const configFlags = readSpecializedConfig(cwd, flags.config, 'start', {
+    username:
+      (externalCliOptions && externalCliOptions.accountSid) || undefined,
+  }) as StartCliFlags;
   const cli = mergeFlagsAndConfig<StartCliFlags>(configFlags, flags, cliInfo);
   const config = {} as StartCliConfig;
 
+  const pkgJson = await readPackageJsonContent(cli);
+
   config.inspect = getInspectInfo(cli);
   config.baseDir = getBaseDirectory(cli);
   config.env = await getEnvironment(cli, config.baseDir);
@@ -184,6 +186,7 @@ export async function getConfigFromCli(
   config.assetsFolderName = cli.assetsFolder;
   config.functionsFolderName = cli.functionsFolder;
   config.forkProcess = cli.forkProcess;
+  config.pkgJson = pkgJson;
 
   return config;
 }

packages/twilio-run/src/printers/start.ts

@@ -4,43 +4,44 @@ import boxen from 'boxen';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
 import wrapAnsi from 'wrap-ansi';
+import { ServerConfig } from '../../../runtime-handler/dist/dev-runtime/types';
 import { StartCliConfig } from '../config/start';
 import { getFunctionsAndAssets } from '../runtime/internal/runtime-paths';
 import { logger } from '../utils/logger';
 import { shouldPrettyPrint, terminalLink, windowSize } from './utils';
 
 function printAsset(
   asset: ServerlessResourceConfig,
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ): string {
   const prefix = config.legacyMode ? '/asset' : '';
   return chalk`{dim ${config.url}${prefix}}${asset.path}`;
 }
 
 function printFunction(
   fn: ServerlessResourceConfig,
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ): string {
   return chalk`{dim ${config.url}}${fn.path}`;
 }
 
 function printPlainRouteInfo(
   functions: ServerlessResourceConfig[],
   assets: ServerlessResourceConfig[],
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ): string {
   const functionHeading = 'Functions';
   let functionInfo;
   if (functions.length > 0) {
-    functionInfo = functions.map(fn => printFunction(fn, config)).join('\n');
+    functionInfo = functions.map((fn) => printFunction(fn, config)).join('\n');
   } else {
     functionInfo = 'No functions found';
   }
 
   const assetHeading = 'Assets';
   let assetInfo;
   if (assets.length > 0) {
-    assetInfo = assets.map(asset => printAsset(asset, config)).join('\n');
+    assetInfo = assets.map((asset) => printAsset(asset, config)).join('\n');
   } else {
     assetInfo = 'No assets found';
   }
@@ -67,7 +68,7 @@ function printPlainRouteInfo(
 
 function prettyPrintAsset(
   asset: ServerlessResourceConfig,
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ): string {
   const prefix = config.legacyMode ? '/asset' : '';
   const assetPath = prefix + asset.path;
@@ -83,7 +84,7 @@ function prettyPrintAsset(
 
 function prettyPrintFunction(
   fn: ServerlessResourceConfig,
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ) {
   const accessPrefix =
     fn.access === 'protected' ? chalk.cyan.bold('[protected] ') : '';
@@ -94,7 +95,7 @@ function prettyPrintFunction(
 function printPrettyRouteInfo(
   functions: ServerlessResourceConfig[],
   assets: ServerlessResourceConfig[],
-  config: StartCliConfig
+  config: StartCliConfig | ServerConfig
 ): string {
   const functionHeading = chalk`{green.bold Twilio functions available:}`;
   let functionInfo;
@@ -146,15 +147,34 @@ function printPrettyRouteInfo(
   return boxen(wrappedOutput, { padding: 1 });
 }
 
-export async function printRouteInfo(config: StartCliConfig): Promise<void> {
-  const searchConfig: SearchConfig = {
-    functionsFolderNames: config.functionsFolderName
-      ? [config.functionsFolderName]
-      : undefined,
-    assetsFolderNames: config.assetsFolderName
-      ? [config.assetsFolderName]
-      : undefined,
-  };
+// A magic function from https://fettblog.eu/typescript-hasownproperty/
+// This narrows down a type based on the property that an object has. It is used
+// below to distinguish between `StartCliConfig` and `ServerConfig` as the
+// `ServerConfig` does not have functionsFolderName or assetsFolderName
+// properties.
+function hasOwnProperty<X extends {}, Y extends PropertyKey>(
+  obj: X,
+  prop: Y
+): obj is X & Record<Y, unknown> {
+  return obj.hasOwnProperty(prop);
+}
+
+export async function printRouteInfo(
+  config: StartCliConfig | ServerConfig
+): Promise<void> {
+  const searchConfig: SearchConfig = {};
+  if (
+    hasOwnProperty(config, 'functionsFolderName') &&
+    typeof config.functionsFolderName === 'string'
+  ) {
+    searchConfig.functionsFolderNames = [config.functionsFolderName];
+  }
+  if (
+    hasOwnProperty(config, 'assetsFolderName') &&
+    typeof config.assetsFolderName === 'string'
+  ) {
+    searchConfig.assetsFolderNames = [config.assetsFolderName];
+  }
 
   const { functions, assets } = await getFunctionsAndAssets(
     config.baseDir,