feat(sdk)!: Rename StreamrClient#updateStream() and `Stream#update(…

…)` (#2862) **This is a breaking change as this changes the API** Renamed to `setStreamMetadata()` and `setMetadata()`. The new names describe the functionality clearly: the methods updates only the metadata, and any existing value is overwritten by the new value.
streamr-dev · Nov 11, 2024 · c734928 · c734928
1 parent af2bcb8
commit c734928
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,9 +36,10 @@ Changes before Tatum release are not documented in this file.
 - **BREAKING CHANGE:** Type `StreamMetadata` is `Record<string, unknown>` (https://github.com/streamr-dev/network/pull/2825, https://github.com/streamr-dev/network/pull/2845)
   - some new accessors available, see above
   - no default values are injected (https://github.com/streamr-dev/network/pull/2851)
-- **BREAKING CHANGE:** Method `Stream#update()` overwrites metadata instead of merging it (https://github.com/streamr-dev/network/pull/2826)
 - **BREAKING CHANGE:** Method `Stream#addToStorageNode()` doesn't wait for acknowledgment by default (https://github.com/streamr-dev/network/pull/2810)
-- **BREAKING CHANGE:** Parameters and return type of method `StreamrClient#updateStream()` (https://github.com/streamr-dev/network/pull/2859, https://github.com/streamr-dev/network/pull/2855)
+- **BREAKING CHANGE:** Replace methods `StreamrClient#updateStream()` and `Stream#update()`: (https://github.com/streamr-dev/network/pull/2826, https://github.com/streamr-dev/network/pull/2855, https://github.com/streamr-dev/network/pull/2859, https://github.com/streamr-dev/network/pull/2862)
+  - use `StreamrClient#setStreamMetadata()` and `Stream#setMetadata()` instead
+  - both methods overwrite metadata instead of merging it
 - Upgrade `StreamRegistry` from v4 to v5 (https://github.com/streamr-dev/network/pull/2780)
 - Network-level changes:
   - avoid routing through proxy connections (https://github.com/streamr-dev/network/pull/2801) 

diff --git a/packages/sdk/src/Stream.ts b/packages/sdk/src/Stream.ts
@@ -94,8 +94,8 @@ export class Stream {
     /**
      * Updates the metadata of the stream.
      */
-    async update(metadata: StreamMetadata): Promise<void> {
-        await this.client.updateStream(this.id, metadata)
+    async setMetadata(metadata: StreamMetadata): Promise<void> {
+        await this.client.setStreamMetadata(this.id, metadata)
         this.metadata = metadata
     }
 
@@ -159,8 +159,8 @@ export class Stream {
     /**
      * See {@link StreamrClient.removeStreamFromStorageNode | StreamrClient.removeStreamFromStorageNode}.
      */
-    async removeFromStorageNode(storageNodeAddress: HexString): Promise<void> {
-        return this.client.removeStreamFromStorageNode(this.id, toEthereumAddress(storageNodeAddress))
+    async removeFromStorageNode(nodeAddress: HexString): Promise<void> {
+        return this.client.removeStreamFromStorageNode(this.id, toEthereumAddress(nodeAddress))
     }
 
     /**
@@ -207,7 +207,7 @@ export class Stream {
                 fields
             }
         })
-        await this.update(merged)
+        await this.setMetadata(merged)
     }
 
     /**
@@ -231,7 +231,7 @@ export class Stream {
     }
 
     async setDescription(description: string): Promise<void> {
-        await this.update({
+        await this.setMetadata({
             ...this.getMetadata(),
             description
         })
@@ -253,7 +253,7 @@ export class Stream {
      * Sets the value of `storageDays` field
      */
     async setStorageDayCount(count: number): Promise<void> {
-        await this.update({
+        await this.setMetadata({
             ...this.getMetadata(),
             storageDays: count
         })

diff --git a/packages/sdk/src/StreamrClient.ts b/packages/sdk/src/StreamrClient.ts
@@ -402,9 +402,9 @@ export class StreamrClient {
     /**
      * Updates the metadata of a stream.
      */
-    async updateStream(streamIdOrPath: string, metadata: StreamMetadata): Promise<void> {
+    async setStreamMetadata(streamIdOrPath: string, metadata: StreamMetadata): Promise<void> {
         const streamId = await this.streamIdBuilder.toStreamID(streamIdOrPath)
-        await this.streamRegistry.updateStreamMetadata(streamId, metadata)
+        await this.streamRegistry.setStreamMetadata(streamId, metadata)
     }
 
     /**

diff --git a/packages/sdk/src/contracts/StreamRegistry.ts b/packages/sdk/src/contracts/StreamRegistry.ts
@@ -256,7 +256,7 @@ export class StreamRegistry {
         }
     }
 
-    async updateStreamMetadata(streamId: StreamID, metadata: StreamMetadata): Promise<void> {
+    async setStreamMetadata(streamId: StreamID, metadata: StreamMetadata): Promise<void> {
         await this.connectToContract()
         const ethersOverrides = await getEthersOverrides(this.rpcProviderSource, this.config)
         await waitForTx(this.streamRegistryContract!.updateStreamMetadata(

diff --git a/packages/sdk/test/end-to-end/StreamRegistry.test.ts b/packages/sdk/test/end-to-end/StreamRegistry.test.ts
@@ -236,10 +236,10 @@ describe('StreamRegistry', () => {
         }, TIMEOUT)
     })
 
-    describe('update', () => {
+    describe('setMetadata', () => {
         it('happy path', async () => {
             const description = `description-${Date.now()}`
-            await createdStream.update({
+            await createdStream.setMetadata({
                 description
             })
             await until(async () => {

diff --git a/packages/sdk/test/test-utils/fake/FakeStreamRegistry.ts b/packages/sdk/test/test-utils/fake/FakeStreamRegistry.ts
@@ -57,7 +57,7 @@ export class FakeStreamRegistry implements Methods<StreamRegistry> {
         }
     }
 
-    async updateStreamMetadata(streamId: StreamID, metadata: StreamMetadata): Promise<void> {
+    async setStreamMetadata(streamId: StreamID, metadata: StreamMetadata): Promise<void> {
         const registryItem = this.chain.getStream(streamId)
         if (registryItem === undefined) {
             throw new Error('Stream not found')

diff --git a/packages/sdk/test/unit/Stream.test.ts b/packages/sdk/test/unit/Stream.test.ts
@@ -34,18 +34,18 @@ describe('Stream', () => {
         })
     })
 
-    describe('update', () => {
+    describe('setMetadata', () => {
         it('fields not updated if transaction fails', async () => {
             const client: Partial<StreamrClient> = {
-                updateStream: jest.fn().mockRejectedValue(new Error('mock-error')),
+                setStreamMetadata: jest.fn().mockRejectedValue(new Error('mock-error')),
             } 
 
             const stream = new Stream(toStreamID('mock-id'), {
                 description: 'original-description'
             }, client as any)
 
             await expect(() => {
-                return stream.update({
+                return stream.setMetadata({
                     description: 'updated-description'
                 })
             }).rejects.toThrow('mock-error')