sdk: add app address in member metadata stream view (#4545)

Author: miguel-nascimento

packages/sdk/src/streamStateView_MemberMetadata.ts

@@ -26,13 +26,15 @@ export type UserInfo = {
     displayNameEncrypted: boolean
     ensAddress?: string
     nft?: Nft
+    appAddress?: string
 }
 
 export class StreamStateView_MemberMetadata {
     readonly usernames: MemberMetadata_Usernames
     readonly displayNames: MemberMetadata_DisplayNames
     readonly ensAddresses: MemberMetadata_EnsAddresses
     readonly nfts: MemberMetadata_Nft
+    readonly appAddresses = new Map<string, string>()
     readonly currentUserId: string
     constructor(streamId: string, currentUserId: string) {
         this.usernames = new MemberMetadata_Usernames(streamId, currentUserId)
@@ -47,6 +49,7 @@ export class StreamStateView_MemberMetadata {
         displayNames: { userId: string; wrappedEncryptedData: WrappedEncryptedData }[],
         ensAddresses: { userId: string; ensAddress: Uint8Array }[],
         nfts: { userId: string; nft: MemberPayload_Nft }[],
+        appAddresses: { userId: string; appAddress: string }[],
         cleartexts: Record<string, Uint8Array | string> | undefined,
         encryptionEmitter: TypedEmitter<StreamEncryptionEvents> | undefined,
     ) {
@@ -93,6 +96,12 @@ export class StreamStateView_MemberMetadata {
 
         this.ensAddresses.applySnapshot(ensAddresses)
         this.nfts.applySnapshot(nfts)
+
+        for (const item of appAddresses) {
+            if (item.appAddress) {
+                this.appAddresses.set(item.userId, item.appAddress)
+            }
+        }
     }
 
     onConfirmedEvent(
@@ -185,13 +194,23 @@ export class StreamStateView_MemberMetadata {
         const displayNameInfo = this.displayNames.info(userId)
         const ensAddress = this.ensAddresses.info(userId)
         const nft = this.nfts.info(userId)
+        const appAddress = this.appAddresses.get(userId)
         return {
             ...usernameInfo,
             ...displayNameInfo,
             ensAddress,
             nft,
+            appAddress,
         }
     }
+
+    setAppAddress(userId: string, appAddress: string): void {
+        this.appAddresses.set(userId, appAddress)
+    }
+
+    removeAppAddress(userId: string): void {
+        this.appAddresses.delete(userId)
+    }
 }
 
 function sortPayloads(

packages/sdk/src/streamStateView_Members.ts

@@ -177,12 +177,19 @@ export class StreamStateView_Members extends StreamStateView_AbstractContent {
                 userId: member.userId,
                 nft: member.nft!,
             }))
+        const appAddresses = Array.from(this.joined.values())
+            .filter((x) => isDefined(x.appAddress))
+            .map((member) => ({
+                userId: member.userId,
+                appAddress: member.appAddress!,
+            }))
 
         this.memberMetadata.applySnapshot(
             usernames,
             displayNames,
             ensAddresses,
             nfts,
+            appAddresses,
             cleartexts,
             encryptionEmitter,
         )
@@ -313,13 +320,18 @@ export class StreamStateView_Members extends StreamStateView_AbstractContent {
                             })
                             if (membership.appAddress) {
                                 this.apps.add(userId)
+                                this.memberMetadata.setAppAddress(
+                                    userId,
+                                    userIdFromAddress(membership.appAddress),
+                                )
                             }
                             this.streamMemberIdsView.addMember(this.streamId, userId)
                             break
                         case MembershipOp.SO_LEAVE: {
                             const leavingMember = this.joined.get(userId)
                             if (leavingMember?.appAddress) {
                                 this.apps.delete(userId)
+                                this.memberMetadata.removeAppAddress(userId)
                             }
                             this.joined.delete(userId)
                             this.streamMemberIdsView.removeMember(this.streamId, userId)

packages/sdk/src/tests/multi/botMembership.test.ts

@@ -99,6 +99,13 @@ describe('bot membership tests', () => {
             expect(botUserStreamView.userContent.isMember(spaceId, MembershipOp.SO_JOIN)).toBe(true)
         })
 
+        // Verify that the bot's userInfo includes the appAddress
+        const spaceStream = spaceOwner.stream(spaceId)
+        await spaceOwner.waitForStream(spaceId)
+        expect(spaceStream).toBeDefined()
+        const botUserInfo = spaceStream!.view.getMemberMetadata().userInfo(bot.userId)
+        expect(botUserInfo.appAddress?.toLowerCase()).toBe(foundAppAddress.toLowerCase())
+
         // Have space owner add the bot to the channel
         await expect(spaceOwner.joinUser(channelId, bot.userId)).resolves.toBeDefined()
 
@@ -212,6 +219,12 @@ describe('bot membership tests', () => {
             expect(botUserStreamView.userContent.isMember(spaceId, MembershipOp.SO_JOIN)).toBe(true)
         })
 
+        // Verify that the bot's userInfo includes the appAddress
+        const spaceStream = spaceOwner.stream(spaceId)
+        expect(spaceStream).toBeDefined()
+        const botUserInfo = spaceStream!.view.getMemberMetadata().userInfo(bot.userId)
+        expect(botUserInfo.appAddress).toBe(foundAppAddress)
+
         // Space owner CAN add bot to default channel despite bot not satisfying entitlements
         await expect(spaceOwner.joinUser(defaultChannelId, bot.userId)).resolves.toBeDefined()
 

packages/sdk/src/tests/multi_ne/memberMetadata.test.ts

@@ -75,6 +75,20 @@ describe('memberMetadataTests', () => {
         }
     })
 
+    test('clientDoesntHaveAppAddress', async () => {
+        await expect(bobsClient.initializeUser()).resolves.not.toThrow()
+        bobsClient.startSync()
+
+        const streamId = makeUniqueSpaceStreamId()
+        await bobsClient.createSpace(streamId)
+        await bobsClient.waitForStream(streamId)
+
+        const streamView = bobsClient.streams.get(streamId)!.view
+        expect(streamView.getMemberMetadata().userInfo(bobsClient.userId).appAddress).toEqual(
+            undefined,
+        )
+    })
+
     test('clientCanSetDisplayNamesInDM', async () => {
         await expect(bobsClient.initializeUser()).resolves.not.toThrow()
         bobsClient.startSync()
@@ -313,6 +327,9 @@ describe('memberMetadataTests', () => {
         for (const client of [bobsClient, alicesClient]) {
             const streamView = client.streams.get(streamId)!.view
             expect(streamView.getMemberMetadata()?.usernames.plaintextUsernames).toEqual(expected)
+            expect(
+                streamView.getMemberMetadata()?.userInfo(client.userId).appAddress,
+            ).toBeUndefined()
         }
     })