Updated Broker type interfaces; improving unit test; code formatting.

Author: dishantlangayan

src/commands/missionctrl/broker/create.ts

@@ -1,7 +1,7 @@
 import {Flags} from '@oclif/core'
 
 import {ScCommand} from '../../../sc-command.js'
-import {EventBrokerCreateApiResponse, EventBrokerCreateDetail} from '../../../types/broker.js'
+import {EventBrokerOperationApiResponse, EventBrokerOperationDetail} from '../../../types/broker.js'
 import {camelCaseToTitleCase, renderKeyValueTable} from '../../../util/internal.js'
 import {ScConnection} from '../../../util/sc-connection.js'
 
@@ -65,7 +65,7 @@ Token Permissions: [ \`services:post\` ]`
     }),
   }
 
-  public async run(): Promise<EventBrokerCreateDetail> {
+  public async run(): Promise<EventBrokerOperationDetail> {
     const {flags} = await this.parse(MissionctrlBrokerCreate)
 
     const datacenterId = flags['datacenter-id'] ?? ''
@@ -109,14 +109,14 @@ Token Permissions: [ \`services:post\` ]`
     }
 
     // API call
-    const resp = await conn.post<EventBrokerCreateApiResponse>(apiUrl, body)
+    const resp = await conn.post<EventBrokerOperationApiResponse>(apiUrl, body)
     // Display results
     this.log('Event broker service created successfully.')
     this.print(resp.data)
     return resp.data
   }
 
-  private print(broker: EventBrokerCreateDetail): void {
+  private print(broker: EventBrokerOperationDetail): void {
     const tableRows = [
       ['Key', 'Value'],
       ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),

src/commands/missionctrl/broker/delete.ts

@@ -1,8 +1,13 @@
-import { Flags } from '@oclif/core'
+import {Flags} from '@oclif/core'
 
-import { ScCommand } from '../../../sc-command.js'
-import { EventBrokerListApiResponse } from '../../../types/broker.js'
-import { ScConnection } from '../../../util/sc-connection.js'
+import {ScCommand} from '../../../sc-command.js'
+import {
+  EventBrokerListApiResponse,
+  EventBrokerOperationApiResponse,
+  EventBrokerOperationDetail,
+} from '../../../types/broker.js'
+import {camelCaseToTitleCase, renderKeyValueTable} from '../../../util/internal.js'
+import {ScConnection} from '../../../util/sc-connection.js'
 
 export default class MissionctrlBrokerDelete extends ScCommand<typeof MissionctrlBrokerDelete> {
   static override args = {}
@@ -28,8 +33,8 @@ Token Permissions: [ \`services:delete\` **or** \`services:delete:self\` **or**
     }),
   }
 
-  public async run(): Promise<{ message: string }> {
-    const { flags } = await this.parse(MissionctrlBrokerDelete)
+  public async run(): Promise<EventBrokerOperationDetail> {
+    const {flags} = await this.parse(MissionctrlBrokerDelete)
 
     const name = flags.name ?? ''
     const brokerId = flags['broker-id'] ?? ''
@@ -57,9 +62,20 @@ Token Permissions: [ \`services:delete\` **or** \`services:delete:self\` **or**
 
     // API call to delete environment by id
     apiUrl += `/${brokerIdToDelete}`
-    await conn.delete<string>(apiUrl)
-    const message = `Event broker service with id '${brokerIdToDelete}' has been deleted successfully.`
-    this.log(message)
-    return { message }
+    const resp = await conn.delete<EventBrokerOperationApiResponse>(apiUrl)
+
+    // Display results
+    this.print(resp.data)
+
+    return resp.data
+  }
+
+  private print(broker: EventBrokerOperationDetail): void {
+    const tableRows = [
+      ['Key', 'Value'],
+      ...Object.entries(broker).map(([key, value]) => [camelCaseToTitleCase(key), value]),
+    ]
+    this.log()
+    this.log(renderKeyValueTable(tableRows))
   }
 }

src/commands/missionctrl/broker/display.ts

@@ -1,7 +1,7 @@
 import { Flags } from '@oclif/core'
 
 import { ScCommand } from '../../../sc-command.js'
-import { EventBrokerListApiResponse, EventBrokerServiceDetail } from '../../../types/broker.js'
+import { EventBrokerApiResponse, EventBrokerListApiResponse, EventBrokerServiceDetail } from '../../../types/broker.js'
 import { camelCaseToTitleCase, renderKeyValueTable } from '../../../util/internal.js'
 import { ScConnection } from '../../../util/sc-connection.js'
 
@@ -43,9 +43,9 @@ export default class MissionctrlBrokerDisplay extends ScCommand<typeof Missionct
     if (brokerId) {
       // API call to get broker by id
       apiUrl += `/${brokerId}`
-      const resp = await conn.get<EventBrokerServiceDetail>(apiUrl)
-      this.print(resp)
-      rawResp = [resp]
+      const resp = await conn.get<EventBrokerApiResponse>(apiUrl)
+      this.print(resp.data)
+      rawResp = [resp.data]
     } else if (name) {
       // API call to get broker by name
       apiUrl += `?customAttributes=name=="${name}"`

src/commands/missionctrl/broker/list.ts

@@ -1,9 +1,9 @@
-import { Flags } from '@oclif/core'
+import {Flags} from '@oclif/core'
 
-import { ScCommand } from '../../../sc-command.js'
-import { EventBrokerListApiResponse, EventBrokerServiceDetail } from '../../../types/broker.js'
-import { renderTable } from '../../../util/internal.js'
-import { ScConnection } from '../../../util/sc-connection.js'
+import {ScCommand} from '../../../sc-command.js'
+import {EventBrokerListApiResponse, EventBrokerServiceDetail} from '../../../types/broker.js'
+import {renderTable} from '../../../util/internal.js'
+import {ScConnection} from '../../../util/sc-connection.js'
 
 export default class MissionctrlBrokerList extends ScCommand<typeof MissionctrlBrokerList> {
   static override args = {}
@@ -12,17 +12,19 @@ export default class MissionctrlBrokerList extends ScCommand<typeof MissionctrlB
 Your token must have one of the permissions listed in the Token Permissions.
 
 Token Permissions: [ \`mission_control:access\` **or** \`services:get\` **or** \`services:get:self\` **or** \`services:view\` **or** \`services:view:self\` ]`
-  static override examples = ['<%= config.bin %> <%= command.id %> --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc']
+  static override examples = [
+    '<%= config.bin %> <%= command.id %> --name=MyBrokerName --pageNumber=1 --pageSize=10 --sort=name:asc',
+  ]
   static override flags = {
     name: Flags.string({
       char: 'n',
-      description: 'Name of the event broker service to match on.'
+      description: 'Name of the event broker service to match on.',
     }),
     pageNumber: Flags.integer({
-      description: 'The page number to get. Defaults to 1'
+      description: 'The page number to get. Defaults to 1',
     }),
     pageSize: Flags.integer({
-      description: 'The number of event broker services to return per page. Defaults to 100',
+      description: 'The number of event broker services to return per page. Defaults to 10',
       max: 100,
       min: 1,
     }),
@@ -37,7 +39,7 @@ Token Permissions: [ \`mission_control:access\` **or** \`services:get\` **or** \
   }
 
   public async run(): Promise<EventBrokerServiceDetail[]> {
-    const { flags } = await this.parse(MissionctrlBrokerList)
+    const {flags} = await this.parse(MissionctrlBrokerList)
 
     const conn = new ScConnection()
 

src/commands/missionctrl/broker/opstatus.ts

@@ -1,10 +1,15 @@
-import { Flags } from '@oclif/core'
-import { MultiBar, Presets, SingleBar } from 'cli-progress'
-
-import { ScCommand } from '../../../sc-command.js'
-import { AllOperationResponse, EventBrokerListApiResponse, OperationData, OperationResponse } from '../../../types/broker.js'
-import { renderTable, sleep } from '../../../util/internal.js'
-import { ScConnection } from '../../../util/sc-connection.js'
+import {Flags} from '@oclif/core'
+import {MultiBar, Presets, SingleBar} from 'cli-progress'
+
+import {ScCommand} from '../../../sc-command.js'
+import {
+  EventBrokerAllOperationsApiResponse,
+  EventBrokerListApiResponse,
+  EventBrokerOperationApiResponse,
+  EventBrokerOperationDetail,
+} from '../../../types/broker.js'
+import {renderTable, sleep} from '../../../util/internal.js'
+import {ScConnection} from '../../../util/sc-connection.js'
 
 export default class MissionctrlBrokerOpstatus extends ScCommand<typeof MissionctrlBrokerOpstatus> {
   static override args = {}
@@ -29,16 +34,18 @@ export default class MissionctrlBrokerOpstatus extends ScCommand<typeof Missionc
     }),
     'show-progress': Flags.boolean({
       char: 'p',
-      description: 'Displays a status bar of the in-progress operations. The command will wait for completion of each step of the operation.'
+      description:
+        'Displays a status bar of the in-progress operations. The command will wait for completion of each step of the operation.',
     }),
     'wait-ms': Flags.integer({
       char: 'w',
-      description: 'The milliseconds to wait between API calls for checking progress of the operation. Default is 5000 ms.'
+      description:
+        'The milliseconds to wait between API calls for checking progress of the operation. Default is 5000 ms.',
     }),
   }
 
-  public async run(): Promise<OperationData[]> {
-    const { flags } = await this.parse(MissionctrlBrokerOpstatus)
+  public async run(): Promise<EventBrokerOperationDetail[]> {
+    const {flags} = await this.parse(MissionctrlBrokerOpstatus)
 
     const name = flags.name ?? ''
     let brokerId = flags['broker-id'] ?? ''
@@ -56,23 +63,25 @@ export default class MissionctrlBrokerOpstatus extends ScCommand<typeof Missionc
       // API call to get broker by name
       apiUrl += `?customAttributes=name=="${name}"`
       const resp = await conn.get<EventBrokerListApiResponse>(apiUrl)
-      // FUTURE: show status of multiple brokers operations that match the name 
+      // FUTURE: show status of multiple brokers operations that match the name
       if (resp.data.length === 0) {
         this.error(`No brokers found with name: ${name}.`)
       } else if (resp.data.length > 1) {
-        this.error(`Multiple broker services found with: ${name}. Exactly one broker service must match the provided name.`)
+        this.error(
+          `Multiple broker services found with: ${name}. Exactly one broker service must match the provided name.`,
+        )
       } else {
         brokerId = resp.data[0]?.id
       }
     }
 
     // API call to retrieve status of the broker operation
     apiUrl = `/missionControl/eventBrokerServices/${brokerId}/operations`
-    
-    const resp = await conn.get<AllOperationResponse>(apiUrl)
+
+    const resp = await conn.get<EventBrokerAllOperationsApiResponse>(apiUrl)
     const opStatusArray = [
       ['Operation Id', 'Operation Type', 'Status', 'Created Time', 'Completed Time'],
-      ...resp.data.map((item: OperationData) => [
+      ...resp.data.map((item: EventBrokerOperationDetail) => [
         item.id,
         item.operationType,
         item.status,
@@ -85,42 +94,51 @@ export default class MissionctrlBrokerOpstatus extends ScCommand<typeof Missionc
     this.log(renderTable(opStatusArray))
 
     // If show-progress flag is set, display progress bars for each operation
-    if(showProgress && resp.data.length > 0) {
+    if (showProgress && resp.data.length > 0) {
       // Create progress bar for each operation
-      const multiProgressBar = new MultiBar({
-        clearOnComplete: false,
-        format: ' {bar} | {operationType} | {value}/{total}',
-        hideCursor: true,
-      }, Presets.shades_classic)
-      
+      const multiProgressBar = new MultiBar(
+        {
+          clearOnComplete: false,
+          format: ' {bar} | {operationType} | {value}/{total}',
+          hideCursor: true,
+        },
+        Presets.shades_classic,
+      )
+
       // Get the initial progress for each operation
       const progressBars: [string, SingleBar][] = []
       let completedOperations = 0
       let allCompleted = false
       for (const operationData of resp.data) {
         const opStatusApiUrl = `/missionControl/eventBrokerServices/${brokerId}/operations/${operationData.id}?expand=progressLogs`
         // eslint-disable-next-line no-await-in-loop
-        const opStatusResp = await conn.get<OperationResponse>(opStatusApiUrl)
-        this.debug(`Operation ID: ${operationData.id}, Type: ${operationData.operationType}, Status: ${operationData.status}`)
+        const opStatusResp = await conn.get<EventBrokerOperationApiResponse>(opStatusApiUrl)
+        this.debug(
+          `Operation ID: ${operationData.id}, Type: ${operationData.operationType}, Status: ${operationData.status}`,
+        )
         if (opStatusResp.data.progressLogs) {
           const numSteps = opStatusResp.data.progressLogs.length
           // start a new progress bar for the operation with a total value of size of the steps
-          const progressBar = multiProgressBar.create(numSteps, 0, { operationType: operationData.operationType })
+          const progressBar = multiProgressBar.create(numSteps, 0, {operationType: operationData.operationType})
           // Update the progress with the steps completed
-          const completedNumSteps = opStatusResp.data.progressLogs.filter(log => log.status === 'success').length
+          const completedNumSteps = opStatusResp.data.progressLogs.filter((log) => log.status === 'success').length
           progressBar.update(completedNumSteps)
-          if (completedNumSteps === numSteps || opStatusResp.data.status === 'SUCCEEDED' || opStatusResp.data.status === 'FAILED') {
+          if (
+            completedNumSteps === numSteps ||
+            opStatusResp.data.status === 'SUCCEEDED' ||
+            opStatusResp.data.status === 'FAILED'
+          ) {
             completedOperations += 1
             progressBar.stop()
           }
-          
+
           // Add the operation ID and progress bar to the list
           progressBars.push([operationData.id, progressBar])
         }
       }
 
       // Check if all operations are completed
-      if(completedOperations === progressBars.length) {
+      if (completedOperations === progressBars.length) {
         allCompleted = true
       }
 
@@ -132,29 +150,37 @@ export default class MissionctrlBrokerOpstatus extends ScCommand<typeof Missionc
         // eslint-disable-next-line no-await-in-loop
         allCompleted = await this.pollAllOperationStatus(conn, brokerId, progressBars)
       }
-      
+
       multiProgressBar.stop()
       this.log() // Add a new line for better readability
     }
 
     return resp.data
   }
 
-  private async pollAllOperationStatus(conn: ScConnection, brokerId: string, progressBars: [string, SingleBar][]): Promise<boolean> {
+  private async pollAllOperationStatus(
+    conn: ScConnection,
+    brokerId: string,
+    progressBars: [string, SingleBar][],
+  ): Promise<boolean> {
     let completedOperations = 0
     let allCompleted = false
     // For each operation, get the latest status and update the progress bar
     for (const [operationId, progressBar] of progressBars) {
       const opStatusApiUrl = `/missionControl/eventBrokerServices/${brokerId}/operations/${operationId}?expand=progressLogs`
       // eslint-disable-next-line no-await-in-loop
-      const opStatusResp = await conn.get<OperationResponse>(opStatusApiUrl)
+      const opStatusResp = await conn.get<EventBrokerOperationApiResponse>(opStatusApiUrl)
       if (opStatusResp.data.progressLogs) {
         const numSteps = opStatusResp.data.progressLogs.length
-        const completedNumSteps = opStatusResp.data.progressLogs.filter(log => log.status === 'success').length
+        const completedNumSteps = opStatusResp.data.progressLogs.filter((log) => log.status === 'success').length
         // Update progress bar
         progressBar.setTotal(numSteps)
         progressBar.update(completedNumSteps)
-        if (completedNumSteps === numSteps || opStatusResp.data.status === 'SUCCEEDED' || opStatusResp.data.status === 'FAILED') {
+        if (
+          completedNumSteps === numSteps ||
+          opStatusResp.data.status === 'SUCCEEDED' ||
+          opStatusResp.data.status === 'FAILED'
+        ) {
           completedOperations += 1
           progressBar.stop()
         }
@@ -164,10 +190,10 @@ export default class MissionctrlBrokerOpstatus extends ScCommand<typeof Missionc
     }
 
     // Check if all operations are completed
-    if(completedOperations === progressBars.length) {
+    if (completedOperations === progressBars.length) {
       allCompleted = true
     }
 
     return allCompleted
   }
-}
+}