@ably/cli/dist/src/commands/rooms/occupancy/get.js

Ably CLI for Pub/Sub, Chat and Spaces

import { Args } from "@oclif/core";
import { ChatBaseCommand } from "../../../chat-base-command.js";
export default class RoomsOccupancyGet extends ChatBaseCommand {
    static args = {
        room: Args.string({
            description: "Room to get occupancy for",
            required: true,
        }),
    };
    static description = "Get current occupancy metrics for a room";
    static examples = [
        "$ ably rooms occupancy get my-room",
        '$ ably rooms occupancy get --api-key "YOUR_API_KEY" my-room',
        "$ ably rooms occupancy get my-room --json",
        "$ ably rooms occupancy get my-room --pretty-json",
    ];
    static flags = {
        ...ChatBaseCommand.globalFlags,
    };
    chatClient = null;
    room = null;
    async run() {
        const { args, flags } = await this.parse(RoomsOccupancyGet);
        try {
            // Create Chat client
            this.chatClient = await this.createChatClient(flags);
            if (!this.chatClient) {
                this.error("Failed to create Chat client");
                return;
            }
            const { room: roomName } = args;
            // Get the room with occupancy enabled
            this.room = await this.chatClient.rooms.get(roomName);
            // Attach to the room to access occupancy with timeout
            let attachTimeout;
            await Promise.race([
                this.room.attach(),
                new Promise((_, reject) => {
                    attachTimeout = setTimeout(() => reject(new Error("Room attach timeout")), 10000);
                }),
            ]);
            clearTimeout(attachTimeout);
            // Get occupancy metrics using the Chat SDK's occupancy API
            let occupancyTimeout;
            const occupancyMetrics = await Promise.race([
                this.room.occupancy.get(),
                new Promise((_, reject) => {
                    occupancyTimeout = setTimeout(() => reject(new Error("Occupancy get timeout")), 5000);
                }),
            ]);
            clearTimeout(occupancyTimeout);
            // Output the occupancy metrics based on format
            if (this.shouldOutputJson(flags)) {
                this.log(this.formatJsonOutput({
                    metrics: occupancyMetrics,
                    room: roomName,
                    success: true,
                }, flags));
            }
            else {
                this.log(`Occupancy metrics for room '${roomName}':\n`);
                this.log(`Connections: ${occupancyMetrics.connections ?? 0}`);
                this.log(`Presence Members: ${occupancyMetrics.presenceMembers ?? 0}`);
            }
        }
        catch (error) {
            if (this.shouldOutputJson(flags)) {
                this.log(this.formatJsonOutput({
                    error: error instanceof Error ? error.message : String(error),
                    room: args.room,
                    success: false,
                }, flags));
            }
            else {
                this.error(`Error fetching room occupancy: ${error instanceof Error ? error.message : String(error)}`);
            }
        }
    }
}