feat(did-manager): matching DIDs by alias should not depend on the pr…

…ovider fixes #1215 BREAKING CHANGE: The behavior of `DIDManager` has changed when working with `alias`. It is mostly ignoring `provider` unless it is used to create new identifiers. `AbstractDIDStore` APIs have been adapted and implementations have changed.
decentralized-identity · Aug 4, 2023 · 7851375 · 7851375
1 parent ecdb2a2
commit 7851375
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 31 deletions.
diff --git a/__tests__/shared/didManager.ts b/__tests__/shared/didManager.ts
@@ -167,7 +167,7 @@ export default (testContext: {
           provider: 'did:web',
           alias: 'example.com',
         }),
-      ).rejects.toThrow('Identifier with alias: example.com, provider: did:web already exists')
+      ).rejects.toThrow(/Identifier with alias: example.com already exists/)
     })
 
     it('should get identifier', async () => {
@@ -199,13 +199,12 @@ export default (testContext: {
       expect(identifier3).toEqual(identifier4)
 
       const identifierKey1 = await agent.didManagerGetOrCreate({
-        alias: 'carol',
+        alias: 'caroline',
         provider: 'did:key',
       })
 
       const identifierKey2 = await agent.didManagerGetOrCreate({
-        alias: 'carol',
-        provider: 'did:key',
+        alias: 'caroline',
       })
 
       expect(identifierKey1).toEqual(identifierKey2)
@@ -215,7 +214,7 @@ export default (testContext: {
         provider: 'did:ethr',
       })
 
-      expect(identifier5).not.toEqual(identifier4)
+      expect(identifier5).toEqual(identifier4)
 
       const identifier6 = await agent.didManagerGetByAlias({
         alias: 'alice',
@@ -232,7 +231,7 @@ export default (testContext: {
       const aliceIdentifiers = await agent.didManagerFind({
         alias: 'alice',
       })
-      expect(aliceIdentifiers.length).toEqual(2)
+      expect(aliceIdentifiers.length).toEqual(1)
 
       const goerliIdentifiers = await agent.didManagerFind({
         provider: 'did:ethr:goerli',

diff --git a/__tests__/shared/webDidFlow.ts b/__tests__/shared/webDidFlow.ts
@@ -66,21 +66,17 @@ export default (testContext: {
     it('should create identifier with alias: alice', async () => {
       alice = await agent.didManagerGetOrCreate({
         alias: 'alice',
-        provider: 'did:ethr:goerli',
       })
 
-      expect(alice.provider).toEqual('did:ethr:goerli')
       expect(alice.alias).toEqual('alice')
       expect(alice.did).toBeDefined()
     })
 
     it('should create identifier with alias: bob', async () => {
       bob = await agent.didManagerGetOrCreate({
         alias: 'bob',
-        provider: 'did:ethr:goerli',
       })
 
-      expect(bob.provider).toEqual('did:ethr:goerli')
       expect(bob.alias).toEqual('bob')
       expect(bob.did).toBeDefined()
     })
@@ -115,12 +111,10 @@ export default (testContext: {
       it('issuer - Alice, subject - Bob', async () => {
         const a = await agent.didManagerGetOrCreate({
           alias: 'alice',
-          provider: 'did:ethr:goerli',
         })
 
         const b = await agent.didManagerGetOrCreate({
           alias: 'bob',
-          provider: 'did:ethr:goerli',
         })
 
         const verifiableCredential = await agent.createVerifiableCredential({

diff --git a/packages/data-store-json/src/identifier/did-store.ts b/packages/data-store-json/src/identifier/did-store.ts
@@ -50,8 +50,8 @@ export class DIDStoreJson extends AbstractDIDStore {
 
     if (did !== undefined && alias === undefined) {
       where = { did }
-    } else if (did === undefined && alias !== undefined && provider !== undefined) {
-      where = { alias, provider }
+    } else if (did === undefined && alias !== undefined) {
+      where = { alias }
     } else {
       throw Error('invalid_arguments: DidStoreJson.get requires did or (alias and provider)')
     }
@@ -61,7 +61,7 @@ export class DIDStoreJson extends AbstractDIDStore {
       identifier = this.cacheTree.dids[where.did]
     } else {
       identifier = Object.values(this.cacheTree.dids).find(
-        (iid: IIdentifier) => iid.provider === where.provider && iid.alias === where.alias,
+        (iid: IIdentifier) => iid.alias === where.alias,
       )
     }
 

diff --git a/packages/data-store/src/identifier/did-store.ts b/packages/data-store/src/identifier/did-store.ts
@@ -39,11 +39,11 @@ export class DIDStore extends AbstractDIDStore {
     alias: string
     provider: string
   }): Promise<IIdentifier> {
-    let where = {}
+    let where: { did?: string; alias?: string; provider?: string } = {}
     if (did !== undefined && alias === undefined) {
       where = { did }
-    } else if (did === undefined && alias !== undefined && provider !== undefined) {
-      where = { alias, provider }
+    } else if (did === undefined && alias !== undefined) {
+      where = { alias }
     } else {
       throw Error('[veramo:data-store:identifier-store] Get requires did or (alias and provider)')
     }

diff --git a/packages/did-manager/src/abstract-identifier-store.ts b/packages/did-manager/src/abstract-identifier-store.ts
@@ -7,7 +7,7 @@ import { IIdentifier } from '@veramo/core-types'
 export abstract class AbstractDIDStore {
   abstract importDID(args: IIdentifier): Promise<boolean>
   abstract getDID(args: { did: string }): Promise<IIdentifier>
-  abstract getDID(args: { alias: string; provider: string }): Promise<IIdentifier>
+  abstract getDID(args: { alias: string }): Promise<IIdentifier>
   abstract deleteDID(args: { did: string }): Promise<boolean>
   abstract listDIDs(args: { alias?: string; provider?: string }): Promise<IIdentifier[]>
 }
diff --git a/packages/did-manager/src/id-manager.ts b/packages/did-manager/src/id-manager.ts
@@ -93,9 +93,8 @@ export class DIDManager implements IAgentPlugin {
   }
 
   /** {@inheritDoc @veramo/core-types#IDIDManager.didManagerGetByAlias} */
-  async didManagerGetByAlias({ alias, provider }: IDIDManagerGetByAliasArgs): Promise<IIdentifier> {
-    const providerName = provider || this.defaultProvider
-    return this.store.getDID({ alias, provider: providerName })
+  async didManagerGetByAlias({ alias }: IDIDManagerGetByAliasArgs): Promise<IIdentifier> {
+    return this.store.getDID({ alias })
   }
 
   /** {@inheritDoc @veramo/core-types#IDIDManager.didManagerCreate} */
@@ -107,11 +106,11 @@ export class DIDManager implements IAgentPlugin {
     if (args?.alias !== undefined) {
       let existingIdentifier
       try {
-        existingIdentifier = await this.store.getDID({ alias: args.alias, provider: providerName })
+        existingIdentifier = await this.store.getDID({ alias: args.alias })
       } catch (e) {}
       if (existingIdentifier) {
         throw Error(
-          `illegal_argument: Identifier with alias: ${args.alias}, provider: ${providerName} already exists: ${existingIdentifier.did}`,
+          `illegal_argument: Identifier with alias: ${args.alias} already exists: ${existingIdentifier.did}`,
         )
       }
     }
@@ -133,14 +132,21 @@ export class DIDManager implements IAgentPlugin {
     { provider, alias, kms, options }: IDIDManagerGetOrCreateArgs,
     context: IAgentContext<IKeyManager>,
   ): Promise<IIdentifier> {
+    let identifier: IIdentifier | undefined
     try {
-      const providerName = provider || this.defaultProvider
-      // @ts-ignore
-      const identifier = await this.store.getDID({ alias, provider: providerName })
-      return identifier
+      identifier = await this.store.getDID({ alias })
     } catch {
-      return this.didManagerCreate({ provider, alias, kms, options }, context)
+      const providerName = provider || this.defaultProvider
+      return this.didManagerCreate({ provider: providerName, alias, kms, options }, context)
     }
+    if (identifier && provider && identifier.provider !== provider) {
+      if (this.getProvider(identifier.provider) !== this.getProvider(provider)) {
+        throw Error(
+          `illegal_argument: Identifier with alias: ${alias}, already exists ${identifier.did}, but was created with a different provider: ${identifier.provider}!==${provider}`,
+        )
+      }
+    }
+    return identifier
   }
 
   /** {@inheritDoc @veramo/core-types#IDIDManager.didManagerUpdate} */

diff --git a/packages/did-manager/src/memory-did-store.ts b/packages/did-manager/src/memory-did-store.ts
@@ -21,9 +21,9 @@ export class MemoryDIDStore extends AbstractDIDStore {
     if (did && !alias) {
       if (!this.identifiers[did]) throw Error(`not_found: IIdentifier not found with did=${did}`)
       return this.identifiers[did]
-    } else if (!did && alias && provider) {
+    } else if (!did && alias) {
       for (const key of Object.keys(this.identifiers)) {
-        if (this.identifiers[key].alias === alias && this.identifiers[key].provider === provider) {
+        if (this.identifiers[key].alias === alias) {
           return this.identifiers[key]
         }
       }