@leverege/build-tools 2.38.2 → 2.39.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.38.2",
+  "version": "2.39.0-beta.2",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -14,12 +14,12 @@
     "compile_server": "NODE_ENV=server babel -d lib/server src/",
     "compile_web": "NODE_ENV=web babel -d lib/web src/",
     "lint": "find ./src -name \\*.\\*js | xargs npx eslint --report-unused-disable-directives",
-    "prepublintOnly": "npm run lint && npm run build",
-    "prepublishOnly": "npm run compile",
+    "xprepublintOnly": "npm run lint && npm run build",
+    "xprepublishOnly": "npm run compile",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "bin": {
-    "build-tools": "src/build-tools.js",
+    "build-tools": "src/build-tools.mjs",
     "circleate": "src/circleate.sh",
     "decrypt-secrets": "src/decrypt-secrets.sh",
     "dirty-git": "src/dirty-git.sh",
@@ -55,17 +55,16 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "ansi-colors": "^4.1.3",
-    "chalk": "^4.1.2",
+    "chalk": "^5.3.0",
     "command-line-args": "^5.2.1",
-    "command-line-usage": "^6.1.3",
+    "command-line-usage": "^7.0.1",
     "deepmerge": "^4.3.1",
-    "dotenv": "^16.3.1",
     "enquirer": "^2.4.1",
-    "execa": "^5.1.1",
-    "get-bin-path": "^10.0.0",
-    "glob": "^8.1.0",
+    "execa": "^8.0.1",
+    "glob": "^10.3.4",
     "js-yaml": "^4.1.0",
-    "npm-registry-fetch": "^13.3.1",
+    "ms": "^2.1.3",
+    "npm-registry-fetch": "^16.0.0",
     "parse-gitignore": "^2.0.0",
     "read-pkg": "^8.1.0",
     "readline-sync": "^1.4.10",
@@ -74,10 +73,7 @@
     "zx": "^7.2.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.22.10",
-    "@babel/core": "^7.22.11",
-    "@leverege/babel-preset-leverege-node": "^2.0.0",
-    "@leverege/eslint-config-leverege": "^3.0.1",
-    "npm": "^9.8.1"
+    "@leverege/eslint-config-leverege": "^4.2.0",
+    "npm": "^10.0.0"
   }
 }

package/src/Utils.mjs

@@ -0,0 +1,30 @@
+import chalk from 'chalk'
+import { $ } from 'execa'
+
+const debugEnabled = process.env.BUILD_TOOLS_DEBUG === '1'
+
+// eslint-disable-next-line no-console
+export const log = console.log
+export const debug = ( obj, text ) => {
+  if ( debugEnabled ) {
+    log( obj, `${chalk.yellow( '***DEBUG:' )} ${chalk.green( text )}` )
+  }
+}
+
+export const shellCmd = async ( cmdstr, opts = {} ) => {
+  try {
+    // due to the escaping rules we pull apart the cmdstr and invoke $ using
+    // the (command, argsArray) or the escaped command sent to spawn will have
+    // addition double quotes which causes fail
+    const [ command, ...args ] = cmdstr.split( ' ' )
+
+    debug( { command, args }, '<==execa $ invoke' )
+    const results = await $( opts )`${command} ${args}`
+    debug( { results }, '<==execa $ results' )
+
+    return results.stdout
+  } catch ( error ) {
+    debug( { error } )
+    throw error
+  }
+}

package/src/{build-tools.js → build-tools.mjs}

@@ -1,13 +1,31 @@
 #!/usr/bin/env node
+/* eslint-disable security/detect-non-literal-fs-filename */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import url from 'node:url'
+
+import chalk from 'chalk'
+import cliArgs from 'command-line-args'
+import cliHelp from 'command-line-usage'
+import npmRegistryFetch from 'npm-registry-fetch'
+import { lt as semverLt } from 'semver'
+
+// because __dirname goes away with ESM
+const getFilename = () => {
+  const filename = url.fileURLToPath( import.meta.url )
+  return filename
+}
 
-const fs = require( 'node:fs' )
-const path = require( 'node:path' )
+const getDirname = () => {
+  const dirname = path.dirname( getFilename() )
+  return dirname
+}
 
-const chalk = require( 'chalk' )
-const cliArgs = require( 'command-line-args' )
-const cliHelp = require( 'command-line-usage' )
-const npmRegistryFetch = require( 'npm-registry-fetch' )
-const semverLt = require( 'semver/functions/lt' )
+const repoRoot = path.dirname( getDirname() )
+const thisVersion = JSON.parse(
+  fs.readFileSync( `${repoRoot}/package.json` )
+).version
 
 /* eslint-disable no-console */
 
