fix(linux): Improve dependency checks (#195)

* Add some package management logic

* Improve wording and skip install if not an apt-based distro

* Use dependency package tools for esp32 setup

* Change device alias back to lin

* Use dependency detection for system packages on esp8266

* Fix imports after the files have been renamed

* Fix format and lint errors

* Use === for comparison

* Fix the pylib dependency check

* Rebase and clean up merge conflicts

* Ensure that Linux setup and update works with correct filenames

Author: dahenson

src/toolbox/prompt/devices.ts

@@ -8,8 +8,8 @@ export const DEVICE_ALIAS: Record<Device | 'esp', Device> = Object.freeze({
   windows_nt: 'windows',
   windows: 'windows',
   win: 'windows',
-  linux: 'linux',
-  lin: 'linux',
+  linux: 'lin',
+  lin: 'lin',
   esp32: 'esp32',
   wasm: 'wasm',
   pico: 'pico',

src/toolbox/setup/esp32/linux.ts

@@ -1,13 +1,31 @@
 import type { GluegunPrint } from 'gluegun'
-import { execWithSudo } from '../../system/exec'
+import type { Dependency } from '../../system/types'
+import { findMissingDependencies, installPackages } from '../../system/packages'
 
-// apt-get install git wget flex bison gperf python-is-python3 python3-pip python3-serial python-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util
 export async function installDeps(
   spinner: ReturnType<GluegunPrint['spin']>,
 ): Promise<void> {
-  await execWithSudo(
-    'apt-get install --yes git wget flex bison gperf python-is-python3 python3-pip python3-serial python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util',
-    { stdout: process.stdout },
-  )
+  const dependencies: Dependency[] = [
+    { name: 'bison', packageName: 'bison', type: 'binary' },
+    { name: 'ccache', packageName: 'ccache', type: 'binary' },
+    { name: 'cmake', packageName: 'cmake', type: 'binary' },
+    { name: 'dfu-util', packageName: 'dfu-util', type: 'binary' },
+    { name: 'flex', packageName: 'flex', type: 'binary' },
+    { name: 'git', packageName: 'git', type: 'binary' },
+    { name: 'gperf', packageName: 'gperf', type: 'binary' },
+    { name: 'libffi', packageName: 'libffi-dev', type: 'library' },
+    { name: 'libssl', packageName: 'libssl-dev', type: 'library' },
+    { name: 'ninja', packageName: 'ninja-build', type: 'binary' },
+    { name: 'pip', packageName: 'python-pip', type: 'binary' },
+    { name: 'pyserial-miniterm', packageName: 'python3-serial', type: 'binary' },
+    { name: 'python', packageName: 'python-is-python3', type: 'binary' },
+    { name: 'setuptools', packageName: 'python3-setuptools', type: 'pylib' },
+    { name: 'wget', packageName: 'wget', type: 'binary' },
+  ]
+
+  const missingDependencies = await findMissingDependencies(dependencies)
+  if (missingDependencies.length !== 0) {
+    await installPackages(missingDependencies)
+  }
   spinner.succeed()
 }

src/toolbox/setup/esp8266/linux.ts

@@ -1,13 +1,20 @@
 import type { GluegunPrint } from 'gluegun'
-import { execWithSudo } from '../../system/exec'
+import type { Dependency } from '../../system/types'
+import { findMissingDependencies, installPackages } from '../../system/packages'
 
 export async function installDeps(
   spinner: ReturnType<GluegunPrint['spin']>,
 ): Promise<void> {
   spinner.start('Installing python deps with apt-get')
-  await execWithSudo(
-    'apt-get install --yes python-is-python3 python3-pip python3-serial',
-    { stdout: process.stdout },
-  )
+  const dependencies: Dependency[] = [
+    { name: 'pip', packageName: 'python-pip', type: 'binary' },
+    { name: 'pyserial-miniterm', packageName: 'python3-serial', type: 'binary' },
+    { name: 'python', packageName: 'python-is-python3', type: 'binary' },
+  ]
+
+  const missingDependencies = await findMissingDependencies(dependencies)
+  if (missingDependencies.length !== 0) {
+    await installPackages(missingDependencies)
+  }
   spinner.succeed()
 }

src/toolbox/setup/linux.ts src/toolbox/setup/lin.tssrc/toolbox/setup/linux.ts renamed to src/toolbox/setup/lin.ts

@@ -10,6 +10,8 @@ import {
 } from './constants'
 import upsert from '../patching/upsert'
 import { execWithSudo } from '../system/exec'
+import { findMissingDependencies, installPackages } from '../system/packages'
+import type { Dependency } from '../system/types'
 import type { PlatformSetupArgs } from './types'
 import { fetchRelease, downloadReleaseTools } from './moddable'
 
@@ -48,24 +50,29 @@ export default async function ({
   const spinner = print.spin()
   spinner.start('Beginning setup...')
 
-  // 0. clone moddable repo into ./local/share directory if it does not exist yet
   filesystem.dir(INSTALL_DIR)
 
-  await upsert(EXPORTS_FILE_PATH, `# Generated by xs-dev CLI`)
+  // 0. check for the required build tools and libraries
+  const dependencies: Dependency[] = [
+    { name: 'bison', packageName: 'bison', type: 'binary' },
+    { name: 'flex', packageName: 'flex', type: 'binary' },
+    { name: 'gcc', packageName: 'gcc', type: 'binary' },
+    { name: 'git', packageName: 'git', type: 'binary' },
+    { name: 'gperf', packageName: 'gperf', type: 'binary' },
+    { name: 'make', packageName: 'make', type: 'binary' },
+    { name: 'wget', packageName: 'wget', type: 'binary' },
+    { name: 'ncurses', packageName: 'libncurses-dev', type: 'library' },
+    { name: 'gtk+-3.0', packageName: 'libgtk-3-dev', type: 'library' }
+  ]
+
+  spinner.start('Checking for missing dependencies...')
+  const missingDependencies = await findMissingDependencies(dependencies)
 
   // 1. Install or update the packages required to compile:
-  spinner.start('Installing dependencies...')
-  await execWithSudo(
-    'apt-get install --yes gcc git wget make libncurses-dev flex bison gperf',
-    { stdout: process.stdout },
-  )
-  spinner.succeed()
-
-  // 2. Install the development version of the GTK+ 3 library
-  spinner.start('Installing GTK+ 3...')
-  await execWithSudo('apt-get --yes install libgtk-3-dev', {
-    stdout: process.stdout,
-  })
+  spinner.start('Attempting to install dependencies...')
+  if (missingDependencies.length !== 0) {
+    await installPackages(missingDependencies)
+  }
   spinner.succeed()
 
   // 3. Download the Moddable repository, or use the git command line tool as follows:
@@ -140,6 +147,7 @@ export default async function ({
   process.env.MODDABLE = INSTALL_PATH
   process.env.PATH = `${String(process.env.PATH)}:${BIN_PATH}`
 
+  await upsert(EXPORTS_FILE_PATH, `# Generated by xs-dev CLI`)
   await upsert(EXPORTS_FILE_PATH, `export MODDABLE=${process.env.MODDABLE}`)
   await upsert(EXPORTS_FILE_PATH, `export PATH="${BIN_PATH}:$PATH"`)
 

src/toolbox/system/exec.ts

@@ -37,6 +37,16 @@ export async function execWithSudo(
   await system.exec(`sudo --askpass --preserve-env ${command}`, options)
 }
 
+/**
+ * Use Policykit pkexec to run the command as an admin user
+ */
+export async function pkexec(
+  command: string,
+  options: Record<string, unknown> = {},
+): Promise <void> {
+  await system.exec(`pkexec ${command}`, options)
+}
+
 /**
  * Utility for updating in-memory process.env after running a command
  */

src/toolbox/system/packages.ts

@@ -0,0 +1,56 @@
+import type { Dependency } from './types'
+import { pkexec } from '../system/exec'
+import { print, system } from 'gluegun'
+
+/**
+ * Check if the list of dependencies are installed on the system.
+ **/
+export async function findMissingDependencies(dependencies: Dependency[]): Promise<Dependency[]> {
+  const missingDependencies: Dependency[] = []
+
+  for (const dep of dependencies) {
+    if (dep.type === 'binary') {
+      if (system.which(dep.name) === null) {
+        missingDependencies.push(dep)
+      }
+    }
+    if (dep.type === 'library') {
+      try {
+        await system.run(`pkg-config --exists ${dep.name}`)
+      } catch (error) {
+        missingDependencies.push(dep)
+      }
+    }
+    if (dep.type === 'pylib') {
+      try {
+        await system.run(`pip3 show ${dep.name}`)
+      } catch (error) {
+        missingDependencies.push(dep)
+      }
+    }
+  }
+
+  return missingDependencies
+}
+
+/**
+ * Attempt to install packages on the linux platform.
+ **/
+export async function installPackages(packages: Dependency[]): Promise<void> {
+  const packageManager = system.which('apt')
+
+  if (packageManager !== null && packageManager !== undefined) {
+    await pkexec(
+      `${packageManager} install --yes ${packages.map((p) => p.packageName).join(' ')}`,
+      { stdout: process.stdout },
+    )
+  } else {
+    print.warning(
+      'xs-dev attempted to install dependencies, but does not yet support your package manager',
+    )
+    print.warning(
+      `Please install these dependencies before running this command again: ${packages.map((p) => p.packageName).join(', ')}`,
+    )
+    process.exit(1)
+  }
+}

src/toolbox/system/types.ts

@@ -0,0 +1,5 @@
+export interface Dependency {
+  name: string
+  packageName: string
+  type: 'binary' | 'library' | 'pylib'
+}