@ludeo/cloud-common 1.2.173-beta-yahil-4 → 1.2.174-beta-yahil-1

package/src/v4/types/mqtt/types.ts

@@ -0,0 +1,232 @@
+/**
+ * MQTT Types for site-controller <-> ludeocast-agent communication
+ *
+ * Architecture:
+ * - Ludeocast agent runs on a VM identified by MACHINE_RESOURCE_ID (env var)
+ * - Agent publishes ALL status updates to: agent/status-updates/{machineResourceId}
+ * - This includes both machine updates and game updates running on that machine
+ *
+ * Message Flow:
+ * - Site-Controller → Agent: Commands (init, start-game, terminate-game, etc.)
+ *   Published to: agent/{machineResourceId}/command/{commandName}
+ *
+ * - Agent → Site-Controller: Status Updates (machine + game status changes)
+ *   Published to: agent/status-updates/{machineResourceId}
+ *   Site-Controller subscribes to: agent/status-updates/+ (all agents)
+ *   Routes by resourceType (machine/game) to appropriate service
+ */
+
+import { IsEnum, IsString, IsUUID, IsOptional } from 'class-validator';
+import { ValidateNestedType } from '../../../decorators';
+import { MachineMode, GameCreationPayload } from '../site-controller/types';
+import { CloudResourceStatus } from '../pools/resource/status';
+import { CloudPoolType } from '../pools/type';
+
+// ==========================================================================
+// SITE-CONTROLLER → AGENT (Commands)
+// ==========================================================================
+
+// ========== Command Payloads ==========
+
+export const AGENT_STRING = 'agent';
+export const COMMAND_STRING = 'command'
+
+export class InitCommandPayload {
+  @IsEnum(MachineMode)
+  mode: MachineMode;
+}
+
+export class StartGameCommandPayload {
+  @IsUUID()
+  gameResourceId: string;
+
+  payload: GameCreationPayload;
+}
+
+export class TerminateGameCommandPayload {
+  @IsUUID()
+  gameResourceId: string;
+}
+
+export class ExportLogsCommandPayload {
+  @IsUUID()
+  gameResourceId: string;
+
+  @IsString()
+  uploadURL: string;
+}
+
+export class ResourceStatusUpdatePayload {
+  @IsUUID()
+  machineResourceId: string;
+
+  @IsUUID()
+  gameResourceId?: string; // Present for game status updates, absent for machine status
+
+  @IsEnum(CloudResourceStatus)
+  status: CloudResourceStatus;
+
+  @IsOptional()
+  @IsString()
+  reason?: string;
+}
+
+// ========== Command Classes ==========
+
+/**
+ * Init command - Initialize the agent with a specific mode
+ * Topic: agent/{machineResourceId}/command/init
+ */
+export class InitCommand {
+  static readonly COMMAND_NAME = 'init';
+
+  @IsUUID()
+  readonly machineResourceId: string;
+
+  @ValidateNestedType(() => InitCommandPayload)
+  payload: InitCommandPayload;
+
+  constructor(machineResourceId: string, payload: InitCommandPayload) {
+    this.machineResourceId = machineResourceId;
+    this.payload = payload;
+  }
+
+  /** Get topic for publishing this command */
+  getTopic(): string {
+    return `${AGENT_STRING}/${this.machineResourceId}/${COMMAND_STRING}/${InitCommand.COMMAND_NAME}`;
+  }
+}
+
+/**
+ * Start game command - Start a game instance on the agent
+ * Topic: agent/{machineResourceId}/command/start-game
+ */
+export class StartGameCommand {
+  static readonly COMMAND_NAME = 'start-game';
+
+  @IsUUID()
+  readonly machineResourceId: string;
+
+  @ValidateNestedType(() => StartGameCommandPayload)
+  payload: StartGameCommandPayload;
+
+  constructor(machineResourceId: string, payload: StartGameCommandPayload) {
+    this.machineResourceId = machineResourceId;
+    this.payload = payload;
+  }
+
+  getTopic(): string {
+    return `${AGENT_STRING}/${this.machineResourceId}/${COMMAND_STRING}/${StartGameCommand.COMMAND_NAME}`;
+  }
+}
+
+/**
+ * Terminate game command - Stop a running game instance
+ * Topic: agent/{machineResourceId}/command/terminate-game
+ */
+export class TerminateGameCommand {
+  static readonly COMMAND_NAME = 'terminate-game';
+
+  @IsUUID()
+  readonly machineResourceId: string;
+
+  @ValidateNestedType(() => TerminateGameCommandPayload)
+  payload: TerminateGameCommandPayload;
+
+  constructor(machineResourceId: string, payload: TerminateGameCommandPayload) {
+    this.machineResourceId = machineResourceId;
+    this.payload = payload;
+  }
+
+  getTopic(): string {
+    return `${AGENT_STRING}/${this.machineResourceId}/${COMMAND_STRING}/${TerminateGameCommand.COMMAND_NAME}`;
+  }
+}
+
+/**
+ * Export logs command - Export logs to a specified URL
+ * Topic: agent/{machineResourceId}/command/export-logs
+ */
+export class ExportLogsCommand {
+  static readonly COMMAND_NAME = 'export-logs';
+
+  @IsUUID()
+  readonly machineResourceId: string;
+
+  @ValidateNestedType(() => ExportLogsCommandPayload)
+  payload: ExportLogsCommandPayload;
+
+  constructor(machineResourceId: string, payload: ExportLogsCommandPayload) {
+    this.machineResourceId = machineResourceId;
+    this.payload = payload;
+  }
+
+  getTopic(): string {
+    return `${AGENT_STRING}/${this.machineResourceId}/${COMMAND_STRING}/${ExportLogsCommand.COMMAND_NAME}`;
+  }
+}
+
+/**
+ * Shutdown command - Gracefully shutdown the agent
+ * Topic: agent/{machineResourceId}/command/shutdown
+ */
+export class ShutdownCommand {
+  static readonly COMMAND_NAME = 'shutdown';
+
+  @IsUUID()
+  readonly machineResourceId: string;
+
+  payload = {};
+
+  constructor(machineResourceId: string) {
+    this.machineResourceId = machineResourceId;
+  }
+
+  getTopic(): string {
+    return `${AGENT_STRING}/${this.machineResourceId}/${COMMAND_STRING}/${ShutdownCommand.COMMAND_NAME}`;
+  }
+}
+
+/**
+ * Resource status update command - Update the status of a resource
+ * Topic: agent/{machineResourceId}/command/resource-status-update
+ */
+export class ResourceStatusUpdateCommand {
+    static readonly COMMAND_NAME = 'resource-status-update';
+
+    @ValidateNestedType(() => ResourceStatusUpdatePayload)
+    payload: ResourceStatusUpdatePayload;
+
+    constructor(payload: ResourceStatusUpdatePayload) {
+        this.payload = payload;
+    }
+    
+    static getTopic(machineResourceId: string): string {
+        return `agent/resource-status-updates/${machineResourceId}`;
+    }
+}
+
+// ==========================================================================
+// AGENT → SITE-CONTROLLER (Status Updates)
+// ==========================================================================
+
+/**
+ * Status update from agent to site-controller
+ * Topic: agent/status-updates/{machineResourceId}
+ *
+ * Agent always includes machineResourceId (since it's running on that machine).
+ * Optionally includes gameResourceId when reporting game status.
+ *
+ * Status types:
+ * - Machine status: { machineResourceId, status, ... } (no gameResourceId)
+ * - Game status: { machineResourceId, gameResourceId, status, ... }
+ *
+ * Site-controller subscribes to agent/status-updates/+ and routes based on gameResourceId presence.
+ */
+
+
+/** Pattern for site-controller to subscribe to ALL status updates from ALL agents */
+export const RESOURCE_STATUS_SUBSCRIBE_PATTERN = `agent/${ResourceStatusUpdateCommand.COMMAND_NAME}/#`;
+
+export const AGENT_COMMAND_SUBSCRIBE_PATTERN = `agent/command/#`;
+

package/src/v4/types/site-controller/index.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+

package/src/v4/types/site-controller/types.ts

@@ -0,0 +1,32 @@
+/**
+ * Site Controller Types
+ * All types used by site-controller events and services
+ */
+
+// ========== Machine Types ==========
+
+export enum MachineMode {
+  Proton = 'proton',
+  Android = 'android',
+}
+
+// ========== Game Types ==========
+
+export interface ProtonGameCreationPayload {
+  exeRelativePath: string;
+  additionalEnvironmentVariables?: Record<string, string>;
+}
+
+export interface AndroidGameCreationPayload {
+  packageId: string;
+}
+
+export type GameCreationPayload = ProtonGameCreationPayload | AndroidGameCreationPayload;
+
+// ========== Operation Status ==========
+
+export enum OperationStatus {
+  Success = 'success',
+  Error = 'error',
+}
+