fix: query the record by credential and proof role

Signed-off-by: Berend Sliedrecht <[email protected]>
openwallet-foundation · Mar 1, 2024 · 6f0a374 · 6f0a374
1 parent add7e09
commit 6f0a374
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 54 deletions.
diff --git a/packages/anoncreds/src/protocols/credentials/v1/V1CredentialProtocol.ts b/packages/anoncreds/src/protocols/credentials/v1/V1CredentialProtocol.ts
@@ -203,9 +203,10 @@ export class V1CredentialProtocol
 
     agentContext.config.logger.debug(`Processing credential proposal with message id ${proposalMessage.id}`)
 
-    let credentialRecord = await this.findByThreadAndConnectionId(
+    let credentialRecord = await this.findByThreadIdConnectionIdAndRole(
       messageContext.agentContext,
       proposalMessage.threadId,
+      CredentialRole.Issuer,
       connection?.id
     )
 
@@ -503,7 +504,12 @@ export class V1CredentialProtocol
 
     agentContext.config.logger.debug(`Processing credential offer with id ${offerMessage.id}`)
 
-    let credentialRecord = await this.findByThreadAndConnectionId(agentContext, offerMessage.threadId, connection?.id)
+    let credentialRecord = await this.findByThreadIdConnectionIdAndRole(
+      agentContext,
+      offerMessage.threadId,
+      CredentialRole.Holder,
+      connection?.id
+    )
 
     const offerAttachment = offerMessage.getOfferAttachmentById(INDY_CREDENTIAL_OFFER_ATTACHMENT_ID)
     if (!offerAttachment) {
@@ -739,7 +745,11 @@ export class V1CredentialProtocol
 
     agentContext.config.logger.debug(`Processing credential request with id ${requestMessage.id}`)
 
-    const credentialRecord = await this.getByThreadAndConnectionId(messageContext.agentContext, requestMessage.threadId)
+    const credentialRecord = await this.getByThreadIdConnectionIdAndRole(
+      messageContext.agentContext,
+      requestMessage.threadId,
+      CredentialRole.Issuer
+    )
     agentContext.config.logger.trace('Credential record found when processing credential request', credentialRecord)
 
     const proposalMessage = await didCommMessageRepository.findAgentMessage(messageContext.agentContext, {
@@ -885,9 +895,10 @@ export class V1CredentialProtocol
     // only depends on the public api, rather than the internal API (this helps with breaking changes)
     const connectionService = agentContext.dependencyManager.resolve(ConnectionService)
 
-    const credentialRecord = await this.getByThreadAndConnectionId(
+    const credentialRecord = await this.getByThreadIdConnectionIdAndRole(
       messageContext.agentContext,
       issueMessage.threadId,
+      CredentialRole.Holder,
       connection?.id
     )
 
@@ -990,9 +1001,10 @@ export class V1CredentialProtocol
     // only depends on the public api, rather than the internal API (this helps with breaking changes)
     const connectionService = agentContext.dependencyManager.resolve(ConnectionService)
 
-    const credentialRecord = await this.getByThreadAndConnectionId(
+    const credentialRecord = await this.getByThreadIdConnectionIdAndRole(
       messageContext.agentContext,
       ackMessage.threadId,
+      CredentialRole.Issuer,
       connection?.id
     )
 
@@ -1029,7 +1041,7 @@ export class V1CredentialProtocol
    *
    */
   public async createProblemReport(
-    agentContext: AgentContext,
+    _agentContext: AgentContext,
     { credentialRecord, description }: CredentialProtocolOptions.CreateCredentialProblemReportOptions
   ): Promise<CredentialProtocolOptions.CredentialProtocolMsgReturnType<ProblemReportMessage>> {
     const message = new V1CredentialProblemReportMessage({

diff --git a/packages/anoncreds/src/protocols/credentials/v1/__tests__/V1CredentialProtocolCred.test.ts b/packages/anoncreds/src/protocols/credentials/v1/__tests__/V1CredentialProtocolCred.test.ts
@@ -132,7 +132,7 @@ const didCommMessageRecord = new DidCommMessageRecord({
 })
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const getAgentMessageMock = async (agentContext: AgentContext, options: { messageClass: any }) => {
+const getAgentMessageMock = async (_agentContext: AgentContext, options: { messageClass: any }) => {
   if (options.messageClass === V1ProposeCredentialMessage) {
     return credentialProposalMessage
   }
@@ -312,7 +312,7 @@ describe('V1CredentialProtocol', () => {
         invalidCredentialStates.map(async (state) => {
           await expect(
             credentialProtocol.acceptOffer(agentContext, { credentialRecord: mockCredentialRecord({ state }) })
-          ).rejects.toThrowError(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
+          ).rejects.toThrow(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
         })
       )
     })
@@ -347,6 +347,7 @@ describe('V1CredentialProtocol', () => {
       // then
       expect(credentialRepository.getSingleByQuery).toHaveBeenNthCalledWith(1, agentContext, {
         threadId: 'somethreadid',
+        role: CredentialRole.Issuer,
       })
       expect(repositoryUpdateSpy).toHaveBeenCalledTimes(1)
       expect(returnedCredentialRecord.state).toEqual(CredentialState.RequestReceived)
@@ -363,6 +364,7 @@ describe('V1CredentialProtocol', () => {
       // then
       expect(credentialRepository.getSingleByQuery).toHaveBeenNthCalledWith(1, agentContext, {
         threadId: 'somethreadid',
+        role: CredentialRole.Issuer,
       })
       expect(returnedCredentialRecord.state).toEqual(CredentialState.RequestReceived)
     })
@@ -375,7 +377,7 @@ describe('V1CredentialProtocol', () => {
           mockFunction(credentialRepository.getSingleByQuery).mockReturnValue(
             Promise.resolve(mockCredentialRecord({ state }))
           )
-          await expect(credentialProtocol.processRequest(messageContext)).rejects.toThrowError(
+          await expect(credentialProtocol.processRequest(messageContext)).rejects.toThrow(
             `Credential record is in invalid state ${state}. Valid states are: ${validState}.`
           )
         })
@@ -516,6 +518,7 @@ describe('V1CredentialProtocol', () => {
       expect(credentialRepository.getSingleByQuery).toHaveBeenNthCalledWith(1, agentContext, {
         threadId: 'somethreadid',
         connectionId: connection.id,
+        role: CredentialRole.Holder,
       })
 
       expect(didCommMessageRepository.saveAgentMessage).toHaveBeenCalledWith(agentContext, {
@@ -614,7 +617,7 @@ describe('V1CredentialProtocol', () => {
                 connectionId: 'b1e2f039-aa39-40be-8643-6ce2797b5190',
               }),
             })
-          ).rejects.toThrowError(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
+          ).rejects.toThrow(`Credential record is in invalid state ${state}. Valid states are: ${validState}.`)
         })
       )
     })
@@ -652,6 +655,7 @@ describe('V1CredentialProtocol', () => {
       expect(credentialRepository.getSingleByQuery).toHaveBeenNthCalledWith(1, agentContext, {
         threadId: 'somethreadid',
         connectionId: connection.id,
+        role: CredentialRole.Issuer,
       })
       expect(repositoryUpdateSpy).toHaveBeenCalledTimes(1)
       const [[, updatedCredentialRecord]] = repositoryUpdateSpy.mock.calls
@@ -746,18 +750,24 @@ describe('V1CredentialProtocol', () => {
       const expected = mockCredentialRecord()
       mockFunction(credentialRepository.getById).mockReturnValue(Promise.resolve(expected))
       const result = await credentialProtocol.getById(agentContext, expected.id)
-      expect(credentialRepository.getById).toBeCalledWith(agentContext, expected.id)
+      expect(credentialRepository.getById).toHaveBeenCalledWith(agentContext, expected.id)
 
       expect(result).toBe(expected)
     })
 
     it('getById should return value from credentialRepository.getSingleByQuery', async () => {
       const expected = mockCredentialRecord()
       mockFunction(credentialRepository.getSingleByQuery).mockReturnValue(Promise.resolve(expected))
-      const result = await credentialProtocol.getByThreadAndConnectionId(agentContext, 'threadId', 'connectionId')
-      expect(credentialRepository.getSingleByQuery).toBeCalledWith(agentContext, {
+      const result = await credentialProtocol.getByThreadIdConnectionIdAndRole(
+        agentContext,
+        'threadId',
+        CredentialRole.Issuer,
+        'connectionId'
+      )
+      expect(credentialRepository.getSingleByQuery).toHaveBeenCalledWith(agentContext, {
         threadId: 'threadId',
         connectionId: 'connectionId',
+        role: CredentialRole.Issuer,
       })
 
       expect(result).toBe(expected)
@@ -767,7 +777,7 @@ describe('V1CredentialProtocol', () => {
       const expected = mockCredentialRecord()
       mockFunction(credentialRepository.findById).mockReturnValue(Promise.resolve(expected))
       const result = await credentialProtocol.findById(agentContext, expected.id)
-      expect(credentialRepository.findById).toBeCalledWith(agentContext, expected.id)
+      expect(credentialRepository.findById).toHaveBeenCalledWith(agentContext, expected.id)
 
       expect(result).toBe(expected)
     })
@@ -777,7 +787,7 @@ describe('V1CredentialProtocol', () => {
 
       mockFunction(credentialRepository.getAll).mockReturnValue(Promise.resolve(expected))
       const result = await credentialProtocol.getAll(agentContext)
-      expect(credentialRepository.getAll).toBeCalledWith(agentContext)
+      expect(credentialRepository.getAll).toHaveBeenCalledWith(agentContext)
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })
@@ -787,7 +797,7 @@ describe('V1CredentialProtocol', () => {
 
       mockFunction(credentialRepository.findByQuery).mockReturnValue(Promise.resolve(expected))
       const result = await credentialProtocol.findAllByQuery(agentContext, { state: CredentialState.OfferSent })
-      expect(credentialRepository.findByQuery).toBeCalledWith(agentContext, { state: CredentialState.OfferSent })
+      expect(credentialRepository.findByQuery).toHaveBeenCalledWith(agentContext, { state: CredentialState.OfferSent })
 
       expect(result).toEqual(expect.arrayContaining(expected))
     })

diff --git a/packages/anoncreds/src/protocols/proofs/v1/V1ProofProtocol.ts b/packages/anoncreds/src/protocols/proofs/v1/V1ProofProtocol.ts
@@ -171,7 +171,12 @@ export class V1ProofProtocol extends BaseProofProtocol implements ProofProtocol<
 
     agentContext.config.logger.debug(`Processing presentation proposal with message id ${proposalMessage.id}`)
 
-    let proofRecord = await this.findByThreadAndConnectionId(agentContext, proposalMessage.threadId, connection?.id)
+    let proofRecord = await this.findByThreadIdConnectionIdAndRole(
+      agentContext,
+      proposalMessage.threadId,
+      ProofRole.Verifier,
+      connection?.id
+    )
 
     // Proof record already exists, this is a response to an earlier message sent by us
     if (proofRecord) {
@@ -422,7 +427,12 @@ export class V1ProofProtocol extends BaseProofProtocol implements ProofProtocol<
 
     agentContext.config.logger.debug(`Processing presentation request with id ${proofRequestMessage.id}`)
 
-    let proofRecord = await this.findByThreadAndConnectionId(agentContext, proofRequestMessage.threadId, connection?.id)
+    let proofRecord = await this.findByThreadIdConnectionIdAndRole(
+      agentContext,
+      proofRequestMessage.threadId,
+      ProofRole.Prover,
+      connection?.id
+    )
 
     const requestAttachment = proofRequestMessage.getRequestAttachmentById(INDY_PROOF_REQUEST_ATTACHMENT_ID)
     if (!requestAttachment) {
@@ -760,7 +770,7 @@ export class V1ProofProtocol extends BaseProofProtocol implements ProofProtocol<
     // only depends on the public api, rather than the internal API (this helps with breaking changes)
     const connectionService = agentContext.dependencyManager.resolve(ConnectionService)
 
-    const proofRecord = await this.getByThreadAndConnectionId(agentContext, presentationMessage.threadId)
+    const proofRecord = await this.getByThreadIdConnectionIdAndRole(agentContext, presentationMessage.threadId)
 
     const proposalMessage = await didCommMessageRepository.findAgentMessage(agentContext, {
       associatedRecordId: proofRecord.id,
@@ -887,9 +897,10 @@ export class V1ProofProtocol extends BaseProofProtocol implements ProofProtocol<
     // only depends on the public api, rather than the internal API (this helps with breaking changes)
     const connectionService = agentContext.dependencyManager.resolve(ConnectionService)
 
-    const proofRecord = await this.getByThreadAndConnectionId(
+    const proofRecord = await this.getByThreadIdConnectionIdAndRole(
       agentContext,
       presentationAckMessage.threadId,
+      ProofRole.Prover,
       connection?.id
     )
 
@@ -920,7 +931,7 @@ export class V1ProofProtocol extends BaseProofProtocol implements ProofProtocol<
   }
 
   public async createProblemReport(
-    agentContext: AgentContext,
+    _agentContext: AgentContext,
     { proofRecord, description }: ProofProtocolOptions.CreateProofProblemReportOptions
   ): Promise<ProofProtocolOptions.ProofProtocolMsgReturnType<ProblemReportMessage>> {
     const message = new V1PresentationProblemReportMessage({

diff --git a/packages/core/src/modules/credentials/protocol/BaseCredentialProtocol.ts b/packages/core/src/modules/credentials/protocol/BaseCredentialProtocol.ts
@@ -23,6 +23,7 @@ import type { Query } from '../../../storage/StorageService'
 import type { ProblemReportMessage } from '../../problem-reports'
 import type { CredentialStateChangedEvent } from '../CredentialEvents'
 import type { CredentialFormatService, ExtractCredentialFormats } from '../formats'
+import type { CredentialRole } from '../models'
 import type { CredentialExchangeRecord } from '../repository'
 
 import { EventEmitter } from '../../../agent/EventEmitter'
@@ -141,9 +142,10 @@ export abstract class BaseCredentialProtocol<CFs extends CredentialFormatService
 
     agentContext.config.logger.debug(`Processing problem report with message id ${credentialProblemReportMessage.id}`)
 
-    const credentialRecord = await this.getByThreadAndConnectionId(
+    const credentialRecord = await this.getByThreadIdConnectionIdAndRole(
       agentContext,
       credentialProblemReportMessage.threadId,
+      undefined,
       connection.id
     )
 
@@ -275,41 +277,49 @@ export abstract class BaseCredentialProtocol<CFs extends CredentialFormatService
    * Retrieve a credential record by connection id and thread id
    *
    * @param connectionId The connection id
+   * @param role The role of the record, i.e. holder or issuer
    * @param threadId The thread id
+   *
    * @throws {RecordNotFoundError} If no record is found
    * @throws {RecordDuplicateError} If multiple records are found
    * @returns The credential record
    */
-  public getByThreadAndConnectionId(
+  public getByThreadIdConnectionIdAndRole(
     agentContext: AgentContext,
     threadId: string,
+    role?: CredentialRole,
     connectionId?: string
   ): Promise<CredentialExchangeRecord> {
     const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
 
     return credentialRepository.getSingleByQuery(agentContext, {
       connectionId,
       threadId,
+      role,
     })
   }
 
   /**
    * Find a credential record by connection id and thread id, returns null if not found
    *
-   * @param connectionId The connection id
    * @param threadId The thread id
+   * @param role The role of the record, i.e. holder or issuer
+   * @param connectionId The connection id
+   *
    * @returns The credential record
    */
-  public findByThreadAndConnectionId(
+  public findByThreadIdConnectionIdAndRole(
     agentContext: AgentContext,
     threadId: string,
+    role?: CredentialRole,
     connectionId?: string
   ): Promise<CredentialExchangeRecord | null> {
     const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
 
     return credentialRepository.findSingleByQuery(agentContext, {
       connectionId,
       threadId,
+      role,
     })
   }
 

diff --git a/packages/core/src/modules/credentials/protocol/CredentialProtocol.ts b/packages/core/src/modules/credentials/protocol/CredentialProtocol.ts
@@ -112,12 +112,12 @@ export interface CredentialProtocol<CFs extends CredentialFormatService[] = Cred
     credentialRecord: CredentialExchangeRecord,
     options?: DeleteCredentialOptions
   ): Promise<void>
-  getByThreadAndConnectionId(
+  getByThreadIdConnectionIdAndRole(
     agentContext: AgentContext,
     threadId: string,
     connectionId?: string
   ): Promise<CredentialExchangeRecord>
-  findByThreadAndConnectionId(
+  findByThreadIdConnectionIdAndRole(
     agentContext: AgentContext,
     threadId: string,
     connectionId?: string