feat: remove oidc4vp transaction on wallet error notification (#1771)

Signed-off-by: Misha Sizov <[email protected]>

pkg/service/oidc4vp/oidc4vp_service.go

@@ -84,6 +84,7 @@ type transactionManager interface {
 	DeleteReceivedClaims(claimsID string) error
 	GetByOneTimeToken(nonce string) (*Transaction, bool, error)
 	Get(txID TxID) (*Transaction, error)
+	Delete(txID TxID) error
 }
 
 type requestObjectStore interface {

pkg/service/oidc4vp/oidc4vp_wallet_notification.go

@@ -76,6 +76,12 @@ func (s *Service) HandleWalletNotification(ctx context.Context, req *WalletNotif
 		return err
 	}
 
+	// Delete tx from store.
+	err = s.transactionManager.Delete(req.TxID)
+	if err != nil {
+		return err
+	}
+
 	return nil
 }
 

pkg/service/oidc4vp/oidc4vp_wallet_notification_test.go

@@ -132,6 +132,10 @@ func TestService_HandleWalletNotification_SupportedAuthResponseErrorTypes(t *tes
 					return nil
 				})
 
+			transactionManager.EXPECT().
+				Delete(transactionID).Times(1).
+				Return(nil)
+
 			s := oidc4vp.NewService(&oidc4vp.Config{
 				EventSvc:           eventService,
 				EventTopic:         spi.VerifierEventTopic,
@@ -228,6 +232,10 @@ func TestService_HandleWalletNotification_EdgeCases(t *testing.T) {
 							OrganizationID: profileOrgID,
 							WebHook:        profileWebHook,
 						}, nil)
+
+					transactionManager.EXPECT().
+						Delete(transactionID).Times(1).
+						Return(nil)
 				},
 				check: func(t *testing.T, err error) {
 					assert.NoError(t, err)
@@ -375,6 +383,45 @@ func TestService_HandleWalletNotification_EdgeCases(t *testing.T) {
 				ErrorDescription: "error description",
 			},
 		},
