@raisenow/tamaro-cli 1.0.8 → 1.0.9

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')
+  }
+}

package/src/lib/helpers.ts

@@ -1,13 +1,15 @@
-import {basename, resolve} from 'path'
+import {basename, relative, resolve} from 'path'
 import {existsSync, realpathSync} from 'fs'
 import chalk from 'chalk'
-import {notify as nodeNotify} from 'node-notifier'
+import notifier from 'node-notifier'
 import {getIfUtils, IfUtils, IfUtilsFn} from 'webpack-config-utils'
 import columnify from 'columnify'
 import boxen from 'boxen'
 import {expand as dotenvExpand} from 'dotenv-expand'
 import {config as dotenvConfig} from 'dotenv'
+import open from 'open'
 import stripIndent from 'strip-indent'
+import {commandSync, ExecaSyncReturnValue, SyncOptions} from 'execa'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -21,11 +23,8 @@ export type EnvVars = {
 // Supported packages
 ///////////////////////////////////////////////////////////////////////////////
 
-const TAMARO_CORE_PACKAGE_NAMES = ['@raisenow/tamaro-core', 'demo-tamaro-core']
-const TAMARO_CONFIGURATIONS_PACKAGE_NAMES = [
-  '@raisenow/tamaro-configurations',
-  'demo-tamaro-configurations',
-]
+const TAMARO_CORE_PACKAGE_NAMES = ['@raisenow/tamaro-core']
+const TAMARO_CONFIGURATIONS_PACKAGE_NAMES = ['@raisenow/tamaro-configurations']
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -51,9 +50,8 @@ export const getIfCoreFns = (): IfUtils => {
     }
   }
 
