leon/scripts/build-binaries.js

import path from 'node:path'
import fs from 'node:fs'

import { command } from 'execa'
import archiver from 'archiver'
import prettyBytes from 'pretty-bytes'

import {
  PYTHON_BRIDGE_SRC_PATH,
  PYTHON_TCP_SERVER_SRC_PATH,
  BINARIES_FOLDER_NAME,
  NODEJS_BRIDGE_DIST_PATH,
  PYTHON_BRIDGE_DIST_PATH,
  PYTHON_TCP_SERVER_DIST_PATH,
  NODEJS_BRIDGE_BIN_NAME,
  PYTHON_BRIDGE_BIN_NAME,
  PYTHON_TCP_SERVER_BIN_NAME,
  NODEJS_BRIDGE_ROOT_PATH
} from '@/constants'
import { OSTypes } from '@/types'
import { LogHelper } from '@/helpers/log-helper'
import { LoaderHelper } from '@/helpers/loader-helper'
import { SystemHelper } from '@/helpers/system-helper'

/**
 * Build binaries for the given OS according to the given build target
 * 1. Get the correct OS platform and CPU architecture
 * 2. If Linux, install the required dependencies
 * 3. Build the given build target
 * 4. Pack the distribution entities into a ZIP file
 */

const BUILD_TARGETS = new Map()

BUILD_TARGETS.set('nodejs-bridge', {
  name: 'Node.js bridge',
  needsPythonEnv: false,
  distPath: NODEJS_BRIDGE_DIST_PATH,
  archiveName: `${NODEJS_BRIDGE_BIN_NAME.split('.')[0]}.zip`
})
BUILD_TARGETS.set('python-bridge', {
  name: 'Python bridge',
  needsPythonEnv: true,
  pipfilePath: path.join(PYTHON_BRIDGE_SRC_PATH, 'Pipfile'),
  setupFilePath: path.join(PYTHON_BRIDGE_SRC_PATH, 'setup.py'),
  distPath: PYTHON_BRIDGE_DIST_PATH,
  archiveName: `${PYTHON_BRIDGE_BIN_NAME}-${BINARIES_FOLDER_NAME}.zip`,
  dotVenvPath: path.join(PYTHON_BRIDGE_SRC_PATH, '.venv')
})
BUILD_TARGETS.set('tcp-server', {
  name: 'Python TCP server',
  needsPythonEnv: true,
  pipfilePath: path.join(PYTHON_TCP_SERVER_SRC_PATH, 'Pipfile'),
  setupFilePath: path.join(PYTHON_TCP_SERVER_SRC_PATH, 'setup.py'),
  distPath: PYTHON_TCP_SERVER_DIST_PATH,
  archiveName: `${PYTHON_TCP_SERVER_BIN_NAME}-${BINARIES_FOLDER_NAME}.zip`,
  dotVenvPath: path.join(PYTHON_TCP_SERVER_SRC_PATH, '.venv')
})
;(async () => {
  LoaderHelper.start()

  const { argv } = process
  const givenBuildTarget = argv[2].toLowerCase()

  if (!BUILD_TARGETS.has(givenBuildTarget)) {
    LogHelper.error(
      `Invalid build target: ${givenBuildTarget}. Valid targets are: ${Array.from(
        BUILD_TARGETS.keys()
      ).join(', ')}`
    )
    process.exit(1)
  }

  const {
    name: buildTarget,
    needsPythonEnv,
    pipfilePath,
    setupFilePath,
    distPath,
    archiveName,
    dotVenvPath
  } = BUILD_TARGETS.get(givenBuildTarget)
  const buildPath = needsPythonEnv
    ? path.join(distPath, BINARIES_FOLDER_NAME)
    : path.join(distPath, 'bin')

  const { type: osType } = SystemHelper.getInformation()

  /**
   * Install requirements
   */
  try {
    if (needsPythonEnv && osType === OSTypes.Linux) {
      LogHelper.info('Checking whether the "patchelf" utility can be found...')

      await command('patchelf --version', { shell: true })

      LogHelper.success('The "patchelf" utility has been found')
    }
  } catch (e) {
    const installPatchelfCommand = 'sudo apt install patchelf'

    LogHelper.error(
      `The "patchelf" utility is not installed. Please run the following command: "${installPatchelfCommand}" or install it via a packages manager supported by your Linux distribution such as DNF, YUM, etc. Then try again`
    )
    process.exit(1)
  }

  LogHelper.info(`Building the ${buildTarget}...`)

  if (needsPythonEnv) {
    /**
     * Build for binaries requiring a Python environment
     */
    try {
      // Required environment variables to set up
      process.env.PIPENV_PIPFILE = pipfilePath
      process.env.PIPENV_VENV_IN_PROJECT = true

      /**
       * cx_Freeze usage
       * @see https://cx-freeze.readthedocs.io/en/latest/setup_script.html#build-exe
       */
      await command(
        `pipenv run python ${setupFilePath} build_exe --build-exe ${buildPath}`,
        {
          shell: true,
          stdio: 'inherit'
        }
      )

      LogHelper.success(`The ${buildTarget} has been built`)
    } catch (e) {
      LogHelper.error(
        `An error occurred while building the ${buildTarget}. Try to delete the ${dotVenvPath} folder, run the setup command then build again: ${e}`
      )
      process.exit(1)
    }
  } else {
    /**
     * Build for binaries not requiring a Python environment
     */
    try {
      const distBinPath = path.join(NODEJS_BRIDGE_DIST_PATH, 'bin')
      const distMainFilePath = path.join(distBinPath, 'index.js')
      const distRenamedMainFilePath = path.join(
        distBinPath,
        NODEJS_BRIDGE_BIN_NAME
      )

      await fs.promises.rm(buildPath, { recursive: true, force: true })

      const inputMainFilePath = path.join(
        NODEJS_BRIDGE_ROOT_PATH,
        'src',
        'main.ts'
      )

      await command(`ncc build ${inputMainFilePath} --out ${distBinPath}`, {
        shell: true,
        stdio: 'inherit'
      })

      await fs.promises.rename(distMainFilePath, distRenamedMainFilePath)

      LogHelper.success(`The ${buildTarget} has been built`)
    } catch (e) {
      LogHelper.error(
        `An error occurred while building the ${buildTarget}: ${e}`
      )
      process.exit(1)
    }
  }

  /**
   * Pack distribution entities into a ZIP archive
   */
  const archivePath = path.join(distPath, archiveName)
  LogHelper.info(`Packing to ${archivePath}...`)

  const output = fs.createWriteStream(archivePath)
  const archive = archiver('zip')

  output.on('close', () => {
    const size = prettyBytes(archive.pointer())

    LogHelper.info(`Total archive size: ${size}`)
    LogHelper.success(`${buildTarget} has been packed to ${archivePath}`)
    process.exit(0)
  })

  archive.on('error', (err) => {
    LogHelper.error(
      `An error occurred while packing the ${buildTarget}: ${err}`
    )
  })

  archive.pipe(output)

  if (needsPythonEnv) {
    archive.directory(buildPath, BINARIES_FOLDER_NAME)
  } else {
    archive.directory(buildPath, 'bin')
  }

  await archive.finalize()
})()