fix: priority sorting for didcomm services (#1555)

Signed-off-by: Timo Glastra <[email protected]>

packages/core/src/modules/connections/__tests__/helpers.test.ts

@@ -140,7 +140,7 @@ describe('convertToNewDidDocument', () => {
           serviceEndpoint: 'did:sov:SKJVx2kn373FNgvff1SbJo',
           recipientKeys: ['EoGusetSxDJktp493VCyh981nUnzMamTRjvBaHZAy68d'],
           routingKeys: ['EoGusetSxDJktp493VCyh981nUnzMamTRjvBaHZAy68d'],
-          priority: 5,
+          priority: 6,
         }),
         new IndyAgentService({
           id: 'did:sov:SKJVx2kn373FNgvff1SbJo#service-2#something-extra',
@@ -159,7 +159,7 @@ describe('convertToNewDidDocument', () => {
         serviceEndpoint: 'did:sov:SKJVx2kn373FNgvff1SbJo',
         recipientKeys: ['EoGusetSxDJktp493VCyh981nUnzMamTRjvBaHZAy68d'],
         routingKeys: ['EoGusetSxDJktp493VCyh981nUnzMamTRjvBaHZAy68d'],
-        priority: 5,
+        priority: 6,
       }),
       new IndyAgentService({
         id: '#service-2#something-extra',

packages/core/src/modules/connections/models/did/DidDoc.ts

@@ -84,6 +84,6 @@ export class DidDoc {
     >
 
     // Sort services based on indicated priority
-    return services.sort((a, b) => b.priority - a.priority)
+    return services.sort((a, b) => a.priority - b.priority)
   }
 }

packages/core/src/modules/connections/models/did/__tests__/DidDoc.test.ts

@@ -192,7 +192,7 @@ describe('Did | DidDoc', () => {
     })
 
     it('returns all IndyAgentService and DidCommService instances sorted by priority', async () => {
-      expect(didDoc.didCommServices).toEqual([didDoc.service[2], didDoc.service[1]])
+      expect(didDoc.didCommServices).toEqual([didDoc.service[1], didDoc.service[2]])
     })
   })
 })

packages/core/src/modules/connections/services/helpers.ts

@@ -41,7 +41,11 @@ export function convertToNewDidDocument(didDoc: DidDoc): DidDocument {
     }
   })
 
-  didDoc.didCommServices.forEach((service) => {
+  // FIXME: we reverse the didCommServices here, as the previous implementation was wrong
+  // and we need to keep the same order to not break the did creation process.
+  // When we implement the migration to did:peer:2 and did:peer:3 according to the
+  // RFCs we can change it.
+  didDoc.didCommServices.reverse().forEach((service) => {
     const serviceId = normalizeId(service.id)
 
     // For didcommv1, we need to replace the old id with the new ones

packages/core/src/modules/dids/domain/DidDocument.ts

@@ -178,7 +178,7 @@ export class DidDocument {
     >
 
     // Sort services based on indicated priority
-    return services.sort((a, b) => b.priority - a.priority)
+    return services.sort((a, b) => a.priority - b.priority)
   }
 
   // TODO: it would probably be easier if we add a utility to each service so we don't have to handle logic for all service types here

packages/core/src/modules/dids/domain/__tests__/DidDocument.test.ts

@@ -208,7 +208,7 @@ describe('Did | DidDocument', () => {
     it('returns all IndyAgentService and DidCommService instances sorted by priority', async () => {
       const services = didDocumentInstance.service ?? []
 
-      expect(didDocumentInstance.didCommServices).toEqual([services[2], services[1]])
+      expect(didDocumentInstance.didCommServices).toEqual([services[1], services[2]])
     })
   })
 

packages/core/src/types.ts

@@ -70,6 +70,9 @@ export enum DidCommMimeType {
 }
 
 export interface InitConfig {
+  /**
+   * Agent public endpoints, sorted by priority (higher priority first)
+   */
   endpoints?: string[]
   label: string
   walletConfig?: WalletConfig