@leverege/build-tools 2.50.2 → 2.50.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.50.2",
+  "version": "2.50.3",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -64,7 +64,7 @@
     "execa": "^8.0.1",
     "glob": "^10.3.12",
     "handlebars": "^4.7.8",
-    "inquirer": "^9.2.18",
+    "inquirer": "^9.2.19",
     "js-yaml": "^4.1.0",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^16.2.1",
@@ -74,7 +74,7 @@
     "readline-sync": "^1.4.10",
     "semver": "^7.6.0",
     "simple-git": "^3.24.0",
-    "zx": "^8.0.1"
+    "zx": "^8.0.2"
   },
   "devDependencies": {
     "@leverege/eslint-config-leverege": "^4.2.0",

package/registry-compass.yaml

@@ -0,0 +1,20 @@
+registry:
+  - root: us-docker.pkg.dev
+  - repositories:
+    - name: stack
+      charts:
+        - api-server
+        - authz-server
+        - emailer
+        - message-processor
+    - name: leverege
+      charts:
+        - pubsub-pulse
+        - pusher
+        - overdose
+    - name: cox-health
+      charts:
+        - actions-server
+        - analytics-server
+        - centrak-healthz
+        - centrak-ingestor

package/src/chart-compass.mjs

@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+/*
+ * chart-to-registry will...
+ */
+import fs from 'node:fs'
+
+import chalk from 'chalk'
+import commandLineArgs from 'command-line-args'
+import commandLineUsage from 'command-line-usage'
+import { lt as semverLt } from 'semver'
+import YAML from 'js-yaml'
+
+import {
+  condir,
+  debug,
+  errorExit,
+  log,
+  warning,
+  getGitRootDirectory,
+  parsePackageJson,
+  parseHelmChart,
+  shellCmd } from './Utils.mjs'
+
+const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
+  /* eslint-disable max-len */
+  {
+    name : 'location',
+    type : String,
+    description : '{green the location of the artifact registry the chart will be pushed to (default us-docker.pkg.dev)}',
+  },
+  {
+    name : 'project',
+    type : String,
+    description : '{green the name of the google project containing the npmrc and slack config secrets (default leverege-registry)}',
+  },
+  {
+    name : 'repository',
+    type : String,
+    description : '{green the target repository to receive the pushed chart}',
+  },
+  {
+    name : 'dry-run',
+    type : Boolean,
+    description : '{yellow perform everything except the actual chart push}',
+  },
+  {
+    name : 'help',
+    type : Boolean,
+    description : '{green display this help screen}',
+  },
+  /* eslint-enable max-len */
+]
+
+const sections = [
+  {
+    header : 'Leverege Helm Chart Compass (for helmup)',
+    content : `{green This tool helps helmup navigate the helm charts stored in the
+artifact-registries.}`
+  },
+  { header : 'Options',
+    optionList : commandLineOptions,
+  },
+]
+
+const args = commandLineArgs( commandLineOptions, { camelCase : true, partial : true } )
+const usage = commandLineUsage( sections )
+
+if ( args.help ) {
+  log( usage )
+  process.exit( 0 )
+}
+
+/* eslint-disable no-underscore-dangle */
+if ( args._unknown ) {
+  log( usage )
+  log( `\nUnrecognized argument [${chalk.bold.red( args._unknown )}]\n` )
+  process.exit( 1 )
+}
+/* eslint-enable no-underscore-dangle */
+
+const minNodejsVersion = '18.0.0'
+if ( semverLt( process.version, minNodejsVersion ) ) {
+  errorExit( `\n***ERROR: must be running at least node ${minNodejsVersion}\n` )
+}
+
+// First of all, fail if we are not in a git repository
+let gitRoot
+try {
+  gitRoot = await getGitRootDirectory()
+} catch ( error ) {
+  errorExit( chalk.red.bold( error ), { errorCode : 5 } )
+}
+
+const chartCompass = YAML.load( fs.readFileSync( './registry-compass.yaml', 'utf8' ) )
+
+condir( { chartCompass }, '<==Navigation' )

package/src/helm-charts/elasticsearch8/helmup.plugin

@@ -28,5 +28,10 @@ service:
     prometheus.io/scrape: "true"
 es:
   uri: http://elasticsearch8.elastic.svc.cluster.local:9200