-  console.error(
-    chalk.red(
-      stripIndent(`\
+  logError(
+    stripIndent(`\
       You must run "npx @raisenow/tamaro-cli" commands from:
       1. Root of "${chalk.bold(TAMARO_CORE_PACKAGE_NAMES[0])}" package folder.
       2. Root of particular customer configuration folder of "${chalk.bold(
@@ -61,9 +59,8 @@ export const getIfCoreFns = (): IfUtils => {
       )}" package.
       You are currently in "${chalk.bold(realpathSync(process.cwd()))}".
     `),
-    ),
   )
-  process.exit(0)
+  process.exit(1)
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -131,6 +128,24 @@ export const getPaths = (ifCore: IfUtilsFn) => {
   )
 }
 
+///////////////////////////////////////////////////////////////////////////////
+
+type Paths = {
+  [key: string]: string | undefined
+}
+
+export const getRelativePaths = (paths: Paths): Paths => {
+  const relativePaths: Paths = {}
+
+  for (const [type, absPath] of Object.entries(paths)) {
+    if (absPath) {
+      relativePaths[type] = relative('./', absPath) || '.'
+    }
+  }
+
+  return relativePaths
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // Env vars
 ///////////////////////////////////////////////////////////////////////////////
@@ -231,23 +246,77 @@ export const getEnvVars = (
 // Other
 ///////////////////////////////////////////////////////////////////////////////
 
-export const logCommand = (...args: any[]): void => {
-  console.log(chalk.dim(...args))
+export const delay = (ms: number) =>
+  new Promise((resolve) => setTimeout(resolve, ms))
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logTitle = (title: string) => {
+  console.log(`\n${chalk.bold(title)}`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logError = (message?: string) => {
+  if (message) {
+    console.log(chalk.red(message))
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const fail = (message?: string) => {
+  logError(message)
+  process.exit(1)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logCommand = (command: string): void => {
+  console.log(chalk.dim(stripIndent(command)))
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const prepareCommand = (command: string): string => {
+  return command
+    .replace(/\n/gm, ' ')
+    .replace(/[ \t]{2,}/gm, ' ')
+    .trim()
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const runCommandSync = (
+  command: string,
+  options?: SyncOptions,
+): ExecaSyncReturnValue => {
+  return commandSync(prepareCommand(command), options)
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-// Log data into console as a table
 export const logDataTable = (
   vars: {[key: string]: string | undefined},
-  title: string,
+  title?: string,
 ): void => {
-  const boxTitle = chalk.bold(`${title}:\n`)
-  const boxTable = columnify(vars, {showHeaders: false})
+  logTable(columnify(vars, {showHeaders: false}), title)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logTable = (text: string, title?: string): void => {
+  let out = ''
+  const boxTitle = title ? chalk.bold(`${title}`) : undefined
+
+  if (boxTitle) {
+    out += `${boxTitle}\n`
+  }
+
+  out += text
 
-  // eslint-disable-next-line no-console
   console.log(
-    boxen(`${boxTitle}\n${boxTable}`, {
+    boxen(out, {
       margin: 0,
       padding: {
         top: 0,
@@ -265,15 +334,23 @@ export const logDataTable = (
 export type NotifyArgs = {
   title: string
   message: string
+  target?: string
 }
 
 export const notify = (args: NotifyArgs): void => {
-  const {title, message} = args
+  const {title, message, target} = args
 
-  nodeNotify({
+  notifier.notify({
     title,
     message,
-    contentImage: resolveOwn('src/assets/rnw-logo.png'),
+    contentImage: 'https://assets.raisenow.io/favicon.png',
     sound: 'Funk',
+    timeout: 30,
   })
+
+  if (target) {
+    notifier.on('click', () => {
+      open(target)
+    })
+  }
 }

package/src/webpack.config.ts

@@ -1,4 +1,5 @@
 import {basename, dirname} from 'path'
+import {existsSync} from 'fs'
 import glob from 'glob'
 import {getIfUtils, removeEmpty} from 'webpack-config-utils'
 import webpack, {
@@ -27,6 +28,7 @@ import {
   getEnvVars,
   getIfCoreFns,
   getPaths,
+  getRelativePaths,
   logDataTable,
   moduleFileExtensions,
   resolveApp,
@@ -50,8 +52,10 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
   const envVars = getEnvVars(paths.appEnv, ifMin, ifCore, ifLocalCore)
   const {ifHmr} = getIfUtils({hmr: process.env.HMR_ENABLED === 'true'}, ['hmr'])
   const port = await getPortPromise({port: 1234})
+  const useTailwind =
+    ifCore() && paths.appTailwindConfig && existsSync(paths.appTailwindConfig)
 
-  logDataTable(paths, 'Paths')
+  logDataTable(getRelativePaths(paths), 'Paths')
   logDataTable(envVars.raw, 'Environment variables')
 
   const getCssLoaders = (cssOptions: any = {}): RuleSetUseItem[] => {
@@ -78,7 +82,15 @@ const getWebpackConfig = async (env: any): Promise<Configuration> => {
         options: {
           postcssOptions: {
             plugins: removeEmpty([
-              ifCore([require.resolve('tailwindcss'), paths.appTailwindConfig]),
+              useTailwind
+                ? [
+                    // eslint-disable-next-line node/no-missing-require
+                    require.resolve('tailwindcss', {
+                      paths: [paths.appNodeModules],
+                    }),
+                    paths.appTailwindConfig,
+                  ]
+                : undefined,
               require.resolve('postcss-custom-properties'),
               require.resolve('autoprefixer'),
             ]),

package/src/commands/build/index.ts

@@ -1,42 +0,0 @@
-import {commandSync} from 'execa'
-import {logCommand, notify, resolveOwn} from 'lib/helpers'
-import resolveBin from 'resolve-bin'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type BuildOptions = {
-  localCore?: boolean
-  analyze?: boolean
-  deploy?: boolean
-  tag?: string
-  serve?: boolean
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const prepareBuildFlags = (options: BuildOptions): string => {
-  const {localCore, analyze} = options
-  let flags: string[] = []
-
-  flags = localCore ? [...flags, '--env localCore'] : flags
-  flags = analyze ? [...flags, '--env analyze'] : flags
-
-  return flags.join(' ')
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const build = async (options: BuildOptions): Promise<void> => {
-  const flags = prepareBuildFlags(options)
-
-  const wpBin = resolveBin.sync('webpack')
-  const wpConfig = resolveOwn('dist/webpack.config.js')
-  const cmd = `${wpBin} --config ${wpConfig} --env min ${flags}`
-  logCommand(cmd)
-  commandSync(cmd, {stdio: 'inherit'})
-
-  notify({
-    title: '"build" command',
-    message: 'Process is done',
-  })
-}

package/src/commands/deploy/index.ts

@@ -1,24 +0,0 @@
-import {commandSync} from 'execa'
-import {getIfCoreFns, getPaths, logCommand} from 'lib/helpers'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type DeployOptions = {
-  tag?: string
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const deploy = async (options: DeployOptions): Promise<void> => {
-  // todo: ensure build exists
-  // todo: handle "tag" option
-  // todo: implement
-  const {ifCore} = getIfCoreFns()
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const paths = getPaths(ifCore)
-
-  const cmd = `echo Deploying to AWS is not implemented yet`
-  logCommand(cmd)
-  commandSync(cmd, {stdio: 'inherit'})
-}

package/src/commands/dev/index.ts

@@ -1,32 +0,0 @@
-import {commandSync} from 'execa'
-import {logCommand, resolveOwn} from 'lib/helpers'
-import resolveBin from 'resolve-bin'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type DevOptions = {
-  localCore?: boolean
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const prepareDevFlags = (options: DevOptions): string => {
-  const {localCore} = options
-  let flags: string[] = []
-
-  flags = localCore ? [...flags, '--env localCore'] : flags
-
-  return flags.join(' ')
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const dev = async (options: DevOptions): Promise<void> => {
-  const flags = prepareDevFlags(options)
-
-  const wpBin = resolveBin.sync('webpack')
-  const wpConfig = resolveOwn('dist/webpack.config.js')
-  const cmd = `${wpBin} serve --config ${wpConfig} ${flags}`
-  logCommand(cmd)
-  commandSync(cmd, {stdio: 'inherit'})
-}

package/src/commands/serve/index.ts

@@ -1,12 +0,0 @@
-import {commandSync} from 'execa'
-import {getIfCoreFns, getPaths, logCommand} from 'lib/helpers'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const serve = async (): Promise<void> => {
-  const {ifCore} = getIfCoreFns()
-  const paths = getPaths(ifCore)
-  const cmd = `npx -y http-server ${paths.appDist} --cors --port 1234`
-  logCommand(cmd)
-  commandSync(cmd, {stdio: 'inherit'})
-}