@uscreen.de/dev-service 0.13.1 → 0.14.0

package/src/check.js

@@ -1,9 +1,11 @@
 'use strict'
 
+import { exec } from 'node:child_process'
+import path from 'node:path'
 import fs from 'fs-extra'
-import path from 'path'
-import { exec } from 'child_process'
 import YAML from 'yaml'
+import { COMPOSE_DIR } from './constants.js'
+
 import {
   checkComposeDir,
   escape,
@@ -13,60 +15,6 @@ import {
   warning
 } from './utils.js'
 
-import { COMPOSE_DIR } from './constants.js'
-
-/**
- * Get paths to other running dev-service instances
- */
-export const checkOtherServices = async () => {
-  const paths = (await getComposePaths())
-    .filter((p) => p !== COMPOSE_DIR)
-    .filter((p) => p.endsWith('/services/.compose'))
-    .map((p) => p.replace(/\/services\/.compose$/, ''))
-
-  if (paths.length > 0) {
-    warning(
-      [
-        'dev-service is already running, started in following folder(s):',
-        ...paths.map((p) => `  ${p}`)
-      ].join('\n')
-    )
-  }
-}
-
-/**
- * check for processes using needed ports
- */
-export const checkUsedPorts = async (service) => {
-  if (!checkComposeDir()) {
-    throw Error('No services found. Try running `service install`')
-  }
-
-  const requiredPorts = getRequiredPorts(service)
-  const ownPorts = await getOwnPorts()
-  const ports = requiredPorts.filter((p) => !ownPorts.includes(p))
-
-  const portsToPids = await getPIDs(ports)
-
-  if (Object.keys(portsToPids).length === 0) return // everything ok
-
-  const pids = [...new Set(Object.values(portsToPids))]
-  const pidsToProcesses = await getProcesses(pids)
-
-  throw Error(
-    [
-      'Required port(s) are already allocated:',
-      ...Object.entries(portsToPids).map(
-        ([port, pid]) =>
-          `- port ${port} is used by process with pid ${pid}` +
-          (pidsToProcesses[pid] && pidsToProcesses[pid].cmd
-            ? ` (${pidsToProcesses[pid].cmd})`
-            : '')
-      )
-    ].join('\n')
-  )
-}
-
 /**
  * Get all ports required (by given service)
  */
@@ -74,24 +22,51 @@ const getRequiredPorts = (service) => {
   const files = getComposeFiles()
   const ports = []
   for (const f of files) {
-    if (service && `${service}.yml` !== f) continue
+    if (service && `${service}.yml` !== f) {
+      continue
+    }
 
     const yaml = YAML.parse(
       fs.readFileSync(path.resolve(COMPOSE_DIR, f), 'utf8')
     )
     ports.push(
       ...Object.values(yaml.services)
-        .map((v) => v.ports)
-        .filter((p) => p)
+        .map(v => v.ports)
+        .filter(p => p)
         .flat()
     )
   }
 
-  const uniquePorts = [...new Set(ports.map((p) => p.split(':')[0]))]
+  const uniquePorts = [...new Set(ports.map(p => p.split(':')[0]))]
 
   return uniquePorts
 }
 
+/**
+ * Get own ports
+ */
+const getContainerPorts = containerId =>
+  new Promise((resolve, reject) => {
+    exec(`docker port ${containerId}`, (err, stdout, stderr) => {
+      if (err) {
+        return reject(err)
+      }
+
+      const errMessage = stderr.toString().trim()
+      if (errMessage) {
+        return reject(new Error(errMessage))
+      }
+
+      const lines = stdout.split('\n').filter(l => l)
+      const ports = lines
+        .map(l => l.match(/.*:(\d+)/))
+        .map(m => (m.length >= 1 ? m[1] : null))
+        .filter(p => p)
+
+      resolve(ports)
+    })
+  })
+
 /**
  * get ports currently used by this services instance
  */
@@ -109,13 +84,17 @@ const getOwnPorts = () =>
 
     ps.push('ps', '-q')
 
-    exec(`docker-compose ${ps.join(' ')}`, function (err, stdout, stderr) {
-      if (err) return reject(err)
+    exec(`docker-compose ${ps.join(' ')}`, (err, stdout, stderr) => {
+      if (err) {
+        return reject(err)
+      }
 
       const errMessage = stderr.toString().trim()
-      if (errMessage) return reject(Error(errMessage))
+      if (errMessage) {
+        return reject(new Error(errMessage))
+      }
 
-      const ids = stdout.split('\n').filter((id) => id)
+      const ids = stdout.split('\n').filter(id => id)
 
       Promise.all(ids.map(getContainerPorts)).then((ps) => {
         const ports = [].concat(...ps)
@@ -125,23 +104,27 @@ const getOwnPorts = () =>
   })
 
 /**
- * Get own ports
+ * Find process listening to given port
  */
-const getContainerPorts = (containerId) =>
-  new Promise((resolve, reject) => {
-    exec(`docker port ${containerId}`, function (err, stdout, stderr) {
-      if (err) return reject(err)
+const getPID = port =>
+  new Promise((resolve) => {
+    exec(`lsof -nP -i:${port}`, (_, stdout) => {
+      // `lsof` already returns a non-zero exit code if it did not find any running
+      // process for the given port. Therefore we refrain from rejecting this Promise
+      // if an error was handed over.
 
-      const errMessage = stderr.toString().trim()
-      if (errMessage) return reject(Error(errMessage))
+      const process = stdout
+        .toString()
+        .split(/\n/)
+        .filter(r => r)
+        .map(r => r.split(/\s+/))
+        .find(r => (r[9] || '').match(/(LISTEN)/))
 
-      const lines = stdout.split('\n').filter((l) => l)
-      const ports = lines
-        .map((l) => l.match(/.*:(\d+)/))
-        .map((m) => (m.length >= 1 ? m[1] : null))
-        .filter((p) => p)
+      if (!process) {
+        return resolve(null)
+      }
 
-      resolve(ports)
+      resolve(process[1])
     })
   })
 
@@ -162,26 +145,39 @@ const getPIDs = async (ports) => {
 }
 
 /**
- * Find process listening to given port
+ * Get process details for given pid
  */
-const getPID = (port) =>
+const getProcess = async pid =>
   new Promise((resolve, reject) => {
-    exec(`lsof -nP -i:${port}`, function (_, stdout, stderr) {
-      // `lsof` already returns a non-zero exit code if it did not find any running
-      // process for the given port. Therefore we refrain from rejecting this Promise
-      // if an error was handed over.
+    exec(
+      `ps -p ${pid} -ww -o pid,ppid,uid,gid,args`,
+      (err, stdout, stderr) => {
+        if (err) {
+          return reject(err)
+        }
 
-      const process = stdout
-        .toString()
-        .split(/\n/)
-        .filter((r) => r)
-        .map((r) => r.split(/\s+/))
-        .find((r) => (r[9] || '').match(/(LISTEN)/))
+        const errMessage = stderr.toString().trim()
+        if (errMessage) {
+          return reject(new Error(errMessage))
+        }
 
-      if (!process) return resolve(null)
+        const processes = stdout
+          .toString()
+          .split(/\n/)
+          .slice(1) // skip headers
+          .filter(r => r)
+          .map(r => r.split(/\s+/))
+          .map(([pid, ppid, uid, gid, ...args]) => ({
+            pid,
+            ppid,
+            uid,
+            gid,
+            cmd: args.join(' ')
+          }))
 
-      resolve(process[1])
-    })
+        resolve(processes[0])
+      }
+    )
   })
 
 /**
@@ -201,33 +197,56 @@ const getProcesses = async (pids) => {
 }
 
 /**
- * Get process details for given pid
+ * Get paths to other running dev-service instances
  */
-const getProcess = async (pid) =>
-  new Promise((resolve, reject) => {
-    exec(
-      `ps -p ${pid} -ww -o pid,ppid,uid,gid,args`,
-      function (err, stdout, stderr) {
-        if (err) return reject(err)
+export const checkOtherServices = async () => {
+  const paths = (await getComposePaths())
+    .filter(p => p !== COMPOSE_DIR)
+    .filter(p => p.endsWith('/services/.compose'))
+    .map(p => p.replace(/\/services\/.compose$/, ''))
 
-        const errMessage = stderr.toString().trim()
-        if (errMessage) return reject(Error(errMessage))
+  if (paths.length > 0) {
+    warning(
+      [
+        'dev-service is already running, started in following folder(s):',
+        ...paths.map(p => `  ${p}`)
+      ].join('\n')
+    )
+  }
+}
 
-        const processes = stdout
-          .toString()
-          .split(/\n/)
-          .slice(1) // skip headers
-          .filter((r) => r)
-          .map((r) => r.split(/\s+/))
-          .map(([pid, ppid, uid, gid, ...args]) => ({
-            pid,
-            ppid,
-            uid,
-            gid,
-            cmd: args.join(' ')
-          }))
+/**
+ * check for processes using needed ports
+ */
+export const checkUsedPorts = async (service) => {
+  if (!checkComposeDir()) {
+    throw new Error('No services found. Try running `service install`')
+  }
 
-        resolve(processes[0])
-      }
-    )
-  })
+  const requiredPorts = getRequiredPorts(service)
+  const ownPorts = await getOwnPorts()
+  const ports = requiredPorts.filter(p => !ownPorts.includes(p))
+
+  const portsToPids = await getPIDs(ports)
+
+  if (Object.keys(portsToPids).length === 0) {
+    // everything ok
+    return
+  }
+
+  const pids = [...new Set(Object.values(portsToPids))]
+  const pidsToProcesses = await getProcesses(pids)
+
+  throw new Error(
+    [
+      'Required port(s) are already allocated:',
+      ...Object.entries(portsToPids).map(
+        ([port, pid]) =>
+          `- port ${port} is used by process with pid ${pid}${
+            pidsToProcesses[pid] && pidsToProcesses[pid].cmd
+              ? ` (${pidsToProcesses[pid].cmd})`
+              : ''}`
+      )
+    ].join('\n')
+  )
+}

package/src/constants.js

@@ -1,8 +1,9 @@
 'use strict'
 
-import path from 'path'
-import { createRequire } from 'module'
-import { fileURLToPath } from 'url'
+import { createRequire } from 'node:module'
+import path from 'node:path'
+import process from 'node:process'
+import { fileURLToPath } from 'node:url'
 
 const require = createRequire(import.meta.url)
 const __filename = fileURLToPath(import.meta.url)
@@ -14,6 +15,7 @@ const __dirname = path.dirname(__filename)
 
 // Dev-Service
 export const { version } = require('../package.json')
+
 export const TEMPLATES_DIR = path.resolve(__dirname, '../templates')
 
 // Project

package/src/install.js

@@ -1,26 +1,26 @@
 'use strict'
 
-import path from 'path'
-import os from 'os'
+import os from 'node:os'
+import path from 'node:path'
 import fs from 'fs-extra'
-import YAML from 'yaml'
-import parseJson from 'parse-json'
 import { customAlphabet } from 'nanoid'
+import parseJson from 'parse-json'
+import YAML from 'yaml'
 
 import {
-  TEMPLATES_DIR,
-  SERVICES_DIR,
-  COMPOSE_DIR,
-  VOLUMES_DIR
-} from './constants.js'
-
-import {
-  readPackageJson,
-  escape,
   docker,
+  escape,
+  readPackageJson,
   resetComposeDir
 } from '../src/utils.js'
 
+import {
+  COMPOSE_DIR,
+  SERVICES_DIR,
+  TEMPLATES_DIR,
+  VOLUMES_DIR
+} from './constants.js'
+
 const nanoid = customAlphabet(
   '1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
   12
@@ -32,7 +32,7 @@ const OPTIONS_PATH = path.resolve(SERVICES_DIR, '.options')
  * Helper methods
  */
 const getName = (service) => {
-  const withoutTag = service.replace(/:[a-z0-9_][a-z0-9_.-]{0,127}$/i, '')
+  const withoutTag = service.replace(/:\w[\w.-]{0,127}$/, '')
   const [name] = withoutTag.split('/').slice(-1)
 
   return name
@@ -59,9 +59,9 @@ const fillTemplate = (template, data, removeSections, keepSections) => {
 }
 
 const getOptions = () => {
-  const raw =
-    fs.existsSync(OPTIONS_PATH) &&
-    fs.readFileSync(OPTIONS_PATH, { encoding: 'utf-8' })
+  const raw
+    = fs.existsSync(OPTIONS_PATH)
+      && fs.readFileSync(OPTIONS_PATH, { encoding: 'utf-8' })
 
   return raw ? parseJson(raw) : {}
 }
@@ -78,20 +78,26 @@ const ensureVolumesDir = async () => {
 
 const ensureNamedVolumes = async (content) => {
   const data = YAML.parse(content)
-  if (!data || !data.volumes) return
+  if (!data || !data.volumes) {
+    return
+  }
 
   const volumes = []
   for (const key in data.volumes) {
-    if (!data.volumes[key]) continue
+    if (!data.volumes[key]) {
+      continue
+    }
 
     const name = data.volumes[key].name
-    if (!name) continue
+    if (!name) {
+      continue
+    }
 
     volumes.push(name)
   }
 
   await Promise.all(
-    volumes.map((v) =>
+    volumes.map(v =>
       docker('volume', 'create', `--name=${v}`, '--label=keep')
     )
   )
@@ -112,14 +118,6 @@ const copyAdditionalFiles = (name) => {
   }
 }
 
-const readServiceData = (service) => {
-  if (typeof service === 'string') {
-    return readStandardServiceData(service)
-  } else if (typeof service === 'object') {
-    return readCustomServiceData(service)
-  }
-}
-
 const readCustomServiceData = (service) => {
   const image = service.image
   const name = getName(image)
@@ -133,14 +131,18 @@ const readCustomServiceData = (service) => {
       const volumeArray = volume.split(':')
 
       // volume is unnamed:
-      if (volumeArray.length === 1) continue
+      if (volumeArray.length === 1) {
+        continue
+      }
 
       // => volume is named or mapped to a host path:
       const [volumeName] = volumeArray
 
       // volume has invalid volume name / volume is mapped to a host path
       // (@see https://github.com/moby/moby/issues/21786):
-      if (!volumeName.match(/^[a-zA-Z0-9][a-zA-Z0-9_.-]+$/)) continue
+      if (!volumeName.match(/^[a-z0-9][\w.-]+$/i)) {
+        continue
+      }
 
       // volume is named => we add it to top level "volumes" directive:
       volumes[volumeName] = {
@@ -172,14 +174,25 @@ const readStandardServiceData = (service) => {
   const result = { image: service, name }
 
   const exists = fs.existsSync(src)
-  if (exists) result.template = fs.readFileSync(src, { encoding: 'utf8' })
+  if (exists) {
+    result.template = fs.readFileSync(src, { encoding: 'utf8' })
+  }
 
   return result
 }
 
+const readServiceData = (service) => {
+  if (typeof service === 'string') {
+    return readStandardServiceData(service)
+  }
+  else if (typeof service === 'object') {
+    return readCustomServiceData(service)
+  }
+}
+
 const serviceInstall = async (data, projectname, volumeType, volumesPrefix) => {
   const removeSections = ['mapped-volumes', 'named-volumes'].filter(
-    (e) => e !== volumeType
+    e => e !== volumeType
   )
   const keepSections = [volumeType]
 
@@ -213,14 +226,14 @@ export const install = async (opts) => {
   const projectname = escape(name)
 
   // cleanse services from falsy values:
-  const services = all.filter((s) => s)
+  const services = all.filter(s => s)
 
   // validate custom services:
-  const invalid = services.filter((s) => typeof s === 'object' && !s.image)
+  const invalid = services.filter(s => typeof s === 'object' && !s.image)
   if (invalid.length > 0) {
-    throw Error(
+    throw new Error(
       `Invalid custom services:\n${invalid
-        .map((i) => JSON.stringify(i, null, 2))
+        .map(i => JSON.stringify(i, null, 2))
         .join(',\n')}`
     )
   }
@@ -229,9 +242,9 @@ export const install = async (opts) => {
   const data = services.map(readServiceData)
 
   // exit if not all services' images are supported:
-  const unsupported = data.filter((d) => !d.template).map((d) => d.name)
+  const unsupported = data.filter(d => !d.template).map(d => d.name)
   if (unsupported.length > 0) {
-    throw Error(`Unsupported services: ${unsupported.join(', ')}`)
+    throw new Error(`Unsupported services: ${unsupported.join(', ')}`)
   }
 
   // install services:
@@ -267,18 +280,20 @@ export const install = async (opts) => {
   if (options.volumes && options.volumes.mode === 'volumes-id') {
     const volumesPrefix = options.volumes.id
     await Promise.all(
-      data.map((d) =>
+      data.map(d =>
         serviceInstall(d, projectname, 'named-volumes', volumesPrefix)
       )
     )
-  } else if (options.volumes && options.volumes.mode === 'mapped-volumes') {
+  }
+  else if (options.volumes && options.volumes.mode === 'mapped-volumes') {
     await Promise.all(
-      data.map((d) => serviceInstall(d, projectname, 'mapped-volumes'))
+      data.map(d => serviceInstall(d, projectname, 'mapped-volumes'))
     )
-  } else {
+  }
+  else {
     const volumesPrefix = projectname
     await Promise.all(
-      data.map((d) =>
+      data.map(d =>
         serviceInstall(d, projectname, 'named-volumes', volumesPrefix)
       )
     )

package/src/status.js

@@ -0,0 +1,63 @@
+'use strict'
+
+import { exec } from 'node:child_process'
+import chalk from 'chalk'
+import { getComposeCommand } from './utils.js'
+
+const execOutput = cmd =>
+  new Promise((resolve) => {
+    exec(cmd, (err, stdout) => {
+      resolve(err ? null : stdout.trim())
+    })
+  })
+
+export const status = async () => {
+  const preferredCmd = await getComposeCommand()
+
+  const [
+    dockerPath,
+    dockerVersion,
+    composePluginVersion,
+    dockerComposePath,
+    dockerComposeVersion
+  ] = await Promise.all([
+    execOutput('which docker'),
+    execOutput('docker --version'),
+    execOutput('docker compose version --short'),
+    execOutput('which docker-compose'),
+    execOutput('docker-compose --version')
+  ])
+
+  console.log('\nDetected tools:\n')
+
+  if (dockerPath) {
+    console.log(`  docker          ${chalk.dim(dockerPath)}`)
+    console.log(`                  ${dockerVersion || chalk.yellow('version unknown')}`)
+  }
+  else {
+    console.log(`  docker          ${chalk.red('not found')}`)
+  }
+
+  console.log('')
+
+  const pluginActive = preferredCmd === 'docker compose'
+
+  if (composePluginVersion) {
+    const label = pluginActive ? chalk.green(' [active]') : ''
+    console.log(`  docker compose  plugin  ${composePluginVersion}${label}`)
+  }
+  else {
+    console.log(`  docker compose  ${chalk.dim('not available')}`)
+  }
+
+  if (dockerComposePath) {
+    const label = !pluginActive ? chalk.green(' [active]') : ''
+    console.log(`  docker-compose  ${chalk.dim(dockerComposePath)}`)
+    console.log(`                  ${dockerComposeVersion || chalk.yellow('version unknown')}${label}`)
+  }
+  else {
+    console.log(`  docker-compose  ${chalk.dim('not found')}`)
+  }
+
+  console.log('')
+}