Merge pull request #16 from ernilambar/update-error-codes

Update error codes

Author: ernilambar

index.js

@@ -6,6 +6,8 @@
  * Deploys a WordPress plugin or theme to the WordPress.org SVN repo.
  * Config is read from package.json under the "wpDeployer" key.
  * Run from the project root (where package.json and wpDeployer config live).
+ *
+ * Exit codes: 0 success, 1 config/validation/preflight, 2 deploy failure, 130 SIGINT.
  */
 
 import fs from 'fs-extra'
@@ -14,6 +16,9 @@ import { exec as execCb } from 'child_process'
 import { promisify } from 'util'
 import { resolveSettings } from './lib/config.js'
 import { createPluginSteps, createThemeSteps } from './lib/steps.js'
+import { runPreflightSync } from './lib/preflight.js'
+import { DeployError } from './lib/deploy-error.js'
+import { EXIT_SUCCESS, EXIT_CONFIG, EXIT_RUNTIME, EXIT_SIGINT } from './lib/exit-codes.js'
 
 const exec = promisify(execCb)
 
@@ -22,20 +27,51 @@ const pkg = fs.readJsonSync('./package.json')
 const awk = process.platform === 'win32' ? 'gawk' : 'awk'
 const noRunIfEmpty = process.platform !== 'darwin' ? '--no-run-if-empty ' : ''
 
+process.on('SIGINT', () => {
+  console.error(chalk.yellow('Interrupted.'))
+  process.exit(EXIT_SIGINT)
+})
+
 const wpDeployer = async () => {
   console.log(chalk.cyan('Processing...'))
 
-  const { settings, error } = resolveSettings(pkg)
+  const { settings, error, errorMessage } = resolveSettings(pkg)
+  if (error === 'invalid_slug') {
+    console.error(chalk.red(`Invalid slug: ${errorMessage}`))
+    return EXIT_CONFIG
+  }
   if (error === 'username_required') {
     console.error(chalk.red('Username is required.'))
-    process.exit()
+    return EXIT_CONFIG
   }
   if (error === 'theme_earlier_version_required') {
     console.error(chalk.red('For repoType theme, earlierVersion is required.'))
-    process.exit()
+    return EXIT_CONFIG
+  }
+  if (error === 'invalid_new_version') {
+    console.error(chalk.red(`Invalid package version for SVN (newVersion): ${errorMessage}`))
+    return EXIT_CONFIG
+  }
+  if (error === 'invalid_earlier_version') {
+    console.error(chalk.red(`Invalid earlierVersion for SVN: ${errorMessage}`))
+    return EXIT_CONFIG
+  }
+  if (error === 'invalid_svn_url') {
+    console.error(chalk.red(`Invalid SVN URL: ${errorMessage}`))
+    return EXIT_CONFIG
   }
 
-  const helpers = { exec, chalk, fs, awk, noRunIfEmpty }
+  try {
+    runPreflightSync(settings, { fs, awk })
+  } catch (e) {
+    if (e instanceof DeployError) {
+      console.error(chalk.red(e.message))
+      return e.exitCode
+    }
+    throw e
+  }
+
+  const helpers = { exec, fs, awk, noRunIfEmpty }
   const steps = settings.repoType === 'plugin'
     ? createPluginSteps(settings, helpers)
     : createThemeSteps(settings, helpers)
@@ -45,9 +81,23 @@ const wpDeployer = async () => {
     for (const step of steps) {
       s = await step(s)
     }
+    console.log(chalk.green('Finished successfully.'))
+    return EXIT_SUCCESS
   } catch (err) {
-    console.error(chalk.red(err))
+    console.error(chalk.red(err?.message || err))
+    return EXIT_RUNTIME
   }
 }
 
 wpDeployer()
+  .then((code) => {
+    process.exit(code ?? EXIT_SUCCESS)
+  })
+  .catch((err) => {
+    if (err instanceof DeployError) {
+      console.error(chalk.red(err.message))
+      process.exit(err.exitCode)
+    }
+    console.error(chalk.red(err?.message || err))
+    process.exit(EXIT_RUNTIME)
+  })

lib/config.js

@@ -4,11 +4,14 @@
  */
 
 import merge from 'just-merge'
