broker.controller.ts

import { Controller, Get, Logger, Param, Post, Request } from '@nestjs/common';
import {
  BrokerListClientResponse,
  GetBrokerStatusClientResponse,
  StartAllBrokersClientResponse,
  StopAllBrokersClientResponse,
} from '@api-interfaces';
import { BaseCmsResponse } from '@type';
import { BrokerService } from './broker.service';

/**
 * Controller for handling broker-related operations.
 * Provides REST API endpoints for broker management operations including:
 * - Get broker list for a specific host
 * - Stop a broker
 * - Start a broker
 * - Restart a broker
 * - Get broker status
 * - All endpoints receive `hostUid` as a path parameter
 * - Follows RESTful pattern: /:hostUid/broker/{action}/{identifier}
 *
 * @category Controllers
 * @since 1.0.0
 */
@Controller(':hostUid/broker')
export class BrokerController {
  private readonly logger = new Logger(BrokerController.name);

  constructor(private readonly brokerService: BrokerService) {}

  /**
   * Start all brokers on a host (CMS task: startbroker).
   *
   * @route POST /:hostUid/broker/start-all
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @returns StartAllBrokersClientResponse { success: true } on success
   * @example
   * // POST /host-uid/broker/start-all
   */
  @Post('start-all')
  async startAllBrokers(
    @Request() req,
    @Param('hostUid') hostUid: string
  ): Promise<StartAllBrokersClientResponse> {
    const userId = req.user.sub;
    this.logger.log(`Starting all brokers on host: ${hostUid}`);
    return await this.brokerService.startAllBrokers(userId, hostUid);
  }

  /**
   * Stop all brokers on a host (CMS task: stopbroker).
   *
   * @route POST /:hostUid/broker/stop-all
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @returns StopAllBrokersClientResponse { success: true } on success
   * @example
   * // POST /host-uid/broker/stop-all
   */
  @Post('stop-all')
  async stopAllBrokers(
    @Request() req,
    @Param('hostUid') hostUid: string
  ): Promise<StopAllBrokersClientResponse> {
    const userId = req.user.sub;
    this.logger.log(`Stopping all brokers on host: ${hostUid}`);
    return await this.brokerService.stopAllBrokers(userId, hostUid);
  }

  /**
   * Get list of brokers for a specific host.
   *
   * @route GET /:hostUid/broker/list
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @returns List of brokers
   * @example
   * // GET /host-uid/broker/list
   */
  @Get('list')
  async getBrokers(
    @Request() req,
    @Param('hostUid') hostUid: string
  ): Promise<BrokerListClientResponse> {
    const userId = req.user.sub;

    const response = await this.brokerService.getBrokers(userId, hostUid);
    return response;
  }

  /**
   * Stop a broker.
   *
   * @route POST /:hostUid/broker/stop/:bname
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @param bname - Broker name from path parameter
   * @returns Response indicating success or failure
   * @example
   * // POST /host-uid/broker/stop/query_editor
   */
  @Post('stop/:bname')
  async stopBroker(
    @Request() req,
    @Param('hostUid') hostUid: string,
    @Param('bname') bname: string
  ): Promise<BaseCmsResponse> {
    const userId = req.user.sub;

    this.logger.log(`Stopping broker: ${bname} on host: ${hostUid}`);
    const response = await this.brokerService.stopBroker(userId, hostUid, bname);
    return response;
  }

  /**
   * Start a broker.
   *
   * @route POST /:hostUid/broker/start/:bname
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @param bname - Broker name from path parameter
   * @returns Response indicating success or failure
   * @example
   * // POST /host-uid/broker/start/query_editor
   */
  @Post('start/:bname')
  async startBroker(
    @Request() req,
    @Param('hostUid') hostUid: string,
    @Param('bname') bname: string
  ): Promise<BaseCmsResponse> {
    const userId = req.user.sub;

    this.logger.log(`Starting broker: ${bname} on host: ${hostUid}`);
    const response = await this.brokerService.startBroker(userId, hostUid, bname);
    return response;
  }

  /**
   * Restart a broker.
   *
   * @route POST /:hostUid/broker/restart/:bname
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @param bname - Broker name from path parameter
   * @returns Boolean indicating success
   * @example
   * // POST /host-uid/broker/restart/query_editor
   */
  @Post('restart/:bname')
  async restartBroker(
    @Request() req,
    @Param('hostUid') hostUid: string,
    @Param('bname') bname: string
  ): Promise<boolean> {
    const userId = req.user.sub;

    this.logger.log(`Restarting broker: ${bname} on host: ${hostUid}`);
    const response: boolean = await this.brokerService.restartBroker(userId, hostUid, bname);
    return response;
  }

  /**
   * Get broker status including application server information.
   *
   * @route GET /:hostUid/broker/status/:bname
   * @param req - Request object containing user information
   * @param hostUid - Host unique identifier from path parameter
   * @param bname - Broker name from path parameter
   * @returns Broker status data without BaseCmsResponse fields
   * @example
   * // POST /host-uid/broker/status/query_editor
   */
  @Get('status/:bname')
  async getBrokerStatus(
    @Request() req,
    @Param('hostUid') hostUid: string,
    @Param('bname') bname: string
  ): Promise<GetBrokerStatusClientResponse> {
    const userId = req.user.sub;

    this.logger.log(`Getting broker status: ${bname} on host: ${hostUid}`);
    const response = await this.brokerService.getBrokerStatus(userId, hostUid, bname);
    return response;
  }
}