@raisenow/tamaro-cli 1.0.5 → 1.0.9

package/src/commands/deploy.ts

@@ -0,0 +1,151 @@
+import {existsSync} from 'fs'
+import stripIndent from 'strip-indent'
+import {
+  fail,
+  getIfCoreFns,
+  getPaths,
+  getWidgetUuid,
+  logCommand,
+  logDataTable,
+  logTitle,
+  notify,
+} from 'lib/helpers'
+import {assertProfileValid, AwsOptions, runAwsCommandSync} from 'lib/aws'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DeployOptions = AwsOptions & {
+  tag: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const AWS_S3_BUCKET = 'tamaro.raisenow.com'
+export const CORE_CONFIG_NAME = 'tamaro-core'
+const AWS_CLOUDFRONT_DISTRIBUTION_ID = 'EHJ1OM458YQ0I'
+export const DEFAULT_TAG = 'latest'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const deploy = async (options: DeployOptions): Promise<void> => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+
+  assertOptionsValid(options)
+  assertDistPathExists(paths.appDist)
+
+  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
+  `
+  logTitle('Deploying to AWS S3 …')
+  logCommand(cmdSyncAll)
+
+  try {
+    runAwsCommandSync(cmdSyncAll, {stdout: 'inherit'})
+  } 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
+  `
+  logCommand(cmdCpEntry)
+
+  try {
+    runAwsCommandSync(cmdCpEntry, {stdout: 'inherit'})
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+  // Invalidate cloudfront cache
+  /////////////////////////////////////////////////////////////////////////////
+
+  const cmdInvalidateCache = `
+    aws cloudfront create-invalidation
+      --distribution-id ${AWS_CLOUDFRONT_DISTRIBUTION_ID}
+      --paths /${configName}/${tag}/*
+  `
+  logTitle('Invalidating edge cache …')
+  logCommand(cmdInvalidateCache)
+
+  try {
+    // ignore output
+    runAwsCommandSync(cmdInvalidateCache)
+  } 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}`
+
+  logDataTable(
+    {
+      'Demo page:': demoPage,
+      'Entry point:': entryPoint,
+    },
+    `Bundle for “${configName}” is deployed with tag “${tag}”`,
+  )
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  notify({
+    title: 'deploy',
+    message: stripIndent(`
+      Bundle for “${configName}” is deployed with tag “${tag}”.
+      Demo page: ${demoPage}
+    `),
+    target: demoPage,
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+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}.`)
+  }
+}

package/src/commands/dev.ts

@@ -0,0 +1,61 @@
+import resolveBin from 'resolve-bin'
+import {
+  fail,
+  getIfCoreFns,
+  logCommand,
+  logTitle,
+  resolveOwn,
+  runCommandSync,
+} from 'lib/helpers'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DevOptions = {
+  localCore: boolean
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const dev = async (options: DevOptions): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = prepareFlags(options)
+  const {ifCore} = getIfCoreFns()
+  const title = ifCore(
+    'Running dev web-server for Tamaro Core …',
+    'Running dev web-server for customer configuration …',
+  )
+  const wpBin = resolveBin.sync('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} = options
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore() && localCore) {
+    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (options: DevOptions): string => {
+  const {localCore} = options
+  let flags: string[] = []
+
+  flags = localCore ? [...flags, '--env localCore'] : flags
+
+  return flags.join(' ')
+}

package/src/commands/list-deployed.ts

@@ -0,0 +1,102 @@
+import {
+  fail,
+  getIfCoreFns,
+  getWidgetUuid,
+  logCommand,
+  logTable,
+  logTitle,
+} from 'lib/helpers'
+import {assertProfileValid, AwsOptions, runAwsCommandSync} from 'lib/aws'
+import {AWS_S3_BUCKET, CORE_CONFIG_NAME} from 'commands/deploy'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type ListDeployedOptions = AwsOptions & {
+  config?: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const listDeployed = async (
+  options: ListDeployedOptions,
+): Promise<void> => {
+  assertOptionsValid(options)
+
+  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}`
+  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 = runAwsCommandSync(cmd)
+    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')
+  }
+
+  logTable(text)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+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 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,29 @@
+import {getPortPromise} from 'portfinder'
+import {
+  getIfCoreFns,
+  getPaths,
+  logCommand,
+  logTitle,
+  runCommandSync,
+} from 'lib/helpers'
+
+///////////////////////////////////////////////////////////////////////////////
+
+const DEFAULT_PORT = 1234
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const serve = async (): Promise<void> => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const port = await getPortPromise({port: DEFAULT_PORT})
+  const cmd = `
+    npx -y http-server ${paths.appDist}
+      --cors
+      --port ${port}
+  `
+
+  logTitle(`Running web-server for pre-built bundle …`)
+  logCommand(cmd)
+  runCommandSync(cmd, {stdio: 'inherit'})
+}

package/src/lib/aws.ts

@@ -0,0 +1,119 @@
+import {commandSync, ExecaSyncReturnValue, SyncOptions} from 'execa'
+import stripIndent from 'strip-indent'
+import {fail, prepareCommand} from './helpers'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type AwsOptions = {
+  profile: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const DEFAULT_AWS_PROFILE = 'payments-prod-cs-deployer'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const runAwsCommandSync = (
+  command: string,
+  options?: SyncOptions,
+): ExecaSyncReturnValue => {
+  authenticate()
+
+  return commandSync(prepareCommand(command), options)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const authenticate = () => {
+  // If "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables are set,
+  // then don't try to authenticate the user.
+  // This may be useful for using this CLI in automated systems like pipelines.
+  if (isSetEnv()) {
+    return
+  }
+
+  try {
+    checkIdentity()
+  } catch (error) {
+    login()
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const isSetEnv = () => {
+  return !!(process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const assertProfileValid = (profile: string) => {
+  // If "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables are set,
+  // then ignore "--profile" flag.
+  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)
+  }
+
+  // Set it here, so we don't need to explicitly pass "--profile" flag
+  // to all subsequent "aws" commands.
+  // If "AWS_PROFILE" were set before, it will be overriden by "--profile" flag,
+  // which has default value, so may be omitted.
+  process.env.AWS_PROFILE = profile
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const getAvailableProfiles = (): string[] => {
+  const {stdout} = commandSync('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 = () => {
+  commandSync('aws sts get-caller-identity')
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+// Opens sso authentication page in the browser.
+// Fails if user canceled authentication process.
+const login = () => {
+  try {
+    commandSync('aws sso login', {stdio: 'inherit'})
+    console.log('')
+  } catch (error) {
+    fail('Login failed')
+  }
+}