autopass 3.3.0 → 3.4.1

package/spec/hyperdispatch/index.js

@@ -7,7 +7,7 @@ const { version, getEncoding, setVersion } = require('./messages.js')
 const defaultVersion = version
 
 class Router {
-  constructor() {
+  constructor () {
     this._handler0 = null
     this._handler1 = null
     this._handler2 = null
@@ -20,7 +20,7 @@ class Router {
     this._missing = 8
   }
 
-  add(name, handler) {
+  add (name, handler) {
     switch (name) {
       case '@autopass/remove-writer':
         this._handler0 = handler
@@ -52,7 +52,7 @@ class Router {
     this._missing--
   }
 
-  _checkAll() {
+  _checkAll () {
     assert(this._handler0 !== null, 'Missing handler for "@autopass/remove-writer"')
     assert(this._handler1 !== null, 'Missing handler for "@autopass/add-writer"')
     assert(this._handler2 !== null, 'Missing handler for "@autopass/put"')
@@ -63,7 +63,7 @@ class Router {
     assert(this._handler7 !== null, 'Missing handler for "@autopass/del-invite"')
   }
 
-  async dispatch(message, context) {
+  async dispatch (message, context) {
     if (this._missing > 0) {
       this._checkAll()
     }
@@ -95,7 +95,7 @@ class Router {
   }
 }
 
-function encode(name, message, { version = defaultVersion } = {}) {
+function encode (name, message, { version = defaultVersion } = {}) {
   const state = { buffer: null, start: 0, end: 0 }
 
   const route = getRouteByName(name)
@@ -111,7 +111,7 @@ function encode(name, message, { version = defaultVersion } = {}) {
   return state.buffer
 }
 
-function decode(buffer, { version = defaultVersion } = {}) {
+function decode (buffer, { version = defaultVersion } = {}) {
   const state = { buffer, start: 0, end: buffer.length }
 
   const id = c.uint.decode(state)
@@ -170,7 +170,7 @@ const route7 = {
   enc: getEncoding('@autopass/del-invite')
 }
 
-function getRouteByName(name) {
+function getRouteByName (name) {
   switch (name) {
     case '@autopass/remove-writer':
       return route0
@@ -193,7 +193,7 @@ function getRouteByName(name) {
   }
 }
 
-function getRouteById(id) {
+function getRouteById (id) {
   switch (id) {
     case 0:
       return route0

package/spec/hyperdispatch/messages.js

@@ -1,12 +1,12 @@
 // This file is autogenerated by the hyperschema compiler
-// Schema Version: 3
+// Schema Version: 4
 /* eslint-disable camelcase */
 /* eslint-disable quotes */
 /* eslint-disable space-before-function-paren */
 
 const { c } = require('hyperschema/runtime')
 
-const VERSION = 3
+const VERSION = 4
 
 // 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 (version >= 4 && m.name) c.string.preencode(state, m.name)
   },
   encode(state, m) {
+    const flags = ((version >= 4 && m.name) ? 1 : 0) | ((version >= 4 && m.readOnly) ? 2 : 0)
+
     c.buffer.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (version >= 4 && m.name) c.string.encode(state, m.name)
   },
   decode(state) {
     const r0 = c.buffer.decode(state)
+    const flags = state.start < state.end ? c.uint.decode(state) : 0
 
     return {
-      key: r0
+      key: r0,
+      name: (version >= 4 && (flags & 1) !== 0) ? c.string.decode(state) : null,
+      readOnly: (version >= 4 && (flags & 2) !== 0)
     }
   }
 }
@@ -104,7 +115,7 @@ const encoding4 = {
     if (version >= 3 && m.additional) encoding4_5.preencode(state, m.additional)
   },
   encode(state, m) {
-    const flags = (version >= 2 && m.readOnly ? 1 : 0) | (version >= 3 && m.additional ? 2 : 0)
+    const flags = ((version >= 2 && m.readOnly) ? 1 : 0) | ((version >= 3 && m.additional) ? 2 : 0)
 
     c.buffer.encode(state, m.id)
     c.buffer.encode(state, m.invite)
@@ -126,8 +137,8 @@ const encoding4 = {
       invite: r1,
       publicKey: r2,
       expires: r3,
-      readOnly: version >= 2 && (flags & 1) !== 0,
-      additional: version >= 3 && (flags & 2) !== 0 ? encoding4_5.decode(state) : null
+      readOnly: (version >= 2 && (flags & 1) !== 0),
+      additional: (version >= 3 && (flags & 2) !== 0) ? encoding4_5.decode(state) : null
     }
   }
 }
@@ -173,6 +184,52 @@ const encoding7 = {
   }
 }
 
+// @autopass/invitee
+const encoding8 = {
+  preencode(state, m) {
+    c.fixed32.preencode(state, m.key)
+    state.end++ // max flag is 1 so always one byte
+
+    if (version >= 4 && m.name) c.string.preencode(state, m.name)
+  },
+  encode(state, m) {
+    const flags = (version >= 4 && m.name) ? 1 : 0
+
+    c.fixed32.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (version >= 4 && 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: (version >= 4 && (flags & 1) !== 0) ? c.string.decode(state) : null
+    }
+  }
+}
+
+// @autopass/public-invite-metadata
+const encoding9 = {
+  preencode(state, m) {
+    state.end++ // max flag is 1 so always one byte
+  },
+  encode(state, m) {
+    const flags = (version >= 4 && m.readOnly) ? 1 : 0
+
+    c.uint.encode(state, flags)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      readOnly: (version >= 4 && (flags & 1) !== 0)
+    }
+  }
+}
+
 // @autopass/invite.additional, deferred due to recusive use
 const encoding4_5 = c.frame(encoding7)
 
@@ -215,6 +272,10 @@ function getEncoding(name) {
       return encoding6
     case '@autopass/additional-invite-data':
       return encoding7
+    case '@autopass/invitee':
+      return encoding8
+    case '@autopass/public-invite-metadata':
+      return encoding9
     default:
       throw new Error('Encoder not found ' + name)
   }

package/spec/schema/index.js

@@ -1,12 +1,12 @@
 // This file is autogenerated by the hyperschema compiler
-// Schema Version: 3
+// Schema Version: 4
 /* eslint-disable camelcase */
 /* eslint-disable quotes */
 /* eslint-disable space-before-function-paren */
 
 const { c } = require('hyperschema/runtime')
 
-const VERSION = 3
+const VERSION = 4
 
 // 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 (version >= 4 && m.name) c.string.preencode(state, m.name)
   },
   encode(state, m) {
+    const flags = ((version >= 4 && m.name) ? 1 : 0) | ((version >= 4 && m.readOnly) ? 2 : 0)
+
     c.buffer.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (version >= 4 && m.name) c.string.encode(state, m.name)
   },
   decode(state) {
     const r0 = c.buffer.decode(state)
+    const flags = state.start < state.end ? c.uint.decode(state) : 0
 
     return {
-      key: r0
+      key: r0,
+      name: (version >= 4 && (flags & 1) !== 0) ? c.string.decode(state) : null,
+      readOnly: (version >= 4 && (flags & 2) !== 0)
     }
   }
 }
@@ -104,7 +115,7 @@ const encoding4 = {
     if (version >= 3 && m.additional) encoding4_5.preencode(state, m.additional)
   },
   encode(state, m) {
-    const flags = (version >= 2 && m.readOnly ? 1 : 0) | (version >= 3 && m.additional ? 2 : 0)
+    const flags = ((version >= 2 && m.readOnly) ? 1 : 0) | ((version >= 3 && m.additional) ? 2 : 0)
 
     c.buffer.encode(state, m.id)
     c.buffer.encode(state, m.invite)
@@ -126,8 +137,8 @@ const encoding4 = {
       invite: r1,
       publicKey: r2,
       expires: r3,
-      readOnly: version >= 2 && (flags & 1) !== 0,
-      additional: version >= 3 && (flags & 2) !== 0 ? encoding4_5.decode(state) : null
+      readOnly: (version >= 2 && (flags & 1) !== 0),
+      additional: (version >= 3 && (flags & 2) !== 0) ? encoding4_5.decode(state) : null
     }
   }
 }
@@ -173,6 +184,52 @@ const encoding7 = {
   }
 }
 
+// @autopass/invitee
+const encoding8 = {
+  preencode(state, m) {
+    c.fixed32.preencode(state, m.key)
+    state.end++ // max flag is 1 so always one byte
+
+    if (version >= 4 && m.name) c.string.preencode(state, m.name)
+  },
+  encode(state, m) {
+    const flags = (version >= 4 && m.name) ? 1 : 0
+
+    c.fixed32.encode(state, m.key)
+    c.uint.encode(state, flags)
+
+    if (version >= 4 && 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: (version >= 4 && (flags & 1) !== 0) ? c.string.decode(state) : null
+    }
+  }
+}
+
+// @autopass/public-invite-metadata
+const encoding9 = {
+  preencode(state, m) {
+    state.end++ // max flag is 1 so always one byte
+  },
+  encode(state, m) {
+    const flags = (version >= 4 && m.readOnly) ? 1 : 0
+
+    c.uint.encode(state, flags)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      readOnly: (version >= 4 && (flags & 1) !== 0)
+    }
+  }
+}
+
 // @autopass/invite.additional, deferred due to recusive use
 const encoding4_5 = c.frame(encoding7)
 
@@ -215,6 +272,10 @@ function getEncoding(name) {
       return encoding6
     case '@autopass/additional-invite-data':
       return encoding7
+    case '@autopass/invitee':
+      return encoding8
+    case '@autopass/public-invite-metadata':
+      return encoding9
     default:
       throw new Error('Encoder not found ' + name)
   }

package/spec/schema/schema.json

@@ -1,5 +1,5 @@
 {
-  "version": 3,
+  "version": 4,
   "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": 4
+        },
+        {
+          "name": "readOnly",
+          "type": "bool",
+          "version": 4
         }
       ]
     },
@@ -160,6 +170,38 @@
           "version": 3
         }
       ]
+    },
+    {
+      "name": "invitee",
+      "namespace": "autopass",
+      "compact": false,
+      "flagsPosition": 1,
+      "fields": [
+        {
+          "name": "key",
+          "required": true,
+          "type": "fixed32",
+          "version": 4
+        },
+        {
+          "name": "name",
+          "type": "string",
+          "version": 4
+        }
+      ]
+    },
+    {
+      "name": "public-invite-metadata",
+      "namespace": "autopass",
+      "compact": false,
+      "flagsPosition": 0,
+      "fields": [
+        {
+          "name": "readOnly",
+          "type": "bool",
+          "version": 4
+        }
+      ]
     }
   ]
 }

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)
+  })
+}