fix: fileExists should not require write access by default (#407)

* chore(release): publish %s

 - [email protected]
 - @twilio-labs/[email protected]
 - @twilio-labs/[email protected]
 - @twilio/[email protected]
 - @twilio-labs/[email protected]
 - @twilio-labs/[email protected]
 - [email protected]

* fileExists should not require write access

Fixes #406

* chore: override @types/prettier to fix build

* chore(runtime-handler): update default twilio to 3.80.0

This removes the vulnerability alerts for @twilio/runtime-handler but
might cause some side-effects for the edge case where a customer has
specified this version of runtime-handler but has not specified a
version of twilio. In this case the local and deployed behavior
might vary depending on the APIs used by the customer in Functions.

* chore(twilio-run): update got version

* chore(serverless-api): update got & file-type

* fix(serverless-api): change file-type package usage

* fix(twilio-run): replace listr and fix got usage

* chore(serverless-api): upgrade typescript version

* test(serverless-api): temporarily turn off tests that use file-type

* chore(serverless-api): turn off typedoc for now

* chore: remove Node 12 from Actions flow

* chore(release): publish %s

 - [email protected]
 - @twilio-labs/[email protected]
 - @twilio-labs/[email protected]
 - @twilio/[email protected]
 - @twilio-labs/[email protected]
 - [email protected]

* fileExists should not require write access

Fixes #406

* fix: add option for write access check

Co-authored-by: Dominik Kundel <[email protected]>

Author: rectalogic

packages/serverless-api/src/utils/fs.ts

@@ -22,16 +22,22 @@ export const writeFile = promisify(fs.writeFile);
 export const readDir = promisify(recursiveReadDir);
 export const stat = promisify(fs.stat);
 
+const READ_ONLY = fs.constants.R_OK;
+const READ_WRITE = fs.constants.R_OK | fs.constants.W_OK;
+
 /**
  * Checks if a given file exists by checking if we have read & write access
  *
  * @export
  * @param {string} filePath full path of the file to check
  * @returns
  */
-export async function fileExists(filePath: string) {
+export async function fileExists(
+  filePath: string,
+  hasWriteAccess: boolean = false
+) {
   try {
-    await access(filePath, fs.constants.R_OK | fs.constants.W_OK);
+    await access(filePath, hasWriteAccess ? READ_WRITE : READ_ONLY);
     return true;
   } catch (err) {
     return false;
@@ -168,7 +174,7 @@ export async function getDirContent(
   );
 
   return unfilteredFiles.filter(
-    entry => typeof entry !== 'undefined'
+    (entry) => typeof entry !== 'undefined'
   ) as FileInfo[];
 }
 
@@ -283,7 +289,7 @@ async function getServerlessConfigs(
   ignoreExtension?: string
 ): Promise<ServerlessResourceConfigWithFilePath[]> {
   return Promise.all(
-    dirContent.map(async file => {
+    dirContent.map(async (file) => {
       const { path, access } = getPathAndAccessFromFileInfo(
         file,
         ignoreExtension

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

@@ -63,7 +63,7 @@ export async function writeDefaultConfigFile(
 ): Promise<boolean> {
   const fullConfigFilePath = path.resolve(baseDir, fileName);
 
-  const configFileExists = await fileExists(fullConfigFilePath);
+  const configFileExists = await fileExists(fullConfigFilePath, true);
 
   if (configFileExists && !overrideExisting) {
     return false;

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

@@ -25,7 +25,7 @@ async function writeEnvFile(
   newEnvironmentVariableKeys: string[];
 }> {
   const envFilePath = path.join(targetDir, '.env');
-  const envFileExists = await fileExists(envFilePath);
+  const envFileExists = await fileExists(envFilePath, true);
   if (!envFileExists) {
     await downloadFile(contentUrl, envFilePath);
     return { newEnvironmentVariableKeys: [] };

packages/twilio-run/src/utils/deployInfoCache.ts

@@ -38,7 +38,7 @@ export function getDeployInfoCache(
   deployInfoCacheFileName: string = '.twiliodeployinfo'
 ): DeployInfoCache {
   const fullPath = path.resolve(baseDir, deployInfoCacheFileName);
-  const deployCacheInfoExists = fileExistsSync(fullPath);
+  const deployCacheInfoExists = fileExistsSync(fullPath, true);
 
   if (deployCacheInfoExists) {
     debug('Found deploy info cache at "%s"', fullPath);

packages/twilio-run/src/utils/fs.ts

@@ -11,18 +11,27 @@ export const mkdir = promisify(fs.mkdir);
 const stat = promisify(fs.stat);
 const open = promisify(fs.open);
 
-export async function fileExists(filePath: string): Promise<boolean> {
+const READ_ONLY = fs.constants.R_OK;
+const READ_WRITE = fs.constants.R_OK | fs.constants.W_OK;
+
+export async function fileExists(
+  filePath: string,
+  hasWriteAccess: boolean = false
+): Promise<boolean> {
   try {
-    await access(filePath, fs.constants.R_OK | fs.constants.W_OK);
+    await access(filePath, hasWriteAccess ? READ_WRITE : READ_ONLY);
     return true;
   } catch (err) {
     return false;
   }
 }
 
-export function fileExistsSync(filePath: string): boolean {
+export function fileExistsSync(
+  filePath: string,
+  hasWriteAccess: boolean = false
+): boolean {
   try {
-    fs.accessSync(filePath, fs.constants.R_OK | fs.constants.W_OK);
+    fs.accessSync(filePath, hasWriteAccess ? READ_WRITE : READ_ONLY);
     return true;
   } catch (err) {
     return false;
@@ -36,15 +45,15 @@ export function downloadFile(
   return new Promise((resolve, reject) => {
     return mkdir(path.dirname(targetPath), { recursive: true })
       .then(() => open(targetPath, 'wx'))
-      .then(fd => {
+      .then((fd) => {
         const writeStream = fs.createWriteStream('', { fd });
         got
           .stream(contentUrl)
           .on('response', resolve)
           .on('error', reject)
           .pipe(writeStream);
       })
-      .catch(err => reject(err));
+      .catch((err) => reject(err));
   });
 }