@@ -65,10 +83,6 @@ const sections = [
 const args = cliArgs( optionList, { partial : true } )
 const help = cliHelp( sections )
 
-const repoRoot = path.dirname( __dirname )
-const thisPackage = require( `${repoRoot}/package.json` )
-const thisVersion = thisPackage.version
-
 if ( args.root ) {
   console.log( repoRoot )
   process.exit( 0 )
@@ -93,7 +107,7 @@ const checkForLatest = async ( pkg = '@leverege/build-tools' ) => {
     }
     try {
       const tokenLine = fs.readFileSync( tokenFile ).toString()
-      const tokenRegX = new RegExp( '.*registry.npmjs.org\\/:\\w+=+(.*)' )
+      const tokenRegX = '.*registry.npmjs.org\\/:\\w+=+(.*)' // old => new RegExp( '.*registry.npmjs.org\\/:\\w+=+(.*)' )
       const tokenStr = tokenLine.match( tokenRegX )
       if ( !tokenStr ) {
         console.error( `\n***ERROR: malformed npm token in ${tokenFile}\n` )
@@ -103,6 +117,7 @@ const checkForLatest = async ( pkg = '@leverege/build-tools' ) => {
     } catch ( err ) {
       console.error( err )
     }
+    return undefined
   }
 
   try {
@@ -113,6 +128,7 @@ const checkForLatest = async ( pkg = '@leverege/build-tools' ) => {
   } catch ( err ) {
     console.log( err )
   }
+  return undefined
 }
 
 const checkAndAnnounce = () => {

package/src/circle-lib.yml

@@ -0,0 +1,150 @@
+version: 2.1
+jobs:
+  install:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-npm-deps-{{ checksum "package-lock.json" }}
+            - v1-npm-deps-
+
+      - run:
+          name: Setup @leverege Token
+          command: echo \${NPMRC} > ~/.npmrc
+
+      - run: npm install
+
+      - save_cache:
+          key: v1-npm-deps-{{ checksum "package-lock.json" }}
+          paths:
+            - ./node_modules
+
+      - persist_to_workspace:
+          root: /home/circleci/project
+          paths:
+            - ./node_modules
+
+  security-check:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Check for vulnerabilities
+          command: npm audit --production --audit-level=moderate
+
+  license-check:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Check for LICENSE and README files
+          command: npm run pkglint
+
+      - run:
+          name: Check for license violations (e.g. GPL)
+          command: npx license-checker --production --summary --failOn GPL
+
+  lint:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Lint and save results
+          command: npm run lint-ci
+
+      - store_test_results:
+          path: reports
+
+  docs:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Generate docs
+          command: npx jsdoc -r src -R README.md -d docs
+      - store_artifacts:
+          path: docs
+          prefix: docs
+
+  coverage:
+    # coverage runs tests, generates coverage, and saves docs
+    environment:
+      TZ: 'America/New_York'
+    docker:
+      - image: $CIRCLE_NODE_IMG
+      # IF YOU NEED ANY OF THESE, UNCOMMENT TO USE
+      # - image: redis
+      # - image: circleci/mysql:5.7
+      #   environment:
+      #     MYSQL_USER: root
+      #     MYSQL_ROOT_PASSWORD: root
+      #     MYSQL_ALLOW_EMPTY_PASSWORD: true
+      #     MYSQL_HOST: 127.0.0.1
+      # - image: nsqio/nsq
+      #   command: /nsqlookupd -broadcast-address localhost:4160 -tcp-address 0.0.0.0:4160 -http-address 0.0.0.0:4161
+
+      # - image: nsqio/nsq
+      #   command: >
+      #     /nsqd
+      #     -broadcast-address localhost:4150
+      #     -tcp-address 0.0.0.0:4150
+      #     -http-address 0.0.0.0:4151
+      #     -lookupd-tcp-address localhost:4160
+
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+
+      # UNCOMMENT IF YOU NEED DECRYPTING SECRETS
+      # - run:
+      #     name: Load secrets
+      #     command: npm run decrypt
+
+      - run:
+          name: Run Tests and Generate Code Coverage
+          command: npm run coverage
+
+      - run:
+          name: Check if coverage meets at least 70%
+          command: npx c8 check-coverage --functions 70 --lines 70 --statements 70
+
+      - store_artifacts:
+          path: coverage
+          prefix: coverage
+
+workflows:
+  version: 2.1
+  test-build-deploy:
+    jobs:
+      - install:
+          context: npm
+      - security-check:
+          requires:
+            - install
+      - license-check:
+          requires:
+            - install
+      - lint:
+          requires:
+            - install
+      - coverage:
+          requires:
+            - install
+      - docs:
+          requires:
+            - install

package/src/circle-srv.yml

@@ -0,0 +1,213 @@
+version: 2.1
+#orbs:
+#  gcp-gcr: circleci/gcp-gcr@0.6.1
+executors:
+  default:
+    description: >
+      A debian-based machine executor.
+    machine: true
+jobs:
+  install:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-npm-deps-{{ checksum "package-lock.json" }}
+            - v1-npm-deps-
+
+      - run:
+          name: Setup @leverege Token
+          command: echo \${NPMRC} > ~/.npmrc
+
+      - run: npm install
+
+      - save_cache:
+          key: v1-npm-deps-{{ checksum "package-lock.json" }}
+          paths:
+            - ./node_modules
+
+      - persist_to_workspace:
+          root: /home/circleci/project
+          paths:
+            - ./node_modules
+
+  security-check:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Check for vulnerabilities
+          command: npm audit --production --audit-level=moderate
+
+  license-check:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Check for LICENSE and README files
+          command: npm run pkglint
+
+      - run:
+          name: Check for license violations (e.g. GPL)
+          command: npx license-checker --production --summary --failOn GPL
+
+  lint:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Lint and save results
+          command: npm run lint-ci
+
+      - store_test_results:
+          path: reports
+
+  docs:
+    docker:
+      - image: $CIRCLE_NODE_IMG
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+      - run:
+          name: Generate docs
+          command: npx jsdoc -r src -R README.md -d docs
+      - store_artifacts:
+          path: docs
+          prefix: docs
+
+  coverage:
+    # coverage runs tests, generates coverage, and saves docs
+    environment:
+      TZ: 'America/New_York'
+    docker:
+      - image: $CIRCLE_NODE_IMG
+      # IF YOU NEED ANY OF THESE, UNCOMMENT TO USE
+      # - image: redis
+      # - image: circleci/mysql:5.7
+      #   environment:
+      #     MYSQL_USER: root
+      #     MYSQL_ROOT_PASSWORD: root
+      #     MYSQL_ALLOW_EMPTY_PASSWORD: true
+      #     MYSQL_HOST: 127.0.0.1
+      # - image: nsqio/nsq
+      #   command: /nsqlookupd -broadcast-address localhost:4160 -tcp-address 0.0.0.0:4160 -http-address 0.0.0.0:4161
+
+      # - image: nsqio/nsq
+      #   command: >
+      #     /nsqd
+      #     -broadcast-address localhost:4150
+      #     -tcp-address 0.0.0.0:4150
+      #     -http-address 0.0.0.0:4151
+      #     -lookupd-tcp-address localhost:4160
+
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+
+      # UNCOMMENT IF YOU NEED DECRYPTING SECRETS
+      # - run:
+      #     name: Load secrets
+      #     command: npm run decrypt
+
+      - run:
+          name: Run Tests and Generate Code Coverage
+          command: npm run coverage
+
+      - run:
+          name: Check if coverage meets at least 70%
+          command: npx c8 check-coverage --functions 70 --lines 70 --statements 70
+
+      - store_artifacts:
+          path: coverage
+          prefix: coverage
+
+  build:
+    # build should make dist image and prepare docker file
+    docker:
+      - image: $CIRCLE_NODE_IMG
+
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
+
+      - run:
+          name: Setup @leverege Token
+          command: echo \${NPMRC} > ~/.npmrc.ro
+
+      - run:
+          name: Determine version number and container name
+          command: |
+            container="\`node -p \"require('./package.json').leverege.container\"\`"
+            if [ "\$container" == "undefined" ];
+            then
+              container=\$CIRCLE_PROJECT_REPONAME
+            fi
+            NODE_IMAGE="\`node -p \"require('./package.json').leverege.nodeimg\"\`"
+
+            echo \$(git describe --tags) > package_version
+            echo \${container} > container_name
+            echo \${NODE_IMAGE} > node_img
+
+      - run:
+          name: Create Dockerfile and build dist directory
+          command: mkdir -p docker && npm run dockerize \$(git describe --tags)
+
+      - persist_to_workspace:
+          root: ~/project
+          paths:
+            - docker/*
+            - package_version
+            - container_name
+            - node_img
+
+workflows:
+  version: 2.1
+  test-build-deploy:
+    jobs:
+      - install:
+          context: npm
+      - security-check:
+          requires:
+            - install
+      - license-check:
+          requires:
+            - install
+      - lint:
+          requires:
+            - install
+      - coverage:
+          requires:
+            - install
+      - docs:
+          requires:
+            - install
+      - build:
+          context: npm
+          filters:
+            branches:
+              only:
+                - development
+                - /release-.*/
+                - master
+          requires:
+            - install
+            - security-check
+            - license-check
+            - lint
+            - coverage
+            - docs
+

package/src/firebaseDeploy.mjs

@@ -78,6 +78,7 @@ const targets = Object
           // 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,
@@ -209,7 +210,7 @@ try {
   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}`
+  await $`npm run clean && DOTENV_CONFIG_PATH=${path.join( process.cwd(), '.env.temp' )} npm run build && firebase use ${TARGET.projectId} && firebase ${deployType} --only ${hostingPrefix}${TARGET.siteId}`
 } catch ( err ) {
   console.error( err )
 }

package/src/firebaseServe.mjs

@@ -61,6 +61,7 @@ const targets = Object
       .entries( config.hosting )
       .forEach( ( [ siteId, aliases ] ) => {
         aliases.forEach( ( alias ) => {
+          // eslint-disable-next-line no-param-reassign
           prev[alias] = {
             projectId,
             siteId,
@@ -138,7 +139,7 @@ EXIT_EVENTS
 await fs.writeFile( path.join( process.cwd(), '.env.temp' ), envFileContent )
 
 try {
-  await $`DOTENV_CONFIG_PATH=${path.join( process.cwd(), '.env.temp' )} DEPLOYMENT_TARGET=${TARGET.siteId} npm run serve --colors`
+  await $`DOTENV_CONFIG_PATH=${path.join( process.cwd(), '.env.temp' )} npm run serve --colors`
 } catch ( err ) {
   console.error( err )
 }

package/src/getjson.mjs

@@ -18,7 +18,7 @@
 /**
  * Get a command line switch parser.
  */
-import fs from 'fs'
+import fs from 'node:fs'
 import cliArgs from 'command-line-args'
 import cliHelp from 'command-line-usage'
 
@@ -64,9 +64,9 @@ if ( !args.file ) {
 }
 
 try {
-  const json = JSON.parse( fs.readFileSync( args.file, 'utf8' ) )
+  const json = JSON.parse( fs.readFileSync( args.file, 'utf8' ) ) // eslint-disable-line security/detect-non-literal-fs-filename
   const value = json[args.key]
-  const match = new RegExp( args.regex || '.*' ).exec( value )
+  const match = new RegExp( args.regex || '.*' ).exec( value ) // eslint-disable-line security/detect-non-literal-regexp
 
   console.log( match ? match[match.length - 1] : '' )
 } catch ( e ) {

package/src/helm-charts/firebase-rules/firebase.json

@@ -0,0 +1,5 @@
+{
+  "database": [
+    {"target": "leverege", "rules": "leverege.rules.json"}
+  ]
+}

package/src/helm-charts/firebase-rules/firebaserc.ovh

@@ -0,0 +1,24 @@
+{
+  "projects": {
+    "default": "OVH:<PROJECT_ID>"
+  },
+  "targets": {
+    "OVH:<PROJECT_ID>": {
+      "database": {
+        "leverege": [
+          "OVH:<PROJECT_ID>",
+          "OVH:<PROJECT_ID>-rt-0",
+          "OVH:<PROJECT_ID>-rt-1",
+          "OVH:<PROJECT_ID>-rt-2",
+          "OVH:<PROJECT_ID>-rt-3",
+          "OVH:<PROJECT_ID>-rt-4",
+          "OVH:<PROJECT_ID>-rt-5",
+          "OVH:<PROJECT_ID>-rt-6",
+          "OVH:<PROJECT_ID>-rt-7",
+          "OVH:<PROJECT_ID>-rt-8",
+          "OVH:<PROJECT_ID>-rt-9"
+        ]
+      }
+    }
+  }
+}

package/src/helm-charts/firebase-rules/gitignore

@@ -0,0 +1,2 @@
+firebaserc
+.firebaserc

package/src/helm-charts/firebase-rules/helmup.plugin

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# make sure we're running from the proper dir
+cd $GITTOP/firebase-rules
+
+# grab a copy of existing rules - date time stamp DTS comes from bash-funcs
+firebase --project $GCP_PROJECT_ID \
+                   database:get /.settings/rules > leverege.rules.previous.json
+
+# copy the current ovh generated rc file to where firebase will find it
+cp firebaserc .firebaserc
+
+# Note: GCP_PROJECT_ID is passed down from helmup's environment.
+firebase --project $GCP_PROJECT_ID deploy --only database