@raisenow/tamaro-cli 1.0.8 → 1.0.11

package/src/commands/deploy.ts

@@ -0,0 +1,163 @@
+import {existsSync} from 'fs'
+import {
+  AWS_CLOUDFRONT_DISTRIBUTION_ID,
+  AWS_S3_BUCKET,
+  CORE_CONFIG_NAME,
+} from 'lib/constants'
+import {
+  assertProfileValid,
+  AwsOptions,
+  withAwsAuthenticate,
+  prepareFlags as prepareAwsFlags,
+} from 'lib/aws'
+import {getIfCoreFns, getPaths, getWidgetUuid} from 'lib/resolve'
+import {logCommand, logDataTable, logTitle} from 'lib/logging'
+import {notify} from 'lib/notifier'
+import {fail, runCommandSync} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DeployOptions = AwsOptions & {
+  tag: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const deploy = async (options: DeployOptions): Promise<void> => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+
+  assertOptionsValid(options)
+  assertDistPathExists(paths.appDist)
+
+  const flags = prepareFlags([], options).join(' ')
+  const {tag} = options
+  const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
+  const deployUrl = `s3://${AWS_S3_BUCKET}/${configName}/${tag}`
+  const entryFilename = ifCore('index.js', 'widget.js')
+
+  /////////////////////////////////////////////////////////////////////////////
+  // Sync all files except entrypoint (without deleting old files)
+  /////////////////////////////////////////////////////////////////////////////
+
+  const cmdSyncAll = `
+    aws s3 sync ${paths.appDist} ${deployUrl}
+      --acl public-read
+      --size-only
+      --exclude ${paths.appDist}/${entryFilename}
+      --cache-control max-age=31536000
+      ${flags}
+  `
+  logTitle('Deploying to AWS S3 …')
+  logCommand(cmdSyncAll)
+
+  try {
+    withAwsAuthenticate(
+      () => runCommandSync(cmdSyncAll, {stdout: 'inherit'}),
+      options,
+    )
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+  // Copy entrypoint
+  /////////////////////////////////////////////////////////////////////////////
+
+  const cmdCpEntry = `
+    aws s3 cp ${paths.appDist}/${entryFilename} ${deployUrl}/${entryFilename}
+      --acl public-read
+      --cache-control max-age=64800
+      ${flags}
+  `
+  logCommand(cmdCpEntry)
+
+  try {
+    withAwsAuthenticate(
+      () => runCommandSync(cmdCpEntry, {stdout: 'inherit'}),
+      options,
+    )
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+  // Invalidate cloudfront cache
+  /////////////////////////////////////////////////////////////////////////////
+
+  const cmdInvalidateCache = `
+    aws cloudfront create-invalidation
+      --distribution-id ${AWS_CLOUDFRONT_DISTRIBUTION_ID}
+      --paths /${configName}/${tag}/*
+      ${flags}
+  `
+  logTitle('\nInvalidating edge cache …')
+  logCommand(cmdInvalidateCache)
+
+  try {
+    // ignore output
+    withAwsAuthenticate(() => runCommandSync(cmdInvalidateCache), options)
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  const demoPage = `https://${AWS_S3_BUCKET}/${configName}/${tag}/index.html`
+  const entryPoint = `https://${AWS_S3_BUCKET}/${configName}/${tag}/${entryFilename}`
+
+  logTitle(`\nBundle for “${configName}” is deployed with tag “${tag}”.`)
+  logDataTable({
+    'Demo page:': demoPage,
+    'Entry point:': entryPoint,
+  })
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  process.on('exit', () => {
+    notify({
+      title: 'deploy',
+      message: `
+        Bundle for “${configName}” is deployed with tag “${tag}”.
+        Demo page: ${demoPage}
+        Entry point: ${entryPoint}
+      `,
+    })
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: DeployOptions) => {
+  const {tag, profile} = options
+
+  assertTagValid(tag)
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertDistPathExists = (distPath: string) => {
+  if (!existsSync(distPath)) {
+    fail(`
+      Dist folder does not exists.
+      Make sure you have built the bundle before trying to deploy it.
+    `)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertTagValid = (tag: string) => {
+  const regex = /^[a-zA-Z0-9-_.]+$/
+
+  if (!regex.test(tag)) {
+    fail(`Flag "--tag" has forbidden format. Allowed format: ${regex}.`)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (flags: string[], options: DeployOptions): string[] => {
+  return prepareAwsFlags(flags, options)
+}

package/src/commands/dev.ts

@@ -0,0 +1,68 @@
+import {getPortPromise} from 'portfinder'
+import {getIfCoreFns, resolveBin, resolveOwn} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {fail, runCommandSync} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DevOptions = {
+  localCore: boolean
+  port: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const dev = async (options: DevOptions): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = (await prepareFlags([], options)).join(' ')
+  const {ifCore} = getIfCoreFns()
+  const title = ifCore(
+    'Running dev web-server for Tamaro Core …',
+    'Running dev web-server for customer configuration …',
+  )
+  const wpBin = resolveBin('webpack')
+  const wpConfig = resolveOwn('dist/webpack.config.js')
+  const cmd = `
+    ${wpBin} serve
+      --config ${wpConfig}
+      ${flags}
+  `
+
+  logTitle(title)
+  logCommand(cmd)
+  runCommandSync(cmd, {stdio: 'inherit'})
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: DevOptions) => {
+  const {localCore, port} = options
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore() && localCore) {
+    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+  }
+
+  if (isNaN(Number(port))) {
+    fail('Flag "--port" should be a number.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = async (
+  flags: string[],
+  options: DevOptions,
+): Promise<string[]> => {
+  const {localCore, port: defaultPort} = options
+  const port = await getPortPromise({port: Number(defaultPort)})
+
+  if (localCore) {
+    flags.push('--env localCore')
+  }
+
+  flags.push(`--port ${port}`)
+
+  return flags
+}

package/src/commands/list-deployed.ts

@@ -0,0 +1,112 @@
+import {AWS_S3_BUCKET, CORE_CONFIG_NAME} from 'lib/constants'
+import {
+  assertProfileValid,
+  AwsOptions,
+  withAwsAuthenticate,
+  prepareFlags as prepareAwsFlags,
+} from 'lib/aws'
+import {getIfCoreFns, getWidgetUuid} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {fail, runCommandSync} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type ListDeployedOptions = AwsOptions & {
+  config?: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const listDeployed = async (
+  options: ListDeployedOptions,
+): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = prepareFlags([], options).join(' ')
+  const {config} = options
+  const {ifCore} = getIfCoreFns()
+  const configName = config ?? ifCore(CORE_CONFIG_NAME, getWidgetUuid())
+  const title =
+    !config && ifCore()
+      ? `Listing deployments of Tamaro Core …`
+      : `Listing deployments of “${configName}” customer configuration …`
+
+  const deployUrl = `s3://${AWS_S3_BUCKET}/${configName}/`
+  const cmd = `aws s3 ls ${deployUrl} ${flags}`
+  let out = ''
+
+  logTitle(title)
+  logCommand(cmd)
+
+  // If customer configuration folder does not exist on AWS S3,
+  // command fails with blank stderr, so we need to handle this case.
+  try {
+    const result = withAwsAuthenticate(() => runCommandSync(cmd), options)
+    out = result.stdout
+  } catch (error: any) {
+    out = error.stdout
+
+    if (error.stderr) {
+      fail(error.stderr)
+    }
+  }
+
+  const lines = out.split('\n')
+  const tags = parseTags(lines)
+  let text = ''
+
+  if (tags.length === 0) {
+    text = 'No deployments found.'
+  } else {
+    text = tags
+      .map((tag, idx) => {
+        // prettier-ignore
+        return `${idx + 1}. https://${AWS_S3_BUCKET}/${configName}/${tag}/index.html`
+      })
+      .join('\n')
+  }
+
+  console.log(`${text}\n`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: ListDeployedOptions) => {
+  const {config, profile} = options
+
+  assertConfigValid(config)
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertConfigValid = (config: string | undefined) => {
+  if (!config) {
+    return
+  }
+
+  const regex = /^[a-zA-Z0-9-_]+$/
+
+  if (!regex.test(config)) {
+    fail(`Flag "--config" has forbidden format. Allowed format: ${regex}.`)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (
+  flags: string[],
+  options: ListDeployedOptions,
+): string[] => {
+  return prepareAwsFlags(flags, options)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const parseTags = (lines: string[]): string[] => {
+  const regex = /^\s*PRE\s*/
+
+  return lines
+    .filter((line) => regex.test(line))
+    .map((line) => line.replace(regex, '').replace(/\/$/, ''))
+}

package/src/commands/serve.ts

@@ -0,0 +1,53 @@
+import {getPortPromise} from 'portfinder'
+import {getIfCoreFns, getPaths} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {fail, runCommandSync} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type ServeOptions = {
+  port: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const serve = async (options: ServeOptions): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = (await prepareFlags([], options)).join(' ')
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const cmd = `
+    npx -y serve ${paths.appDist}
+      --cors
+      ${flags}
+  `
+
+  logTitle(`Running web-server for pre-built bundle …`)
+  logCommand(cmd)
+  runCommandSync(cmd, {stdio: 'inherit'})
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: ServeOptions) => {
+  const {port} = options
+
+  if (isNaN(Number(port))) {
+    fail('Flag "--port" should be a number.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = async (
+  flags: string[],
+  options: ServeOptions,
+): Promise<string[]> => {
+  const {port: defaultPort} = options
+  const port = await getPortPromise({port: Number(defaultPort)})
+
+  flags.push(`-p ${port}`)
+
+  return flags
+}

package/src/lib/InterpolateHtmlPlugin.ts

@@ -1,14 +1,18 @@
-import HtmlWebpackPlugin from 'html-webpack-plugin'
 import {Compiler} from 'webpack'
+import HtmlWebpackPlugin from 'html-webpack-plugin'
 import escapeStringRegexp from 'escape-string-regexp'
 
 ///////////////////////////////////////////////////////////////////////////////
 
-type Replacements = {[key: string]: any}
+export type Replacements = {[key: string]: any}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const PLUGIN_NAME = 'InterpolateHtmlPlugin'
 
 ///////////////////////////////////////////////////////////////////////////////
 
-class InterpolateHtmlPlugin {
+export class InterpolateHtmlPlugin {
   replacements: Replacements
 
   constructor(replacements: Replacements) {
@@ -16,16 +20,16 @@ class InterpolateHtmlPlugin {
   }
 
   apply(compiler: Compiler): void {
-    compiler.hooks.compilation.tap('InterpolateHtmlPlugin', (compilation) => {
+    compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
       const hooks = HtmlWebpackPlugin.getHooks(compilation)
 
-      hooks.alterAssetTagGroups.tap('InterpolateHtmlPlugin', (assets) => {
+      hooks.alterAssetTagGroups.tap(PLUGIN_NAME, (assets) => {
         this.replacements['ENTRY'] = assets.headTags[0].attributes['src']
 
         return assets
       })
 
-      hooks.afterTemplateExecution.tap('InterpolateHtmlPlugin', (data) => {
+      hooks.afterTemplateExecution.tap(PLUGIN_NAME, (data) => {
         // Run HTML through a series of user-specified string replacements.
         Object.entries(this.replacements).forEach(([key, value]) => {
           data.html = data.html.replace(
@@ -39,5 +43,3 @@ class InterpolateHtmlPlugin {
     })
   }
 }
-
-export default InterpolateHtmlPlugin

package/src/lib/aws.ts

@@ -0,0 +1,127 @@
+import {execaCommandSync} from 'execa'
+import stripIndent from 'strip-indent'
+import {fail} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type AwsOptions = {
+  profile: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const withAwsAuthenticate = <Result = any>(
+  fn: () => Result,
+  options: AwsOptions,
+): Result => {
+  awsAuthenticate(options)
+
+  return fn()
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const awsAuthenticate = (options: AwsOptions) => {
+  if (isSetEnv()) {
+    // Don't try to authenticate the user.
+    // This may be useful if CLI is running within an automated system like pipeline,
+    // where "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" are used instead of "AWS_PROFILE".
+    return
+  }
+
+  try {
+    checkIdentity(options)
+  } catch (error) {
+    login(options)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+// Returns true if "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables are set.
+export const isSetEnv = () => {
+  return !!(process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const assertProfileValid = (profile: string) => {
+  if (isSetEnv()) {
+    return
+  }
+
+  const profiles = getAvailableProfiles()
+
+  if (!profiles.includes(profile)) {
+    console.log(`Using AWS profile: “${profile}”`)
+
+    let message
+
+    if (profiles.length === 0) {
+      message = stripIndent(`
+        No AWS profiles found.
+      `)
+    } else {
+      message = stripIndent(`
+        AWS profile “${profile}” has not been found.
+        Available profiles are: ${profiles.map((v) => `“${v}”`).join(', ')}.
+      `)
+    }
+
+    message += stripIndent(`
+      Run “aws configure sso” to set up SSO-enabled profile.
+      Check the wiki for more information:
+      https://raisenow.atlassian.net/wiki/x/lIrWvg
+    `)
+
+    fail(message)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const getAvailableProfiles = (): string[] => {
+  const {stdout} = execaCommandSync('aws configure list-profiles')
+
+  return stdout.split('\n')
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+// Returns caller identity data (output is ignored here).
+// Fails in case of expired SSO session.
+const checkIdentity = (options: AwsOptions) => {
+  const flags = prepareFlags([], options).join(' ')
+
+  execaCommandSync(`aws sts get-caller-identity ${flags}`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+// Opens SSO authentication page in the browser.
+// Fails if user canceled authentication process.
+const login = (options: AwsOptions) => {
+  const flags = prepareFlags([], options).join(' ')
+
+  try {
+    execaCommandSync(`aws sso login ${flags}`, {stdio: 'inherit'})
+    console.log('')
+  } catch (error) {
+    fail('Login failed.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const prepareFlags = (
+  flags: string[],
+  options: AwsOptions,
+): string[] => {
+  const {profile} = options
+
+  if (!isSetEnv()) {
+    flags.push(`--profile ${profile}`)
+  }
+
+  return flags
+}

package/src/lib/command.ts

@@ -0,0 +1,27 @@
+import {execaCommandSync, ExecaSyncReturnValue, SyncOptions} from 'execa'
+import {logError} from 'lib/logging'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const fail = (message?: string) => {
+  logError(message)
+  process.exit(1)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const prepareCommand = (cmd: string): string => {
+  return cmd
+    .replace(/\n/gm, ' ')
+    .replace(/[ \t]{2,}/gm, ' ')
+    .trim()
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const runCommandSync = (
+  cmd: string,
+  options?: SyncOptions,
+): ExecaSyncReturnValue => {
+  return execaCommandSync(prepareCommand(cmd), options)
+}

package/src/lib/constants.ts

@@ -0,0 +1,7 @@
+export const DEFAULT_TAG = 'latest'
+export const DEFAULT_PORT = 1234
+export const DEFAULT_AWS_PROFILE = 'payments-prod-cs-deployer'
+export const DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET = 'rnw-email-service'
+export const AWS_S3_BUCKET = 'tamaro.raisenow.com'
+export const CORE_CONFIG_NAME = 'tamaro-core'
+export const AWS_CLOUDFRONT_DISTRIBUTION_ID = 'EHJ1OM458YQ0I'