@streamr/cli-tools 8.3.0-beta.1 → 8.3.1

package/CHANGELOG.md

@@ -20,6 +20,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 
 
+## [8.3.1] - 2023-05-03
+
+### Fixed
+
+- Fix `stream create` ouput (now valid JSON without extra characters)
+
+
 ## [7.0.0] - 2022-11-15
 
 ### Changed
@@ -149,7 +156,8 @@ ordering and gap filling.
 - Re-organize README.md and a few touches to Developing section paragraphs.
 
 
-[Unreleased]: https://github.com/streamr-dev/network/compare/cli-tools%2fv7.0.0...HEAD
+[Unreleased]: https://github.com/streamr-dev/network/compare/cli-tools%2fv8.3.1...HEAD
+[8.3.1]: https://github.com/streamr-dev/network/compare/cli-tools%2fv7.0.0...cli-tools%2fv8.3.1
 [7.0.0]: https://github.com/streamr-dev/network/compare/cli-tools%2fv6.1.1...cli-tools%2fv7.0.0
 [6.1.1]: https://github.com/streamr-dev/network/compare/cli-tools%2fv6.1.0...cli-tools%2fv6.1.1
 [6.1.0]: https://github.com/streamr-dev/network/compare/cli-tools%2fv6.0.0...cli-tools%2fv6.1.0

package/bin/streamr-stream-create.ts

@@ -12,7 +12,7 @@ createClientCommand(async (client: StreamrClient, streamIdOrPath: string, option
         partitions: options.partitions
     }
     const stream = await client.createStream(body)
-    console.info({ id: stream.id, ...stream.getMetadata() }, null, 2)
+    console.info(JSON.stringify({ id: stream.id, ...stream.getMetadata() }, null, 2))
 })
     .arguments('<streamId>')
     .description('create a new stream')

package/dist/bin/streamr-stream-create.js

@@ -12,7 +12,7 @@ const command_1 = require("../src/command");
         partitions: options.partitions
     };
     const stream = await client.createStream(body);
-    console.info({ id: stream.id, ...stream.getMetadata() }, null, 2);
+    console.info(JSON.stringify({ id: stream.id, ...stream.getMetadata() }, null, 2));
 })
     .arguments('<streamId>')
     .description('create a new stream')

package/dist/bin/streamr-stream-create.js.map

