fix: clone record before emitting event (#833)

Signed-off-by: Timo Glastra <timo@animo.id>
openwallet-foundation · Jun 3, 2022 · 8192861 · 8192861
1 parent 28e0ffa
commit 8192861
Show file tree

Hide file tree

Showing 15 changed files with 146 additions and 150 deletions.
diff --git a/packages/core/src/modules/basic-messages/services/BasicMessageService.ts b/packages/core/src/modules/basic-messages/services/BasicMessageService.ts
@@ -6,6 +6,7 @@ import type { BasicMessageTags } from '../repository'
 import { Lifecycle, scoped } from 'tsyringe'
 
 import { EventEmitter } from '../../../agent/EventEmitter'
+import { JsonTransformer } from '../../../utils'
 import { BasicMessageEventTypes } from '../BasicMessageEvents'
 import { BasicMessageRole } from '../BasicMessageRole'
 import { BasicMessage } from '../messages'
@@ -33,10 +34,7 @@ export class BasicMessageService {
     })
 
     await this.basicMessageRepository.save(basicMessageRecord)
-    this.eventEmitter.emit<BasicMessageStateChangedEvent>({
-      type: BasicMessageEventTypes.BasicMessageStateChanged,
-      payload: { message: basicMessage, basicMessageRecord },
-    })
+    this.emitStateChangedEvent(basicMessageRecord, basicMessage)
 
     return basicMessage
   }
@@ -53,9 +51,14 @@ export class BasicMessageService {
     })
 
     await this.basicMessageRepository.save(basicMessageRecord)
+    this.emitStateChangedEvent(basicMessageRecord, message)
+  }
+
+  private emitStateChangedEvent(basicMessageRecord: BasicMessageRecord, basicMessage: BasicMessage) {
+    const clonedBasicMessageRecord = JsonTransformer.clone(basicMessageRecord)
     this.eventEmitter.emit<BasicMessageStateChangedEvent>({
       type: BasicMessageEventTypes.BasicMessageStateChanged,
-      payload: { message, basicMessageRecord },
+      payload: { message: basicMessage, basicMessageRecord: clonedBasicMessageRecord },
     })
   }
 

diff --git a/packages/core/src/modules/connections/services/ConnectionService.ts b/packages/core/src/modules/connections/services/ConnectionService.ts
@@ -181,13 +181,7 @@ export class ConnectionService {
     })
 
     await this.connectionRepository.update(connectionRecord)
-    this.eventEmitter.emit<ConnectionStateChangedEvent>({
-      type: ConnectionEventTypes.ConnectionStateChanged,
-      payload: {
-        connectionRecord,
-        previousState: null,
-      },
-    })
+    this.emitStateChangedEvent(connectionRecord, null)
 
     this.logger.debug(`Process message ${ConnectionRequestMessage.type} end`, connectionRecord)
     return connectionRecord
@@ -509,10 +503,17 @@ export class ConnectionService {
     connectionRecord.state = newState
     await this.connectionRepository.update(connectionRecord)
 
+    this.emitStateChangedEvent(connectionRecord, previousState)
+  }
+
+  private emitStateChangedEvent(connectionRecord: ConnectionRecord, previousState: DidExchangeState | null) {
+    // Connection record in event should be static
+    const clonedConnection = JsonTransformer.clone(connectionRecord)
+
     this.eventEmitter.emit<ConnectionStateChangedEvent>({
       type: ConnectionEventTypes.ConnectionStateChanged,
       payload: {
-        connectionRecord,
+        connectionRecord: clonedConnection,
         previousState,
       },
     })

diff --git a/packages/core/src/modules/credentials/protocol/v1/V1CredentialService.ts b/packages/core/src/modules/credentials/protocol/v1/V1CredentialService.ts
@@ -3,7 +3,6 @@ import type { HandlerInboundMessage } from '../../../../agent/Handler'
 import type { InboundMessageContext } from '../../../../agent/models/InboundMessageContext'
 import type { Attachment } from '../../../../decorators/attachment/Attachment'
 import type { ConnectionRecord } from '../../../connections'
-import type { CredentialStateChangedEvent } from '../../CredentialEvents'
 import type {
   ServiceAcceptCredentialOptions,
   CredentialOfferTemplate,
@@ -36,7 +35,6 @@ import { ConnectionService } from '../../../connections/services'
 import { DidResolverService } from '../../../dids'
 import { MediationRecipientService } from '../../../routing'
 import { AutoAcceptCredential } from '../../CredentialAutoAcceptType'
-import { CredentialEventTypes } from '../../CredentialEvents'
 import { CredentialProtocolVersion } from '../../CredentialProtocolVersion'
 import { CredentialState } from '../../CredentialState'
 import { CredentialUtils } from '../../CredentialUtils'
@@ -177,13 +175,7 @@ export class V1CredentialService extends CredentialService {
       associatedRecordId: credentialRecord.id,
     })
 
-    this.eventEmitter.emit<CredentialStateChangedEvent>({
-      type: CredentialEventTypes.CredentialStateChanged,
-      payload: {
-        credentialRecord,
-        previousState: null,
-      },
-    })
+    this.emitStateChangedEvent(credentialRecord, null)
 
     return { credentialRecord, message }
   }