+		{
+			name: "Error: failed to delete transaction",
+			fields: fields{
+				setup: func() {
+					transactionManager.EXPECT().
+						Get(transactionID).Times(1).
+						Return(&oidc4vp.Transaction{
+							ID:             transactionID,
+							ProfileID:      profileID,
+							ProfileVersion: profileVersion,
+						}, nil)
+
+					profileService.EXPECT().
+						GetProfile(profileID, profileVersion).
+						Return(&profileapi.Verifier{
+							ID:             profileID,
+							Version:        profileVersion,
+							OrganizationID: profileOrgID,
+							WebHook:        profileWebHook,
+						}, nil)
+
+					eventService.EXPECT().
+						Publish(gomock.Any(), spi.VerifierEventTopic, gomock.Any()).
+						Return(nil)
+
+					transactionManager.EXPECT().
+						Delete(transactionID).Times(1).
+						Return(errors.New("transaction service error"))
+				},
+				check: func(t *testing.T, err error) {
+					assert.ErrorContains(t, err, "transaction service error")
+				},
+			},
+			notification: &oidc4vp.WalletNotification{
+				TxID:             transactionID,
+				Error:            "invalid_scope",
+				ErrorDescription: "error description",
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

pkg/service/oidc4vp/txmanager.go

@@ -70,6 +70,7 @@ type txStore interface {
 	) (TxID, *Transaction, error)
 	Update(update TransactionUpdate, profileTransactionDataTTL int32) error
 	Get(txID TxID) (*Transaction, error)
+	Delete(txID TxID) error
 }
 
 type txClaimsStore interface {
@@ -156,7 +157,7 @@ func (tm *TxManager) StoreReceivedClaims(
 	return tm.txStore.Update(TransactionUpdate{ID: txID, ReceivedClaimsID: receivedClaimsID}, profileTransactionDataTTL)
 }
 
-// Get transaction id.
+// Get transaction by TxID.
 func (tm *TxManager) Get(txID TxID) (*Transaction, error) {
 	tx, err := tm.txStore.Get(txID)
 	if errors.Is(err, ErrDataNotFound) {
@@ -185,6 +186,17 @@ func (tm *TxManager) Get(txID TxID) (*Transaction, error) {
 	return tx, nil
 }
 
+// Delete transaction by TxID.
+// Note, that given func does not remove associated claims from store.
+func (tm *TxManager) Delete(txID TxID) error {
+	err := tm.txStore.Delete(txID)
+	if err != nil {
+		return fmt.Errorf("delete tx from store: %w", err)
+	}
+
+	return nil
+}
+
 // GetByOneTimeToken get transaction by nonce and then delete nonce.
 func (tm *TxManager) GetByOneTimeToken(nonce string) (*Transaction, bool, error) {
 	txID, valid, err := tm.nonceStore.GetAndDelete(nonce)

pkg/service/oidc4vp/txmanager_test.go

@@ -14,6 +14,7 @@ import (
 	"testing"
 
 	"github.com/golang/mock/gomock"
+	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/trustbloc/vc-go/presexch"
@@ -557,6 +558,42 @@ func TestTxManagerDeleteReceivedClaims(t *testing.T) {
 	})
 }
 
+func TestTxManagerDeleteTransaction(t *testing.T) {
+	t.Run("Success", func(t *testing.T) {
+		txID := oidc4vp.TxID(uuid.NewString())
+
+		store := NewMockTxStore(gomock.NewController(t))
+		store.EXPECT().Delete(txID).Return(nil)
+
+		claimsStore := NewMockTxClaimsStore(gomock.NewController(t))
+		nonceStore := NewMockTxNonceStore(gomock.NewController(t))
+		crypto := NewMockDataProtector(gomock.NewController(t))
+
+		manager := oidc4vp.NewTxManager(nonceStore, store, claimsStore, crypto,
+			testutil.DocumentLoader(t))
+
+		err := manager.Delete(txID)
+		require.NoError(t, err)
+	})
+
+	t.Run("Error", func(t *testing.T) {
+		txID := oidc4vp.TxID(uuid.NewString())
+
+		store := NewMockTxStore(gomock.NewController(t))
+		store.EXPECT().Delete(txID).Return(errors.New("some error"))
+
+		claimsStore := NewMockTxClaimsStore(gomock.NewController(t))
+		nonceStore := NewMockTxNonceStore(gomock.NewController(t))
+		crypto := NewMockDataProtector(gomock.NewController(t))
+
+		manager := oidc4vp.NewTxManager(nonceStore, store, claimsStore, crypto,
+			testutil.DocumentLoader(t))
+
+		err := manager.Delete(txID)
+		require.Contains(t, err.Error(), "some error")
+	})
+}
+
 func TestClaimsToRaw(t *testing.T) {
 	t.Run("data nil", func(t *testing.T) {
 		manager := oidc4vp.NewTxManager(nil, nil, nil, nil,

pkg/storage/mongodb/oidc4vptxstore/oidc4vp_tx_store.go

@@ -159,6 +159,26 @@ func (p *TxStore) Get(strID oidc4vp.TxID) (*oidc4vp.Transaction, error) {
 	return txFromDocument(txDoc)
 }
 
+// Delete deletes oidc4vp.Transaction from store.
+func (p *TxStore) Delete(strID oidc4vp.TxID) error {
+	ctxWithTimeout, cancel := p.mongoClient.ContextWithTimeout()
+	defer cancel()
+
+	collection := p.mongoClient.Database().Collection(txCollection)
+
+	id, err := txIDFromString(strID)
+	if err != nil {
+		return err
+	}
+
+	_, err = collection.DeleteOne(ctxWithTimeout, bson.M{"_id": id})
+	if err != nil {
+		return fmt.Errorf("delete tx: %w", err)
+	}
+
+	return nil
+}
+
 func (p *TxStore) Update(update oidc4vp.TransactionUpdate, _ int32) error {
 	ctxWithTimeout, cancel := p.mongoClient.ContextWithTimeout()
 	defer cancel()