+import { validateSvnSafeVersion, validateSvnUrl } from './validators/index.js'
+import { hasPathUnsafeChars } from './validators/shared.js'
 
 export function getDefaults (pkg) {
   return {
     url: '',
     slug: `${pkg.name}`,
+    // Seeded from pkg.name; resolveSettings aligns with slug when wpDeployer omits mainFile
     mainFile: `${pkg.name}.php`,
     username: '',
     repoType: 'plugin',
@@ -27,26 +30,60 @@ export function getDefaults (pkg) {
 /**
  * Resolve settings from package.json. Does not exit; returns an error key if validation fails.
  * @param {object} pkg - Parsed package.json (must have name, version)
- * @returns {{ settings: object, error: null | 'username_required' | 'theme_earlier_version_required' }}
+ * @returns {{ settings: object, error: null | 'invalid_slug' | 'username_required' | 'theme_earlier_version_required' | 'invalid_svn_url' | 'invalid_new_version' | 'invalid_earlier_version', errorMessage?: string }}
  */
 export function resolveSettings (pkg) {
   const defaults = getDefaults(pkg)
-  let settings = merge(defaults, Object.prototype.hasOwnProperty.call(pkg, 'wpDeployer') ? pkg.wpDeployer : {})
+  const wpDeployer = Object.prototype.hasOwnProperty.call(pkg, 'wpDeployer') ? pkg.wpDeployer : {}
+  let settings = merge(defaults, wpDeployer)
+
+  const slug = settings.slug
+  if (typeof slug !== 'string' || slug.length === 0) {
+    return { settings, error: 'invalid_slug', errorMessage: 'slug must be a non-empty string.' }
+  }
+  if (slug !== slug.trim()) {
+    return { settings, error: 'invalid_slug', errorMessage: 'slug must not have leading or trailing whitespace.' }
+  }
+  if (slug === '.' || slug === '..' || slug.includes('..')) {
+    return { settings, error: 'invalid_slug', errorMessage: 'slug must not be "." or ".." or contain "..".' }
+  }
+  if (hasPathUnsafeChars(slug)) {
+    return {
+      settings,
+      error: 'invalid_slug',
+      errorMessage: 'slug must be a single path segment (no / or \\).'
+    }
+  }
+
+  if (!Object.prototype.hasOwnProperty.call(wpDeployer, 'mainFile')) {
+    settings.mainFile = `${settings.slug}.php`
+  }
 
   settings = merge(settings, {
     svnPath: settings.tmpDir.replace(/\/$|$/, '/') + settings.slug
   })
 
   settings.buildDir = settings.buildDir.replace(/\/$|$/, '/')
 
+  // Default WordPress.org SVN URLs follow `slug` (merged default: pkg.name), not pkg.name directly.
   if (!settings.url) {
     if (settings.repoType === 'plugin') {
-      settings.url = `https://plugins.svn.wordpress.org/${pkg.name}/`
+      settings.url = `https://plugins.svn.wordpress.org/${settings.slug}/`
     } else if (settings.repoType === 'theme') {
-      settings.url = `https://themes.svn.wordpress.org/${pkg.name}/`
+      settings.url = `https://themes.svn.wordpress.org/${settings.slug}/`
     }
   }
 
+  const urlResult = validateSvnUrl(settings.url)
+  if (!urlResult.ok) {
+    return {
+      settings,
+      error: 'invalid_svn_url',
+      errorMessage: urlResult.message
+    }
+  }
+  settings.url = urlResult.value
+
   if (!settings.username) {
     return { settings, error: 'username_required' }
   }
@@ -55,5 +92,27 @@ export function resolveSettings (pkg) {
     return { settings, error: 'theme_earlier_version_required' }
   }
 
+  const newVersionResult = validateSvnSafeVersion(settings.newVersion)
+  if (!newVersionResult.ok) {
+    return {
+      settings,
+      error: 'invalid_new_version',
+      errorMessage: newVersionResult.message
+    }
+  }
+  settings.newVersion = newVersionResult.value
+
+  if (settings.repoType === 'theme') {
+    const earlierResult = validateSvnSafeVersion(settings.earlierVersion)
+    if (!earlierResult.ok) {
+      return {
+        settings,
+        error: 'invalid_earlier_version',
+        errorMessage: earlierResult.message
+      }
+    }
+    settings.earlierVersion = earlierResult.value
+  }
+
   return { settings, error: null }
 }

lib/deploy-error.js

@@ -0,0 +1,16 @@
+import { EXIT_RUNTIME } from './exit-codes.js'
+
+/**
+ * Error with explicit CLI exit code (preflight / deploy).
+ */
+export class DeployError extends Error {
+  /**
+   * @param {string} message
+   * @param {number} [exitCode=EXIT_RUNTIME]
+   */
+  constructor (message, exitCode = EXIT_RUNTIME) {
+    super(message)
+    this.name = 'DeployError'
+    this.exitCode = exitCode
+  }
+}

lib/exit-codes.js

@@ -0,0 +1,8 @@
+/** Process exit codes for the wp-deployer CLI */
+export const EXIT_SUCCESS = 0
+/** Invalid config, validation, or preflight (environment / paths) */
+export const EXIT_CONFIG = 1
+/** Deploy pipeline / SVN / filesystem failure */
+export const EXIT_RUNTIME = 2
+/** User interrupt */
+export const EXIT_SIGINT = 130

lib/preflight.js

@@ -0,0 +1,103 @@
+/**
+ * Pre-deploy checks: required tools on PATH, build/assets directories.
+ */
+
+import path from 'path'
+import { execSync } from 'child_process'
+import { DeployError } from './deploy-error.js'
+import { EXIT_CONFIG } from './exit-codes.js'
+
+/**
+ * @param {string} command - Executable name (no spaces)
+ */
+function assertOnPath (command) {
+  try {
+    if (process.platform === 'win32') {
+      execSync(`where ${command}`, { stdio: 'ignore' })
+    } else {
+      execSync(`command -v ${command}`, { stdio: 'ignore', shell: true })
+    }
+  } catch {
+    throw new DeployError(
+      `${command} not found on PATH. Install it or fix your environment.`,
+      EXIT_CONFIG
+    )
+  }
+}
+
+function stripTrailingSlash (dir) {
+  return dir.replace(/\/+$/, '') || dir
+}
+
+function needsBuildCopy (settings) {
+  if (settings.repoType === 'theme') return true
+  return settings.deployTrunk === true
+}
+
+function needsAssetsDir (settings) {
+  return settings.repoType === 'plugin' && settings.deployAssets === true
+}
+
+function needsAwk (settings) {
+  if (settings.repoType === 'theme') return true
+  return settings.deployTrunk === true || settings.deployAssets === true
+}
+
+/**
+ * @param {object} settings - Resolved wpDeployer settings
+ * @param {{ fs: import('fs-extra').default, awk: string }} io
+ * @param {{ checkCommands?: boolean }} [options] - Set checkCommands false in tests only
+ */
+export function runPreflightSync (settings, { fs, awk }, options = {}) {
+  const { checkCommands = true } = options
+
+  if (checkCommands) {
+    assertOnPath('svn')
+    if (needsAwk(settings)) {
+      assertOnPath(awk)
+    }
+  }
+
+  const cwd = process.cwd()
+
+  if (needsBuildCopy(settings)) {
+    const rel = stripTrailingSlash(settings.buildDir)
+    const abs = path.resolve(cwd, rel)
+    if (!fs.existsSync(abs)) {
+      throw new DeployError(
+        `buildDir does not exist: ${settings.buildDir} (resolved to ${abs})`,
+        EXIT_CONFIG
+      )
+    }
+    if (!fs.statSync(abs).isDirectory()) {
+      throw new DeployError(
+        `buildDir is not a directory: ${settings.buildDir}`,
+        EXIT_CONFIG
+      )
+    }
+    const entries = fs.readdirSync(abs)
+    if (entries.length === 0) {
+      throw new DeployError(
+        `buildDir is empty: ${settings.buildDir}. Build your project before deploying.`,
+        EXIT_CONFIG
+      )
+    }
+  }
+
+  if (needsAssetsDir(settings)) {
+    const rel = stripTrailingSlash(settings.assetsDir)
+    const abs = path.resolve(cwd, rel)
+    if (!fs.existsSync(abs)) {
+      throw new DeployError(
+        `assetsDir does not exist: ${settings.assetsDir} (resolved to ${abs})`,
+        EXIT_CONFIG
+      )
+    }
+    if (!fs.statSync(abs).isDirectory()) {
+      throw new DeployError(
+        `assetsDir is not a directory: ${settings.assetsDir}`,
+        EXIT_CONFIG
+      )
+    }
+  }
+}