@@ -1 +1 @@
-{"version":3,"file":"streamr-stream-create.js","sourceRoot":"","sources":["../../bin/streamr-stream-create.ts"],"names":[],"mappings":";;;AACA,2BAAwB;AAExB,0CAAgD;AAChD,4CAAoD;AAEpD,IAAA,6BAAmB,EAAC,KAAK,EAAE,MAAqB,EAAE,cAAsB,EAAE,OAAY,EAAE,EAAE;IACtF,MAAM,IAAI,GAAQ;QACd,EAAE,EAAE,cAAc;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,MAAM,EAAE,OAAO,CAAC,YAAY;QAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;KACjC,CAAA;IACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAC9C,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;AACrE,CAAC,CAAC;KACG,SAAS,CAAC,YAAY,CAAC;KACvB,WAAW,CAAC,qBAAqB,CAAC;KAClC,MAAM,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;KACjE,MAAM,CAAC,8BAA8B,EAAE,gCAAgC,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACtG,MAAM,CAAC,0BAA0B,EAAE,0BAA0B,EAC1D,IAAA,yBAAgB,EAAC,cAAc,CAAC,CAAC;KACpC,UAAU,EAAE,CAAA"}
+{"version":3,"file":"streamr-stream-create.js","sourceRoot":"","sources":["../../bin/streamr-stream-create.ts"],"names":[],"mappings":";;;AACA,2BAAwB;AAExB,0CAAgD;AAChD,4CAAoD;AAEpD,IAAA,6BAAmB,EAAC,KAAK,EAAE,MAAqB,EAAE,cAAsB,EAAE,OAAY,EAAE,EAAE;IACtF,MAAM,IAAI,GAAQ;QACd,EAAE,EAAE,cAAc;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,MAAM,EAAE,OAAO,CAAC,YAAY;QAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;KACjC,CAAA;IACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;AACrF,CAAC,CAAC;KACG,SAAS,CAAC,YAAY,CAAC;KACvB,WAAW,CAAC,qBAAqB,CAAC;KAClC,MAAM,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;KACjE,MAAM,CAAC,8BAA8B,EAAE,gCAAgC,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACtG,MAAM,CAAC,0BAA0B,EAAE,0BAA0B,EAC1D,IAAA,yBAAgB,EAAC,cAAc,CAAC,CAAC;KACpC,UAAU,EAAE,CAAA"}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@streamr/cli-tools",
-    "version": "8.3.0-beta.1",
+    "version": "8.3.1",
     "description": "Command line tools for Streamr",
     "repository": {
         "type": "git",
@@ -15,7 +15,7 @@
         "check": "tsc -p ./tsconfig.json --noEmit",
         "clean": "jest --clearCache || true; rm -rf dist *.tsbuildinfo node_modules/.cache || true",
         "eslint": "eslint --cache --cache-location=node_modules/.cache/.eslintcache/ '*/**/*.{js,ts}'",
-        "test": "echo \"Error: no test specified\" && exit 1"
+        "test": "npm run build && jest --forceExit"
     },
     "keywords": [
         "streamr",
@@ -28,16 +28,18 @@
     "dependencies": {
         "@ethersproject/wallet": "^5.5.0",
         "@snapshot-labs/snapshot.js": "^0.4.43",
-        "@streamr/utils": "8.3.0-beta.1",
+        "@streamr/utils": "8.3.1",
         "commander": "^10.0.1",
         "easy-table": "^1.1.1",
         "event-stream": "^4.0.1",
         "lodash": "^4.17.21",
-        "streamr-client": "8.3.0-beta.1"
+        "streamr-client": "8.3.1"
     },
     "devDependencies": {
-        "@types/easy-table": "1.2.0",
+        "@streamr/test-utils": "8.3.1",
         "@types/event-stream": "^4.0.0",
-        "@types/lodash": "^4.14.175"
+        "@types/lodash": "^4.14.175",
+        "@types/merge2": "^1.4.0",
+        "merge2": "^1.4.1"
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamr/cli-tools",
-  "version": "8.3.0-beta.1",
+  "version": "8.3.1",
   "description": "Command line tools for Streamr",
   "repository": {
     "type": "git",
@@ -15,7 +15,7 @@
     "check": "tsc -p ./tsconfig.json --noEmit",
     "clean": "jest --clearCache || true; rm -rf dist *.tsbuildinfo node_modules/.cache || true",
     "eslint": "eslint --cache --cache-location=node_modules/.cache/.eslintcache/ '*/**/*.{js,ts}'",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "npm run build && jest --forceExit"
   },
   "keywords": [
     "streamr",
@@ -28,16 +28,18 @@
   "dependencies": {
     "@ethersproject/wallet": "^5.5.0",
     "@snapshot-labs/snapshot.js": "^0.4.43",
-    "@streamr/utils": "8.3.0-beta.1",
+    "@streamr/utils": "8.3.1",
     "commander": "^10.0.1",
     "easy-table": "^1.1.1",
     "event-stream": "^4.0.1",
     "lodash": "^4.17.21",
-    "streamr-client": "8.3.0-beta.1"
+    "streamr-client": "8.3.1"
   },
   "devDependencies": {
-    "@types/easy-table": "1.2.0",
+    "@streamr/test-utils": "8.3.1",
     "@types/event-stream": "^4.0.0",
-    "@types/lodash": "^4.14.175"
+    "@types/lodash": "^4.14.175",
+    "@types/merge2": "^1.4.0",
+    "merge2": "^1.4.1"
   }
 }

package/test/mock-data.test.ts

@@ -0,0 +1,19 @@
+import { collect } from '@streamr/utils'
+import 'jest-extended'
+import { startCommand } from './utils'
+
+describe('mock-data', () => {
+
+    it('generate', async () => {
+        const abortController = new AbortController()
+        const outputIterable = startCommand('mock-data generate', {
+            abortSignal: abortController.signal,
+            devEnvironment: false
+        })
+        const firstLine = (await collect(outputIterable, 1))[0]
+        abortController.abort()
+        const json = JSON.parse(firstLine)
+        expect(json).toBeObject()
+    })
+
+})

package/test/storage-node.test.ts

@@ -0,0 +1,32 @@
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import 'jest-extended'
+import { StreamID } from 'streamr-client'
+import { DOCKER_DEV_STORAGE_NODE, createTestClient, runCommand } from './utils'
+
+const isStored = async (streamId: StreamID): Promise<boolean> => {
+    const output = await runCommand(`storage-node list-streams ${DOCKER_DEV_STORAGE_NODE}`)
+    return output.join().includes(streamId)
+}
+
+describe('storage node', () => {
+
+    it('add and remove stream', async () => {
+        const privateKey = await fetchPrivateKeyWithGas()
+        const client = createTestClient(privateKey)
+        const stream = await client.createStream(`/${Date.now()}`)
+        await client.destroy()
+        await runCommand(`storage-node add-stream ${DOCKER_DEV_STORAGE_NODE} ${stream.id}`, {
+            privateKey
+        })
+        expect(await isStored(stream.id)).toBeTrue()
+        await runCommand(`storage-node remove-stream ${DOCKER_DEV_STORAGE_NODE} ${stream.id}`, {
+            privateKey
+        })
+        expect(await isStored(stream.id)).toBeFalse()
+    }, 80 * 1000)
+
+    it('list nodes', async () => {
+        const outputLines = await runCommand('storage-node list')
+        expect(outputLines[2]).toEqual(DOCKER_DEV_STORAGE_NODE.toLowerCase())
+    })
+})

package/test/stream-create.test.ts

@@ -0,0 +1,26 @@
+import { Wallet } from '@ethersproject/wallet'
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import { createTestClient, runCommand } from './utils'
+
+describe('create stream', () => {
+
+    it('happy path', async () => {
+        const privateKey = await fetchPrivateKeyWithGas()
+        const address = new Wallet(privateKey).address.toLowerCase()
+        const path = `/${Date.now()}`
+        const streamId = `${address}${path}`
+        const outputLines = await runCommand(`stream create ${path}`, {
+            privateKey
+        })
+        const outputJson = JSON.parse(outputLines.join(''))
+        expect(outputJson).toMatchObject({
+            id: streamId,
+            partitions: 1
+        })
+        const client = createTestClient()
+        const stream = await client.getStream(streamId)
+        expect(stream.getMetadata().partitions).toBe(1)
+        await client.destroy()
+    }, 20 * 1000)
+
+})

package/test/stream-permission.test.ts

@@ -0,0 +1,29 @@
+import { fetchPrivateKeyWithGas, randomEthereumAddress } from '@streamr/test-utils'
+import 'jest-extended'
+import { StreamPermission } from 'streamr-client'
+import { createTestClient, runCommand } from './utils'
+
+describe('permission', () => {
+
+    it('grant and revoke', async () => {
+        const privateKey = await fetchPrivateKeyWithGas()
+        const client = createTestClient(privateKey)
+        const stream = await client.createStream(`/${Date.now()}`)
+        const otherUser = randomEthereumAddress()
+        const hasPermission = () => client.hasPermission({
+            user: otherUser,
+            permission: StreamPermission.PUBLISH,
+            streamId: stream.id,
+            allowPublic: false
+        })
+        await runCommand(`stream grant-permission ${stream.id} ${otherUser} publish`, {
+            privateKey
+        })
+        expect(await hasPermission()).toBeTrue()
+        await runCommand(`stream revoke-permission ${stream.id} ${otherUser} publish`, {
+            privateKey
+        })
+        expect(await hasPermission()).toBeFalse()
+        await client.destroy()
+    }, 40 * 1000)
+})

package/test/stream-publish-subscribe.test.ts

@@ -0,0 +1,35 @@
+import { Wallet } from '@ethersproject/wallet'
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import { collect } from '@streamr/utils'
+import { StreamPermission } from 'streamr-client'
+import { createTestClient, runCommand, startCommand } from './utils'
+
+describe('publish and subscribe', () => {
+
+    it('happy path', async () => {
+        const publisherPrivateKey = await fetchPrivateKeyWithGas()
+        const subscriberPrivateKey = await fetchPrivateKeyWithGas()
+        const client = createTestClient(publisherPrivateKey)
+        const stream = await client.createStream(`/${Date.now()}`)
+        await stream.grantPermissions({
+            user: new Wallet(subscriberPrivateKey).address,
+            permissions: [StreamPermission.SUBSCRIBE]
+        })
+        const subscriberAbortController = new AbortController()
+        const subscriberOutputIterable = startCommand(`stream subscribe ${stream.id}`, {
+            privateKey: subscriberPrivateKey,
+            abortSignal: subscriberAbortController.signal
+        })
+        setImmediate(async () => {
+            await runCommand(`stream publish ${stream.id}`, {
+                inputLines: [JSON.stringify({ foo: 123 })],
+                privateKey: publisherPrivateKey
+            })
+        })
+        const receivedMessage = (await collect(subscriberOutputIterable, 1))[0]
+        subscriberAbortController.abort()
+        expect(JSON.parse(receivedMessage)).toEqual({
+            foo: 123
+        })
+    }, 40 * 1000)
+})

package/test/stream-resend.test.ts

@@ -0,0 +1,66 @@
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import range from 'lodash/range'
+import { Message, Stream } from 'streamr-client'
+import { DOCKER_DEV_STORAGE_NODE, createTestClient, runCommand } from './utils'
+import { wait } from '@streamr/utils'
+
+const parseJSONs = (lines: string[]): any[] => {
+    return lines.map((line) => JSON.parse(line))
+}
+
+describe('resend stream', () => {
+
+    let privateKey: string
+    let stream: Stream
+    const messages: Message[] = []
+
+    beforeAll(async () => {
+        privateKey = await fetchPrivateKeyWithGas()
+        const client = createTestClient(privateKey)
+        stream = await client.createStream(`/${Date.now()}`)
+        await stream.addToStorageNode(DOCKER_DEV_STORAGE_NODE)
+        for (const msgId of range(10)) {
+            await wait(10) // to prevent duplicate timestamps (to make test assertions simpler)
+            const msg = await stream.publish({ msgId })
+            messages.push(msg)
+        }
+        await wait(1000)
+        await client.destroy()
+    }, 20 * 1000)
+
+    it('last', async () => {
+        const outputLines = await runCommand(`stream resend last 3 ${stream.id}`, {
+            privateKey
+        })
+        expect(parseJSONs(outputLines)).toEqual([
+            { msgId: 7 },
+            { msgId: 8 },
+            { msgId: 9 }
+        ])
+    }, 20 * 1000)
+
+    it('from', async () => {
+        const minTimestamp = new Date(messages[8].timestamp).toISOString()
+        const outputLines = await runCommand(`stream resend from ${minTimestamp} ${stream.id}`, {
+            privateKey
+        })
+        expect(parseJSONs(outputLines)).toEqual([
+            { msgId: 8 },
+            { msgId: 9 }
+        ])
+    }, 20 * 1000)
+
+    it('range', async () => {
+        const minTimestamp = new Date(messages[2].timestamp).toISOString()
+        const maxTimestamp = new Date(messages[4].timestamp).toISOString()
+        const outputLines = await runCommand(`stream resend range ${minTimestamp} ${maxTimestamp} ${stream.id}`, {
+            privateKey
+        })
+        expect(parseJSONs(outputLines)).toEqual([
+            { msgId: 2 },
+            { msgId: 3 },
+            { msgId: 4 }
+        ])
+    }, 20 * 1000)
+
+})

package/test/stream-search.test.ts

@@ -0,0 +1,20 @@
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import { randomString } from '@streamr/utils'
+import { createTestClient, runCommand } from './utils'
+
+describe('search streams', () => {
+
+    it('happy path', async () => {
+        const testId = randomString(10)
+        const client = createTestClient(await fetchPrivateKeyWithGas())
+        const stream1 = await client.createStream(`/${testId}-1`)
+        const stream2 = await client.createStream(`/${testId}-2`)
+        await client.destroy()
+        const outputLines = await runCommand(`stream search ${testId}`)
+        expect(outputLines).toEqual([
+            stream1.id,
+            stream2.id
+        ])
+    }, 20 * 1000)
+
+})

package/test/stream-show.test.ts

@@ -0,0 +1,30 @@
+import { Wallet } from '@ethersproject/wallet'
+import { fetchPrivateKeyWithGas } from '@streamr/test-utils'
+import { createTestClient, runCommand } from './utils'
+
+describe('show stream', () => {
+
+    it('happy path', async () => {
+        const creatorPrivateKey = await fetchPrivateKeyWithGas()
+        const client = createTestClient(creatorPrivateKey)
+        const stream = await client.createStream(`/${Date.now()}`)
+        await client.destroy()
+        const outputLines = await runCommand(`stream show ${stream.id} --include-permissions`)
+        const outputJson = JSON.parse(outputLines.join(''))
+        expect(outputJson).toMatchObject({
+            id: stream.id,
+            partitions: 1,
+            permissions: [{
+                permissions: [
+                    'edit',
+                    'delete',
+                    'publish',
+                    'subscribe',
+                    'grant'
+                ],
+                user: new Wallet(creatorPrivateKey).address.toLowerCase()
+            }]
+        })
+    }, 20 * 1000)
+
+})

package/test/utils.ts

@@ -0,0 +1,74 @@
+import { collect } from '@streamr/utils'
+import { spawn } from 'child_process'
+import merge2 from 'merge2'
+import { CONFIG_TEST, StreamrClient } from 'streamr-client'
+
+export const DOCKER_DEV_STORAGE_NODE = '0xde1112f631486CfC759A50196853011528bC5FA0'
+
+export interface StartCommandOptions {
+    privateKey?: string
+    devEnvironment?: boolean
+    inputLines?: string[]
+    abortSignal?: AbortSignal
+}
+
+export const runCommand = async (commandLine: string, opts?: StartCommandOptions): Promise<string[]> => {
+    const lines = startCommand(commandLine, opts)
+    return await collect(lines)
+}
+
+export async function* startCommand(commandLine: string, opts?: StartCommandOptions): AsyncGenerator<string> {
+    const args: string[] = ['dist/bin/streamr.js']
+    args.push(...commandLine.split(' '))
+    if (opts?.privateKey !== undefined) {
+        args.push('--private-key', opts.privateKey)
+    }
+    if (opts?.devEnvironment !== false) {
+        args.push('--dev')
+    }
+    const executable = spawn(`node`, args, {
+        signal: opts?.abortSignal,
+        env: {
+            PATH: process.env.PATH
+        }
+    })
+    executable.on('error', (err: any) => {
+        // expected error when AbortSignal#abort is called
+        if (err.code !== 'ABORT_ERR') {
+            console.error(err)
+        }
+    })
+    const outputs = merge2(executable.stdout, executable.stderr)
+    if (opts?.inputLines !== undefined) {
+        setImmediate(() => {
+            executable.stdin.write(opts.inputLines!.join('\n') + '\n')
+        })
+    }
+    yield* lines(outputs[Symbol.asyncIterator]())
+}
+
+async function* lines(src: AsyncIterable<Buffer>): AsyncGenerator<string, any, any> {
+    let buffer = ''
+    for await (const chunk of src) {
+        buffer += chunk.toString('utf-8')
+        while (true) {
+            const delimeterPos = buffer.indexOf('\n')
+            if (delimeterPos === -1) {
+                break
+            }
+            const line = buffer.substring(0, delimeterPos)
+            yield line
+            buffer = buffer.substring(delimeterPos + 1)
+        }
+    }
+    if (buffer !== '') {
+        yield buffer
+    }
+}
+
+export const createTestClient = (privateKey?: string): StreamrClient => {
+    return new StreamrClient({
+        ...CONFIG_TEST,
+        auth: (privateKey !== undefined) ? { privateKey } : undefined
+    })
+}

package/test/wallet.test.ts

@@ -0,0 +1,11 @@
+import { runCommand } from './utils'
+
+describe('wallet', () => {
+
+    it('whoami', async () => {
+        const outputLines = await runCommand('wallet whoami')
+        expect(outputLines.length).toBe(1)
+        expect(outputLines[0]).toMatch(/^0x[0-9a-f]{40}$/)
+    })
+
+})