@raisenow/tamaro-cli 1.0.8 → 1.0.9

package/src/cli.ts

@@ -2,10 +2,18 @@
 
 import {createCommand} from 'commander'
 import pkg from '../package.json'
+import {logError} from 'lib/helpers'
 import {dev, DevOptions} from 'commands/dev'
 import {build, BuildOptions} from 'commands/build'
-import {deploy, DeployOptions} from 'commands/deploy'
+import {DEFAULT_TAG, deploy, DeployOptions} from 'commands/deploy'
 import {serve} from 'commands/serve'
+import {listDeployed, ListDeployedOptions} from 'commands/list-deployed'
+import {
+  DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET,
+  deployEmailConfig,
+  DeployEmailConfigOptions,
+} from 'commands/deploy-email-config'
+import {DEFAULT_AWS_PROFILE} from 'lib/aws'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -18,7 +26,7 @@ process.on('unhandledRejection', (error) => {
 
 // Exit on ctrl+c
 process.on('SIGINT', () => {
-  process.exit(0)
+  process.exit(1)
 })
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -29,8 +37,14 @@ const cli = createCommand().name(pkg.name).version(pkg.version, '-v, --version')
 
 cli
   .command('dev')
-  .description('Run dev web-server for Tamaro Core or customer configuration')
-  .option('--local-core', 'Load Tamaro Core from localhost instead of CDN')
+  .description(
+    'Run the local development server for Tamaro Core or a particular customer configuration',
+  )
+  .option(
+    '--local-core',
+    'Load Tamaro Core from localhost instead of the CDN',
+    false,
+  )
   .action(async (options: DevOptions) => {
     await dev(options)
   })
@@ -38,17 +52,31 @@ cli
 cli
   .command('build')
   .description(
-    'Build optimised (minified) bundle of Tamaro Core or customer configuration for production',
+    'Build an optimised (minified) bundle of Tamaro Core or a customer configuration',
   )
-  .option('--local-core', 'Load Tamaro Core from localhost instead of CDN')
-  .option('--analyze', 'Generate bundle statistics to "reports" folder')
+  .option(
+    '--local-core',
+    'Load Tamaro Core from localhost instead of the CDN',
+    false,
+  )
+  .option('--analyze', 'Generate bundle statistics to "reports" folder', false)
   .option(
     '--deploy',
-    'Deploy Tamaro Core or customer configuration bundle to AWS',
+    'Deploy Tamaro Core or a customer configuration bundle to AWS S3',
+    false,
+  )
+  .option('--serve', 'Run the generated bundle with a local web server', false)
+  .option(
+    '--tag <tag>',
+    'Tag which should be used for the deployment of the bundle',
+    DEFAULT_TAG,
   )
-  .option('--serve', 'Run web-server for the bundle')
-  .option('--tag <tag>', 'Tag which will be used for deployment of the bundle')
-  .action(async (options: BuildOptions) => {
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of the bundle',
+    DEFAULT_AWS_PROFILE,
+  )
+  .action(async (options: BuildOptions & DeployOptions) => {
     await build(options)
 
     if (options.deploy) {
@@ -63,21 +91,71 @@ cli
 cli
   .command('deploy')
   .description(
-    'Deploy prebuilt Tamaro Core or customer configuration bundle to AWS',
+    'Deploy a pre-built Tamaro Core or customer configuration bundle to AWS S3',
+  )
+  .option(
+    '--tag <tag>',
+    'Tag which should be used for the deployment of the bundle',
+    DEFAULT_TAG,
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of the bundle',
+    DEFAULT_AWS_PROFILE,
   )
-  .option('--tag <tag>', 'Tag which will be used for deployment of the bundle')
   .action(async (options: DeployOptions) => {
     await deploy(options)
   })
 
 cli
   .command('serve')
-  .description('Run web-server for prebuilt bundle')
+  .description('Run a local web server for pre-built bundle')
   .action(async () => {
     await serve()
   })
 
+cli
+  .command('list-deployed')
+  .description(
+    'List deployments of Tamaro Core or a particular customer configuration',
+  )
+  .option(
+    '--config <config>',
+    'Configuration name (default: current customer configuration)',
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for fetching deployments',
+    DEFAULT_AWS_PROFILE,
+  )
+  .action(async (options: ListDeployedOptions) => {
+    await listDeployed(options)
+  })
+
+cli
+  .command('deploy-email-config')
+  .description('Deploy a widget’s email configuration to AWS S3')
+  .option(
+    '--bucket <bucket>',
+    'AWS S3 bucket where it should be deployed',
+    DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET,
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of email configuration',
+    DEFAULT_AWS_PROFILE,
+  )
+  .action(async (options: DeployEmailConfigOptions) => {
+    await deployEmailConfig(options)
+  })
+
 ///////////////////////////////////////////////////////////////////////////////
 ;(async () => {
-  await cli.parseAsync(process.argv)
+  try {
+    await cli.parseAsync(process.argv)
+  } catch (error: any) {
+    if (error.signal === 'SIGINT' && error.signalDescription) {
+      logError(`\n${error.signalDescription}`)
+    }
+  }
 })()

package/src/commands/build.ts

@@ -0,0 +1,97 @@
+import resolveBin from 'resolve-bin'
+import {
+  fail,
+  getIfCoreFns,
+  getPaths,
+  getWidgetUuid,
+  logCommand,
+  logDataTable,
+  logTitle,
+  notify,
+  resolveOwn,
+  runCommandSync,
+} from 'lib/helpers'
+import {assertProfileValid} from 'lib/aws'
+import {CORE_CONFIG_NAME, DeployOptions} from 'commands/deploy'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type BuildOptions = {
+  localCore: boolean
+  analyze: boolean
+  deploy: boolean
+  serve: boolean
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const build = async (
+  options: BuildOptions & DeployOptions,
+): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = prepareFlags(options)
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
+  const title = ifCore(
+    'Building optimised (minified) bundle of Tamaro Core …',
+    `Building optimised (minified) bundle of “${configName}” customer configuration …`,
+  )
+
+  const wpBin = resolveBin.sync('webpack')
+  const wpConfig = resolveOwn('dist/webpack.config.js')
+  const cmd = `
+    ${wpBin}
+      --config ${wpConfig}
+      --env min
+      ${flags}
+  `
+
+  logTitle(title)
+  logCommand(cmd)
+  runCommandSync(cmd, {stdio: 'inherit'})
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  logDataTable(
+    {'Path:': paths.appDist},
+    `Bundle for “${configName}” customer configuration is done.`,
+  )
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  notify({
+    title: 'build',
+    message: `Bundle for “${configName}” customer configuration is done.`,
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: BuildOptions & DeployOptions) => {
+  const {localCore, deploy, profile} = options
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore() && localCore) {
+    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+  }
+
+  if (localCore && deploy) {
+    fail('Flags "--local-core" and "--deploy" must not be used together.')
+  }
+
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (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(' ')
+}

package/src/commands/deploy-email-config.ts

@@ -0,0 +1,107 @@
+import {existsSync} from 'fs'
+import {
+  fail,
+  getIfCoreFns,
+  getPaths,
+  getWidgetUuid,
+  logCommand,
+  logDataTable,
+  logTitle,
+  notify,
+} from 'lib/helpers'
+import {assertProfileValid, AwsOptions, runAwsCommandSync} from 'lib/aws'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DeployEmailConfigOptions = AwsOptions & {
+  bucket: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET = 'rnw-email-service'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const deployEmailConfig = async (
+  options: DeployEmailConfigOptions,
+): Promise<void> => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const emailConfigPath = `${paths.app}/email-config`
+
+  assertOptionsValid(options)
+  assertEmailConfigPathExists(emailConfigPath)
+  assertIsNotCore()
+
+  const {bucket} = options
+  const configName = getWidgetUuid()
+  const deployUrl = `s3://${bucket}/${configName}`
+
+  const cmd = `
+    aws s3 sync ${emailConfigPath} ${deployUrl}
+      --delete
+      --exact-timestamps
+  `
+  logTitle(
+    `Deploying email configuration for “${configName}” customer configuration to AWS S3 …`,
+  )
+  logCommand(cmd)
+
+  try {
+    runAwsCommandSync(cmd, {stdout: 'inherit'})
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  logDataTable(
+    {'Deploy URL:': deployUrl},
+    `Email configuration for “${configName}” customer configuration is deployed.`,
+  )
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  notify({
+    title: `deploy-email-config`,
+    message: `Email configuration for “${configName}” customer configuration is deployed.`,
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: DeployEmailConfigOptions) => {
+  const {bucket, profile} = options
+
+  assertBucketValid(bucket)
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertEmailConfigPathExists = (distPath: string) => {
+  if (!existsSync(distPath)) {
+    fail('Email config folder does not exists. Nothing to deploy.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertBucketValid = (tag: string) => {
+  const regex = /^[a-zA-Z0-9-_]+$/
+
+  if (!regex.test(tag)) {
+    fail(`Flag "--bucket" has forbidden format. Allowed format: ${regex}.`)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertIsNotCore = () => {
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore()) {
+    fail('You cannot deploy widget email configuration for Tamaro Core.')
+  }
+}

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