autopass 3.3.0 → 3.4.0

package/spec/schema/index.js

@@ -1,12 +1,12 @@
 // This file is autogenerated by the hyperschema compiler
-// Schema Version: 3
+// Schema Version: 1
 /* eslint-disable camelcase */
 /* eslint-disable quotes */
 /* eslint-disable space-before-function-paren */
 
 const { c } = require('hyperschema/runtime')
 
-const VERSION = 3
+const VERSION = 1
 
 // eslint-disable-next-line no-unused-vars
 let version = VERSION
@@ -62,15 +62,26 @@ const encoding1 = {
 const encoding2 = {
   preencode(state, m) {
     c.buffer.preencode(state, m.key)
+    state.end++ // max flag is 2 so always one byte
+
+    if (m.name) c.string.preencode(state, m.name)
   },
   encode(state, m) {
+    const flags = (m.name ? 1 : 0) | (m.readOnly ? 2 : 0)
+
     c.buffer.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (m.name) c.string.encode(state, m.name)
   },
   decode(state) {
     const r0 = c.buffer.decode(state)
+    const flags = c.uint.decode(state)
 
     return {
-      key: r0
+      key: r0,
+      name: (flags & 1) !== 0 ? c.string.decode(state) : null,
+      readOnly: (flags & 2) !== 0
     }
   }
 }
@@ -92,8 +103,78 @@ const encoding3 = {
   }
 }
 