+
+resources:
+  requests:
+    cpu: 50m
+    memory: 32Mi
 ELASTIC8_EXPORTER_CHART_MOD
 removeHelmRepo prometheus-community

package/src/helm-charts/redis/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "Redis"
 
 OCI_CHART="oci://registry-1.docker.io/bitnamicharts/redis"
 
-[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="18.16.1"
+[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="19.1.2"
 
 helm upgrade --install redis $OCI_CHART       \
              --values  redis/redis-local.yaml \

package/src/helm-charts/stackdriver-exporter/values-local.yaml

@@ -13,6 +13,27 @@ annotations:
   prometheus.io/port: "9255"
   prometheus.io/scrape: "true" # this is a string annotation - so quoted!
 
+tolerations:
+- key: "preemptible"
+  operator: "Equal"
+  value: "true"
+  effect: "NoSchedule"
+
+affinity:
+  nodeAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      nodeSelectorTerms:
+      - matchExpressions:
+        - key: target-env
+          operator: In
+          values:
+          - preemptible
+
+resources:
+  requests:
+    cpu: 50m
+    memory: 32Mi
+
 # NOTE to future selves - the exporter's helm chart does not have a clue
 # regarding workload identity, which means the gcloud and k8s service
 # accounts have to be managed outside of the chart by helmup. In order to get

package/src/helm-charts/traefik/helmup.plugin

@@ -1,12 +1,19 @@
 #!/bin/bash
-
+#
+# Release Notes => https://github.com/traefik/traefik-helm-chart/releases
+#
+# ***REMEMBER*** the instructions provided on the internet typically assume
+#                the default namespace not traefik
+#
+# ***DO NOT FORGET*** the -n traefik for kubectl commands
+#
 showInstalling "Traefik Load Balancer / Router"
 
 TRAEFIK_NAMESPACE="traefik"
 
 addHelmRepo traefik https://helm.traefik.io/traefik
 
-[ -z "$TRAEFIK_CHART_VERSION" ] && TRAEFIK_CHART_VERSION="26"
+[ -z "$TRAEFIK_CHART_VERSION" ] && TRAEFIK_CHART_VERSION="27"
 helm upgrade --install traefik traefik/traefik \
              --namespace $TRAEFIK_NAMESPACE --create-namespace \
              --values  traefik/traefik-local.yaml \

package/src/helm-charts/traefik/traefik-local.yaml

@@ -18,6 +18,12 @@ logs:
     enabled: true
     format: json
 
+# minimal resources to prevent CPU starvation
+resources:
+  requests:
+    cpu: "100m"
+    memory: "50Mi"
+
 # Custom entry points may be added here - the first two are port definitions
 # for both unsecured and secured MQTT ports used by connect. Note that the
 # mqtts port has TLS termination performed by traefik and both ports are then

package/src/helm-charts/velero/velero-local.yaml

@@ -13,6 +13,16 @@ schedules:
           release: "postgres"
           app: "postgresql"
 
+  elasticsearch:
+    disabled: false
+    schedule: "0 6 * * *"
+    template:
+      ttl: "720h"
+      snapshotVolumes: true
+      labelSelector:
+        matchLabels:
+          app.kubernetes.io/name: elasticsearch
+
   tsdb:
     disabled: false
     schedule: "0 8 * * *"

package/src/zx-testing

@@ -0,0 +1,216 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+// https://github.com/google/zx
+/* eslint-disable max-len */
+import pkg from 'enquirer'
+import colors from 'ansi-colors'
+import { $, fs, argv, path, chalk } from 'zx'
+
+const { prompt } = pkg
+
+// This will preserve coloration from spawned child processes
+process.env.FORCE_COLORS = 3
+process.env.FORCE_COLOR = '1'
+
+let TARGET
+let CHANNEL
+
+// A single unnamed parameter is assumed to be a deploy target.
+// If named parameters exist, they may not be stored in argv,
+// so don't look for a larger length of argv to decide whether to look for named paramters
+if ( argv._.length === 1 ) {
+  TARGET = argv._[0]
+} else {
+  TARGET = argv.target
+
+  if ( argv.channelName ) {
+    CHANNEL = {}
+    CHANNEL.name = argv.channelName
+    CHANNEL.expiration = argv.channelExpiration ?? '7d'
+  }
+}
+
+// If target has not been defined on the command line,
+// then enter interactive mode
+const INTERACTIVE_MODE = !TARGET
+
+let exited = false
+
+const SECRETS_DIR = 'secrets'
+const EXIT_EVENTS = [ 'SIGINT', 'exit', 'uncaughException', 'unhandledRejection' ]
+
+const [
+  firebaserc,
+  firebaseJson,
+  gitBranch
+] = await Promise.all( [
+  fs.exists( path.join( process.cwd(), '.firebaserc' ) ),
+  fs.exists( path.join( process.cwd(), 'firebase.json' ) ),
+  $`git rev-parse --abbrev-ref HEAD -C ${process.cwd()}`
+    .then( ( { stdout } ) => {
+      return stdout.split( '\n' )[0]
+    } )
+] )
+
+if ( !firebaserc ) {
+  console.log( chalk.red( 'No .firebaserc file found. Make sure that you are executing firebaseDeploy from within a firebase project directory.' ) )
+}
+
+if ( !firebaseJson ) {
+  console.log( chalk.red( 'No firebase.json file found. Make sure that you are executing firebaseDeploy from within a firebase project directory.' ) )
+}
+
+if ( !firebaserc || !firebaseJson ) {
+  process.exit()
+}
+
+const firebasercContent = JSON.parse( await fs.readFile( path.join( process.cwd(), '.firebaserc' ), { encoding : 'utf-8' } ) )
+
+let maxSiteIdLength = 0
+
+const targets = Object
+  .entries( firebasercContent.targets )
+  .reduce( ( prev, [ projectId, config ] ) => {
+    Object
+      .entries( config.hosting )
+      .forEach( ( [ siteId, aliases ] ) => {
+        aliases.forEach( ( alias ) => {
+          // Store the longest length of site id for formatting later on
+          maxSiteIdLength = Math.max( siteId.length, maxSiteIdLength )
+
+          // eslint-disable-next-line no-param-reassign
+          prev[alias] = {
+            projectId,
+            siteId,
+            alias,
+            production : config.production
+          }
+        } )
+      } )
+
+    return prev
+  }, {} )
+
+if ( INTERACTIVE_MODE ) {
+  const { targetEnv } = await prompt( [ {
+    type : 'autocomplete',
+    name : 'targetEnv',
+    message : 'To which environment would you like to deploy?',
+    choices : Object.values( targets ).map( ( t ) => {
+      const productionLabel = t.production ? colors.bold.red( '--PRODUCTION--' ) : ''
+      return { message : `${colors.bold.cyan( 'Site: ' )}${t.siteId.padEnd( maxSiteIdLength )} ${colors.bold.green( 'Project: ' )}${t.projectId} ${productionLabel}`, value : t.alias }
+    } )
+  } ] )
+
+  TARGET = targets[targetEnv]
+
+  if ( TARGET.production ) {
+    const { confirmProductionDeploy } = await prompt( [ {
+      type : 'confirm',
+      name : 'confirmProductionDeploy',
+      message : `${colors.bold.red( 'WARNING: ' )} This is a ${colors.bold.yellow( 'PRODUCTION' )} environment. Are you sure you want to deploy here?`
+    } ] )
+    if ( !confirmProductionDeploy ) {
+      console.log( 'Cancelling deployment...' )
+      process.exit()
+    }
+  }
+
+  const { useChannel } = await prompt( [ {
+    type : 'confirm',
+    name : 'useChannel',
+    message : 'Do you want to deploy to a temporary preview channel?'
+  } ] )
+
+  if ( useChannel ) {
+    const { channelName, channelExpiration } = await prompt( [ {
+      type : 'input',
+      name : 'channelName',
+      message : 'To which channel would you like to deploy?',
+      initial : gitBranch ?? 'temp-deploy'
+    }, {
+      type : 'input',
+      name : 'channelExpiration',
+      message : 'When should the channel expire?',
+      initial : '7d'
+    } ] )
+
+    CHANNEL = { name : channelName, expiration : channelExpiration }
+  }
+} else {
+  TARGET = targets[TARGET]
+}
+
+if ( !TARGET ) {
+  console.log( chalk.red( 'No such target exists in .firebaserc config.' ) )
+  process.exit()
+}
+
+const [ aliasFileExists, siteIdFileExists, sharedFileExists ] = await Promise.all( [
+  fs.exists( path.join( process.cwd(), SECRETS_DIR, `${TARGET.alias}.env` ) ),
+  fs.exists( path.join( process.cwd(), SECRETS_DIR, `${TARGET.siteId}.env` ) ),
+  fs.exists( path.join( process.cwd(), SECRETS_DIR, 'shared.env' ) )
+] )
+
+if ( !aliasFileExists && !siteIdFileExists ) {
+  console.log( chalk.red( `No env file for ${TARGET.alias} exists. Check your secrets directory and try again` ) )
+  process.exit()
+}
+
+const exec = []
+
+if ( sharedFileExists ) {
+  exec.push( fs.readFile( path.join( process.cwd(), SECRETS_DIR, 'shared.env' ), { encoding : 'utf-8' } ) )
+}
+
+if ( aliasFileExists ) {
+  exec.push( fs.readFile( path.join( process.cwd(), SECRETS_DIR, `${TARGET.alias}.env` ), { encoding : 'utf-8' } ) )
+} else {
+  exec.push( fs.readFile( path.join( process.cwd(), SECRETS_DIR, `${TARGET.siteId}.env` ), { encoding : 'utf-8' } ) )
+}
+
+console.log( `\n\n\n${colors.bold.green( '====== Deployment Summary ======' )}` )
+console.log( `${colors.blue( 'Firebase project:' )} ${TARGET.projectId} ${TARGET.production ? colors.yellow( '--PRODUCTION--' ) : ''}` )
+console.log( `${colors.blue( 'Site ID:' )} ${TARGET.siteId}` )
+console.log( `${colors.blue( 'Channel Name:' )} ${CHANNEL?.name ?? colors.italic.gray( '(none)' )}` )
+console.log( `${colors.blue( 'Channel Expiration date:' )} ${CHANNEL?.name ? CHANNEL.expiration ?? colors.italic.gray( '(none)' ) : colors.italic.gray( '(n/a)' )}` ) 
+console.log( `${colors.blue( 'Shared .env file:' )} ${sharedFileExists ? `${SECRETS_DIR}/shared.env` : colors.italic.gray( '(none)' )}` )
+console.log( `${colors.blue( 'Additional .env overrides:' )} ${aliasFileExists ? `${SECRETS_DIR}/${TARGET.alias}.env` : `${SECRETS_DIR}/${TARGET.siteId}.env`}` )
+console.log( `${colors.bold.green( '===============================' )}` )
+
+if ( INTERACTIVE_MODE ) {
+  const { confirmSelections } = await prompt( [ {
+    type : 'confirm',
+    name : 'confirmSelections',
+    message : 'Proceed with this deployment?'
+  } ] )
+
+  if ( !confirmSelections ) {
+    console.log( 'Cancelling deployment...' )
+    process.exit()
+  }
+}
+const envFileContent = ( await Promise.all( exec ) ).join( '\n' )
+
+EXIT_EVENTS
+  .forEach( ( event ) => {
+    process.on( event, () => {
+      if ( !exited ) {
+        exited = true
+        fs.removeSync( path.join( process.cwd(), '.env.temp' ) )
+      }
+    } )
+  } )
+
+await fs.writeFile( path.join( process.cwd(), '.env.temp' ), envFileContent )
+
+try {
+
+  // deploying to a channel requires slightly different parameter structure 
+  const deployType = CHANNEL ? `hosting:channel:deploy ${CHANNEL.name} ${CHANNEL.expiration ? `--expires ${CHANNEL.expiration}` : ''}`.split( ' ' ) : 'deploy'
+  const hostingPrefix = CHANNEL ? '' : 'hosting:'
+
+  await $`npm run clean && DOTENV_CONFIG_PATH=${path.join( process.cwd(), '.env.temp' )} DEPLOYMENT_TARGET=${TARGET.siteId} npm run build && firebase use ${TARGET.projectId} && firebase ${deployType} --only ${hostingPrefix}${TARGET.siteId}`
+} catch ( err ) {
+  console.error( err )
+}