fix(agent-service): return 409 Conflict for duplicate DID creation

apps/agent-service/src/agent-service.service.spec.ts

@@ -0,0 +1,115 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Test, TestingModule } from '@nestjs/testing';
+import { AgentServiceService } from './agent-service.service';
+import { AgentServiceRepository } from './repositories/agent-service.repository';
+import { PrismaService } from '@credebl/prisma-service';
+import { CommonService } from '@credebl/common';
+import { CACHE_MANAGER } from '@nestjs/cache-manager';
+import { UserActivityRepository } from 'libs/user-activity/repositories';
+import { NATSClient } from '@credebl/common/NATSClient';
+import { RpcException } from '@nestjs/microservices';
+import { ResponseMessages } from '@credebl/common/response-messages';
+import { DidMethod } from '@credebl/enum/enum';
+
+describe('AgentServiceService - createDid duplicate handling', () => {
+  let service: AgentServiceService;
+  let commonService: Partial<CommonService>;
+  let agentServiceRepository: Partial<AgentServiceRepository>;
+
+  beforeEach(async () => {
+    commonService = {
+      httpPost: jest.fn(),
+      decryptPassword: jest.fn().mockResolvedValue('decrypted-api-key')
+    };
+
+    agentServiceRepository = {
+      getOrgAgentDetails: jest.fn().mockResolvedValue({
+        id: 'agent-id-1',
+        agentEndPoint: 'http://localhost:3000',
+        ledgerId: null,
+        apiKey: 'encrypted-api-key'
+      }),
+      getLedgerByNameSpace: jest.fn().mockResolvedValue({ id: 'ledger-id-1' }),
+      getOrgDid: jest.fn().mockResolvedValue([]),
+      storeDidDetails: jest.fn(),
+      updateIsPrimaryDid: jest.fn(),
+      setPrimaryDid: jest.fn(),
+      getLedger: jest.fn().mockResolvedValue({ id: 'ledger-id-1' }),
+      updateLedgerId: jest.fn()
+    };
+
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        AgentServiceService,
+        { provide: AgentServiceRepository, useValue: agentServiceRepository },
+        { provide: PrismaService, useValue: {} },
+        { provide: CommonService, useValue: commonService },
+        { provide: 'NATS_CLIENT', useValue: { send: jest.fn() } },
+        { provide: CACHE_MANAGER, useValue: { get: jest.fn(), set: jest.fn() } },
+        { provide: UserActivityRepository, useValue: {} },
+        { provide: NATSClient, useValue: {} }
+      ]
+    }).compile();
+
+    service = module.get<AgentServiceService>(AgentServiceService);
+    jest.spyOn(service, 'getOrgAgentApiKey').mockResolvedValue('test-api-key');
+  });
+
+  const mockPayload = {
+    seed: '12345678901234567890123456789012',
+    keyType: 'ed25519',
+    method: DidMethod.INDY,
+    network: 'indicio:demonet',
+    role: 'endorser',
+    isPrimaryDid: false
+  };
+
+  const mockUser = {
+    id: 'user-id-1',
+    email: 'test@example.com'
+  } as any;
+
+  it('should throw 409 Conflict with "DID already exist" when Credo returns "CredoError: Key already exists"', async () => {
+    (commonService.httpPost as jest.Mock).mockRejectedValue({
+      response: {
+        status: 500,
+        error: 'CredoError: Key already exists'
+      }
+    });
+
+    try {
+      await service.createDid(mockPayload as any, 'org-id-1', mockUser);
+      fail('Expected RpcException to be thrown');
+    } catch (error) {
+      expect(error).toBeInstanceOf(RpcException);
+      const rpcError = error.getError();
+      expect(rpcError).toEqual({
+        statusCode: 409,
+        message: ResponseMessages.agent.error.didAlreadyExist,
+        error: 'Conflict'
+      });
+    }
+  });
+
+  it('should throw 409 Conflict when DID already exists in organization wallet database', async () => {
+    (commonService.httpPost as jest.Mock).mockResolvedValue({
+      did: 'did:indy:indicio:demonet:existing-did',
+      didDocument: {}
+    });
+
+    (agentServiceRepository.getOrgDid as jest.Mock).mockResolvedValue([{ did: 'did:indy:indicio:demonet:existing-did' }]);
+
+    try {
+      await service.createDid(mockPayload as any, 'org-id-1', mockUser);
+      fail('Expected RpcException to be thrown');
+    } catch (error) {
+      expect(error).toBeInstanceOf(RpcException);
+      const rpcError = error.getError();
+      expect(rpcError).toEqual({
+        statusCode: 409,
+        message: ResponseMessages.agent.error.didAlreadyExist,
+        error: 'Conflict'
+      });
+    }
+  });
+});