-// @autopass/invite
+// @autopass/invitee
 const encoding4 = {
+  preencode(state, m) {
+    c.fixed32.preencode(state, m.key)
+    state.end++ // max flag is 1 so always one byte
+
+    if (m.name) c.string.preencode(state, m.name)
+  },
+  encode(state, m) {
+    const flags = m.name ? 1 : 0
+
+    c.fixed32.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (m.name) c.string.encode(state, m.name)
+  },
+  decode(state) {
+    const r0 = c.fixed32.decode(state)
+    const flags = c.uint.decode(state)
+
+    return {
+      key: r0,
+      name: (flags & 1) !== 0 ? c.string.decode(state) : null
+    }
+  }
+}
+
+// @autopass/public-invite-metadata
+const encoding5 = {
+  preencode(state, m) {
+    state.end++ // max flag is 1 so always one byte
+  },
+  encode(state, m) {
+    const flags = m.readOnly ? 1 : 0
+
+    c.uint.encode(state, flags)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      readOnly: (flags & 1) !== 0
+    }
+  }
+}
+
+// @autopass/additional-invite-data
+const encoding6 = {
+  preencode(state, m) {
+    c.buffer.preencode(state, m.data)
+    c.buffer.preencode(state, m.signature)
+  },
+  encode(state, m) {
+    c.buffer.encode(state, m.data)
+    c.buffer.encode(state, m.signature)
+  },
+  decode(state) {
+    const r0 = c.buffer.decode(state)
+    const r1 = c.buffer.decode(state)
+
+    return {
+      data: r0,
+      signature: r1
+    }
+  }
+}
+
+// @autopass/invite.additional
+const encoding7_5 = c.frame(encoding6)
+
+// @autopass/invite
+const encoding7 = {
   preencode(state, m) {
     c.buffer.preencode(state, m.id)
     c.buffer.preencode(state, m.invite)
@@ -101,10 +182,10 @@ const encoding4 = {
     c.int.preencode(state, m.expires)
     state.end++ // max flag is 2 so always one byte
 
-    if (version >= 3 && m.additional) encoding4_5.preencode(state, m.additional)
+    if (m.additional) encoding7_5.preencode(state, m.additional)
   },
   encode(state, m) {
-    const flags = (version >= 2 && m.readOnly ? 1 : 0) | (version >= 3 && m.additional ? 2 : 0)
+    const flags = (m.readOnly ? 1 : 0) | (m.additional ? 2 : 0)
 
     c.buffer.encode(state, m.id)
     c.buffer.encode(state, m.invite)
@@ -112,28 +193,28 @@ const encoding4 = {
     c.int.encode(state, m.expires)
     c.uint.encode(state, flags)
 
-    if (version >= 3 && m.additional) encoding4_5.encode(state, m.additional)
+    if (m.additional) encoding7_5.encode(state, m.additional)
   },
   decode(state) {
     const r0 = c.buffer.decode(state)
     const r1 = c.buffer.decode(state)
     const r2 = c.buffer.decode(state)
     const r3 = c.int.decode(state)
-    const flags = state.start < state.end ? c.uint.decode(state) : 0
+    const flags = c.uint.decode(state)
 
     return {
       id: r0,
       invite: r1,
       publicKey: r2,
       expires: r3,
-      readOnly: version >= 2 && (flags & 1) !== 0,
-      additional: version >= 3 && (flags & 2) !== 0 ? encoding4_5.decode(state) : null
+      readOnly: (flags & 1) !== 0,
+      additional: (flags & 2) !== 0 ? encoding7_5.decode(state) : null
     }
   }
 }
 
 // @autopass/del-invite
-const encoding5 = {
+const encoding8 = {
   preencode(state, m) {
     c.buffer.preencode(state, m.id)
   },
@@ -150,31 +231,7 @@ const encoding5 = {
 }
 
 // @autopass/del-mirror
-const encoding6 = encoding1
-
-// @autopass/additional-invite-data
-const encoding7 = {
-  preencode(state, m) {
-    c.buffer.preencode(state, m.data)
-    c.buffer.preencode(state, m.signature)
-  },
-  encode(state, m) {
-    c.buffer.encode(state, m.data)
-    c.buffer.encode(state, m.signature)
-  },
-  decode(state) {
-    const r0 = c.buffer.decode(state)
-    const r1 = c.buffer.decode(state)
-
-    return {
-      data: r0,
-      signature: r1
-    }
-  }
-}
-
-// @autopass/invite.additional, deferred due to recusive use
-const encoding4_5 = c.frame(encoding7)
+const encoding9 = encoding1
 
 function setVersion(v) {
   version = v
@@ -207,14 +264,18 @@ function getEncoding(name) {
       return encoding2
     case '@autopass/delete':
       return encoding3
-    case '@autopass/invite':
+    case '@autopass/invitee':
       return encoding4
-    case '@autopass/del-invite':
+    case '@autopass/public-invite-metadata':
       return encoding5
-    case '@autopass/del-mirror':
-      return encoding6
     case '@autopass/additional-invite-data':
+      return encoding6
+    case '@autopass/invite':
       return encoding7
+    case '@autopass/del-invite':
+      return encoding8
+    case '@autopass/del-mirror':
+      return encoding9
     default:
       throw new Error('Encoder not found ' + name)
   }

package/spec/schema/schema.json

@@ -1,5 +1,5 @@
 {
-  "version": 3,
+  "version": 1,
   "schema": [
     {
       "name": "records",
@@ -45,13 +45,23 @@
       "name": "writer",
       "namespace": "autopass",
       "compact": false,
-      "flagsPosition": -1,
+      "flagsPosition": 1,
       "fields": [
         {
           "name": "key",
           "required": true,
           "type": "buffer",
           "version": 1
+        },
+        {
+          "name": "name",
+          "type": "string",
+          "version": 1
+        },
+        {
+          "name": "readOnly",
+          "type": "bool",
+          "version": 1
         }
       ]
     },
@@ -69,6 +79,58 @@
         }
       ]
     },
+    {
+      "name": "invitee",
+      "namespace": "autopass",
+      "compact": false,
+      "flagsPosition": 1,
+      "fields": [
+        {
+          "name": "key",
+          "required": true,
+          "type": "fixed32",
+          "version": 1
+        },
+        {
+          "name": "name",
+          "type": "string",
+          "version": 1
+        }
+      ]
+    },
+    {
+      "name": "public-invite-metadata",
+      "namespace": "autopass",
+      "compact": false,
+      "flagsPosition": 0,
+      "fields": [
+        {
+          "name": "readOnly",
+          "type": "bool",
+          "version": 1
+        }
+      ]
+    },
+    {
+      "name": "additional-invite-data",
+      "namespace": "autopass",
+      "compact": false,
+      "flagsPosition": -1,
+      "fields": [
+        {
+          "name": "data",
+          "required": true,
+          "type": "buffer",
+          "version": 1
+        },
+        {
+          "name": "signature",
+          "required": true,
+          "type": "buffer",
+          "version": 1
+        }
+      ]
+    },
     {
       "name": "invite",
       "namespace": "autopass",
@@ -103,13 +165,13 @@
           "name": "readOnly",
           "required": false,
           "type": "bool",
-          "version": 2
+          "version": 1
         },
         {
           "name": "additional",
           "required": false,
           "type": "@autopass/additional-invite-data",
-          "version": 3
+          "version": 1
         }
       ]
     },
@@ -140,26 +202,6 @@
           "version": 1
         }
       ]
