feat(credentials): added credential sendProblemReport method

packages/core/src/modules/credentials/CredentialServiceOptions.ts

@@ -118,6 +118,10 @@ export interface AcceptCredentialOptions {
   credentialRecord: CredentialExchangeRecord
 }
 
+export interface CreateProblemReportOptions {
+  message: string
+}
+
 export interface CredentialProtocolMsgReturnType<MessageType extends AgentMessage> {
   message: MessageType
   credentialRecord: CredentialExchangeRecord

packages/core/src/modules/credentials/CredentialsModule.ts

@@ -17,6 +17,7 @@ import type {
   FindCredentialMessageReturn,
   FindProposalMessageReturn,
   GetFormatDataReturn,
+  SendProblemReportOptions,
 } from './CredentialsModuleOptions'
 import type { CredentialFormat } from './formats'
 import type { IndyCredentialFormat } from './formats/indy/IndyCredentialFormat'
@@ -67,6 +68,7 @@ export interface CredentialsModule<CFs extends CredentialFormat[], CSs extends C
 
   // Credential
   acceptCredential(options: AcceptCredentialOptions): Promise<CredentialExchangeRecord>
+  sendProblemReport(options: SendProblemReportOptions): Promise<CredentialExchangeRecord>
 
   // Record Methods
   getAll(): Promise<CredentialExchangeRecord[]>
@@ -517,6 +519,30 @@ export class CredentialsModule<
     }
   }
 
