unitup 0.0.12 → 0.1.0

package/src/schedule.js

@@ -0,0 +1,462 @@
+import path from 'node:path';
+import fs from 'node:fs';
+import {
+  sanitizeServiceName,
+  getUnitFilename,
+  getTimerFilename,
+  resolveAbsolutePath,
+  validateDuration,
+  formatFutureTime,
+  formatRelativeTime,
+  saveScheduleMetadata,
+  readScheduleMetadata,
+  deleteScheduleMetadata,
+  getSchedulesDir
+} from './utils.js';
+import {
+  getUserUnitDir,
+  getUnitPath,
+  getTimerPath,
+  timerFileExists,
+  unitFileExists,
+  writeScheduleUnitFiles,
+  deleteScheduleUnitFiles
+} from './unit.js';
+import { runCommand } from './systemd.js';
+import { detectRuntime, resolveRuntimeConfig } from './runtimes/index.js';
+
+/**
+ * Validates a systemd calendar expression using systemd-analyze if available.
+ *
+ * @param {string} expression
+ * @returns {Promise<{ valid: boolean, error?: string, warning?: string }>}
+ */
+export async function validateCalendar(expression) {
+  if (!expression || typeof expression !== 'string' || !expression.trim()) {
+    throw new Error('Calendar expression cannot be empty.');
+  }
+
+  const expr = expression.trim();
+  if (/[;&|$`\n\r]/.test(expr)) {
+    throw new Error(`Calendar expression contains invalid characters or shell injection attempt: "${expr}".`);
+  }
+
+  try {
+    const res = await runCommand('systemd-analyze', ['calendar', expr]);
+    if (res.code === 0) {
+      return { valid: true };
+    }
+    if (res.stderr && res.stderr.includes('Failed to parse calendar expression')) {
+      throw new Error(`Invalid calendar expression "${expr}": ${res.stderr.trim()}`);
+    }
+    // If systemd-analyze binary is missing
+    if (res.code === 127 || (res.stderr && res.stderr.includes('not found'))) {
+      return { valid: true, warning: 'systemd-analyze is not available; calendar expression could not be fully validated by systemd.' };
+    }
+  } catch (err) {
+    if (err.message && err.message.startsWith('Invalid calendar expression')) {
+      throw err;
+    }
+  }
+
+  return { valid: true };
+}
+
+/**
+ * Creates a systemd timer-based schedule.
+ *
+ * @param {Object} opts
+ * @returns {Promise<Object>}
+ */
+export async function createSchedule(opts = {}) {
+  if (opts.every && opts.calendar) {
+    throw new Error('Cannot use both --every and --calendar in the same schedule.');
+  }
+
+  if (!opts.every && !opts.calendar && !opts.onBoot && !opts.onActive) {
+    throw new Error('At least one scheduling option (--every, --calendar, --on-boot, or --on-active) is required.');
+  }
+
+  if (opts.every) {
+    validateDuration(opts.every, '--every');
+  }
+  if (opts.onBoot) {
+    validateDuration(opts.onBoot, '--on-boot');
+  }
+  if (opts.onActive) {
+    validateDuration(opts.onActive, '--on-active');
+  }
+  if (opts.randomDelay) {
+    validateDuration(opts.randomDelay, '--random-delay');
+  }
+  if (opts.calendar) {
+    await validateCalendar(opts.calendar);
+  }
+
+  let rawName = opts.name;
+  if (!rawName) {
+    if (opts.script) {
+      rawName = path.basename(opts.script, path.extname(opts.script));
+    } else if (opts.command) {
+      rawName = path.basename(opts.command);
+    } else {
+      throw new Error('Schedule requires a name, script, or command.');
+    }
+  }
+
+  const safeName = sanitizeServiceName(rawName);
+
+  let commandExec = '';
+  let execArgs = [];
+  let detectedRuntime = opts.runtime || 'node';
+  let scriptPath = '';
+
+  if (opts.command) {
+    commandExec = resolveAbsolutePath(opts.command);
+    execArgs = Array.isArray(opts.args) ? opts.args : [];
+    if (opts.script) {
+      scriptPath = resolveAbsolutePath(opts.script);
+    }
+  } else if (opts.script) {
+    scriptPath = resolveAbsolutePath(opts.script);
+    const runtimeInfo = detectRuntime(scriptPath, opts.runtime);
+    detectedRuntime = runtimeInfo.runtime;
+
+    const resolved = await resolveRuntimeConfig({
+      runtime: detectedRuntime,
+      script: scriptPath,
+      command: opts.command,
+      args: opts.args || [],
+      runtimeArgs: opts.runtimeArgs || [],
+      customNodePath: opts.node
+    });
+
+    commandExec = resolved.command;
+    execArgs = resolved.args;
+  } else {
+    throw new Error('Either script or command must be provided to create schedule.');
+  }
+
+  const cwd = opts.cwd
+    ? resolveAbsolutePath(opts.cwd)
+    : scriptPath
+    ? path.dirname(scriptPath)
+    : path.dirname(commandExec);
+
+  const envObj = {};
+  if (opts.env) {
+    if (Array.isArray(opts.env)) {
+      for (const item of opts.env) {
+        const idx = item.indexOf('=');
+        if (idx > 0) {
+          const key = item.slice(0, idx).trim();
+          const val = item.slice(idx + 1).trim();
+          envObj[key] = val;
+        }
+      }
+    } else if (typeof opts.env === 'object') {
+      Object.assign(envObj, opts.env);
+    }
+  }
+
+  const scheduleOpts = {
+    name: safeName,
+    runtime: detectedRuntime,
+    command: commandExec,
+    args: execArgs,
+    script: scriptPath,
+    cwd,
+    env: envObj,
+    envFile: opts.envFile ? resolveAbsolutePath(opts.envFile) : undefined,
+    group: opts.group || 'default',
+    memoryHigh: opts.memoryHigh,
+    memoryMax: opts.memoryMax,
+    memorySwapMax: opts.memorySwapMax,
+    resources: opts.resources,
+    every: opts.every,
+    calendar: opts.calendar,
+    onBoot: opts.onBoot,
+    onActive: opts.onActive,
+    randomDelay: opts.randomDelay,
+    persistent: opts.persistent
+  };
+
+  const unitFiles = writeScheduleUnitFiles(scheduleOpts);
+
+  if (opts.start || opts.enable) {
+    await runCommand('systemctl', ['--user', 'daemon-reload']);
+    await runCommand('systemctl', ['--user', 'enable', getTimerFilename(safeName)]);
+    await runCommand('systemctl', ['--user', 'start', getTimerFilename(safeName)]);
+  }
+
+  return {
+    name: safeName,
+    group: opts.group || 'default',
+    type: 'timer',
+    runtime: detectedRuntime,
+    command: commandExec,
+    args: execArgs,
+    cwd,
+    schedule: {
+      every: opts.every || null,
+      calendar: opts.calendar || null,
+      onBoot: opts.onBoot || null,
+      onActive: opts.onActive || null,
+      persistent: Boolean(opts.persistent),
+      randomDelay: opts.randomDelay || null
+    },
+    serviceUnit: `unitup-${safeName}.service`,
+    timerUnit: `unitup-${safeName}.timer`,
+    servicePath: unitFiles.servicePath,
+    timerPath: unitFiles.timerPath
+  };
+}
+
+/**
+ * Enables a timer schedule.
+ *
+ * @param {string} name
+ * @returns {Promise<boolean>}
+ */
+export async function enableSchedule(name) {
+  const safeName = sanitizeServiceName(name);
+  if (!timerFileExists(safeName)) {
+    throw new Error(`Schedule timer unit up for "${name}" does not exist.`);
+  }
+  await runCommand('systemctl', ['--user', 'daemon-reload']);
+  const res = await runCommand('systemctl', ['--user', 'enable', '--now', getTimerFilename(safeName)]);
+  return res.code === 0;
+}
+
+/**
+ * Disables a timer schedule.
+ *
+ * @param {string} name
+ * @returns {Promise<boolean>}
+ */
+export async function disableSchedule(name) {
+  const safeName = sanitizeServiceName(name);
+  if (!timerFileExists(safeName)) {
+    throw new Error(`Schedule timer unit up for "${name}" does not exist.`);
+  }
+  const res = await runCommand('systemctl', ['--user', 'disable', '--now', getTimerFilename(safeName)]);
+  return res.code === 0;
+}
+
+/**
+ * Manually runs a scheduled service unit without altering timer schedule.
+ *
+ * @param {string} name
+ * @returns {Promise<boolean>}
+ */
+export async function runSchedule(name) {
+  const safeName = sanitizeServiceName(name);
+  if (!unitFileExists(safeName)) {
+    throw new Error(`Schedule service unit for "${name}" does not exist.`);
+  }
+  const res = await runCommand('systemctl', ['--user', 'start', getUnitFilename(safeName)]);
+  return res.code === 0;
+}
+
+/**
+ * Removes a timer schedule and its service/timer files.
+ *
+ * @param {string} name
+ * @param {Object} [opts]
+ * @param {boolean} [opts.force]
+ * @returns {Promise<boolean>}
+ */
+export async function removeSchedule(name, opts = {}) {
+  const safeName = sanitizeServiceName(name);
+  const timerName = getTimerFilename(safeName);
+  const serviceName = getUnitFilename(safeName);
+
+  // 1. Disable timer unit
+  await runCommand('systemctl', ['--user', 'disable', '--now', timerName]);
+
+  // 2. Check if service is running
+  const activeRes = await runCommand('systemctl', ['--user', 'is-active', serviceName]);
+  const isRunning = activeRes.stdout.trim() === 'active';
+
+  if (isRunning) {
+    if (!opts.force) {
+      throw new Error(`Service ${serviceName} is currently running. Use --force to stop and remove.`);
+    }
+    await runCommand('systemctl', ['--user', 'stop', serviceName]);
+  }
+
+  // 3. Delete files
+  deleteScheduleUnitFiles(safeName);
+
+  // 4. Reload daemon & reset failed
+  await runCommand('systemctl', ['--user', 'daemon-reload']);
+  await runCommand('systemctl', ['--user', 'reset-failed']);
+
+  return true;
+}
+
+/**
+ * Parses systemctl show properties output.
+ *
+ * @param {string} stdout
+ * @returns {Record<string, string>}
+ */
+function parseSystemctlShow(stdout) {
+  const props = {};
+  if (!stdout) return props;
+  const lines = stdout.split('\n');
+  for (const line of lines) {
+    const idx = line.indexOf('=');
+    if (idx > 0) {
+      const k = line.slice(0, idx).trim();
+      const v = line.slice(idx + 1).trim();
+      props[k] = v;
+    }
+  }
+  return props;
+}
+
+/**
+ * Returns detailed status of a schedule.
+ *
+ * @param {string} name
+ * @returns {Promise<Object>}
+ */
+export async function getScheduleStatus(name) {
+  const safeName = sanitizeServiceName(name);
+  const meta = readScheduleMetadata(safeName);
+
+  const timerFilename = getTimerFilename(safeName);
+  const serviceFilename = getUnitFilename(safeName);
+
+  const showTimerRes = await runCommand('systemctl', [
+    '--user',
+    'show',
+    timerFilename,
+    '--property=ActiveState,SubState,NextElapseUSecRealtime,NextElapseUSec,LastTriggerUSec,Unit,Triggers,UnitFileState'
+  ]);
+
+  const showServiceRes = await runCommand('systemctl', [
+    '--user',
+    'show',
+    serviceFilename,
+    '--property=ActiveState,SubState,ExecMainStatus,ExecMainCode'
+  ]);
+
+  const timerProps = parseSystemctlShow(showTimerRes.stdout);
+  const serviceProps = parseSystemctlShow(showServiceRes.stdout);
+
+  // Determine schedule description string
+  let scheduleExpr = '';
+  if (meta?.schedule?.every) {
+    scheduleExpr = `every ${meta.schedule.every}`;
+  } else if (meta?.schedule?.calendar) {
+    scheduleExpr = meta.schedule.calendar;
+  } else if (meta?.schedule?.onBoot) {
+    scheduleExpr = `on-boot ${meta.schedule.onBoot}`;
+  } else if (meta?.schedule?.onActive) {
+    scheduleExpr = `on-active ${meta.schedule.onActive}`;
+  } else {
+    scheduleExpr = 'custom timer';
+  }
+
+  const activeState = timerProps.ActiveState || 'unknown';
+  const unitFileState = timerProps.UnitFileState || 'unknown';
+
+  let status = 'waiting';
+  if (serviceProps.ActiveState === 'active') {
+    status = 'running';
+  } else if (activeState === 'inactive' || unitFileState === 'disabled') {
+    status = 'disabled';
+  } else if (timerProps.SubState) {
+    status = timerProps.SubState;
+  }
+
+  // Parse NextElapse timestamp
+  let rawNext = timerProps.NextElapseUSecRealtime || timerProps.NextElapseUSec;
+  if (!rawNext || rawNext === '0' || rawNext === '18446744073709551615') {
+    rawNext = 'n/a';
+  }
+
+  let nextRun = 'n/a';
+  if (rawNext !== 'n/a') {
+    const num = Number(rawNext);
+    if (!isNaN(num) && num > 0) {
+      nextRun = formatFutureTime(Math.floor(num / 1000));
+    } else {
+      nextRun = formatFutureTime(rawNext);
+    }
+  }
+
+  // Parse LastTrigger timestamp
+  let rawLast = timerProps.LastTriggerUSec;
+  let lastRun = 'never';
+  if (rawLast && rawLast !== '0' && rawLast !== 'n/a') {
+    const num = Number(rawLast);
+    if (!isNaN(num) && num > 0) {
+      lastRun = formatRelativeTime(Math.floor(num / 1000));
+    } else {
+      lastRun = formatRelativeTime(rawLast);
+    }
+  }
+
+  return {
+    name: safeName,
+    group: meta?.group || 'default',
+    schedule: scheduleExpr,
+    nextRun,
+    lastRun,
+    status,
+    activeState,
+    subState: timerProps.SubState || 'unknown',
+    unitFileState,
+    serviceActiveState: serviceProps.ActiveState || 'unknown',
+    metadata: meta,
+    serviceUnit: serviceFilename,
+    timerUnit: timerFilename
+  };
+}
+
+/**
+ * Lists all schedules and their status.
+ *
+ * @param {string} [group]
+ * @returns {Promise<Array<Object>>}
+ */
+export async function listSchedules(group) {
+  const dir = getSchedulesDir();
+  const scheduleNames = new Set();
+
+  if (fs.existsSync(dir)) {
+    const files = fs.readdirSync(dir);
+    for (const f of files) {
+      if (f.endsWith('.json')) {
+        scheduleNames.add(f.slice(0, -5));
+      }
+    }
+  }
+
+  const unitDir = getUserUnitDir();
+  if (fs.existsSync(unitDir)) {
+    const files = fs.readdirSync(unitDir);
+    for (const f of files) {
+      if (f.startsWith('unitup-') && f.endsWith('.timer')) {
+        scheduleNames.add(f.slice(7, -6));
+      }
+    }
+  }
+
+  const result = [];
+  for (const name of scheduleNames) {
+    try {
+      const st = await getScheduleStatus(name);
+      if (!group || st.group === group) {
+        result.push(st);
+      }
+    } catch {
+      // ignore individual parse errors
+    }
+  }
+
+  return result;
+}

package/src/systemd.js

@@ -904,3 +904,129 @@ export async function executeJournalctlMaintenance(action, opts = {}) {
 
   return (res.stdout || res.stderr || 'Journal maintenance completed successfully.').trim();
 }
+
+/**
+ * Retrieves memory usage overview for a single service or schedule task.
+ *
+ * @param {string} name
+ * @returns {Promise<Object>}
+ */
+export async function getServiceMemoryUsage(name) {
+  const safeName = sanitizeServiceName(name);
+  const unitFilename = getUnitFilename(safeName);
+
+  const res = await runCommand('systemctl', [
+    '--user',
+    'show',
+    unitFilename,
+    '--property=ActiveState,SubState,MainPID,MemoryCurrent,MemoryPeak,MemoryHigh,MemoryMax,MemorySwapMax'
+  ]);
+
+  const props = {};
+  if (res.stdout) {
+    for (const line of res.stdout.split('\n')) {
+      const idx = line.indexOf('=');
+      if (idx > 0) {
+        props[line.slice(0, idx).trim()] = line.slice(idx + 1).trim();
+      }
+    }
+  }
+
+  const { readScheduleMetadata } = await import('./utils.js');
+  const meta = readAppMetadata(safeName) || readScheduleMetadata(safeName);
+  const { formatMemoryBytes, resolveEffectiveMemoryLimits } = await import('./utils.js');
+
+  const effective = resolveEffectiveMemoryLimits(meta || {});
+
+  const memoryCurrentBytes = Number(props.MemoryCurrent);
+  const rawBytes = !isNaN(memoryCurrentBytes) && memoryCurrentBytes > 0 && memoryCurrentBytes < 1e15 ? memoryCurrentBytes : 0;
+
+  const status = props.ActiveState === 'active' ? (props.SubState === 'running' ? 'running' : props.SubState || 'active') : (props.ActiveState || 'stopped');
+
+  return {
+    name: safeName,
+    group: meta?.group || 'default',
+    type: meta?.type === 'timer' ? 'timer' : 'service',
+    status,
+    pid: props.MainPID && props.MainPID !== '0' ? props.MainPID : '-',
+    memoryBytes: rawBytes,
+    memory: formatMemoryBytes(props.MemoryCurrent),
+    memoryPeak: formatMemoryBytes(props.MemoryPeak),
+    memoryHigh: formatMemoryBytes(props.MemoryHigh || effective.memoryHigh),
+    memoryMax: formatMemoryBytes(props.MemoryMax || effective.memoryMax),
+    memorySwapMax: formatMemoryBytes(props.MemorySwapMax || effective.memorySwapMax)
+  };
+}
+
+/**
+ * Retrieves aggregated memory usage overview for all unitup services and schedules.
+ *
+ * @param {Object} [opts]
+ * @param {string} [opts.group]
+ * @returns {Promise<Object>}
+ */
+export async function getAllServicesMemoryUsage(opts = {}) {
+  const { formatMemoryBytes } = await import('./utils.js');
+  const services = await listServices({ group: opts.group });
+  const { listSchedules } = await import('./schedule.js');
+  const schedules = await listSchedules(opts.group);
+
+  const items = [];
+  let totalBytes = 0;
+  const processedNames = new Set();
+
+  for (const svc of services) {
+    processedNames.add(svc.name);
+    try {
+      const mem = await getServiceMemoryUsage(svc.name);
+      items.push({
+        name: svc.name,
+        group: svc.group || 'default',
+        type: 'service',
+        status: svc.status,
+        pid: svc.pid,
+        memory: mem.memory,
+        memoryPeak: mem.memoryPeak,
+        memoryMax: mem.memoryMax,
+        memoryHigh: mem.memoryHigh,
+        memoryBytes: mem.memoryBytes
+      });
+      totalBytes += mem.memoryBytes;
+    } catch {
+      // ignore
+    }
+  }
+
+  for (const sched of schedules) {
+    if (!processedNames.has(sched.name)) {
+      processedNames.add(sched.name);
+      try {
+        const mem = await getServiceMemoryUsage(sched.name);
+        items.push({
+          name: sched.name,
+          group: sched.group || 'default',
+          type: 'timer',
+          status: sched.status,
+          pid: mem.pid,
+          memory: mem.memory,
+          memoryPeak: mem.memoryPeak,
+          memoryMax: mem.memoryMax,
+          memoryHigh: mem.memoryHigh,
+          memoryBytes: mem.memoryBytes
+        });
+        totalBytes += mem.memoryBytes;
+      } catch {
+        // ignore
+      }
+    }
+  }
+
+  const runningCount = items.filter(i => i.status === 'running' || i.status === 'active').length;
+
+  return {
+    items,
+    totalBytes,
+    totalMemory: formatMemoryBytes(totalBytes),
+    runningCount
+  };
+}