apps/agent-service/src/agent-service.service.ts

@@ -101,7 +101,7 @@
     private readonly natsClient: NATSClient
   ) {}
 
   async ReplaceAt(input, search, replace, start, end): Promise<string> {
     return input.slice(0, start) + input.slice(start, end).replace(search, replace) + input.slice(end);
   }
 
@@ -132,7 +132,7 @@
       await this.provisionWallet(agentSpinupDto, user);
       return { agentSpinupStatus: AgentSpinUpStatus.DID_CREATED };
     } catch (error) {
       this.handleErrorOnWalletProvision(agentSpinupDto, error, agentProcess);
       throw new RpcException(error.response ?? error);
     }
   }
@@ -233,16 +233,16 @@
       agentProcess = await this.createOrgAgent(agentSpinUpStatus, userId, agentSpinupDto.orgId);
 
       // Credo agent spin-up
       this._agentSpinup(
         walletProvisionPayload,
         agentSpinupDto,
         platformConfig?.sgApiKey,
         orgData,
         user,
         socket,
         agentSpinupDto.ledgerId,
         agentProcess
       );
     } catch (error) {
       this.handleErrorOnWalletProvision(agentSpinupDto, error, agentProcess);
       throw error;
@@ -390,7 +390,7 @@
     }
   }
 
   async prepareWalletProvisionPayload(
     agentSpinupDto: IAgentSpinupDto,
     externalIp: string,
     apiEndpoint: string,
@@ -429,7 +429,7 @@
     return walletProvisionPayload;
   }
 
   async initSocketConnection(socketHost: string): Promise<Socket> {
     const socket = io(socketHost, {
       reconnection: true,
       reconnectionDelay: 5000,
@@ -461,14 +461,14 @@
       const socket = await this.initSocketConnection(`${process.env.SOCKET_HOST}`);
 
       if (agentSpinupDto.clientSocketId) {
         this.emitErrorInWalletCreationEvent(agentSpinupDto, socket, error);
       }
       this.agentServiceRepository.removeOrgAgent(agentProcess?.id);
       this.logger.error(`Error in Agent spin up: ${JSON.stringify(error)}`);
     }
   }
 
   async emitErrorInWalletCreationEvent(agentSpinupDto: IAgentSpinupDto, socket: Socket, error: Error): Promise<void> {
     try {
       socket.emit('error-in-wallet-creation-process', { clientId: agentSpinupDto.clientSocketId, error });
       this.logger.error(`Error in wallet creation process emitted for orgId ${agentSpinupDto.orgId}: ${error.message}`);
@@ -642,7 +642,7 @@
     }
 
     if (payload && payload?.id) {
       this.agentServiceRepository.removeOrgAgent(payload?.id);
     }
 
     this.logger.error(`[_storeOrgAgentDetails] - Error in store agent details : ${JSON.stringify(error)}`);
@@ -827,20 +827,20 @@
       // Get organization data
       const getOrganization = await this.agentServiceRepository.getOrgDetails(payload.orgId);
 
       this.notifyClientSocket('agent-spinup-process-completed', payload.clientSocketId);
 
       const orgAgentDetails = await this.agentServiceRepository.storeOrgAgentDetails(storeOrgAgentData);
 
       this.notifyClientSocket('invitation-url-creation-started', payload.clientSocketId);
 
       // Create the legacy connection invitation
       await this._createConnectionInvitation(payload.orgId, user, getOrganization.name);
 
       this.notifyClientSocket('invitation-url-creation-success', payload.clientSocketId);
 
       return orgAgentDetails;
     } catch (error) {
       this.handleError(error, payload.clientSocketId);
       throw error;
     }
   }
