feat: add sessionId to CE transport

radixdlt · May 8, 2024 · 4419424 · 4419424
1 parent 6a1d2f4
commit 4419424
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 8 deletions.
diff --git a/packages/dapp-toolkit/src/modules/storage/local-storage.module.ts b/packages/dapp-toolkit/src/modules/storage/local-storage.module.ts
@@ -9,6 +9,7 @@ type PartitionKey =
   | 'requests'
   | 'state'
   | 'connectButton'
+  | 'connectorExtension'
 type dAppDefinitionAddress = string
 
 export type StorageChange<T> = {

diff --git a/...it/src/modules/wallet-request/transport/connector-extension/connector-extension.module.ts b/...it/src/modules/wallet-request/transport/connector-extension/connector-extension.module.ts
@@ -1,6 +1,6 @@
 import { ConnectorExtensionSubjects } from './subjects'
 
-import { Err, Result, ResultAsync, err, ok } from 'neverthrow'
+import { Err, Result, ResultAsync, err, ok, okAsync } from 'neverthrow'
 import {
   Subject,
   Subscription,
@@ -25,11 +25,13 @@ import {
   IncomingMessage,
   MessageLifeCycleExtensionStatusEvent,
   WalletInteraction,
+  WalletInteractionExtensionInteraction,
   WalletInteractionResponse,
   eventType,
 } from '../../../../schemas'
-import { SdkError } from '../../../../error'
 import { RequestItemModule } from '../../request-items'
+import { StorageModule } from '../../../storage'
+import { SdkError } from '../../../../error'
 import { TransportProvider } from '../../../../_types'
 
 export type ConnectorExtensionModule = ReturnType<
@@ -42,15 +44,20 @@ export const ConnectorExtensionModule = (input: {
   extensionDetectionTime?: number
   providers: {
     requestItemModule: RequestItemModule
+    storageModule: StorageModule<{ sessionId?: string }>
   }
 }) => {
+  let isExtensionHandlingSessions = false
   const logger = input?.logger?.getSubLogger({
     name: 'ConnectorExtensionModule',
   })
+
   const subjects = input?.subjects ?? ConnectorExtensionSubjects()
   const subscription = new Subscription()
   const extensionDetectionTime = input?.extensionDetectionTime ?? 100
   const requestItemModule = input.providers.requestItemModule
+  const storage =
+    input.providers.storageModule.getPartition('connectorExtension')
 
   subscription.add(
     subjects.incomingMessageSubject
@@ -87,6 +94,35 @@ export const ConnectorExtensionModule = (input: {
       .subscribe(),
   )
 
+  const wrapOutgoingInteraction = (
+    interaction: WalletInteraction,
+  ): ResultAsync<
+    WalletInteractionExtensionInteraction | WalletInteraction,
+    Error
+  > => {
+    if (!isExtensionHandlingSessions) {
+      return okAsync(interaction)
+    }
+    return storage.getState().andThen((state) => {
+      const isAuthorizedRequest =
+        interaction.items.discriminator === 'authorizedRequest'
+
+      const sessionId = isAuthorizedRequest
+        ? state?.sessionId || crypto.randomUUID()
+        : state?.sessionId
+
+      const wrappedRequest = {
+        interactionId: interaction.interactionId,
+        interaction,
+        sessionId,
+        discriminator: 'walletInteraction' as const,
+      }
+      return isAuthorizedRequest
+        ? storage.setState({ sessionId }).map(() => wrappedRequest)
+        : okAsync(wrappedRequest)
+    })
+  }
+
   const handleIncomingMessage = (event: Event) => {
     const message = (event as CustomEvent<IncomingMessage>).detail
     subjects.incomingMessageSubject.next(message)
@@ -134,8 +170,10 @@ export const ConnectorExtensionModule = (input: {
     const sendCancelRequest = () => {
       subjects.outgoingMessageSubject.next({
         interactionId: walletInteraction.interactionId,
-        items: { discriminator: 'cancelRequest' },
         metadata: walletInteraction.metadata,
+        ...(isExtensionHandlingSessions
+          ? { discriminator: 'cancelInteraction' }
+          : { items: { discriminator: 'cancelRequest' } }),
       })
 
       setTimeout(() => {
@@ -200,9 +238,13 @@ export const ConnectorExtensionModule = (input: {
       filter((value): value is Err<never, SdkError> => !('eventType' in value)),
     )
 
-    const sendWalletRequest$ = of(walletInteraction).pipe(
-      tap((message) => {
-        subjects.outgoingMessageSubject.next(message)
+    const sendWalletRequest$ = of(
+      wrapOutgoingInteraction(walletInteraction),
+    ).pipe(
+      tap((result) => {
+        result.map((message) => {
+          subjects.outgoingMessageSubject.next(message)
+        })
       }),
       filter((_): _ is never => false),
     )
@@ -246,12 +288,16 @@ export const ConnectorExtensionModule = (input: {
                   eventType: 'extensionStatus',
                   isWalletLinked: false,
                   isExtensionAvailable: false,
+                  canHandleSessions: false,
                 }) as MessageLifeCycleExtensionStatusEvent,
             ),
           ),
         ),
       ),
     ),
+    tap((event) => {
+      isExtensionHandlingSessions = event.canHandleSessions || false
+    }),
     shareReplay(1),
   )
 
@@ -272,7 +318,9 @@ export const ConnectorExtensionModule = (input: {
         }),
       )
     },
-    disconnect: () => {},
+    disconnect: () => {
+      storage.clear()
+    },
     destroy: () => {
       subscription.unsubscribe()
       removeEventListener(eventType.incomingMessage, handleIncomingMessage)

diff --git a/packages/dapp-toolkit/src/modules/wallet-request/wallet-request.ts b/packages/dapp-toolkit/src/modules/wallet-request/wallet-request.ts
@@ -92,7 +92,7 @@ export const WalletRequestModule = (input: {
   const transports: TransportProvider[] = input.providers.transports ?? [
     ConnectorExtensionModule({
       logger,
-      providers: { requestItemModule },
+      providers: { requestItemModule, storageModule },
     }),
   ]
 
@@ -581,6 +581,7 @@ export const WalletRequestModule = (input: {
 
     stateModule.reset()
     requestItemModule.clear()
+    transports.forEach((transport) => transport?.disconnect())
   }
 
   const destroy = () => {

diff --git a/packages/dapp-toolkit/src/schemas/index.ts b/packages/dapp-toolkit/src/schemas/index.ts
@@ -381,9 +381,32 @@ export type OpenPopupExtensionInteraction = Output<
   typeof OpenPopupExtensionInteraction
 >
 
+export type WalletInteractionExtensionInteraction = Output<
+  typeof WalletInteractionExtensionInteraction
+>
+
+export const WalletInteractionExtensionInteraction = object({
+  interactionId: string(),
+  discriminator: literal('walletInteraction'),
+  interaction: WalletInteraction,
+  sessionId: optional(string()),
+})
+
+export type CancelInteractionExtensionInteraction = Output<
+  typeof CancelInteractionExtensionInteraction
+>
+
+export const CancelInteractionExtensionInteraction = object({
+  interactionId: string(),
+  discriminator: literal('cancelInteraction'),
+  metadata: Metadata,
+})
+
 export const ExtensionInteraction = union([
   StatusExtensionInteraction,
   OpenPopupExtensionInteraction,
+  WalletInteractionExtensionInteraction,
+  CancelInteractionExtensionInteraction,
 ])
 
 export type ExtensionInteraction = Output<typeof ExtensionInteraction>
@@ -401,6 +424,7 @@ export const MessageLifeCycleExtensionStatusEvent = object({
   interactionId: string(),
   isWalletLinked: boolean(),
   isExtensionAvailable: boolean(),
+  canHandleSessions: optional(boolean()),
 })
 
 export type MessageLifeCycleExtensionStatusEvent = Output<