migrate-platform.js

Go to the documentation of this file.

/**
 * @file Database Migration Utility - Add Platform Column to Agents Table
 * @description
 * **TEMPORARY MIGRATION SCRIPT** - One-time database schema migration endpoint to add
 * `platform` column to `agents` table. This file stores Operating System platform detection
 * (win32, linux, darwin) for multi-platform RMM agent support.
 *
 * ⚠️ **IMPORTANT**: This file should be DELETED after running the migration once in production.
 * Keeping migration scripts in codebase after execution creates security risks and confusion.
 *
 * Migration actions:
 * - Adds `platform VARCHAR(20)` column to `agents` table (idempotent with IF NOT EXISTS)
 * - Sets column comment for documentation
 * - Safe to run multiple times (IF NOT EXISTS prevents errors)
 *
 * Platform values:
 * - **win32**: Windows operating systems
 * - **linux**: Linux distributions
 * - **darwin**: macOS/OS X
 *
 * Usage workflow:
 * 1. Deploy code with this migration file
 * 2. Call POST /migrate-platform/add-platform-column once
 * 3. Verify migration success in response
 * 4. Delete routes/migrate-platform.js from codebase
 * 5. Remove route registration from main app.js
 * @module routes/migrate-platform
 * @requires express
 * @requires ../services/db - PostgreSQL database pool
 * @deprecated DELETE THIS FILE AFTER RUNNING MIGRATION
 * @warning This is a temporary utility - not a permanent API endpoint
 */
 
const express = require('express');
const router = express.Router();
const pool = require('../services/db');
 
/**
 * @api {post} /migrate-platform/add-platform-column Add Platform Column Migration
 * @apiName AddPlatformColumn
 * @apiGroup Migrations
 * @apiDescription
 * **ONE-TIME MIGRATION** - Adds platform column to agents table for OS platform tracking.
 * Idempotent operation safe to run multiple times. DELETE THIS FILE AFTER RUNNING ONCE.
 *
 * SQL executed:
 * ```sql
 * ALTER TABLE agents ADD COLUMN IF NOT EXISTS platform VARCHAR(20);
 * COMMENT ON COLUMN agents.platform IS 'Operating system platform (win32, linux, darwin)';
 * ```
 * @apiPermission public
 * @apiNote No authentication for migrations (should be protected in production by firewall/VPN)
 * @apiWarning DELETE routes/migrate-platform.js after running this migration
 * @apiSuccess {boolean} success Migration success status (true)
 * @apiSuccess {string} message Success message
 * @apiSuccess {string} note Reminder to delete migration file
 * @apiError (500) {String} error SQL error message if migration fails
 * @apiExample {curl} Example Request:
 *     curl -X POST https://api.ibghub.com/api/migrate-platform/add-platform-column
 * @apiExample {json} Example Response:
 *     {
 *       "success": true,
 *       "message": "Platform column added to agents table",
 *       "note": "DELETE routes/migrate-platform.js after running this once"
 *     }
 */
 
// One-time migration endpoint to add platform column
// DELETE THIS FILE AFTER RUNNING
router.post('/add-platform-column', async (req, res) => {
  try {
    console.log('🔄 Applying platform column migration...');
    
    await pool.query(`
      ALTER TABLE agents 
      ADD COLUMN IF NOT EXISTS platform VARCHAR(20);
    `);
    
    await pool.query(`
      COMMENT ON COLUMN agents.platform IS 'Operating system platform (win32, linux, darwin)';
    `);
    
    console.log('✅ Platform column migration applied successfully!');
    
    res.json({ 
      success: true, 
      message: 'Platform column added to agents table',
      note: 'DELETE routes/migrate-platform.js after running this once'
    });
    
  } catch (err) {
    console.error('❌ Migration failed:', err.message);
    res.status(500).json({ error: err.message });
  }
});
 
module.exports = router;