@raisenow/tamaro-cli 1.0.10 → 1.0.13

package/src/commands/dev.ts

@@ -1,17 +1,15 @@
-import resolveBin from 'resolve-bin'
-import {
-  fail,
-  getIfCoreFns,
-  logCommand,
-  logTitle,
-  resolveOwn,
-  runCommandSync,
-} from 'lib/helpers'
+import {getPortPromise} from 'portfinder'
+import {getIfCoreFns, resolveBin, resolveOwn} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {fail, runCommandSync} from 'lib/command'
+import {assertEnvValid} from 'lib/env'
 
 ///////////////////////////////////////////////////////////////////////////////
 
 export type DevOptions = {
   localCore: boolean
+  port: string
+  env: string
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -19,13 +17,13 @@ export type DevOptions = {
 export const dev = async (options: DevOptions): Promise<void> => {
   assertOptionsValid(options)
 
-  const flags = prepareFlags(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.sync('webpack')
+  const wpBin = resolveBin('webpack')
   const wpConfig = resolveOwn('dist/webpack.config.js')
   const cmd = `
     ${wpBin} serve
@@ -41,21 +39,34 @@ export const dev = async (options: DevOptions): Promise<void> => {
 ///////////////////////////////////////////////////////////////////////////////
 
 const assertOptionsValid = (options: DevOptions) => {
-  const {localCore} = options
+  const {localCore, port, env} = options
   const {ifCore} = getIfCoreFns()
 
   if (ifCore() && localCore) {
-    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+    fail('Flag “--local-core” is redundant if running in Tamaro Core context.')
   }
+
+  if (isNaN(Number(port))) {
+    fail('Flag “--port” should be a number.')
+  }
+
+  assertEnvValid(env)
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-const prepareFlags = (options: DevOptions): string => {
-  const {localCore} = options
-  let flags: string[] = []
+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 = localCore ? [...flags, '--env localCore'] : flags
+  flags.push(`--port ${port}`)
 
-  return flags.join(' ')
+  return flags
 }

package/src/commands/list-deployed.ts

@@ -1,13 +1,13 @@
+import {AWS_S3_BUCKET, CORE_CONFIG_NAME} from 'lib/constants'
 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'
+  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'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -22,6 +22,7 @@ export const listDeployed = async (
 ): Promise<void> => {
   assertOptionsValid(options)
 
+  const flags = prepareFlags([], options).join(' ')
   const {config} = options
   const {ifCore} = getIfCoreFns()
   const configName = config ?? ifCore(CORE_CONFIG_NAME, getWidgetUuid())
@@ -31,7 +32,7 @@ export const listDeployed = async (
       : `Listing deployments of “${configName}” customer configuration …`
 
   const deployUrl = `s3://${AWS_S3_BUCKET}/${configName}/`
-  const cmd = `aws s3 ls ${deployUrl}`
+  const cmd = `aws s3 ls ${deployUrl} ${flags}`
   let out = ''
 
   logTitle(title)
@@ -40,7 +41,7 @@ export const listDeployed = async (
   // 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)
+    const result = withAwsAuthenticate(() => runCommandSync(cmd), options)
     out = result.stdout
   } catch (error: any) {
     out = error.stdout
@@ -65,7 +66,7 @@ export const listDeployed = async (
       .join('\n')
   }
 
-  logTable(text)
+  console.log(`${text}\n`)
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -87,12 +88,21 @@ const assertConfigValid = (config: string | undefined) => {
   const regex = /^[a-zA-Z0-9-_]+$/
 
   if (!regex.test(config)) {
-    fail(`Flag "--config" has forbidden format. Allowed format: ${regex}.`)
+    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*/
 

package/src/commands/serve.ts

@@ -1,29 +1,53 @@
 import {getPortPromise} from 'portfinder'
-import {
-  getIfCoreFns,
-  getPaths,
-  logCommand,
-  logTitle,
-  runCommandSync,
-} from 'lib/helpers'
+import {getIfCoreFns, getPaths} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {fail, runCommandSync} from 'lib/command'
 
 ///////////////////////////////////////////////////////////////////////////////
 
-const DEFAULT_PORT = 1234
+export type ServeOptions = {
+  port: string
+}
 
 ///////////////////////////////////////////////////////////////////////////////
 
-export const serve = async (): Promise<void> => {
+export const serve = async (options: ServeOptions): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = (await prepareFlags([], options)).join(' ')
   const {ifCore} = getIfCoreFns()
   const paths = getPaths(ifCore)
-  const port = await getPortPromise({port: DEFAULT_PORT})
   const cmd = `
-    npx -y http-server ${paths.appDist}
+    npx -y serve ${paths.appDist}
       --cors
-      --port ${port}
+      ${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

@@ -1,6 +1,6 @@
-import {commandSync, ExecaSyncReturnValue, SyncOptions} from 'execa'
+import {execaCommandSync} from 'execa'
 import stripIndent from 'strip-indent'
-import {fail, prepareCommand} from './helpers'
+import {fail} from 'lib/command'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -10,47 +10,42 @@ export type AwsOptions = {
 
 ///////////////////////////////////////////////////////////////////////////////
 
-export const DEFAULT_AWS_PROFILE = 'payments-prod-cs-deployer'
+export const withAwsAuthenticate = <Result = any>(
+  fn: () => Result,
+  options: AwsOptions,
+): Result => {
+  awsAuthenticate(options)
 
-///////////////////////////////////////////////////////////////////////////////
-
-export const runAwsCommandSync = (
-  command: string,
-  options?: SyncOptions,
-): ExecaSyncReturnValue => {
-  authenticate()
-
-  return commandSync(prepareCommand(command), options)
+  return fn()
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-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.
+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()
+    checkIdentity(options)
   } catch (error) {
-    login()
+    login(options)
   }
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-const isSetEnv = () => {
+// 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 "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" environment variables are set,
-  // then ignore "--profile" flag.
   if (isSetEnv()) {
     return
   }
@@ -81,18 +76,12 @@ export const assertProfileValid = (profile: string) => {
 
     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')
+  const {stdout} = execaCommandSync('aws configure list-profiles')
 
   return stdout.split('\n')
 }
@@ -100,20 +89,39 @@ const getAvailableProfiles = (): string[] => {
 ///////////////////////////////////////////////////////////////////////////////
 
 // Returns caller identity data (output is ignored here).
-// Fails in case of expired sso session.
-const checkIdentity = () => {
-  commandSync('aws sts get-caller-identity')
+// 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.
+// Opens SSO authentication page in the browser.
 // Fails if user canceled authentication process.
-const login = () => {
+const login = (options: AwsOptions) => {
+  const flags = prepareFlags([], options).join(' ')
+
   try {
-    commandSync('aws sso login', {stdio: 'inherit'})
+    execaCommandSync(`aws sso login ${flags}`, {stdio: 'inherit'})
     console.log('')
   } catch (error) {
-    fail('Login failed')
+    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'

package/src/lib/env.ts

@@ -0,0 +1,145 @@
+import {createRequire} from 'module'
+import {basename} from 'path'
+import glob from 'glob'
+import type {IfUtilsFn} from 'webpack-config-utils'
+import {expand as dotenvExpand} from 'dotenv-expand'
+import {config as dotenvConfig} from 'dotenv'
+import stripIndent from 'strip-indent'
+import {getIfCoreFns, getPaths, getWidgetUuid, resolveApp} from 'lib/resolve'
+import {fail} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type EnvVars = {
+  [key: string]: string | undefined
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const require = createRequire(import.meta.url)
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const getEnvVars = (
+  files: string[],
+  ifMin: IfUtilsFn,
+  ifCore: IfUtilsFn,
+  ifLocalCore: IfUtilsFn,
+) => {
+  const filePath = files.find((file) => basename(file) === '.env')
+
+  dotenvExpand(dotenvConfig({path: filePath}))
+
+  process.env.NODE_ENV ??= ifMin('production', 'development')
+  process.env.BABEL_ENV ??= ifMin('production', 'development')
+  process.env.EXPOSE_VAR ??= ifCore('rnw.tamaroCore', 'rnw.tamaro')
+  process.env.ELEMENT_ATTRIBUTE_DATA_WIDGET ??= ifCore(
+    'rnw-tamaro-core',
+    'rnw-tamaro',
+  )
+  process.env.WEBPACK_UNIQUE_NAME ??= ifCore('RnwTamaroCore', 'RnwTamaro')
+  process.env.BUILD_DATE = new Date().toISOString()
+
+  // HMR doesn't work in ie11, it breaks everything.
+  // If you want to run dev-server and test in ie11, set HMR_ENABLED to 'false'
+  process.env.HMR_ENABLED ??= ifMin('false', 'true')
+
+  if (ifCore()) {
+    process.env.PRODUCT_NAME = 'tamaro'
+
+    const corePkgPath = resolveApp('package.json')
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const {version} = require(corePkgPath)
+
+    process.env.PRODUCT_VERSION = version
+  }
+
+  if (!ifCore()) {
+    process.env.WIDGET_UUID = getWidgetUuid()
+
+    if (ifLocalCore()) {
+      process.env.CORE_URL = `http://0.0.0.0:1234/index.js`
+    } else {
+      let version = process.env.CORE_VERSION
+      version = version ? `@${version}` : ''
+
+      process.env.CORE_URL ??= `https://cdn.jsdelivr.net/npm/@raisenow/tamaro-core${version}/dist/index.js`
+    }
+  }
+
+  // var names which will be exposed along with "PUBLIC_*" var names
+  const varNames = [
+    // common
+    'NODE_ENV',
+    'BABEL_ENV',
+    'EXPOSE_VAR',
+    'ELEMENT_ATTRIBUTE_DATA_WIDGET',
+    'WEBPACK_UNIQUE_NAME',
+    'BUILD_DATE',
+
+    // core
+    'PRODUCT_NAME',
+    'PRODUCT_VERSION',
+
+    // config
+    'WIDGET_UUID',
+    'CORE_URL',
+    'CORE_VERSION', // must be explicitly specified in each config
+    'IS_CREDIT_CARD_IFRAME',
+  ]
+
+  // Collect all vars which names start from "PUBLIC_" or present in "varNames" array
+  const raw = Object.keys(process.env)
+    .filter((key) => /^PUBLIC_/.test(key) || varNames.includes(key))
+    .reduce<EnvVars>((env, key) => {
+      env[key] = process.env[key]
+
+      return env
+    }, {})
+
+  // Stringify all values so we can feed into webpack DefinePlugin
+  const stringified = {
+    'process.env': Object.keys(raw).reduce<EnvVars>((env, key) => {
+      env[key] = JSON.stringify(raw[key])
+
+      return env
+    }, {}),
+  }
+
+  return {raw, stringified}
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const assertEnvValid = (env: string) => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const files = glob.sync(paths.appEnv)
+  const envs = files
+    .map((file) => basename(file).replace(/^\.env\.?/, ''))
+    .filter((v) => !!v)
+
+  if (envs.length === 0) {
+    if (env) {
+      console.log('Flag “--env” is ignored.')
+    }
+  }
+
+  if (envs.length !== 0) {
+    if (!env) {
+      fail('Flag “--env” is required.')
+    }
+
+    if (!envs.includes(env)) {
+      fail(
+        stripIndent(`
+          Flag “--env” has wrong value.
+          Available values are: ${envs.map((v) => `“${v}”`).join(', ')}.
+        `),
+      )
+    }
+
+    const filePath = files.find((file) => basename(file) === `.env.${env}`)
+    dotenvExpand(dotenvConfig({path: filePath}))
+  }
+}

package/src/lib/logging.ts

@@ -0,0 +1,32 @@
+import chalk from 'chalk'
+import stripIndent from 'strip-indent'
+import columnify from 'columnify'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logTitle = (title: string) => {
+  console.log(`${chalk.bold(title)}`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logError = (message?: string) => {
+  if (message) {
+    console.log(chalk.red(message))
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logCommand = (cmd: string): void => {
+  console.log(`\n${chalk.dim(stripIndent(cmd).trim())}\n`)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const logDataTable = (data: {
+  [key: string]: string | undefined
+}): void => {
+  console.log(columnify(data, {showHeaders: false}))
+  console.log('')
+}

package/src/lib/notifier.ts

@@ -0,0 +1,22 @@
+import notifier from 'node-notifier'
+import stripIndent from 'strip-indent'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type NotifyArgs = {
+  title: string
+  message: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const notify = (args: NotifyArgs) => {
+  const {title, message = ''} = args
+
+  notifier.notify({
+    title,
+    message: stripIndent(message).trim(),
+    contentImage: 'https://assets.raisenow.io/favicon.png',
+    sound: 'Funk',
+  })
+}