agentVersionTxt.js

Go to the documentation of this file.

/**
 * @file routes/agentVersionTxt.js
 * @module routes/agentVersionTxt
 * @description
 *   Agent version text file endpoint for update checks.
 *   Serves plain text version number from distribution folder for agent auto-update checks.
 *
 *   **Core Features:**
 *   - Unauthenticated endpoint for agent update checks
 *   - Supports external and local distribution paths
 *   - Returns plain text version string (e.g., "1.0.12")
 *   - Used by agents to compare current version with latest
 *
 *   **Path Resolution:**
 *   - Primary: `/opt/apps/IBG_HUB_dist/agent/version.txt`
 *   - Fallback: `../agent/dist/version.txt` (development)
 *   @requires express
 *   @requires fs
 *   @requires path
 *   @author RMM-PSA Development Team
 *   @date 2026-03-12
 *   @since 1.0.0
 */
const express = require('express');
const router = express.Router();
const fs = require('fs');
const path = require('path');
 
/**
 * Resolve agent distribution path with fallback.
 * Checks external production path first, then local development path.
 * @param {string} relPath Relative path within distribution folder
 * @returns {string | null} Resolved absolute path, or null if not found
 * @private
 */
function resolveDistPath(relPath) {
  const externalPath = path.resolve('/opt/apps/IBG_HUB_dist/agent', relPath);
  const localPath = path.resolve(__dirname, '../agent/dist', relPath);
  if (fs.existsSync(externalPath)) return externalPath;
  if (fs.existsSync(localPath)) return localPath;
  return null;
}
 
/**
 * @api {get} /agent/version.txt Get agent version (text)
 * @apiName GetAgentVersionTxt
 * @apiGroup AgentUpdate
 * @apiDescription
 *   Retrieve current agent version as plain text file.
 *   Used by agents for automated update checks. No authentication required.
 *   Resolves from production or development distribution paths.
 * @apiSuccess {string} version Plain text version string (e.g., "1.0.12")
 * @apiError (404) {String} error="version.txt not found" Version file missing
 * @apiError (500) {String} error="Failed to read version.txt" File read error
 * @apiExample {curl} Example usage:
 *   curl -X GET https://api.example.com/agent/version.txt
 * @apiSuccessExample {text} Success-Response:
 *   HTTP/1.1 200 OK
 *   Content-Type: text/plain
 *   
 *   1.0.12
 */
router.get('/version.txt', (req, res) => {
  const versionPath = resolveDistPath('version.txt');
  if (!versionPath || !fs.existsSync(versionPath)) {
    return res.status(404).send('version.txt not found');
  }
  try {
    const version = fs.readFileSync(versionPath, 'utf8').trim();
    res.type('text/plain').send(version);
  } catch (err) {
    console.error('[AgentVersion] Failed to read version.txt:', err);
    res.status(500).send('Failed to read version.txt');
  }
});
 
module.exports = router;