feat: implement upload history

package.json

@@ -67,6 +67,7 @@
     "cafe-utility": "^33.3.1",
     "chalk": "^2.4.2",
     "cli-progress": "^3.11.2",
+    "cli-table3": "^0.6.5",
     "ethers": "^5.7.2",
     "furious-commander": "^1.7.1",
     "inquirer": "^8.2.5",

src/command/feed/feed-command.ts

@@ -73,7 +73,11 @@ export class FeedCommand extends RootCommand {
       this.console.error('The provided identity does not exist. Please select one that exists.')
     }
 
-    return identities[this.identity] || identities[await pickIdentity(this.commandConfig, this.console)]
+    if (!identities[this.identity]) {
+      this.identity = await pickIdentity(this.commandConfig, this.console)
+    }
+
+    return identities[this.identity]
   }
 
   private async writeFeed(stamp: string, wallet: Wallet, topic: Topic, chunkReference: Reference): Promise<FeedInfo> {

src/command/feed/upload.ts

@@ -4,6 +4,7 @@ import { pickStamp } from '../../service/stamp'
 import { stampProperties } from '../../utils/option'
 import { Upload as FileUpload } from '../upload'
 import { FeedCommand } from './feed-command'
+import { saveHistory } from '../../service/history'
 
 export class Upload extends FeedCommand implements LeafCommand {
   public readonly name = 'upload'
@@ -34,6 +35,18 @@ export class Upload extends FeedCommand implements LeafCommand {
 
     const reference = await this.runUpload()
     this.feedManifest = await this.updateFeedAndPrint(this.stamp, reference)
+    saveHistory(
+      {
+        timestamp: Date.now(),
+        reference: reference.toHex(),
+        stamp: this.stamp,
+        path: this.fileUpload.path,
+        uploadType: 'folder',
+        feedIdentity: this.identity,
+        feedAddress: this.feedManifest.toHex(),
+      },
+      this.console,
+    )
     this.console.dim('Successfully uploaded to feed.')
   }
 

src/command/history/history-command.ts

@@ -0,0 +1,3 @@
+import { RootCommand } from '../root-command'
+
+export class HistoryCommand extends RootCommand {}

src/command/history/index.ts

@@ -0,0 +1,11 @@
+import { GroupCommand } from 'furious-commander'
+import { List } from './list'
+import { Show } from './show'
+
+export class History implements GroupCommand {
+  public readonly name = 'history'
+
+  public readonly description = 'Get upload history'
+
+  public subCommandClasses = [List, Show]
+}

src/command/history/list.ts

@@ -0,0 +1,34 @@
+import { HistoryCommand } from './history-command'
+import { getHistory } from '../../service/history'
+import Table from 'cli-table3'
+import { LeafCommand } from 'furious-commander'
+import { ellipsis } from '../../utils/text'
+
+export class List extends HistoryCommand implements LeafCommand {
+  public readonly name = 'list'
+
+  public readonly description = 'Get upload history list'
+
+  public run() {
+    super.init()
+    const table = new Table({
+      head: ['Index', 'Timestamp', 'Reference', 'Postage stamp batch ID', 'File path', 'Upload type'],
+      style: {
+        head: ['green', 'bold'],
+      },
+      wordWrap: true,
+    })
+    const history = getHistory(this.console)
+    table.push(
+      ...history.map(h => [
+        h.index,
+        new Date(h.timestamp).toLocaleString(),
+        h.reference.slice(0, 12),
+        ellipsis(h.stamp, 6, -6),
+        h.path,
+        h.uploadType,
+      ]),
+    )
+    this.console.log(table.toString())
+  }
+}

src/command/history/show.ts

@@ -0,0 +1,46 @@
+import { HistoryCommand } from './history-command'
+import { getHistory } from '../../service/history'
+import { Argument, LeafCommand } from 'furious-commander'
+import { createKeyValue } from '../../utils/text'
+import { exit } from 'process'
+
+export class Show extends HistoryCommand implements LeafCommand {
+  public readonly name = 'show'
+
+  public readonly description = 'Get upload history item'
+
+  @Argument({
+    key: 'index',
+    description: 'Index of the history item',
+    required: true,
+    autocompletePath: true,
+  })
+  public index!: string
+
+  public run() {
+    super.init()
+    const history = getHistory(this.console)
+    const historyItem = history.find(item => item.index === parseInt(this.index))
+
+    if (historyItem === undefined) {
+      this.console.error(`Cound not find history item with index '${this.index}'`)
+      exit(1)
+    }
+    this.console.log(createKeyValue('Timestamp', new Date(historyItem.timestamp).toUTCString()))
+    this.console.log(createKeyValue('Swarm hash', historyItem.reference))
+    this.console.log(createKeyValue('Stamp ID', historyItem.stamp))
+    this.console.log(createKeyValue('Upload type', historyItem.uploadType))
+
+    if (historyItem.path) {
+      this.console.log(createKeyValue('Path', historyItem.path))
+    }
+
+    if (historyItem.feedAddress) {
+      this.console.log(createKeyValue('Feed address', historyItem.feedAddress))
+    }
+
+    if (historyItem.feedIdentity) {
+      this.console.log(createKeyValue('Feed identity', historyItem.feedIdentity))
+    }
+  }
+}

src/command/upload.ts

@@ -15,6 +15,7 @@ import { createSpinner } from '../utils/spinner'
 import { createKeyValue, warningSymbol, warningText } from '../utils/text'
 import { RootCommand } from './root-command'
 import { VerbosityLevel } from './root-command/command-log'
+import { saveHistory } from '../service/history'
 
 export class Upload extends RootCommand implements LeafCommand {
   public readonly name = 'upload'
@@ -166,7 +167,8 @@ export class Upload extends RootCommand implements LeafCommand {
     const url = await this.uploadAnyWithSpinner(tag, uploadingFolder)
 
     this.console.dim('Data has been sent to the Bee node successfully!')
-    this.console.log(createKeyValue('Swarm hash', this.result.getOrThrow().toHex()))
+    const swarmHash = this.result.getOrThrow().toHex()
+    this.console.log(createKeyValue('Swarm hash', swarmHash))
 
     if (this.act) {
       this.console.log(createKeyValue('Swarm history address', this.historyAddress.getOrThrow().toHex()))
@@ -180,6 +182,19 @@ export class Upload extends RootCommand implements LeafCommand {
     this.console.dim('Uploading was successful!')
     this.console.log(createKeyValue('URL', url))
 
+    if (!usedFromOtherCommand) {
+      saveHistory(
+        {
+          timestamp: Date.now(),
+          reference: swarmHash,
+          stamp: this.stamp,
+          path: this.path,
+          uploadType: this.path ? 'file' : 'stdin',
+        },
+        this.console,
+      )
+    }
+
     if (!usedFromOtherCommand) {
       this.console.quiet(this.result.getOrThrow().toHex())
 

src/config.ts

@@ -17,6 +17,7 @@ import { Status } from './command/status'
 import { Upload } from './command/upload'
 import { Utility } from './command/utility'
 import { Wallet } from './command/wallet'
+import { History } from './command/history'
 
 export const beeApiUrl: IOption<string> = {
   key: 'bee-api-url',
@@ -133,4 +134,5 @@ export const rootCommandClasses = [
   Utility,
   Grantee,
   Quickstart,
+  History,
 ]

src/service/history/index.ts

@@ -0,0 +1,31 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs'
+import { homedir } from 'os'
+import { join } from 'path'
+import { History } from './types/history'
+import { exit } from 'process'
+import { CommandLog } from '../../command/root-command/command-log'
+
+const historyFilePath = join(homedir(), '.swarm-upload-history.json')
+
+export function getHistory(console: CommandLog): History[] {
+  if (!existsSync(historyFilePath)) {
+    return []
+  }
+  const historyData = readFileSync(historyFilePath)
+  try {
+    const historyList = JSON.parse(historyData.toString()) as History[]
+
+    return historyList
+  } catch (err) {
+    console.error(`There has been an error parsing history JSON from path: '${historyFilePath}'`)
+
+    exit(1)
+  }
+}
+
+export function saveHistory(historyEntry: History, console: CommandLog) {
+  const history = getHistory(console)
+  historyEntry.index = history.length + 1
+  history.push(historyEntry)
+  writeFileSync(historyFilePath, JSON.stringify(history))
+}

src/service/history/types/history.ts

@@ -0,0 +1,10 @@
+export type History = {
+  index?: number
+  timestamp: number
+  reference: string
+  stamp: string
+  path: string | null
+  uploadType: 'file' | 'folder' | 'stdin'
+  feedAddress?: string | null
+  feedIdentity?: string | null
+}

src/utils/text.ts

@@ -25,6 +25,10 @@ export function createKeyValue(key: string, value: string | number | boolean, pa
   return `${chalk.green.bold(key + ':').padEnd(padLength ? padLength + 1 : 0)} ${String(value)}`
 }
 
+export function ellipsis(value: string, startIndex: number, endIndex?: number | null) {
+  return `${value.slice(0, startIndex)}...${endIndex ? value.slice(endIndex) : ''}`
+}
+
 export function printDivided<T>(
   items: T[],
   printFn: (item: T, console: CommandLog) => void,