@ipld/car 4.1.6 → 5.0.0

package/esm/browser-test/test-buffer-writer.js

@@ -1,311 +0,0 @@
-import * as CarBufferWriter from '../lib/buffer-writer.js';
-import { CarReader } from '../lib/reader-browser.js';
-import { createHeader } from '../lib/encoder.js';
-import { assert } from './common.js';
-import {
-  CID,
-  varint
-} from 'multiformats';
-import * as CBOR from '@ipld/dag-cbor';
-import {
-  sha256,
-  sha512
-} from 'multiformats/hashes/sha2';
-import { identity } from 'multiformats/hashes/identity';
-import * as Raw from 'multiformats/codecs/raw';
-import * as Block from 'multiformats/block';
-describe('CarBufferWriter', () => {
-  const cid = CID.parse('bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu');
-  describe('calculateHeaderLength', async () => {
-    for (const count of [
-        0,
-        1,
-        10,
-        18,
-        24,
-        48,
-        124,
-        255,
-        258,
-        65536 - 1,
-        65536
-      ]) {
-      it(`calculateHeaderLength(new Array(${ count }).fill(36))`, () => {
-        const roots = new Array(count).fill(cid);
-        const sizes = new Array(count).fill(cid.bytes.byteLength);
-        assert.deepEqual(CarBufferWriter.calculateHeaderLength(sizes), createHeader(roots).byteLength);
-      });
-      it(`calculateHeaderLength(new Array(${ count }).fill(36))`, () => {
-        const roots = new Array(count).fill(cid);
-        const rootLengths = roots.map(c => c.bytes.byteLength);
-        assert.deepEqual(CarBufferWriter.calculateHeaderLength(rootLengths), createHeader(roots).byteLength);
-      });
-    }
-    it('estimate on large CIDs', () => {
-      const largeCID = CID.parse(`bafkqbbac${ 'a'.repeat(416) }`);
-      assert.equal(CarBufferWriter.calculateHeaderLength([
-        cid.bytes.byteLength,
-        largeCID.bytes.byteLength
-      ]), createHeader([
-        cid,
-        largeCID
-      ]).byteLength);
-    });
-    it('estimate on large CIDs 2', () => {
-      const largeCID = CID.createV1(Raw.code, identity.digest(new Uint8Array(512).fill(1)));
-      assert.equal(CarBufferWriter.calculateHeaderLength([
-        cid.bytes.byteLength,
-        largeCID.bytes.byteLength
-      ]), createHeader([
-        cid,
-        largeCID
-      ]).byteLength);
-    });
-  });
-  describe('writer', () => {
-    it('estimate header and write blocks', async () => {
-      const headerSize = CarBufferWriter.estimateHeaderLength(1);
-      const dataSize = 256;
-      const buffer = new ArrayBuffer(headerSize + dataSize);
-      const writer = CarBufferWriter.createWriter(buffer, { headerSize });
-      const b1 = await Block.encode({
-        value: { hello: 'world' },
-        codec: CBOR,
-        hasher: sha256
-      });
-      writer.write(b1);
-      const b2 = await Block.encode({
-        value: { bye: 'world' },
-        codec: CBOR,
-        hasher: sha256
-      });
-      writer.write(b2);
-      writer.addRoot(b1.cid);
-      const bytes = writer.close();
-      const reader = await CarReader.fromBytes(bytes);
-      assert.deepEqual(await reader.getRoots(), [b1.cid]);
-      assert.deepEqual(reader._blocks, [
-        {
-          cid: b1.cid,
-          bytes: b1.bytes
-        },
-        {
-          cid: b2.cid,
-          bytes: b2.bytes
-        }
-      ]);
-    });
-    it('overestimate header', async () => {
-      const headerSize = CarBufferWriter.estimateHeaderLength(2);
-      const dataSize = 256;
-      const buffer = new ArrayBuffer(headerSize + dataSize);
-      const writer = CarBufferWriter.createWriter(buffer, { headerSize });
-      const b1 = await Block.encode({
-        value: { hello: 'world' },
-        codec: CBOR,
-        hasher: sha256
-      });
-      writer.write(b1);
-      const b2 = await Block.encode({
-        value: { bye: 'world' },
-        codec: CBOR,
-        hasher: sha256
-      });
-      writer.write(b2);
-      writer.addRoot(b1.cid);
-      assert.throws(() => writer.close(), /Header size was overestimate/);
-      const bytes = writer.close({ resize: true });
-      const reader = await CarReader.fromBytes(bytes);
-      assert.deepEqual(await reader.getRoots(), [b1.cid]);
-      assert.deepEqual(reader._blocks, [
-        {
-          cid: b1.cid,
-          bytes: b1.bytes
-        },
-        {
-          cid: b2.cid,
-          bytes: b2.bytes
-        }
-      ]);
-    });
-    it('underestimate header', async () => {
-      const headerSize = CarBufferWriter.estimateHeaderLength(2);
-      const dataSize = 300;
-      const buffer = new ArrayBuffer(headerSize + dataSize);
-      const writer = CarBufferWriter.createWriter(buffer, { headerSize });
-      const b1 = await Block.encode({
-        value: { hello: 'world' },
-        codec: CBOR,
-        hasher: sha256
-      });
-      writer.write(b1);
-      writer.addRoot(b1.cid);
-      const b2 = await Block.encode({
-        value: { bye: 'world' },
-        codec: CBOR,
-        hasher: sha512
-      });
-      writer.write(b2);
-      assert.throws(() => writer.addRoot(b2.cid), /has no capacity/);
-      writer.addRoot(b2.cid, { resize: true });
-      const bytes = writer.close();
-      const reader = await CarReader.fromBytes(bytes);
-      assert.deepEqual(await reader.getRoots(), [
-        b1.cid,
-        b2.cid
-      ]);
-      assert.deepEqual(reader._blocks, [
-        {
-          cid: b1.cid,
-          bytes: b1.bytes
-        },
-        {
-          cid: b2.cid,
-          bytes: b2.bytes
-        }
-      ]);
-    });
-  });
-  it('has no space for the root', async () => {
-    const headerSize = CarBufferWriter.estimateHeaderLength(1);
-    const dataSize = 100;
-    const buffer = new ArrayBuffer(headerSize + dataSize);
-    const writer = CarBufferWriter.createWriter(buffer, { headerSize });
-    const b1 = await Block.encode({
-      value: { hello: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    writer.write(b1);
-    writer.addRoot(b1.cid);
-    const b2 = await Block.encode({
-      value: { bye: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    writer.write(b2);
-    assert.throws(() => writer.addRoot(b2.cid), /Buffer has no capacity for a new root/);
-    assert.throws(() => writer.addRoot(b2.cid, { resize: true }), /Buffer has no capacity for a new root/);
-    const bytes = writer.close();
-    const reader = await CarReader.fromBytes(bytes);
-    assert.deepEqual(await reader.getRoots(), [b1.cid]);
-    assert.deepEqual(reader._blocks, [
-      {
-        cid: b1.cid,
-        bytes: b1.bytes
-      },
-      {
-        cid: b2.cid,
-        bytes: b2.bytes
-      }
-    ]);
-  });
-  it('has no space for the block', async () => {
-    const headerSize = CarBufferWriter.estimateHeaderLength(1);
-    const dataSize = 58;
-    const buffer = new ArrayBuffer(headerSize + dataSize);
-    const writer = CarBufferWriter.createWriter(buffer, { headerSize });
-    const b1 = await Block.encode({
-      value: { hello: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    writer.write(b1);
-    writer.addRoot(b1.cid);
-    const b2 = await Block.encode({
-      value: { bye: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    assert.throws(() => writer.write(b2), /Buffer has no capacity for this block/);
-    const bytes = writer.close();
-    const reader = await CarReader.fromBytes(bytes);
-    assert.deepEqual(await reader.getRoots(), [b1.cid]);
-    assert.deepEqual(reader._blocks, [{
-        cid: b1.cid,
-        bytes: b1.bytes
-      }]);
-  });
-  it('provide roots', async () => {
-    const b1 = await Block.encode({
-      value: { hello: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    const b2 = await Block.encode({
-      value: { bye: 'world' },
-      codec: CBOR,
-      hasher: sha512
-    });
-    const buffer = new ArrayBuffer(300);
-    const writer = CarBufferWriter.createWriter(buffer, {
-      roots: [
-        b1.cid,
-        b2.cid
-      ]
-    });
-    writer.write(b1);
-    writer.write(b2);
-    const bytes = writer.close();
-    const reader = await CarReader.fromBytes(bytes);
-    assert.deepEqual(await reader.getRoots(), [
-      b1.cid,
-      b2.cid
-    ]);
-    assert.deepEqual(reader._blocks, [
-      {
-        cid: b1.cid,
-        bytes: b1.bytes
-      },
-      {
-        cid: b2.cid,
-        bytes: b2.bytes
-      }
-    ]);
-  });
-  it('provide large CID root', async () => {
-    const bytes = new Uint8Array(512).fill(1);
-    const b1 = await Block.encode({
-      value: { hello: 'world' },
-      codec: CBOR,
-      hasher: sha256
-    });
-    const b2 = {
-      cid: CID.createV1(Raw.code, identity.digest(bytes)),
-      bytes
-    };
-    const headerSize = CBOR.encode({
-      version: 1,
-      roots: [
-        b1.cid,
-        b2.cid
-      ]
-    }).byteLength;
-    const bodySize = CarBufferWriter.blockLength(b1) + CarBufferWriter.blockLength(b2);
-    const varintSize = varint.encodingLength(headerSize);
-    const writer = CarBufferWriter.createWriter(new ArrayBuffer(varintSize + headerSize + bodySize), {
-      roots: [
-        b1.cid,
-        b2.cid
-      ]
-    });
-    writer.write(b1);
-    writer.write(b2);
-    const car = writer.close();
-    const reader = await CarReader.fromBytes(car);
-    assert.deepEqual(await reader.getRoots(), [
-      b1.cid,
-      b2.cid
-    ]);
-    assert.deepEqual(reader._blocks, [
-      {
-        cid: b1.cid,
-        bytes: b1.bytes
-      },
-      {
-        cid: b2.cid,
-        bytes: b2.bytes
-      }
-    ]);
-  });
-});

package/esm/browser-test/test-errors.js

@@ -1,91 +0,0 @@
-import { bytes } from 'multiformats';
-import { encode as cbEncode } from '@ipld/dag-cbor';
-import { encode as vEncode } from 'varint';
-import { CarReader } from '../lib/reader-browser.js';
-import {
-  carBytes,
-  assert,
-  goCarV2Bytes
-} from './common.js';
-function makeHeader(block) {
-  const u = cbEncode(block);
-  const l = vEncode(u.length);
-  const u2 = new Uint8Array(u.length + l.length);
-  u2.set(l, 0);
-  u2.set(u, l.length);
-  return u2;
-}
-describe('Misc errors', () => {
-  const buf = carBytes.slice();
-  it('decode errors', async () => {
-    const buf2 = new Uint8Array(buf.length);
-    buf2.set(buf, 0);
-    buf2[101] = 0;
-    await assert.isRejected(CarReader.fromBytes(buf2), {
-      name: 'Error',
-      message: 'Unexpected CID version (0)'
-    });
-  });
-  it('bad version', async () => {
-    const buf2 = bytes.fromHex('0aa16776657273696f6e03');
-    assert.strictEqual(bytes.toHex(makeHeader({ version: 3 })), '0aa16776657273696f6e03');
-    await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 3');
-  });
-  describe('bad header', async () => {
-    it('sanity check', async () => {
-      const buf2 = makeHeader({
-        version: 1,
-        roots: []
-      });
-      await assert.isFulfilled(CarReader.fromBytes(buf2));
-    });
-    it('no \'version\' array', async () => {
-      const buf2 = makeHeader({ roots: [] });
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('bad \'version\' type', async () => {
-      const buf2 = makeHeader({
-        version: '1',
-        roots: []
-      });
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('no \'roots\' array', async () => {
-      const buf2 = makeHeader({ version: 1 });
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('bad \'roots\' type', async () => {
-      const buf2 = makeHeader({
-        version: 1,
-        roots: {}
-      });
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('extraneous properties', async () => {
-      const buf2 = makeHeader({
-        version: 1,
-        roots: [],
-        blip: true
-      });
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('not an object', async () => {
-      const buf2 = makeHeader([
-        1,
-        []
-      ]);
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('not an object', async () => {
-      const buf2 = makeHeader(null);
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR header format');
-    });
-    it('recursive v2 header', async () => {
-      const v2Header = goCarV2Bytes.slice(0, 51);
-      const buf2 = new Uint8Array(51 * 2);
-      buf2.set(v2Header, 0);
-      buf2.set(v2Header, 51);
-      await assert.isRejected(CarReader.fromBytes(buf2), Error, 'Invalid CAR version: 2 (expected 1)');
-    });
-  });
-});

package/esm/browser-test/test-indexer.js

@@ -1,85 +0,0 @@
-import { CarIndexer } from '../lib/indexer.js';
-import {
-  goCarBytes,
-  goCarIndex,
-  goCarV2Bytes,
-  goCarV2Roots,
-  goCarV2Index,
-  makeIterable,
-  assert
-} from './common.js';
-import { verifyRoots } from './verify-store-reader.js';
-describe('CarIndexer fromBytes()', () => {
-  it('complete', async () => {
-    const indexer = await CarIndexer.fromBytes(goCarBytes);
-    await verifyRoots(indexer);
-    assert.strictEqual(indexer.version, 1);
-    const indexData = [];
-    for await (const index of indexer) {
-      indexData.push(index);
-    }
-    assert.deepStrictEqual(indexData, goCarIndex);
-  });
-  it('v2 complete', async () => {
-    const indexer = await CarIndexer.fromBytes(goCarV2Bytes);
-    const roots = await indexer.getRoots();
-    assert.strictEqual(roots.length, 1);
-    assert.ok(goCarV2Roots[0].equals(roots[0]));
-    assert.strictEqual(indexer.version, 2);
-    const indexData = [];
-    for await (const index of indexer) {
-      indexData.push(index);
-    }
-    assert.deepStrictEqual(indexData, goCarV2Index);
-  });
-  it('bad argument', async () => {
-    for (const arg of [
-        true,
-        false,
-        null,
-        undefined,
-        'string',
-        100,
-        { obj: 'nope' }
-      ]) {
-      await assert.isRejected(CarIndexer.fromBytes(arg));
-    }
-  });
-});
-describe('CarIndexer fromIterable()', () => {
-  async function verifyIndexer(indexer) {
-    await verifyRoots(indexer);
-    assert.strictEqual(indexer.version, 1);
-    const indexData = [];
-    for await (const index of indexer) {
-      indexData.push(index);
-    }
-    assert.deepStrictEqual(indexData, goCarIndex);
-  }
-  it('complete (single chunk)', async () => {
-    const indexer = await CarIndexer.fromIterable(makeIterable(goCarBytes, goCarBytes.length));
-    return verifyIndexer(indexer);
-  });
-  it('complete (101-byte chunks)', async () => {
-    const indexer = await CarIndexer.fromIterable(makeIterable(goCarBytes, 101));
-    return verifyIndexer(indexer);
-  });
-  it('complete (32-byte chunks)', async () => {
-    const indexer = await CarIndexer.fromIterable(makeIterable(goCarBytes, 32));
-    return verifyIndexer(indexer);
-  });
-  it('bad argument', async () => {
-    for (const arg of [
-        new Uint8Array(0),
-        true,
-        false,
-        null,
-        undefined,
-        'string',
-        100,
-        { obj: 'nope' }
-      ]) {
-      await assert.isRejected(CarIndexer.fromIterable(arg));
-    }
-  });
-});

package/esm/browser-test/test-interface.js

@@ -1,24 +0,0 @@
-import * as car from '../car-browser.js';
-import {
-  CarReader,
-  __browser
-} from '../lib/reader-browser.js';
-import { CarIndexer } from '../lib/indexer.js';
-import {
-  CarBlockIterator,
-  CarCIDIterator
-} from '../lib/iterator.js';
-import { CarWriter } from '../lib/writer-browser.js';
-import { assert } from './common.js';
-describe('Interface', () => {
-  it('exports match', () => {
-    assert.strictEqual(car.CarReader, CarReader);
-    assert.strictEqual(car.CarIndexer, CarIndexer);
-    assert.strictEqual(car.CarBlockIterator, CarBlockIterator);
-    assert.strictEqual(car.CarCIDIterator, CarCIDIterator);
-    assert.strictEqual(car.CarWriter, CarWriter);
-  });
-  it('browser exports', () => {
-    assert.strictEqual(__browser, globalThis.process === undefined);
-  });
-});

package/esm/browser-test/test-iterator.js

@@ -1,91 +0,0 @@
-import {
-  CarBlockIterator,
-  CarCIDIterator
-} from '../lib/iterator.js';
-import {
-  carBytes,
-  makeIterable,
-  assert
-} from './common.js';
-import {
-  verifyRoots,
-  verifyBlocks,
-  verifyCids
-} from './verify-store-reader.js';
-async function verifyBlockIterator(iter) {
-  await verifyRoots(iter);
-  await verifyBlocks(iter);
-  assert.strictEqual(iter.version, 1);
-  return iter;
-}
-async function verifyCIDIterator(iter) {
-  await verifyRoots(iter);
-  await verifyCids(iter);
-  assert.strictEqual(iter.version, 1);
-  return iter;
-}
-for (const type of [
-    'Block',
-    'CID'
-  ]) {
-  describe(`Car${ type }Iterator`, () => {
-    it('fromBytes()', async () => {
-      if (type === 'Block') {
-        await verifyBlockIterator(await CarBlockIterator.fromBytes(carBytes));
-      } else {
-        await verifyCIDIterator(await CarCIDIterator.fromBytes(carBytes));
-      }
-    });
-    it('fromBytes() bad double read', async () => {
-      if (type === 'Block') {
-        const iter = await verifyBlockIterator(await CarBlockIterator.fromBytes(carBytes));
-        await assert.isRejected(verifyBlocks(iter), /more than once/i);
-      } else {
-        const iter = await verifyCIDIterator(await CarCIDIterator.fromBytes(carBytes));
-        await assert.isRejected(verifyCids(iter), /more than once/i);
-      }
-    });
-    it('fromBytes() bad argument', async () => {
-      for (const arg of [
-          true,
-          false,
-          null,
-          undefined,
-          'string',
-          100,
-          { obj: 'nope' }
-        ]) {
-        await assert.isRejected((type === 'Block' ? CarBlockIterator : CarCIDIterator).fromBytes(arg));
-      }
-    });
-    it('fromIterable() bad argument', async () => {
-      for (const arg of [
-          new Uint8Array(0),
-          true,
-          false,
-          null,
-          undefined,
-          'string',
-          100,
-          { obj: 'nope' }
-        ]) {
-        await assert.isRejected((type === 'Block' ? CarBlockIterator : CarCIDIterator).fromIterable(arg));
-      }
-    });
-    for (const chunkSize of [
-        carBytes.length,
-        100,
-        64,
-        32
-      ]) {
-      const chunkDesc = chunkSize === carBytes.length ? 'single chunk' : `${ chunkSize }  bytes`;
-      it(`fromIterable() blocks (${ chunkDesc })`, async () => {
-        if (type === 'Block') {
-          await verifyBlockIterator(await CarBlockIterator.fromIterable(makeIterable(carBytes, chunkSize)));
-        } else {
-          await verifyCIDIterator(await CarCIDIterator.fromIterable(makeIterable(carBytes, chunkSize)));
-        }
-      });
-    }
-  });
-}