fix(twilio-run): support exact dependency ranges in templates (#370)

npm install does not preserve the passed dependency ranges resulting in templates that have exact
dependency versions specified but get added with a semver range to the package.json. This change
installs exact dependencies separately with the --save-exact flag.

fix #365

Author: dkundel

packages/twilio-run/__tests__/templating/filesystem.test.ts

@@ -376,6 +376,129 @@ test('installation with a dependency file', async () => {
   );
 });
 
+test('installation with a dependency file with exact dependencies', async () => {
+  // The typing of `got` is not exactly correct for this - it expects a
+  // buffer but depending on inputs `got` can actually return an object.
+  // @ts-ignore
+  mocked(got).mockImplementation(() =>
+    // @ts-ignore
+    Promise.resolve({
+      body: { dependencies: { foo: '1.0.0', got: '6.9.0' } },
+    })
+  );
+
+  // For this test, getFirstMatchingDirectory never errors.
+  mocked(
+    fsHelpers.getFirstMatchingDirectory
+  ).mockImplementation((basePath: string, directories: Array<string>): string =>
+    path.join(basePath, directories[0])
+  );
+
+  await writeFiles(
+    [
+      {
+        name: 'package.json',
+        type: 'package.json',
+        content: 'https://example.com/package.json',
+        directory: '',
+      },
+      {
+        name: '.env',
+        type: '.env',
+        content: 'https://example.com/.env',
+        directory: '',
+      },
+    ],
+    './testing/',
+    'example',
+    'hello'
+  );
+
+  expect(downloadFile).toHaveBeenCalledTimes(1);
+  expect(downloadFile).toHaveBeenCalledWith(
+    'https://example.com/.env',
+    join('testing', '.env')
+  );
+
+  expect(got).toHaveBeenCalledTimes(1);
+  expect(got).toHaveBeenCalledWith('https://example.com/package.json', {
+    json: true,
+  });
+
+  expect(install).toHaveBeenCalledTimes(1);
+  expect(install).toHaveBeenCalledWith(
+    { foo: '1.0.0', got: '6.9.0' },
+    { cwd: './testing/', exact: true }
+  );
+});
+
+test('installation with a dependency file with mixed dependencies', async () => {
+  // The typing of `got` is not exactly correct for this - it expects a
+  // buffer but depending on inputs `got` can actually return an object.
+  // @ts-ignore
+  mocked(got).mockImplementation(() =>
+    // @ts-ignore
+    Promise.resolve({
+      body: {
+        dependencies: {
+          foo: '^1.0.0',
+          got: '6.9.0',
+          twilio: '^3',
+          '@twilio/runtime-handler': '1.2.0-rc.3',
+        },
+      },
+    })
+  );
+
+  // For this test, getFirstMatchingDirectory never errors.
+  mocked(
+    fsHelpers.getFirstMatchingDirectory
+  ).mockImplementation((basePath: string, directories: Array<string>): string =>
+    path.join(basePath, directories[0])
+  );
+
+  await writeFiles(
+    [
+      {
+        name: 'package.json',
+        type: 'package.json',
+        content: 'https://example.com/package.json',
+        directory: '',
+      },
+      {
+        name: '.env',
+        type: '.env',
+        content: 'https://example.com/.env',
+        directory: '',
+      },
+    ],
+    './testing/',
+    'example',
+    'hello'
+  );
+
+  expect(downloadFile).toHaveBeenCalledTimes(1);
+  expect(downloadFile).toHaveBeenCalledWith(
+    'https://example.com/.env',
+    join('testing', '.env')
+  );
+
+  expect(got).toHaveBeenCalledTimes(1);
+  expect(got).toHaveBeenCalledWith('https://example.com/package.json', {
+    json: true,
+  });
+
+  expect(install).toHaveBeenCalledTimes(2);
+  expect(install).toHaveBeenCalledWith(
+    { foo: '^1.0.0', twilio: '^3' },
+    { cwd: './testing/' }
+  );
+  expect(install).toHaveBeenCalledWith(
+    { got: '6.9.0', '@twilio/runtime-handler': '1.2.0-rc.3' },
+    { cwd: './testing/', exact: true }
+  );
+});
+
 test('installation with an existing dot-env file', async () => {
   mocked(fileExists).mockReturnValue(Promise.resolve(true));
   mocked(readFile).mockReturnValue(Promise.resolve('# Comment\nFOO=BAR\n'));
@@ -431,7 +554,7 @@ test('installation with overlapping function files throws errors before writing'
     path.join(basePath, directories[0])
   );
 
-  mocked(fileExists).mockImplementation(p =>
+  mocked(fileExists).mockImplementation((p) =>
     Promise.resolve(p == join('functions', 'example', 'hello.js'))
   );
 
@@ -470,7 +593,7 @@ test('installation with overlapping asset files throws errors before writing', a
     path.join(basePath, directories[0])
   );
 
-  mocked(fileExists).mockImplementation(p =>
+  mocked(fileExists).mockImplementation((p) =>
     Promise.resolve(p == join('assets', 'example', 'hello.wav'))
   );
 

packages/twilio-run/src/templating/filesystem.ts

@@ -5,6 +5,8 @@ import got from 'got';
 import Listr, { ListrTask } from 'listr';
 import path from 'path';
 import { install, InstallResult } from 'pkg-install';
+import semver from 'semver';
+import { PackageJson } from 'type-fest';
 import {
   downloadFile,
   fileExists,
@@ -35,12 +37,12 @@ async function writeEnvFile(
   const newFlags = dotenv.parse(newContent);
 
   const functionKeys = Object.keys(newFlags);
-  const existingKeys = functionKeys.filter(key =>
+  const existingKeys = functionKeys.filter((key) =>
     currentFlags.hasOwnProperty(key)
   );
   const updatedContent = newContent
     .split('\n')
-    .map(line => {
+    .map((line) => {
       const name = line.substr(0, line.indexOf('='));
       if (existingKeys.includes(name)) {
         return '# ' + line;
@@ -65,7 +67,24 @@ async function installDependencies(
   targetDir: string
 ): Promise<InstallResult | undefined> {
   const pkgContent = await got(contentUrl, { json: true });
-  const dependencies = pkgContent.body.dependencies;
+
+  const dependencies: PackageJson.Dependency = {};
+  const exactDependencies: PackageJson.Dependency = {};
+  Object.entries<string>(pkgContent.body.dependencies).forEach(
+    ([name, version]) => {
+      if (Boolean(semver.parse(version))) {
+        exactDependencies[name] = version;
+      } else {
+        dependencies[name] = version;
+      }
+    }
+  );
+  if (exactDependencies && Object.keys(exactDependencies).length > 0) {
+    await install(exactDependencies, {
+      cwd: targetDir,
+      exact: true,
+    });
+  }
   if (dependencies && Object.keys(dependencies).length > 0) {
     return install(dependencies, {
       cwd: targetDir,
@@ -135,7 +154,7 @@ export async function writeFiles(
   }
 
   const tasks = files
-    .map(file => {
+    .map((file) => {
       if (file.type === 'functions') {
         return {
           title: `Creating function: ${path.join(file.directory, file.name)}`,