feat: add link to Twilio Console logs to deploy/activate

package.json

@@ -69,6 +69,7 @@
     "normalize.css": "^8.0.1",
     "ora": "^3.3.1",
     "pkg-install": "^1.0.0",
+    "terminal-link": "^1.3.0",
     "title": "^3.4.1",
     "twilio": "^3.33.0",
     "type-fest": "^0.6.0",

src/commands/activate.ts

@@ -6,14 +6,13 @@ import { Ora } from 'ora';
 import { Argv } from 'yargs';
 import { checkConfigForCredentials } from '../checks/check-credentials';
 import { ActivateCliFlags, getConfigFromFlags } from '../config/activate';
-import { printActivateConfig } from '../printers/activate';
+import { printActivateConfig, printActivateResult } from '../printers/activate';
 import {
   getDebugFunction,
   getOraSpinner,
   logger,
   setLogLevelByName,
 } from '../utils/logger';
-import { writeOutput } from '../utils/output';
 import { ExternalCliOptions, sharedCliOptions } from './shared';
 import { CliInfo } from './types';
 
@@ -68,7 +67,7 @@ export async function handler(
     spinner.succeed(
       `Activated new build ${details} on ${config.targetEnvironment}`
     );
-    writeOutput(result.domain);
+    printActivateResult(result);
   } catch (err) {
     handleError(err, spinner);
   }

src/printers/activate.ts

@@ -1,8 +1,10 @@
-import { ActivateConfig } from '@twilio-labs/serverless-api';
+import { ActivateConfig, ActivateResult } from '@twilio-labs/serverless-api';
 import { stripIndent } from 'common-tags';
 import { logger } from '../utils/logger';
-import { redactPartOfString } from './utils';
+import { writeOutput } from '../utils/output';
+import { getTwilioConsoleDeploymentUrl, redactPartOfString } from './utils';
 import chalk = require('chalk');
+import terminalLink = require('terminal-link');
 
 export function printActivateConfig(config: ActivateConfig) {
   const message = chalk`
@@ -11,3 +13,24 @@ export function printActivateConfig(config: ActivateConfig) {
   `;
   logger.info(stripIndent(message) + '\n');
 }
+
+export function printActivateResult(result: ActivateResult) {
+  logger.info(chalk.cyan.bold('\nActive build available at:'));
+  writeOutput(result.domain);
+
+  const twilioConsoleLogsLink = terminalLink(
+    'Open the Twilio Console',
+    getTwilioConsoleDeploymentUrl(result.serviceSid, result.environmentSid),
+    {
+      fallback: (text: string, url: string) => chalk.dim(url),
+    }
+  );
+
+  logger.info(
+    '\n' +
+      stripIndent(chalk`
+    {cyan.bold View Live Logs:}
+      ${twilioConsoleLogsLink}
+  `)
+  );
+}

src/printers/deploy.ts

@@ -7,10 +7,12 @@ import {
 import chalk from 'chalk';
 import columnify from 'columnify';
 import { stripIndent } from 'common-tags';
+import terminalLink from 'terminal-link';
 import { MergeExclusive } from 'type-fest';
 import { logger } from '../utils/logger';
 import { writeOutput } from '../utils/output';
 import {
+  getTwilioConsoleDeploymentUrl,
   printObjectWithoutHeaders,
   redactPartOfString,
   shouldPrettyPrint,
@@ -58,6 +60,10 @@ function plainPrintDeployedResources(
     environmentSuffix: config.functionsEnv,
     environmentSid: result.environmentSid,
     buildSid: result.buildSid,
+    viewLiveLogs: getTwilioConsoleDeploymentUrl(
+      result.serviceSid,
+      result.environmentSid
+    ),
   };
 
   const output = `
@@ -110,6 +116,14 @@ function prettyPrintDeployedResources(
   config: DeployLocalProjectConfig,
   result: DeployResult
 ) {
+  const twilioConsoleLogsLink = terminalLink(
+    'Open the Twilio Console',
+    getTwilioConsoleDeploymentUrl(result.serviceSid, result.environmentSid),
+    {
+      fallback: (text: string, url: string) => chalk.dim(url),
+    }
+  );
+
   writeOutput(
     chalk`
 {bold.cyan.underline Deployment Details}
@@ -120,6 +134,8 @@ function prettyPrintDeployedResources(
    ${config.functionsEnv} {dim (${result.environmentSid})} 
 {bold.cyan Build SID:}
    ${result.buildSid}
+{bold.cyan View Live Logs:}
+   ${twilioConsoleLogsLink}
   `.trim()
   );
 

src/printers/utils.ts

@@ -8,6 +8,13 @@ export const shouldPrettyPrint = process.stdout.isTTY && !isCi;
 export const supportsEmoji =
   process.platform !== 'win32' || isCi || process.env.TERM === 'xterm-256color';
 
+export function getTwilioConsoleDeploymentUrl(
+  serviceSid: string,
+  environmentSid: string
+) {
+  return `https://www.twilio.com/console/assets/api/${serviceSid}/environment/${environmentSid}`;
+}
+
 export function printObjectWithoutHeaders(obj: {}): string {
   return columnify(obj, { showHeaders: false });
 }