Simplified roomName, channelName and spaceName validation

Author: sacOO7

src/base-command.ts

@@ -1,5 +1,4 @@
 import { InteractiveBaseCommand } from "./interactive-base-command.js";
-import { Interfaces } from "@oclif/core";
 import * as Ably from "ably";
 import chalk from "chalk";
 import colorJson from "color-json";
@@ -128,63 +127,31 @@ export abstract class AblyBaseCommand extends InteractiveBaseCommand {
     this.isWebCliMode = isWebCliMode();
   }
 
-  /**
-   * Mapping of common arg names to their human-readable labels.
-   * The parse() override validates these are non-empty automatically.
-   */
-  private static readonly RESOURCE_ARG_LABELS: Record<string, string> = {
-    channel: "Channel",
-    channels: "Channel", // channels:subscribe uses plural arg name (strict: false, variadic via argv)
-    room: "Room",
-    rooms: "Room", // rooms:messages:subscribe uses plural arg name (strict: false, variadic via argv)
-    space_name: "Space",
-  };
-
-  /**
-   * Override parse() to automatically validate that common resource name
-   * args (channel, room, space_name) are non-empty after oclif parsing.
-   */
-  protected override async parse<
-    F extends Record<string, unknown>,
-    B extends Record<string, unknown>,
-    A extends Record<string, unknown>,
-  >(
-    options?: Interfaces.Input<F, B, A>,
+  protected validateChannelName(
+    args: Record<string, unknown>,
+    flags: BaseFlags,
     argv?: string[],
-  ): Promise<Interfaces.ParserOutput<F, B, A>> {
-    const result = await super.parse(options, argv);
-
-    const parsedArgs = result.args as Record<string, unknown>;
-    const flags = result.flags as BaseFlags;
-    for (const [argName, label] of Object.entries(
-      AblyBaseCommand.RESOURCE_ARG_LABELS,
-    )) {
-      if (
-        argName in parsedArgs &&
-        typeof parsedArgs[argName] === "string" &&
-        !(parsedArgs[argName] as string).trim()
-      ) {
-        this.fail(`${label} name cannot be empty`, flags, "parse");
-      }
+  ): void {
+    const name = (args.channel ?? args.channels ?? "") as string;
+    if (!name.trim()) {
+      this.fail("Channel name cannot be empty", flags, "parse");
     }
 
-    // Also validate argv entries for variadic commands (strict: false)
-    // where extra values bypass the named arg
-    const hasResourceArg = Object.keys(
-      AblyBaseCommand.RESOURCE_ARG_LABELS,
-    ).some((name) => name in parsedArgs);
-    if (hasResourceArg && Array.isArray(result.argv)) {
-      const label = Object.entries(AblyBaseCommand.RESOURCE_ARG_LABELS).find(
-        ([name]) => name in parsedArgs,
-      )?.[1];
-      for (const value of result.argv as string[]) {
-        if (typeof value === "string" && !value.trim()) {
-          this.fail(`${label} name cannot be empty`, flags, "parse");
+    if (argv) {
+      if (argv.length === 0) {
+        this.fail(
+          "At least one channel name is required",
+          flags,
+          "channelSubscribe",
+        );
+      }
+
+      for (const n of argv) {
+        if (!n.trim()) {
+          this.fail("Channel name cannot be empty", flags, "parse");
         }
       }
     }
-
-    return result;
   }
 
   protected isAnonymousWebMode(): boolean {

src/chat-base-command.ts

@@ -17,6 +17,33 @@ export abstract class ChatBaseCommand extends AblyBaseCommand {
   private _chatClient: ChatClient | null = null;
   private _cleanupTimeout: NodeJS.Timeout | undefined;
 
+  protected validateRoomName(
+    args: Record<string, unknown>,
+    flags: BaseFlags,
+    argv?: string[],
+  ): void {
+    const name = (args.room ?? args.rooms ?? "") as string;
+    if (!name.trim()) {
+      this.fail("Room name cannot be empty", flags, "parse");
+    }
+
+    if (argv) {
+      if (argv.length === 0) {
+        this.fail(
+          "At least one room name is required",
+          flags,
+          "roomMessageSubscribe",
+        );
+      }
+
+      for (const n of argv) {
+        if (!n.trim()) {
+          this.fail("Room name cannot be empty", flags, "parse");
+        }
+      }
+    }
+  }
+
   /**
    * Override getClientOptions to disable binary protocol for Chat commands.
    * The Chat API uses realtime.request() for REST calls, and binary (MsgPack)

src/commands/apps/create.ts

@@ -32,6 +32,9 @@ export default class AppsCreateCommand extends ControlBaseCommand {
 
   async run(): Promise<void> {
     const { flags } = await this.parse(AppsCreateCommand);
+    if (!flags.name?.trim()) {
+      this.fail("App name cannot be empty", flags, "parse");
+    }
 
     try {
       const controlApi = this.createControlApi(flags);

src/commands/apps/rules/create.ts

@@ -100,6 +100,9 @@ export default class RulesCreateCommand extends ControlBaseCommand {
 
   async run(): Promise<void> {
     const { flags } = await this.parse(RulesCreateCommand);
+    if (!flags.name?.trim()) {
+      this.fail("Rule name cannot be empty", flags, "parse");
+    }
 
     const appId = await this.requireAppId(flags);
 

src/commands/auth/keys/create.ts

@@ -42,6 +42,9 @@ export default class KeysCreateCommand extends ControlBaseCommand {
 
   async run(): Promise<void> {
     const { flags } = await this.parse(KeysCreateCommand);
+    if (!flags.name?.trim()) {
+      this.fail("Key name cannot be empty", flags, "parse");
+    }
 
     const appId = await this.requireAppId(flags);
 

src/commands/channels/annotations/delete.ts

@@ -51,6 +51,7 @@ export default class ChannelsAnnotationsDelete extends AblyBaseCommand {
 
   async run(): Promise<void> {
     const { args, flags } = await this.parse(ChannelsAnnotationsDelete);
+    this.validateChannelName(args, flags);
     const channelName = args.channel;
     const serial = args.serial;
     const type = args.type;

src/commands/channels/annotations/get.ts

@@ -47,6 +47,7 @@ export default class ChannelsAnnotationsGet extends AblyBaseCommand {
 
   async run(): Promise<void> {
     const { args, flags } = await this.parse(ChannelsAnnotationsGet);
+    this.validateChannelName(args, flags);
     const channelName = args.channel;
     const serial = args.serial;
 

src/commands/channels/annotations/publish.ts

@@ -62,6 +62,7 @@ export default class ChannelsAnnotationsPublish extends AblyBaseCommand {
 
   async run(): Promise<void> {
     const { args, flags } = await this.parse(ChannelsAnnotationsPublish);
+    this.validateChannelName(args, flags);
     const channelName = args.channel;
     const serial = args.serial;
     const type = args.type;

src/commands/channels/annotations/subscribe.ts

@@ -50,6 +50,7 @@ export default class ChannelsAnnotationsSubscribe extends AblyBaseCommand {
 
   async run(): Promise<void> {
     const { args, flags } = await this.parse(ChannelsAnnotationsSubscribe);
+    this.validateChannelName(args, flags);
     const channelName = args.channel;
 
     try {

src/commands/channels/append.ts

@@ -56,6 +56,7 @@ export default class ChannelsAppend extends AblyBaseCommand {
 
   async run(): Promise<void> {
     const { args, flags } = await this.parse(ChannelsAppend);
+    this.validateChannelName(args, flags);
     const channelName = args.channel;
     const serial = args.serial;