+  /**
+   * Send problem report message for a credential record
+   * @param credentialRecordId The id of the credential record for which to send problem report
+   * @param message message to send
+   * @returns credential record associated with the credential problem report message
+   */
+  public async sendProblemReport(options: SendProblemReportOptions) {
+    const credentialRecord = await this.getById(options.credentialRecordId)
+    if (!credentialRecord.connectionId) {
+      throw new AriesFrameworkError(`No connectionId found for credential record '${credentialRecord.id}'.`)
+    }
+    const connection = await this.connectionService.getById(credentialRecord.connectionId)
+
+    const service = this.getService(credentialRecord.protocolVersion)
+    const problemReportMessage = service.createProblemReport({ message: options.message })
+    problemReportMessage.setThread({
+      threadId: credentialRecord.threadId,
+    })
+    const outboundMessage = createOutboundMessage(connection, problemReportMessage)
+    await this.messageSender.sendMessage(outboundMessage)
+
+    return credentialRecord
+  }
+
   public async getFormatData(credentialRecordId: string): Promise<GetFormatDataReturn<CFs>> {
     const credentialRecord = await this.getById(credentialRecordId)
     const service = this.getService(credentialRecord.protocolVersion)

packages/core/src/modules/credentials/CredentialsModuleOptions.ts

@@ -128,3 +128,11 @@ export interface AcceptRequestOptions<CFs extends CredentialFormat[] = Credentia
 export interface AcceptCredentialOptions {
   credentialRecordId: string
 }
+
+/**
+ * Interface for CredentialsModule.sendProblemReport. Will send a problem-report message
+ */
+export interface SendProblemReportOptions {
+  credentialRecordId: string
+  message: string
+}

packages/core/src/modules/credentials/protocol/v1/V1CredentialService.ts

@@ -1,12 +1,14 @@
 import type { AgentMessage } from '../../../../agent/AgentMessage'
 import type { HandlerInboundMessage } from '../../../../agent/Handler'
 import type { InboundMessageContext } from '../../../../agent/models/InboundMessageContext'
+import type { ProblemReportMessage } from '../../../problem-reports'
 import type {
   AcceptCredentialOptions,
   AcceptOfferOptions,
   AcceptProposalOptions,
   AcceptRequestOptions,
   CreateOfferOptions,
+  CreateProblemReportOptions,
   CreateProposalOptions,
   CredentialProtocolMsgReturnType,
   NegotiateOfferOptions,
@@ -30,6 +32,7 @@ import { uuid } from '../../../../utils/uuid'
 import { AckStatus } from '../../../common'
 import { ConnectionService } from '../../../connections/services'
 import { MediationRecipientService } from '../../../routing'
+import { CredentialProblemReportReason } from '../../errors'
 import { IndyCredentialFormatService } from '../../formats/indy/IndyCredentialFormatService'
 import { IndyCredPropose } from '../../formats/indy/models'
 import { AutoAcceptCredential } from '../../models/CredentialAutoAcceptType'
@@ -52,6 +55,7 @@ import {
   INDY_CREDENTIAL_OFFER_ATTACHMENT_ID,
   INDY_CREDENTIAL_REQUEST_ATTACHMENT_ID,
   V1CredentialAckMessage,
+  V1CredentialProblemReportMessage,
   V1IssueCredentialMessage,
   V1OfferCredentialMessage,
   V1ProposeCredentialMessage,
@@ -909,6 +913,22 @@ export class V1CredentialService extends CredentialService<[IndyCredentialFormat
     return credentialRecord
   }
 
+  /**
+   * Create a {@link V1CredentialProblemReportMessage} to be sent.
+   *
+   * @param message message to send
+   * @returns a {@link V1CredentialProblemReportMessage}
+   *
+   */
+  public createProblemReport(options: CreateProblemReportOptions): ProblemReportMessage {
+    return new V1CredentialProblemReportMessage({
+      description: {
+        en: options.message,
+        code: CredentialProblemReportReason.IssuanceAbandoned,
+      },
+    })
+  }
+
   // AUTO RESPOND METHODS
   public async shouldAutoRespondToProposal(options: {
     credentialRecord: CredentialExchangeRecord

packages/core/src/modules/credentials/protocol/v1/__tests__/V1CredentialServiceCred.test.ts

@@ -692,6 +692,7 @@ describe('V1CredentialService', () => {
 
   describe('createProblemReport', () => {
     const threadId = 'fd9c5ddb-ec11-4acd-bc32-540736249746'
+    const message = 'Indy error'
     let credential: CredentialExchangeRecord
 
     beforeEach(() => {
@@ -702,25 +703,24 @@ describe('V1CredentialService', () => {
       })
     })
 
-    test('returns problem report message base once get error', async () => {
+    test('returns problem report message base once get error', () => {
       // given
       mockFunction(credentialRepository.getById).mockReturnValue(Promise.resolve(credential))
 
       // when
-      const credentialProblemReportMessage = new V1CredentialProblemReportMessage({
-        description: {
-          en: 'Indy error',
-          code: CredentialProblemReportReason.IssuanceAbandoned,
-        },
-      })
+      const credentialProblemReportMessage = credentialService.createProblemReport({ message })
 
       credentialProblemReportMessage.setThread({ threadId })
       // then
       expect(credentialProblemReportMessage.toJSON()).toMatchObject({
         '@id': expect.any(String),
         '@type': 'https://didcomm.org/issue-credential/1.0/problem-report',
         '~thread': {
-          thid: 'fd9c5ddb-ec11-4acd-bc32-540736249746',
+          thid: threadId,
+        },
+        description: {
+          code: CredentialProblemReportReason.IssuanceAbandoned,
+          en: message,
         },
       })
     })

packages/core/src/modules/credentials/protocol/v2/V2CredentialService.ts

@@ -1,6 +1,7 @@
 import type { AgentMessage } from '../../../../agent/AgentMessage'
 import type { HandlerInboundMessage } from '../../../../agent/Handler'
 import type { InboundMessageContext } from '../../../../agent/models/InboundMessageContext'
+import type { ProblemReportMessage } from '../../../problem-reports'
 import type {
   CreateProposalOptions,
   CredentialProtocolMsgReturnType,
@@ -14,6 +15,7 @@ import type {
   AcceptCredentialOptions,
   GetFormatDataReturn,
   FormatDataMessagePayload,
+  CreateProblemReportOptions,
 } from '../../CredentialServiceOptions'
 import type {
   CredentialFormat,
@@ -34,6 +36,7 @@ import { uuid } from '../../../../utils/uuid'
 import { AckStatus } from '../../../common'
 import { ConnectionService } from '../../../connections'
 import { MediationRecipientService } from '../../../routing'
+import { CredentialProblemReportReason } from '../../errors'
 import { IndyCredentialFormatService } from '../../formats/indy/IndyCredentialFormatService'
 import { CredentialState, AutoAcceptCredential } from '../../models'
 import { CredentialExchangeRecord, CredentialRepository } from '../../repository'
@@ -52,6 +55,7 @@ import {
 } from './handlers'
 import {
   V2CredentialAckMessage,
+  V2CredentialProblemReportMessage,
   V2IssueCredentialMessage,
   V2OfferCredentialMessage,
   V2ProposeCredentialMessage,
@@ -798,6 +802,22 @@ export class V2CredentialService<CFs extends CredentialFormat[] = CredentialForm
     return credentialRecord
   }
 
+  /**
+   * Create a {@link V2CredentialProblemReportMessage} to be sent.
+   *
+   * @param message message to send
+   * @returns a {@link V2CredentialProblemReportMessage}
+   *
+   */
+  public createProblemReport(options: CreateProblemReportOptions): ProblemReportMessage {
+    return new V2CredentialProblemReportMessage({
+      description: {
+        en: options.message,
+        code: CredentialProblemReportReason.IssuanceAbandoned,
+      },
+    })
+  }
+
   // AUTO ACCEPT METHODS
   public async shouldAutoRespondToProposal(options: {
     credentialRecord: CredentialExchangeRecord

packages/core/src/modules/credentials/protocol/v2/__tests__/V2CredentialServiceCred.test.ts

@@ -652,22 +652,18 @@ describe('CredentialService', () => {
   })
 
   describe('createProblemReport', () => {
-    test('returns problem report message base once get error', async () => {
+    test('returns problem report message base once get error', () => {
       // given
       const credentialRecord = mockCredentialRecord({
         state: CredentialState.OfferReceived,
         threadId: 'somethreadid',
         connectionId: 'b1e2f039-aa39-40be-8643-6ce2797b5190',
       })
+      const message = 'Indy error'
       mockFunction(credentialRepository.getById).mockResolvedValue(credentialRecord)
 
       // when
-      const credentialProblemReportMessage = new V2CredentialProblemReportMessage({
-        description: {
-          en: 'Indy error',
-          code: CredentialProblemReportReason.IssuanceAbandoned,
-        },
-      })
+      const credentialProblemReportMessage = credentialService.createProblemReport({ message })
 
       credentialProblemReportMessage.setThread({ threadId: 'somethreadid' })
       // then
@@ -677,6 +673,10 @@ describe('CredentialService', () => {
         '~thread': {
           thid: 'somethreadid',
         },
+        description: {
+          code: CredentialProblemReportReason.IssuanceAbandoned,
+          en: message,
+        },
       })
     })
   })

packages/core/src/modules/credentials/services/CredentialService.ts

@@ -20,6 +20,7 @@ import type {
   AcceptRequestOptions,
   AcceptCredentialOptions,
   GetFormatDataReturn,
+  CreateProblemReportOptions,
 } from '../CredentialServiceOptions'
 import type { CredentialFormat, CredentialFormatService } from '../formats'
 import type { CredentialExchangeRecord, CredentialRepository } from './../repository'
@@ -84,6 +85,9 @@ export abstract class CredentialService<CFs extends CredentialFormat[] = Credent
   // methods for ack
   abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<CredentialExchangeRecord>
 
+  // methods for problem-report
+  abstract createProblemReport(options: CreateProblemReportOptions): ProblemReportMessage
+
   abstract findProposalMessage(credentialExchangeId: string): Promise<AgentMessage | null>
   abstract findOfferMessage(credentialExchangeId: string): Promise<AgentMessage | null>
   abstract findRequestMessage(credentialExchangeId: string): Promise<AgentMessage | null>