@@ -360,13 +352,8 @@ export class V1CredentialService extends CredentialService {
 
       // Save record
       await this.credentialRepository.save(credentialRecord)
-      this.eventEmitter.emit<CredentialStateChangedEvent>({
-        type: CredentialEventTypes.CredentialStateChanged,
-        payload: {
-          credentialRecord,
-          previousState: null,
-        },
-      })
+      this.emitStateChangedEvent(credentialRecord, null)
+
       await this.didCommMessageRepository.saveAgentMessage({
         agentMessage: proposalMessage,
         role: DidCommMessageRole.Receiver,
@@ -536,13 +523,8 @@ export class V1CredentialService extends CredentialService {
     const { credentialRecord, message } = await this.createOfferProcessing(template, credentialOptions.connection)
 
     await this.credentialRepository.save(credentialRecord)
-    this.eventEmitter.emit<CredentialStateChangedEvent>({
-      type: CredentialEventTypes.CredentialStateChanged,
-      payload: {
-        credentialRecord,
-        previousState: null,
-      },
-    })
+    this.emitStateChangedEvent(credentialRecord, null)
+
     await this.didCommMessageRepository.saveAgentMessage({
       agentMessage: message,
       role: DidCommMessageRole.Sender,
@@ -643,13 +625,7 @@ export class V1CredentialService extends CredentialService {
         role: DidCommMessageRole.Receiver,
         associatedRecordId: credentialRecord.id,
       })
-      this.eventEmitter.emit<CredentialStateChangedEvent>({
-        type: CredentialEventTypes.CredentialStateChanged,
-        payload: {
-          credentialRecord,
-          previousState: null,
-        },
-      })
+      this.emitStateChangedEvent(credentialRecord, null)
     }
 
     return credentialRecord

diff --git a/packages/core/src/modules/credentials/protocol/v2/V2CredentialService.ts b/packages/core/src/modules/credentials/protocol/v2/V2CredentialService.ts
@@ -2,7 +2,6 @@ import type { AgentMessage } from '../../../../agent/AgentMessage'
 import type { HandlerInboundMessage } from '../../../../agent/Handler'
 import type { InboundMessageContext } from '../../../../agent/models/InboundMessageContext'
 import type { Attachment } from '../../../../decorators/attachment/Attachment'
-import type { CredentialStateChangedEvent } from '../../CredentialEvents'
 import type {
   ServiceAcceptCredentialOptions,
   CredentialProtocolMsgReturnType,
@@ -38,7 +37,6 @@ import { ConnectionService } from '../../../connections/services/ConnectionServi
 import { DidResolverService } from '../../../dids'
 import { MediationRecipientService } from '../../../routing'
 import { AutoAcceptCredential } from '../../CredentialAutoAcceptType'
-import { CredentialEventTypes } from '../../CredentialEvents'
 import { CredentialProtocolVersion } from '../../CredentialProtocolVersion'
 import { CredentialState } from '../../CredentialState'
 import { CredentialFormatType } from '../../CredentialsModuleOptions'
@@ -128,14 +126,7 @@ export class V2CredentialService extends CredentialService {
     this.logger.debug('Save meta data and emit state change event')
 
     await this.credentialRepository.save(credentialRecord)
-
-    this.eventEmitter.emit<CredentialStateChangedEvent>({
-      type: CredentialEventTypes.CredentialStateChanged,
-      payload: {
-        credentialRecord,
-        previousState: null,
-      },
-    })
+    this.emitStateChangedEvent(credentialRecord, null)
 
     await this.didCommMessageRepository.saveOrUpdateAgentMessage({
       agentMessage: proposalMessage,
@@ -211,7 +202,7 @@ export class V2CredentialService extends CredentialService {
         role: DidCommMessageRole.Receiver,
         associatedRecordId: credentialRecord.id,
       })
-      await this.emitEvent(credentialRecord)
+      this.emitStateChangedEvent(credentialRecord, null)
     }
     return credentialRecord
   }
@@ -357,7 +348,7 @@ export class V2CredentialService extends CredentialService {
     credentialRecord.connectionId = connection?.id
 
     await this.credentialRepository.save(credentialRecord)
-    await this.emitEvent(credentialRecord)
+    this.emitStateChangedEvent(credentialRecord, null)
 
     await this.didCommMessageRepository.saveOrUpdateAgentMessage({
       agentMessage: credentialOfferMessage,
@@ -513,13 +504,7 @@ export class V2CredentialService extends CredentialService {
         role: DidCommMessageRole.Receiver,
         associatedRecordId: credentialRecord.id,
       })
-      this.eventEmitter.emit<CredentialStateChangedEvent>({
-        type: CredentialEventTypes.CredentialStateChanged,
-        payload: {
-          credentialRecord,
-          previousState: null,
-        },
-      })
+      this.emitStateChangedEvent(credentialRecord, null)
     }
 
     return credentialRecord
@@ -1006,16 +991,6 @@ export class V2CredentialService extends CredentialService {
     return this.serviceFormatMap[credentialFormatType]
   }
 
-  private async emitEvent(credentialRecord: CredentialExchangeRecord) {
-    this.eventEmitter.emit<CredentialStateChangedEvent>({
-      type: CredentialEventTypes.CredentialStateChanged,
-      payload: {
-        credentialRecord,
-        previousState: null,
-      },
-    })
-  }
-
   /**
    * Retrieve a credential record by connection id and thread id
    *

diff --git a/...ages/core/src/modules/credentials/protocol/v2/__tests__/v1credentials-auto-accept.test.ts b/...ages/core/src/modules/credentials/protocol/v2/__tests__/v1credentials-auto-accept.test.ts
@@ -148,7 +148,7 @@ describe('credentials', () => {
             credentialRecordId: expect.any(String),
           },
         ],
-        state: CredentialState.Done,
+        state: CredentialState.CredentialReceived,
       })
       expect(faberCredentialRecord).toMatchObject({
         type: CredentialExchangeRecord.type,
@@ -249,7 +249,7 @@ describe('credentials', () => {
             credentialRecordId: expect.any(String),
           },
         ],
-        state: CredentialState.Done,
+        state: CredentialState.CredentialReceived,
       })
 
       expect(faberCredentialExchangeRecord).toMatchObject({
@@ -344,7 +344,7 @@ describe('credentials', () => {
               credentialRecordId: expect.any(String),
             },
           ],
-          state: CredentialState.Done,
+          state: CredentialState.CredentialReceived,
         })
 
         expect(faberCredentialExchangeRecord).toMatchObject({

diff --git a/...ages/core/src/modules/credentials/protocol/v2/__tests__/v2credentials-auto-accept.test.ts b/...ages/core/src/modules/credentials/protocol/v2/__tests__/v2credentials-auto-accept.test.ts
@@ -150,7 +150,7 @@ describe('credentials', () => {
             },
           },
         },
-        state: CredentialState.Done,
+        state: CredentialState.CredentialReceived,
       })
       expect(faberCredentialRecord).toMatchObject({
         type: CredentialExchangeRecord.type,
@@ -244,7 +244,7 @@ describe('credentials', () => {
             },
           },
         },
-        state: CredentialState.Done,
+        state: CredentialState.CredentialReceived,
       })
 
       expect(faberCredentialRecord).toMatchObject({
@@ -332,7 +332,7 @@ describe('credentials', () => {
               },
             },
           },
-          state: CredentialState.Done,
+          state: CredentialState.CredentialReceived,
         })
 
         expect(faberCredentialRecord).toMatchObject({

diff --git a/packages/core/src/modules/credentials/services/CredentialService.ts b/packages/core/src/modules/credentials/services/CredentialService.ts
@@ -41,6 +41,8 @@ import type { V2RequestCredentialMessage } from './../protocol/v2/messages/V2Req
 import type { CredentialExchangeRecord, CredentialRepository } from './../repository'
 import type { RevocationService } from './RevocationService'
 
+import { JsonTransformer } from '../../../utils'
+
 import { CredentialEventTypes } from './../CredentialEvents'
 import { CredentialState } from './../CredentialState'
 
@@ -210,14 +212,21 @@ export abstract class CredentialService {
     credentialRecord.state = newState
     await this.credentialRepository.update(credentialRecord)
 
+    this.emitStateChangedEvent(credentialRecord, previousState)
+  }
+
+  protected emitStateChangedEvent(credentialRecord: CredentialExchangeRecord, previousState: CredentialState | null) {
+    const clonedCredential = JsonTransformer.clone(credentialRecord)
+
     this.eventEmitter.emit<CredentialStateChangedEvent>({
       type: CredentialEventTypes.CredentialStateChanged,
       payload: {
-        credentialRecord,
+        credentialRecord: clonedCredential,
         previousState: previousState,
       },
     })
   }
+
   /**
    * Retrieve a credential record by id
    *

diff --git a/packages/core/src/modules/oob/OutOfBandModule.ts b/packages/core/src/modules/oob/OutOfBandModule.ts
@@ -4,7 +4,7 @@ import type { Logger } from '../../logger'
 import type { ConnectionRecord, Routing } from '../../modules/connections'
 import type { PlaintextMessage } from '../../types'
 import type { Key } from '../dids'
-import type { HandshakeReusedEvent, OutOfBandStateChangedEvent } from './domain/OutOfBandEvents'
+import type { HandshakeReusedEvent } from './domain/OutOfBandEvents'
 
 import { parseUrl } from 'query-string'
 import { catchError, EmptyError, first, firstValueFrom, map, of, timeout } from 'rxjs'
@@ -207,13 +207,7 @@ export class OutOfBandModule {
     })
 
     await this.outOfBandService.save(outOfBandRecord)
-    this.eventEmitter.emit<OutOfBandStateChangedEvent>({
-      type: OutOfBandEventTypes.OutOfBandStateChanged,
-      payload: {
-        outOfBandRecord,
-        previousState: null,
-      },
-    })
+    this.outOfBandService.emitStateChangedEvent(outOfBandRecord, null)
 
     return outOfBandRecord
   }
@@ -358,13 +352,7 @@ export class OutOfBandModule {
       autoAcceptConnection,
     })
     await this.outOfBandService.save(outOfBandRecord)
-    this.eventEmitter.emit<OutOfBandStateChangedEvent>({
-      type: OutOfBandEventTypes.OutOfBandStateChanged,
-      payload: {
-        outOfBandRecord,
-        previousState: null,
-      },
-    })
+    this.outOfBandService.emitStateChangedEvent(outOfBandRecord, null)
 
     if (autoAcceptInvitation) {
       return await this.acceptInvitation(outOfBandRecord.id, {

diff --git a/packages/core/src/modules/oob/OutOfBandService.ts b/packages/core/src/modules/oob/OutOfBandService.ts
@@ -8,6 +8,7 @@ import { scoped, Lifecycle } from 'tsyringe'
 
 import { EventEmitter } from '../../agent/EventEmitter'
 import { AriesFrameworkError } from '../../error'
+import { JsonTransformer } from '../../utils'
 
 import { OutOfBandEventTypes } from './domain/OutOfBandEvents'
 import { OutOfBandRole } from './domain/OutOfBandRole'
@@ -132,10 +133,16 @@ export class OutOfBandService {
     outOfBandRecord.state = newState
     await this.outOfBandRepository.update(outOfBandRecord)
 
+    this.emitStateChangedEvent(outOfBandRecord, previousState)
+  }
+
+  public emitStateChangedEvent(outOfBandRecord: OutOfBandRecord, previousState: OutOfBandState | null) {
+    const clonedOutOfBandRecord = JsonTransformer.clone(outOfBandRecord)
+
     this.eventEmitter.emit<OutOfBandStateChangedEvent>({
       type: OutOfBandEventTypes.OutOfBandStateChanged,
       payload: {
-        outOfBandRecord,
+        outOfBandRecord: clonedOutOfBandRecord,
         previousState,
       },
     })