@atproto/common 0.2.0 → 0.3.0

package/tests/ipld-vectors.ts

@@ -0,0 +1,279 @@
+import { CID } from 'multiformats/cid'
+
+export const vectors = [
+  {
+    name: 'basic',
+    json: {
+      string: 'abc',
+      unicode: 'a~öñ©⽘☎𓋓😀👨‍👩‍👧‍👧',
+      integer: 123,
+      bool: true,
+      null: null,
+      array: ['abc', 'def', 'ghi'],
+      object: {
+        string: 'abc',
+        number: 123,
+        bool: true,
+        arr: ['abc', 'def', 'ghi'],
+      },
+    },
+    ipld: {
+      string: 'abc',
+      unicode: 'a~öñ©⽘☎𓋓😀👨‍👩‍👧‍👧',
+      integer: 123,
+      bool: true,
+      null: null,
+      array: ['abc', 'def', 'ghi'],
+      object: {
+        string: 'abc',
+        number: 123,
+        bool: true,
+        arr: ['abc', 'def', 'ghi'],
+      },
+    },
+    cbor: new Uint8Array([
+      167, 100, 98, 111, 111, 108, 245, 100, 110, 117, 108, 108, 246, 101, 97,
+      114, 114, 97, 121, 131, 99, 97, 98, 99, 99, 100, 101, 102, 99, 103, 104,
+      105, 102, 111, 98, 106, 101, 99, 116, 164, 99, 97, 114, 114, 131, 99, 97,
+      98, 99, 99, 100, 101, 102, 99, 103, 104, 105, 100, 98, 111, 111, 108, 245,
+      102, 110, 117, 109, 98, 101, 114, 24, 123, 102, 115, 116, 114, 105, 110,
+      103, 99, 97, 98, 99, 102, 115, 116, 114, 105, 110, 103, 99, 97, 98, 99,
+      103, 105, 110, 116, 101, 103, 101, 114, 24, 123, 103, 117, 110, 105, 99,
+      111, 100, 101, 120, 47, 97, 126, 195, 182, 195, 177, 194, 169, 226, 189,
+      152, 226, 152, 142, 240, 147, 139, 147, 240, 159, 152, 128, 240, 159, 145,
+      168, 226, 128, 141, 240, 159, 145, 169, 226, 128, 141, 240, 159, 145, 167,
+      226, 128, 141, 240, 159, 145, 167,
+    ]),
+    cid: 'bafyreiclp443lavogvhj3d2ob2cxbfuscni2k5jk7bebjzg7khl3esabwq',
+  },
+  {
+    name: 'ipld',
+    json: {
+      a: {
+        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      },
+      b: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      },
+      c: {
+        $type: 'blob',
+        ref: {
+          $link: 'bafkreiccldh766hwcnuxnf2wh6jgzepf2nlu2lvcllt63eww5p6chi4ity',
+        },
+        mimeType: 'image/jpeg',
+        size: 10000,
+      },
+    },
+    ipld: {
+      a: CID.parse(
+        'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      ),
+      b: new Uint8Array([
+        156, 81, 17, 142, 242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253,
+        65, 60, 242, 11, 98, 238, 213, 118, 248, 157, 238, 190, 176, 26, 194,
+        204, 141,
+      ]),
+      c: {
+        $type: 'blob',
+        ref: CID.parse(
+          'bafkreiccldh766hwcnuxnf2wh6jgzepf2nlu2lvcllt63eww5p6chi4ity',
+        ),
+        mimeType: 'image/jpeg',
+        size: 10000,
+      },
+    },
+    cbor: new Uint8Array([
+      163, 97, 97, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0,
+      252, 22, 215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72,
+      147, 54, 137, 29, 9, 23, 65, 162, 57, 208, 97, 98, 88, 32, 156, 81, 17,
+      142, 242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253, 65, 60, 242, 11,
+      98, 238, 213, 118, 248, 157, 238, 190, 176, 26, 194, 204, 141, 97, 99,
+      164, 99, 114, 101, 102, 216, 42, 88, 37, 0, 1, 85, 18, 32, 66, 88, 207,
+      255, 120, 246, 19, 105, 118, 151, 86, 63, 146, 108, 145, 229, 211, 87, 77,
+      46, 162, 90, 231, 237, 146, 214, 235, 252, 35, 163, 136, 158, 100, 115,
+      105, 122, 101, 25, 39, 16, 101, 36, 116, 121, 112, 101, 100, 98, 108, 111,
+      98, 104, 109, 105, 109, 101, 84, 121, 112, 101, 106, 105, 109, 97, 103,
+      101, 47, 106, 112, 101, 103,
+    ]),
+    cid: 'bafyreihldkhcwijkde7gx4rpkkuw7pl6lbyu5gieunyc7ihactn5bkd2nm',
+  },
+  {
+    name: 'ipldArray',
+    json: [
+      {
+        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      },
+      {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      {
+        $link: 'bafyreiaizynclnqiolq7byfpjjtgqzn4sfrsgn7z2hhf6bo4utdwkin7ke',
+      },
+      {
+        $link: 'bafyreifd4w4tcr5tluxz7osjtnofffvtsmgdqcfrfi6evjde4pl27lrjpy',
+      },
+    ],
+    ipld: [
+      CID.parse('bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a'),
+      CID.parse('bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q'),
+      CID.parse('bafyreiaizynclnqiolq7byfpjjtgqzn4sfrsgn7z2hhf6bo4utdwkin7ke'),
+      CID.parse('bafyreifd4w4tcr5tluxz7osjtnofffvtsmgdqcfrfi6evjde4pl27lrjpy'),
+    ],
+    cbor: new Uint8Array([
+      132, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22,
+      215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72, 147, 54,
+      137, 29, 9, 23, 65, 162, 57, 208, 216, 42, 88, 37, 0, 1, 113, 18, 32, 206,
+      188, 253, 200, 24, 248, 158, 85, 31, 33, 95, 133, 103, 145, 125, 120, 196,
+      209, 14, 220, 33, 139, 148, 27, 165, 214, 150, 172, 255, 213, 142, 244,
+      216, 42, 88, 37, 0, 1, 113, 18, 32, 8, 206, 26, 37, 182, 8, 114, 225, 240,
+      224, 175, 74, 102, 104, 101, 188, 145, 99, 35, 55, 249, 209, 206, 95, 5,
+      220, 164, 199, 101, 33, 191, 81, 216, 42, 88, 37, 0, 1, 113, 18, 32, 163,
+      229, 185, 49, 71, 179, 93, 47, 159, 186, 73, 155, 92, 82, 150, 179, 147,
+      12, 56, 8, 177, 42, 60, 74, 164, 100, 227, 215, 175, 174, 41, 126,
+    ]),
+    cid: 'bafyreiaj3udmqlqrcbjxjayzuxwp64gt64olcbjfrkldzoqponpru6gq4m',
+  },
+  {
+    name: 'ipldNested',
+    json: {
+      a: {
+        b: [
+          {
+            d: [
+              {
+                $link:
+                  'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              },
+              {
+                $link:
+                  'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              },
+            ],
+            e: [
+              {
+                $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+              },
+              {
+                $bytes: 'iE+sPoHobU9tSIqGI+309LLCcWQIRmEXwxcoDt19tas',
+              },
+            ],
+          },
+        ],
+      },
+    },
+    ipld: {
+      a: {
+        b: [
+          {
+            d: [
+              CID.parse(
+                'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              ),
+              CID.parse(
+                'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+              ),
+            ],
+            e: [
+              new Uint8Array([
+                156, 81, 17, 142, 242, 203, 139, 15, 106, 155, 142, 73, 174,
+                161, 253, 65, 60, 242, 11, 98, 238, 213, 118, 248, 157, 238,
+                190, 176, 26, 194, 204, 141,
+              ]),
+              new Uint8Array([
+                136, 79, 172, 62, 129, 232, 109, 79, 109, 72, 138, 134, 35, 237,
+                244, 244, 178, 194, 113, 100, 8, 70, 97, 23, 195, 23, 40, 14,
+                221, 125, 181, 171,
+              ]),
+            ],
+          },
+        ],
+      },
+    },
+    cbor: new Uint8Array([
+      161, 97, 97, 161, 97, 98, 129, 162, 97, 100, 130, 216, 42, 88, 37, 0, 1,
+      113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22, 215, 60, 105, 68, 35, 124,
+      203, 193, 91, 28, 74, 114, 52, 72, 147, 54, 137, 29, 9, 23, 65, 162, 57,
+      208, 216, 42, 88, 37, 0, 1, 113, 18, 32, 101, 6, 42, 90, 90, 0, 252, 22,
+      215, 60, 105, 68, 35, 124, 203, 193, 91, 28, 74, 114, 52, 72, 147, 54,
+      137, 29, 9, 23, 65, 162, 57, 208, 97, 101, 130, 88, 32, 156, 81, 17, 142,
+      242, 203, 139, 15, 106, 155, 142, 73, 174, 161, 253, 65, 60, 242, 11, 98,
+      238, 213, 118, 248, 157, 238, 190, 176, 26, 194, 204, 141, 88, 32, 136,
+      79, 172, 62, 129, 232, 109, 79, 109, 72, 138, 134, 35, 237, 244, 244, 178,
+      194, 113, 100, 8, 70, 97, 23, 195, 23, 40, 14, 221, 125, 181, 171,
+    ]),
+    cid: 'bafyreid3imdulnhgeytpf6uk7zahjvrsqlofkmm5b5ub2maw4kqus6jp4i',
+  },
+  {
+    name: 'poorlyFormatted',
+    json: {
+      a: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      b: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      c: {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+        another: 'bad value',
+      },
+      d: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        another: 'bad value',
+      },
+      e: {
+        '/': 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      f: {
+        '/': {
+          bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        },
+      },
+    },
+    ipld: {
+      a: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
+      b: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+      c: {
+        $link: 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+        another: 'bad value',
+      },
+      d: {
+        $bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        another: 'bad value',
+      },
+      e: {
+        '/': 'bafyreigoxt64qghytzkr6ik7qvtzc7lyytiq5xbbrokbxjows2wp7vmo6q',
+      },
+      f: {
+        '/': {
+          bytes: 'nFERjvLLiw9qm45JrqH9QTzyC2Lu1Xb4ne6+sBrCzI0',
+        },
+      },
+    },
+    cbor: new Uint8Array([
+      166, 97, 97, 120, 59, 98, 97, 102, 121, 114, 101, 105, 100, 102, 97, 121,
+      118, 102, 117, 119, 113, 97, 55, 113, 108, 110, 111, 112, 100, 106, 105,
+      113, 114, 120, 122, 115, 54, 98, 108, 109, 111, 101, 117, 52, 114, 117,
+      106, 99, 106, 116, 110, 99, 105, 53, 98, 101, 108, 117, 100, 105, 114,
+      122, 50, 97, 97, 98, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119,
+      57, 113, 109, 52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76,
+      117, 49, 88, 98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48, 97,
+      99, 162, 101, 36, 108, 105, 110, 107, 120, 59, 98, 97, 102, 121, 114, 101,
+      105, 103, 111, 120, 116, 54, 52, 113, 103, 104, 121, 116, 122, 107, 114,
+      54, 105, 107, 55, 113, 118, 116, 122, 99, 55, 108, 121, 121, 116, 105,
+      113, 53, 120, 98, 98, 114, 111, 107, 98, 120, 106, 111, 119, 115, 50, 119,
+      112, 55, 118, 109, 111, 54, 113, 103, 97, 110, 111, 116, 104, 101, 114,
+      105, 98, 97, 100, 32, 118, 97, 108, 117, 101, 97, 100, 162, 102, 36, 98,
+      121, 116, 101, 115, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119,
+      57, 113, 109, 52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76,
+      117, 49, 88, 98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48, 103,
+      97, 110, 111, 116, 104, 101, 114, 105, 98, 97, 100, 32, 118, 97, 108, 117,
+      101, 97, 101, 161, 97, 47, 120, 59, 98, 97, 102, 121, 114, 101, 105, 103,
+      111, 120, 116, 54, 52, 113, 103, 104, 121, 116, 122, 107, 114, 54, 105,
+      107, 55, 113, 118, 116, 122, 99, 55, 108, 121, 121, 116, 105, 113, 53,
+      120, 98, 98, 114, 111, 107, 98, 120, 106, 111, 119, 115, 50, 119, 112, 55,
+      118, 109, 111, 54, 113, 97, 102, 161, 97, 47, 161, 101, 98, 121, 116, 101,
+      115, 120, 43, 110, 70, 69, 82, 106, 118, 76, 76, 105, 119, 57, 113, 109,
+      52, 53, 74, 114, 113, 72, 57, 81, 84, 122, 121, 67, 50, 76, 117, 49, 88,
+      98, 52, 110, 101, 54, 43, 115, 66, 114, 67, 122, 73, 48,
+    ]),
+    cid: 'bafyreico7wgbbfe6dpfsuednrtrlh6t2yjl6xq5rf32gl3pgwhwxk77cn4',
+  },
+]
+
+export default vectors

package/tests/ipld.test.ts

@@ -1,89 +1,29 @@
-import { CID } from 'multiformats/cid'
 import * as ui8 from 'uint8arrays'
-import { ipldToJson, jsonToIpld } from '../src'
+import vectors from './ipld-vectors'
+import {
+  cborDecode,
+  cborEncode,
+  cidForCbor,
+  ipldEquals,
+  ipldToJson,
+  jsonToIpld,
+} from '../src'
 
 describe('ipld', () => {
-  it('converts ipld to json', () => {
-    const ipld = {
-      one: 1,
-      two: CID.parse(
-        'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      ),
-      three: new Uint8Array([0, 1, 2, 3]),
-    }
-    const json = ipldToJson(ipld)
-    expect(json).toEqual({
-      one: 1,
-      two: {
-        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      },
-      three: {
-        $bytes: 'AAECAw',
-      },
+  for (const vector of vectors) {
+    it(`passes test vector: ${vector.name}`, async () => {
+      const ipld = jsonToIpld(vector.json)
+      const json = ipldToJson(ipld)
+      const cbor = cborEncode(ipld)
+      const ipldAgain = cborDecode(cbor)
+      const jsonAgain = ipldToJson(ipldAgain)
+      const cid = await cidForCbor(ipld)
+      expect(json).toEqual(vector.json)
+      expect(jsonAgain).toEqual(vector.json)
+      expect(ipldEquals(ipld, vector.ipld)).toBeTruthy()
+      expect(ipldEquals(ipldAgain, vector.ipld)).toBeTruthy()
+      expect(ui8.equals(cbor, vector.cbor)).toBeTruthy()
+      expect(cid.toString()).toEqual(vector.cid)
     })
-  })
-
-  it('converts json to ipld', () => {
-    const json = {
-      one: 1,
-      two: {
-        $link: 'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-      },
-      three: {
-        $bytes: 'AAECAw',
-      },
-    }
-    const expectedCid = CID.parse(
-      'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-    )
-
-    const ipld = jsonToIpld(json)
-    if (!ipld) {
-      throw new Error()
-    }
-    expect(ipld['one']).toBe(1)
-    expect(expectedCid.equals(ipld['two'])).toBeTruthy()
-    expect(ui8.equals(ipld['three'], new Uint8Array([0, 1, 2, 3]))).toBeTruthy()
-  })
-
-  it('converts nested ipld to json', () => {
-    const ipld = {
-      a: {
-        b: [
-          CID.parse(
-            'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          ),
-        ],
-      },
-    }
-    const json = ipldToJson(ipld)
-    expect(json).toEqual({
-      a: {
-        b: [
-          {
-            $link:
-              'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          },
-        ],
-      },
-    })
-  })
-
-  it('converts nested json to ipld', () => {
-    const json = {
-      a: {
-        b: [
-          {
-            $link:
-              'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-          },
-        ],
-      },
-    }
-    const ipld = jsonToIpld(json)
-    const expectedCid = CID.parse(
-      'bafyreidfayvfuwqa7qlnopdjiqrxzs6blmoeu4rujcjtnci5beludirz2a',
-    )
-    expect(ipld && expectedCid.equals(ipld['a']['b']))
-  })
+  }
 })

package/tests/streams.test.ts

@@ -0,0 +1,136 @@
+import * as streams from '../src/streams'
+import { PassThrough, Readable, pipeline } from 'node:stream'
+
+describe('streams', () => {
+  describe('forwardStreamErrors', () => {
+    it('forwards errors through a set of streams', () => {
+      const streamA = new PassThrough()
+      const streamB = new PassThrough()
+      let streamBError: Error | null = null
+      const err = new Error('foo')
+
+      streamB.on('error', (err) => {
+        streamBError = err
+      })
+
+      streams.forwardStreamErrors(streamA, streamB)
+
+      streamA.emit('error', err)
+
+      expect(streamBError).toBe(err)
+    })
+  })
+
+  describe('cloneStream', () => {
+    it('should clone stream', () => {
+      const stream = new PassThrough()
+      let clonedError: Error | undefined
+      let clonedData: string | undefined
+
+      const cloned = streams.cloneStream(stream)
+
+      cloned.on('data', (data) => {
+        clonedData = String(data)
+      })
+      cloned.on('error', (err) => {
+        clonedError = err
+      })
+
+      stream.emit('data', 'foo')
+      stream.emit('error', new Error('foo error'))
+
+      expect(clonedData).toEqual('foo')
+      expect(clonedError?.message).toEqual('foo error')
+    })
+  })
+
+  describe('streamSize', () => {
+    it('reads entire stream and computes size', async () => {
+      const stream = Readable.from(['f', 'o', 'o'])
+
+      const size = await streams.streamSize(stream)
+
+      expect(size).toBe(3)
+    })
+
+    it('returns 0 for empty streams', async () => {
+      const stream = Readable.from([])
+      const size = await streams.streamSize(stream)
+
+      expect(size).toBe(0)
+    })
+  })
+
+  describe('streamToBytes', () => {
+    it('converts stream to byte array', async () => {
+      const stream = Readable.from(Buffer.from('foo'))
+      const bytes = await streams.streamToBytes(stream)
+
+      expect(bytes[0]).toBe('f'.charCodeAt(0))
+      expect(bytes[1]).toBe('o'.charCodeAt(0))
+      expect(bytes[2]).toBe('o'.charCodeAt(0))
+    })
+  })
+
+  describe('byteIterableToStream', () => {
+    it('converts byte iterable to stream', async () => {
+      const iterable: AsyncIterable<Uint8Array> = {
+        async *[Symbol.asyncIterator]() {
+          yield new Uint8Array([0xa, 0xb])
+        },
+      }
+
+      const stream = streams.byteIterableToStream(iterable)
+
+      for await (const chunk of stream) {
+        expect(chunk[0]).toBe(0xa)
+        expect(chunk[1]).toBe(0xb)
+      }
+    })
+  })
+
+  describe('bytesToStream', () => {
+    it('converts byte array to readable stream', async () => {
+      const bytes = new Uint8Array([0xa, 0xb])
+      const stream = streams.bytesToStream(bytes)
+
+      for await (const chunk of stream) {
+        expect(chunk[0]).toBe(0xa)
+        expect(chunk[1]).toBe(0xb)
+      }
+    })
+  })
+
+  describe('MaxSizeChecker', () => {
+    it('destroys once max size is met', async () => {
+      const stream = new Readable()
+      const err = new Error('foo')
+      const checker = new streams.MaxSizeChecker(1, () => err)
+      let lastError: Error | undefined
+
+      const outStream = stream.pipe(checker)
+
+      outStream.on('error', (err) => {
+        lastError = err
+      })
+
+      const waitForStream = new Promise<void>((resolve) => {
+        stream.on('end', () => {
+          resolve()
+        })
+      })
+
+      expect(checker.totalSize).toBe(0)
+
+      stream.push(new Uint8Array([0xa]))
+      stream.push(new Uint8Array([0xb]))
+      stream.push(null)
+
+      await waitForStream
+
+      expect(checker.totalSize).toBe(2)
+      expect(checker.destroyed).toBe(true)
+      expect(lastError).toBe(err)
+    })
+  })
+})