-    },
-    {
-      "name": "additional-invite-data",
-      "namespace": "autopass",
-      "compact": false,
-      "flagsPosition": -1,
-      "fields": [
-        {
-          "name": "data",
-          "required": true,
-          "type": "buffer",
-          "version": 3
-        },
-        {
-          "name": "signature",
-          "required": true,
-          "type": "buffer",
-          "version": 3
-        }
-      ]
     }
   ]
 }

package/test.js

@@ -44,9 +44,8 @@ test('invites', async function (t) {
   await b.ready()
 
   t.teardown(async () => await b.close())
-  b.on('update', function () {
-    if (b.base.system.members === 2) t.pass('b has two members')
-  })
+  await updateUntil(b, () => b.base.system.members === 2)
+  t.pass('b has two members')
 })
 
 test('invites', async function (t) {
@@ -76,9 +75,41 @@ test('invites', async function (t) {
   await b.ready()
 
   t.teardown(async () => await b.close())
-  b.on('update', function () {
-    if (b.base.system.members === 2) t.pass('b has two members')
+  await updateUntil(b, () => b.base.system.members === 2)
+  t.pass('b has two members')
+})
+
+test.solo('invite with name', async function (t) {
+  t.plan(3)
+
+  const tn = await testnet(10, t)
+
+  const a = await create(t, { bootstrap: tn.bootstrap })
+  t.teardown(async () => {
+    await a.close()
   })
+
+  const updateListener = function () {
+    if (a.base.system.members === 2) {
+      t.pass('a has two members')
+      a.removeListener('update', updateListener) // Remove the listener in teardown
+    }
+  }
+
+  a.on('update', updateListener)
+
+  const inv = await a.createInvite()
+
+  const p = await pair(t, inv, { bootstrap: tn.bootstrap, name: 'maf' })
+
+  const b = await p.finished()
+  await b.ready()
+
+  t.teardown(async () => await b.close())
+  await updateUntil(b, () => b.base.system.members === 2)
+  t.pass('b has two members')
+  const arr = await b.listWriters().toArray()
+  t.is(arr[0].name, 'maf')
 })
 
 test('invite resets when createInvite type is different than previous', async function (t) {
@@ -143,9 +174,8 @@ test('blind encryption', async function (t) {
   t.ok(encryptionKeyEncryptedBuffer)
 
   t.teardown(async () => await b.close())
-  b.on('update', function () {
-    if (b.base.system.members === 2) t.pass('b has two members')
-  })
+  await updateUntil(b, () => b.base.system.members === 2)
+  if (b.base.system.members === 2) t.pass('b has two members')
 })
 
 test('suspend and resume', async function (t) {
@@ -207,3 +237,15 @@ async function pair(t, inv, opts) {
   const a = Autopass.pair(new Corestore(dir), inv, opts)
   return a
 }
+
+function updateUntil(b, fn) {
+  return new Promise((resolve) => {
+    if (fn()) return resolve()
+    const check = () => {
+      if (!fn()) return
+      b.off('update', check)
+      resolve()
+    }
+    b.on('update', check)
+  })
+}