fix: identity supports async get and getAll (#365)

Mark get and getAll as async to allow delegating to async children.

Author: tabcat

packages/blockstore-core/src/identity.ts

@@ -1,7 +1,7 @@
 import { NotFoundError } from 'interface-store'
 import { BaseBlockstore } from './base.js'
 import type { Blockstore, Pair } from 'interface-blockstore'
-import type { AbortOptions, Await, AwaitGenerator, AwaitIterable } from 'interface-store'
+import type { AbortOptions, Await, AwaitIterable } from 'interface-store'
 import type { CID } from 'multiformats/cid'
 
 // https://github.com/multiformats/multicodec/blob/d06fc6194710e8909bac64273c43f16b56ca4c34/table.csv#L2
@@ -45,7 +45,7 @@ export class IdentityBlockstore extends BaseBlockstore {
     return this.child.put(key, block, options)
   }
 
-  * get (key: CID, options?: AbortOptions): AwaitGenerator<Uint8Array> {
+  async * get (key: CID, options?: AbortOptions): AsyncGenerator<Uint8Array> {
     if (key.multihash.code === IDENTITY_CODEC) {
       if (this.maxDigestLength != null && key.multihash.digest.byteLength > this.maxDigestLength) {
         throw new IdentityHashDigestTooLongError(`Identity digest too long - ${key.multihash.digest.byteLength} > this.maxDigestLength`)
@@ -97,7 +97,7 @@ export class IdentityBlockstore extends BaseBlockstore {
     }
   }
 
-  * getAll (options?: AbortOptions): AwaitGenerator<Pair> {
+  async * getAll (options?: AbortOptions): AsyncGenerator<Pair> {
     if (this.child != null) {
       yield * this.child.getAll(options)
     }

packages/blockstore-core/test/identity.spec.ts

@@ -11,6 +11,7 @@ import { sha256 } from 'multiformats/hashes/sha2'
 import { IdentityBlockstore } from '../src/identity.js'
 import { MemoryBlockstore } from '../src/memory.js'
 import type { Blockstore } from 'interface-blockstore'
+import type { AbortOptions } from 'interface-store'
 
 describe('identity', () => {
   let blockstore: Blockstore
@@ -86,6 +87,20 @@ describe('identity', () => {
     expect(toBuffer(await all(blockstore.get(cid)))).to.equalBytes(block)
   })
 
+  it('gets CIDs from child (async)', async () => {
+    const block = Uint8Array.from([0, 1, 2, 3, 4])
+    const multihash = await sha256.digest(block)
+    const cid = CID.createV1(raw.code, multihash)
+
+    await child.put(cid, block)
+
+    const { get } = child
+    child.get = async function * (key: CID, options: AbortOptions) { yield * get.bind(child)(key, options) }
+    blockstore = new IdentityBlockstore(child)
+    expect(blockstore.has(cid)).to.be.true()
+    expect(toBuffer(await all(blockstore.get(cid)))).to.equalBytes(block)
+  })
+
   it('has CIDs from child', async () => {
     const block = Uint8Array.from([0, 1, 2, 3, 4])
     const multihash = await sha256.digest(block)
@@ -128,6 +143,24 @@ describe('identity', () => {
     expect(result[0].cid.toString()).to.equal(cid.toString())
   })
 
+  it('gets all pairs from child (async)', async () => {
+    const block = Uint8Array.from([0, 1, 2, 3, 4])
+    const multihash = await sha256.digest(block)
+    const cid = CID.createV1(raw.code, multihash)
+
+    await child.put(cid, block)
+
+    const { getAll } = child
+    child.getAll = async function * (options?: AbortOptions) { yield * getAll.bind(child)(options) }
+    blockstore = new IdentityBlockstore(child)
+    expect(blockstore.has(cid)).to.be.true()
+
+    const result = await all(blockstore.getAll())
+
+    expect(result).to.have.lengthOf(1)
+    expect(result[0].cid.toString()).to.equal(cid.toString())
+  })
+
   it('should enforce a maximum digest size', async () => {
     blockstore = new IdentityBlockstore(child, {
       maxDigestLength: 5
@@ -141,7 +174,7 @@ describe('identity', () => {
     expect(blockstore.put(CID.createV1(raw.code, identity.digest(ok)), buf)).to.be.ok()
     expect(blockstore.has(CID.createV1(raw.code, identity.digest(ok)))).to.be.ok()
 
-    expect(() => all(blockstore.get(CID.createV1(raw.code, identity.digest(tooLong))))).to.throw()
+    await expect(all(blockstore.get(CID.createV1(raw.code, identity.digest(tooLong))))).to.eventually.be.rejected()
       .with.property('name', 'IdentityHashDigestTooLongError')
 
     expect(() => blockstore.put(CID.createV1(raw.code, identity.digest(tooLong)), buf)).to.throw()