chore: refactor reading data from file or stdin (twilio#158)

shrutiburman · Mar 18, 2020 · 66a8ac6 · 66a8ac6
1 parent 151e3cc
commit 66a8ac6
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 112 deletions.
diff --git a/src/commands/email/send.js b/src/commands/email/send.js
@@ -2,9 +2,8 @@ const { flags } = require('@oclif/command');
 const { BaseCommand } = require('@twilio/cli-core').baseCommands;
 const { TwilioCliError } = require('@twilio/cli-core').services.error;
 const emailUtilities = require('../../services/email-utility');
+const { readFileOrStdIn, readFile } = require('../../services/file-io');
 const sgMail = require('@sendgrid/mail');
-const fs = require('fs');
-const path = require('path');
 
 class Send extends BaseCommand {
   async run() {
@@ -17,19 +16,12 @@ class Send extends BaseCommand {
       );
     }
 
-    this.isTTY = process.stdin.isTTY || this.flags['force-tty'];
-
-    const pipedInput = await this.readStream();
-    if (pipedInput) {
-      this.processData(pipedInput);
-    }
-
     await this.promptForFromEmail();
     await this.promptForToEmail();
     await this.promptForSubject();
     await this.promptForText();
 
-    if (!this.isTTY && (!this.flags.to || !this.flags.text || !this.subjectLine || !this.fromEmail)) {
+    if (!process.stdin.isTTY && (!this.flags.to || !this.flags.text || !this.subjectLine || !this.fromEmail)) {
       throw new TwilioCliError('No terminal input available. Please provide --to, --from, --subject, and --text');
     }
 
@@ -44,58 +36,31 @@ class Send extends BaseCommand {
       html: '<p>' + this.emailText + '</p>'
     };
 
-    if (this.pipedInfo) {
-      const attachment = this.createAttachmentArray(this.pipedInfo);
-      sendInformation.attachments = attachment;
+    const fileInfo = await readFileOrStdIn(this.flags.attachment);
+
+    if (fileInfo) {
+      sendInformation.attachments = this.createAttachmentArray(fileInfo);
     } else {
       const attachmentVerdict = await this.askAttachment();
-      await this.promptAttachment(attachmentVerdict);
-      if (this.attachment) {
-        const fileContent = this.readFile(this.attachment);
-        const attachment = this.createAttachmentArray(fileContent);
-        sendInformation.attachments = attachment;
+      const attachment = await this.promptAttachment(attachmentVerdict);
+
+      if (attachment) {
+        sendInformation.attachments = this.createAttachmentArray(readFile(attachment));
       }
     }
     await this.sendEmail(sendInformation);
   }
 
-  async readStream() {
-    const input = await this.getStdin();
-    return Buffer.from(input).toString('base64');
-  }
-
-  getStdin() {
-    return new Promise(resolve => {
-      if (this.isTTY) {
-        resolve('');
-      } else {
-        process.stdin.setEncoding('utf8');
-        process.stdin.once('data', data => {
-          resolve(data);
-        });
-      }
-    });
-  }
-
-  processData(input) {
-    this.fileName = 'piped.txt'; // placeholder filename for attachement
-    this.pipedInfo = input;
-  }
-
   async askAttachment() {
-    this.attachment = this.flags.attachment;
-    if (!this.attachment) {
-      const verdict = await this.inquirer.prompt([
-        {
-          type: 'confirm',
-          name: 'sendAttachment',
-          message: 'Would you like to send an attachment?',
-          default: false
-        }
-      ]);
-      return verdict.sendAttachment;
-    }
-    return false;
+    const verdict = await this.inquirer.prompt([
+      {
+        type: 'confirm',
+        name: 'sendAttachment',
+        message: 'Would you like to send an attachment?',
+        default: false
+      }
+    ]);
+    return verdict.sendAttachment;
   }
 
   async promptAttachment(verdict) {
@@ -106,36 +71,25 @@ class Send extends BaseCommand {
           message: this.getPromptMessage(Send.flags.attachment.description)
         }
       ]);
-      this.attachment = file.path;
+      return file.path;
     }
   }
 
-  readFile(filePath) {
-    this.fileName = path.basename(filePath);
-    try {
-      const coded = fs.readFileSync(filePath, 'base64');
-      return coded;
-    } catch (error) {
-      this.logger.debug(error);
-      throw new TwilioCliError('Unable to read the file: ' + filePath);
-    }
-  }
-
-  createAttachmentArray(fileContent) {
+  createAttachmentArray(fileInfo) {
     return [
       {
-        content: fileContent,
+        content: fileInfo.content,
+        filename: fileInfo.filename,
         type: 'plain/text',
         disposition: 'attachment',
-        filename: this.fileName,
         contentId: 'attachmentText'
       }
     ];
   }
 
   validateEmail(email) {
     let emailList = [];
-    let validEmail;
+    let validEmail = true;
     const multipleEmail = email.includes(',');
     if (multipleEmail === true) {
       emailList = email.split(',').map(item => {
@@ -166,7 +120,7 @@ class Send extends BaseCommand {
       this[key] = this.flags[flagKey];
     }
 
-    if (this.isTTY && !this[key]) {
+    if (process.stdin.isTTY && !this[key]) {
       const answer = await this.inquirer.prompt([
         {
           name: flagKey,
@@ -196,23 +150,18 @@ class Send extends BaseCommand {
   async sendEmail(sendInformation) {
     sgMail.setApiKey(process.env.SENDGRID_API_KEY);
     await sgMail.send(sendInformation);
-    this.logger.info(
-      'Your email containing the message "' +
-      this.emailText +
-      '" sent from ' +
-      this.fromEmail +
-      ' to ' +
-      this.toEmail +
-      ' with the subject line ' +
-      this.subjectLine +
-      ' has been sent!'
-    );
-    if (this.attachment) {
-      this.logger.info('Your attachment from ' + this.attachment + ' path called ' + this.fileName + ' has been sent.');
-    }
-    if (this.pipedInfo) {
-      this.logger.info('Your piped data attachment has been sent.');
+
+    const messageParts = [
+      `Your email containing the message "${sendInformation.text}"`,
+      `sent from "${sendInformation.from}" to "${sendInformation.to}"`,
+      `with the subject line "${sendInformation.subject}"`
+    ];
+    if (sendInformation.attachments) {
+      messageParts.push(`with attachment "${sendInformation.attachments[0].filename}"`);
     }
+    messageParts.push('has been sent!');
+
+    this.logger.info(messageParts.join(' '));
   }
 }
 
@@ -233,10 +182,6 @@ Send.flags = Object.assign(
     }),
     attachment: flags.string({
       description: 'Path for the file that you want to attach.'
-    }),
-    'force-tty': flags.boolean({
-      default: false,
-      hidden: true
     })
   },
   BaseCommand.flags

diff --git a/src/services/file-io.js b/src/services/file-io.js
@@ -0,0 +1,51 @@
+const { TwilioCliError } = require('@twilio/cli-core').services.error;
+const { logger } = require('@twilio/cli-core').services.logging;
+const fs = require('fs');
+const path = require('path');
+
+async function readFileOrStdIn(filePath) {
+  if (filePath) {
+    return readFile(filePath);
+  }
+
+  const pipedInput = await readStream();
+  if (pipedInput) {
+    return {
+      filename: 'piped.txt', // placeholder filename for attachment
+      content: pipedInput
+    };
+  }
+}
+
+function readFile(filePath) {
+  try {
+    return {
+      filename: path.basename(filePath),
+      content: fs.readFileSync(filePath, 'base64')
+    };
+  } catch (error) {
+    logger.debug(error);
+    throw new TwilioCliError('Unable to read the file: ' + filePath);
+  }
+}
+
+async function readStream() {
+  const input = await getStdin();
+  return Buffer.from(input).toString('base64');
+}
+
+function getStdin() {
+  return new Promise(resolve => {
+    if (process.stdin.isTTY) {
+      resolve('');
+    } else {
+      process.stdin.setEncoding('utf8');
+      process.stdin.once('data', data => resolve(data));
+    }
+  });
+}
+
+module.exports = {
+  readFileOrStdIn,
+  readFile
+};
diff --git a/test/.mocharc.yml b/test/.mocharc.yml
@@ -1,4 +1,4 @@
 require: test/helpers/init.js
 recursive: true
 reporter: spec
-timeout: 10000
+timeout: false