feat: modify access list command and introduce access show (#747)

* feat: rename list command to show

* feat: add new list command

* feat: add help text in list output

* fix: update spec

---------

Co-authored-by: Gergely Békési <gergely.bekesi@ethswarm.org>

Author: slapec93

src/command/access/index.ts

@@ -4,11 +4,12 @@ import { History } from './history'
 import { Init } from './init'
 import { List } from './list'
 import { Revoke } from './revoke'
+import { Show } from './show'
 
 export class Access implements GroupCommand {
   public readonly name = 'access'
 
   public readonly description = 'Share access to your uploaded files/folders'
 
-  public subCommandClasses = [Init, Grant, Revoke, List, History]
+  public subCommandClasses = [Init, Grant, Revoke, Show, History, List]
 }

src/command/access/list.ts

@@ -1,40 +1,29 @@
-import { LeafCommand, Option } from 'furious-commander'
-import { exit } from 'process'
+import { LeafCommand } from 'furious-commander'
 import { AccessHistory } from '../../service/access'
-import { granteeListNameProperties } from '../../utils/option'
-import { errorText } from '../../utils/text'
 import { AccessCommand } from './access-command'
 
 export class List extends AccessCommand implements LeafCommand {
   public readonly name = 'list'
 
-  public readonly description = 'List grantees of an existing grantee list'
+  public readonly description = 'List grantee lists'
 
-  @Option(granteeListNameProperties)
-  public listName!: string
-
-  public async run(): Promise<void> {
+  public run() {
     super.init()
 
     const accessHistory = new AccessHistory(this.commandConfig, this.console)
-    const lastHistoryEvent = accessHistory.getEvents(this.listName).sort((a, b) => b.createdAt - a.createdAt)[0]
-
-    if (!lastHistoryEvent) {
-      this.console.error(errorText(`Grantee list with name '${this.listName}' does not exist!`))
-
-      exit(1)
-    }
+    const granteeListNames = Object.keys(accessHistory.getHistory())
 
-    const response = await this.bee.getGrantees(lastHistoryEvent.granteeListRef)
-
-    if (response.grantees.length === 0) {
-      this.console.log(`Grantee list '${this.listName}' has no grantees.`)
+    if (granteeListNames.length === 0) {
+      this.console.log('No grantee lists found.')
 
       return
     }
-    this.console.log(`Grantees of list '${this.listName}':`)
-    for (const grantee of response.grantees) {
-      this.console.log(grantee.toCompressedHex())
+
+    this.console.log(`Grantee lists: \n`)
+    for (const listName of granteeListNames) {
+      this.console.log(listName)
     }
+
+    this.console.log('Run `swarm-cli access show --list-name <name>` to view grantees for a specific list')
   }
 }

src/command/access/show.ts

@@ -0,0 +1,40 @@
+import { LeafCommand, Option } from 'furious-commander'
+import { exit } from 'process'
+import { AccessHistory } from '../../service/access'
+import { granteeListNameProperties } from '../../utils/option'
+import { errorText } from '../../utils/text'
+import { AccessCommand } from './access-command'
+
+export class Show extends AccessCommand implements LeafCommand {
+  public readonly name = 'show'
+
+  public readonly description = 'Show grantees of an existing grantee list'
+
+  @Option(granteeListNameProperties)
+  public listName!: string
+
+  public async run(): Promise<void> {
+    super.init()
+
+    const accessHistory = new AccessHistory(this.commandConfig, this.console)
+    const lastHistoryEvent = accessHistory.getEvents(this.listName).sort((a, b) => b.createdAt - a.createdAt)[0]
+
+    if (!lastHistoryEvent) {
+      this.console.error(errorText(`Grantee list with name '${this.listName}' does not exist!`))
+
+      exit(1)
+    }
+
+    const response = await this.bee.getGrantees(lastHistoryEvent.granteeListRef)
+
+    if (response.grantees.length === 0) {
+      this.console.log(`Grantee list '${this.listName}' has no grantees.`)
+
+      return
+    }
+    this.console.log(`Grantees of list '${this.listName}':`)
+    for (const grantee of response.grantees) {
+      this.console.log(grantee.toCompressedHex())
+    }
+  }
+}

test/command/access.spec.ts

@@ -123,32 +123,50 @@ describeCommand(
       })
     })
 
-    describe('list', () => {
-      it('should list all grantees in the list', async () => {
+    describe('show', () => {
+      it('should show all grantees in the list', async () => {
         const granteePubKey = await getPublicAddress('http://localhost:21633')
         await invokeTestCli(['access', 'init', ...getStampOption(), '-n', 'test-access'])
         await System.sleepMillis(1000)
         await invokeTestCli(['access', 'grant', '--list-name', 'test-access', '--grantee', granteePubKey])
         await System.sleepMillis(1000)
-        await invokeTestCli(['access', 'list', '--list-name', 'test-access'])
+        await invokeTestCli(['access', 'show', '--list-name', 'test-access'])
         expect(getNthLastMessage(2)).toContain(`Grantees of list 'test-access':`)
         expect(getLastMessage()).toContain(granteePubKey)
 
         await invokeTestCli(['access', 'revoke', '--list-name', 'test-access', '--grantee', granteePubKey])
         await System.sleepMillis(1000)
-        await invokeTestCli(['access', 'list', '--list-name', 'test-access'])
+        await invokeTestCli(['access', 'show', '--list-name', 'test-access'])
         expect(getLastMessage()).toContain("Grantee list 'test-access' has no grantees.")
       })
 
       describe('when grantee list does not exist', () => {
         it('should show error message', async () => {
-          await invokeTestCli(['access', 'list', '-n', 'nonexistent-list'])
+          await invokeTestCli(['access', 'show', '-n', 'nonexistent-list'])
           expect(consoleMessages[0]).toContain("Grantee list with name 'nonexistent-list' does not exist!")
           expect(consoleMessages[1]).toContain('process.exit() was called with code 1')
         })
       })
     })
 
+    describe('list', () => {
+      it('should show all grantee list names', async () => {
+        await invokeTestCli(['access', 'init', ...getStampOption(), '-n', 'test-access'])
+        await invokeTestCli(['access', 'init', ...getStampOption(), '-n', 'test-access-2'])
+        await System.sleepMillis(1000)
+        await invokeTestCli(['access', 'list'])
+        expect(getNthLastMessage(3)).toContain('test-access')
+        expect(getNthLastMessage(2)).toContain('test-access-2')
+      })
+
+      describe('when grantee list does not exist', () => {
+        it('should show error message', async () => {
+          await invokeTestCli(['access', 'list'])
+          expect(consoleMessages[0]).toContain('No grantee lists found.')
+        })
+      })
+    })
+
     describe('history', () => {
       it('should show the history of operations on a grantee list', async () => {
         const granteePubKey = await getPublicAddress('http://localhost:21633')