@@ -932,6 +932,27 @@
     } catch (error) {
       this.logger.error(`error in create did : ${JSON.stringify(error)}`);
 
+      const errorText =
+        error?.response?.error?.message ??
+        error?.response?.error ??
+        error?.response?.data?.error ??
+        error?.response?.data?.message ??
+        error?.response?.data ??
+        error?.message ??
+        (typeof error === 'string' ? error : JSON.stringify(error));
+
+      const isDuplicateDid =
+        typeof errorText === 'string' &&
+        (errorText.includes('Key already exists') || errorText.includes('already exist'));
+
+      if (isDuplicateDid) {
+        throw new RpcException({
+          statusCode: HttpStatus.CONFLICT,
+          message: ResponseMessages.agent.error.didAlreadyExist,
+          error: 'Conflict'
+        });
+      }
+
       if (error?.response?.error?.message) {
         throw new RpcException({
           statusCode: error?.response?.status,
@@ -965,10 +986,7 @@
   private checkDidExistence(getDidByOrg, didDetails): void {
     const didExist = getDidByOrg.some((orgDidExist) => orgDidExist.did === didDetails.did);
     if (didExist) {
-      throw new ConflictException(ResponseMessages.agent.error.didAlreadyExist, {
-        cause: new Error(),
-        description: ResponseMessages.errorMessages.serverError
-      });
+      throw new ConflictException(ResponseMessages.agent.error.didAlreadyExist);
     }
   }
 
@@ -1157,7 +1175,7 @@
     return didDetails;
   }
 
   private async createSocketInstance(): Promise<Socket> {
     return io(`${process.env.SOCKET_HOST}`, {
       reconnection: true,
       reconnectionDelay: 5000,
@@ -1254,7 +1272,7 @@
 
         schemaResponse = await this.commonService
           .httpGet(url, { headers: { authorization: getApiKey } })
           .then(async (schema) => schema);
       }
       return schemaResponse;
     } catch (error) {
@@ -1278,7 +1296,7 @@
 
         credDefResponse = await this.commonService
           .httpPost(url, credDefPayload, { headers: { authorization: getApiKey } })
           .then(async (credDef) => credDef);
       } else if (OrgAgentType.SHARED === payload.agentType) {
         const url = `${payload.agentEndPoint}${CommonConstants.URL_SCHM_CREATE_CRED_DEF}`;
         const credDefPayload = {
@@ -1288,7 +1306,7 @@
         };
         credDefResponse = await this.commonService
           .httpPost(url, credDefPayload, { headers: { authorization: getApiKey } })
           .then(async (credDef) => credDef);
       }
 
       return credDefResponse;
@@ -1310,7 +1328,7 @@
         )}`;
         credDefResponse = await this.commonService
           .httpGet(url, { headers: { authorization: getApiKey } })
           .then(async (credDef) => credDef);
       } else if (OrgAgentType.SHARED === payload.agentType) {
         const url = `${payload.agentEndPoint}${CommonConstants.URL_SCHM_GET_CRED_DEF_BY_ID}`.replace(
           '#',
@@ -1318,7 +1336,7 @@
         );
         credDefResponse = await this.commonService
           .httpGet(url, { headers: { authorization: getApiKey } })
           .then(async (credDef) => credDef);
       }
       return credDefResponse;
     } catch (error) {
@@ -1350,7 +1368,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPost(url, issueData, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in sendCredentialCreateOffer in agent service : ${JSON.stringify(error)}`);
@@ -1375,7 +1393,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPost(url, issueData, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in oidcIssuerCreate in agent service : ${JSON.stringify(error)}`);
@@ -1429,7 +1447,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPost(url, credentialPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in oidcCreateCredentialOffer in agent service : ${JSON.stringify(error)}`);
@@ -1442,7 +1460,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPut(url, issuanceMetadata, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in _oidcUpdateCredentialOffer in agent service : ${JSON.stringify(error)}`);
@@ -1481,7 +1499,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpDelete(`${url}`, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in _oidcDeleteCredentialOffer in agent service : ${JSON.stringify(error)}`);
@@ -1494,7 +1512,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPost(`${url}`, {}, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       const errorMsg = error.response ? JSON.stringify(error.response.data) : error.message;
@@ -1508,7 +1526,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpPut(url, templatePayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in oidcIssuerTemplate in agent service : ${JSON.stringify(error)}`);
@@ -1520,7 +1538,7 @@
     try {
       const data = await this.commonService
         .httpGet(url, { headers: { authorization: apiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in getIssueCredentials in agent service : ${JSON.stringify(error)}`);
@@ -1587,7 +1605,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const data = await this.commonService
         .httpGet(url, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return data;
     } catch (error) {
       this.logger.error(`Error in getConnections in agent service : ${JSON.stringify(error)}`);
@@ -1638,7 +1656,7 @@
         .httpGet(`${orgAgentDetails.agentEndPoint}${CommonConstants.URL_AGENT_STATUS}`, {
           headers: { authorization: agentApiKey }
         })
         .then(async (response) => response);
 
       return agentHealthData;
     } catch (error) {
@@ -1698,7 +1716,7 @@
             headers: { authorization: agentApiKey }
           }
         )
         .then(async (response) => response);
 
       return signedDataFromAgent;
     } catch (error) {
@@ -1741,7 +1759,7 @@
         .httpPost(`${url}`, data, {
           headers: { authorization: agentApiKey }
         })
         .then(async (response) => response);
 
       return signedDataFromAgent;
     } catch (error) {
@@ -1769,7 +1787,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const sendProofRequest = await this.commonService
         .httpPost(url, proofRequestPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return sendProofRequest;
     } catch (error) {
       this.logger.error(`Error in send out of band proof request in agent service : ${JSON.stringify(error)}`);
@@ -1792,7 +1810,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const schemaRequest = await this.commonService
         .httpPost(url, requestSchemaPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return schemaRequest;
     } catch (error) {
       this.logger.error(`Error in schema endorsement request in agent service : ${JSON.stringify(error)}`);
@@ -1820,7 +1838,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const signEndorsementTransaction = await this.commonService
         .httpPost(url, signEndorsementPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
 
       return signEndorsementTransaction;
     } catch (error) {
@@ -1834,7 +1852,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const signEndorsementTransaction = await this.commonService
         .httpPost(url, submitEndorsementPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
 
       return signEndorsementTransaction;
     } catch (error) {
@@ -1852,7 +1870,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const sendOutOfbandCredentialOffer = await this.commonService
         .httpPost(url, outOfBandIssuancePayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return sendOutOfbandCredentialOffer;
     } catch (error) {
       this.logger.error(`Error in out-of-band credential in agent service : ${JSON.stringify(error)}`);
@@ -1983,7 +2001,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const receiveInvitationUrlRes = await this.commonService
         .httpPost(url, receiveInvitationUrl, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return receiveInvitationUrlRes;
     } catch (error) {
       this.logger.error(`Error in receive invitation in agent service : ${JSON.stringify(error)}`);
@@ -2072,7 +2090,7 @@
     }
   }
 
   async handleAgentSpinupStatusErrors(error: string): Promise<object> {
     if (error && Object.keys(error).length === 0) {
       throw new InternalServerErrorException(ResponseMessages.agent.error.agentDown, {
         cause: new Error(),
@@ -2088,7 +2106,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const sendQuestionRes = await this.commonService
         .httpPost(url, questionPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return sendQuestionRes;
     } catch (error) {
       this.logger.error(`Error in send question in agent service : ${JSON.stringify(error)}`);
@@ -2101,7 +2119,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const basicMessageRes = await this.commonService
         .httpPost(url, messagePayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return basicMessageRes;
     } catch (error) {
       this.logger.error(`Error in sendBasicMessage in agent service : ${JSON.stringify(error)}`);
@@ -2124,7 +2142,7 @@
 
     const data = await this.commonService
       .httpGet(url, { headers: { authorization: getApiKey } })
       .then(async (response) => response)
       .catch((error) => this.handleAgentSpinupStatusErrors(error));
 
     return data;
@@ -2135,7 +2153,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const schemaRequest = await this.commonService
         .httpPost(url, schemaRequestPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return schemaRequest;
     } catch (error) {
       this.logger.error(`Error in createW3CSchema request in agent service : ${JSON.stringify(error)}`);
@@ -2152,7 +2170,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const createConnectionInvitation = await this.commonService
         .httpPost(url, connectionPayload, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return createConnectionInvitation;
     } catch (error) {
       this.logger.error(`Error in create connection invitation in agent service : ${JSON.stringify(error)}`);
@@ -2160,7 +2178,7 @@
     }
   }
 
   private async tokenEncryption(token: string): Promise<string> {
     try {
       const secret = process.env.CRYPTO_PRIVATE_KEY;
       if (!secret) {
@@ -2182,7 +2200,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const x509Certificate = await this.commonService
         .httpPost(url, options, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return x509Certificate;
     } catch (error) {
       this.logger.error(`Error in creating x509 certificate in agent service : ${JSON.stringify(error)}`);
@@ -2197,7 +2215,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const x509Certificate = await this.commonService
         .httpPost(url, options, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return x509Certificate;
     } catch (error) {
       this.logger.error(`Error in decoding x509 certificate in agent service : ${JSON.stringify(error)}`);
@@ -2212,7 +2230,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const x509Certificate = await this.commonService
         .httpPost(url, options, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return x509Certificate;
     } catch (error) {
       this.logger.error(`Error in creating x509 certificate in agent service : ${JSON.stringify(error)}`);
@@ -2256,7 +2274,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const updateVerifier = await this.commonService
         .httpPut(url, verifierDetails, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return updateVerifier;
     } catch (error) {
       this.logger.error(
@@ -2290,7 +2308,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const createSession = await this.commonService
         .httpPost(url, sessionRequest, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return createSession;
     } catch (error) {
       this.logger.error(
@@ -2312,7 +2330,7 @@
       const getApiKey = await this.getOrgAgentApiKey(orgId);
       const verifySession = await this.commonService
         .httpPost(url, verifyAuthorizationResponse, { headers: { authorization: getApiKey } })
         .then(async (response) => response);
       return verifySession;
     } catch (error) {
       this.logger.error(