Feat/invitor sets device info (#1230)

* feat: Invitor writes DeviceInfo record for invitee

* fix: Disable validation, switch device info read/write logic

* chore: Remove only from deviceInfo write test

* test: Fix config core count in sync tests

* fix: Calculate config count for sync test in right place

* chore: Remove rpc.infoFor

* feat: add peerInfo to invite API

* feat: Skip setting own device info if invitor does

* chore: Update invite fixtures

* test: Adjust sync test config cores back

* chore: Prefer device id for device info docs

* Update src/member-api.js

Co-authored-by: Gregor MacLennan <gmaclennan@awana.digital>

* Update src/member-api.js

Co-authored-by: Gregor MacLennan <gmaclennan@awana.digital>

* chore: Remove deviceInfo validation and its error

* fix: Use kCreateWithDocId for deviceInfo, ensure both name and type set on invite

* fix: Catch error when loading deviceInfo by deviceId

* fix: Only null if not found on datatype get existing for update

---------

Co-authored-by: Mauve Signweaver <contact@mauve.moe>
Co-authored-by: Gregor MacLennan <gmaclennan@awana.digital>

Author: 3 people

proto/rpc.proto

@@ -12,6 +12,7 @@ message Invite {
   optional string projectColor = 7;
   optional string projectDescription = 8;
   bool sendStats = 9;
+  bool invitorWroteDeviceInfo = 10;
 }
 
 message InviteCancel {

src/datatype/index.js

@@ -9,10 +9,12 @@ import {
   InvalidDocError,
   InvalidDocFormatError,
   NotFoundError,
+  nullIfNotFound,
 } from '../errors.js'
 import { TypedEmitter } from 'tiny-typed-emitter'
 import { setProperty, getProperty } from 'dot-prop-extra'
 import { parseBcp47 } from '../intl/parse-bcp-47.js'
+
 /** @import { MapeoDoc, MapeoValue } from '@comapeo/schema' */
 /** @import { RunResult } from 'better-sqlite3' */
 /** @import { SQLiteSelectBase } from 'drizzle-orm/sqlite-core' */
@@ -84,6 +86,7 @@ function generateDate() {
   return new Date().toISOString()
 }
 export const kCreateWithDocId = Symbol('kCreateWithDocId')
+export const kCreateOrUpdateWithDocId = Symbol('kCreateWithDocId')
 export const kSelect = Symbol('select')
 export const kTable = Symbol('table')
 export const kDataStore = Symbol('dataStore')
@@ -187,6 +190,20 @@ export class DataType extends TypedEmitter {
     return this[kCreateWithDocId](docId, value, { checkExisting: false })
   }
 
+  /**
+   * @param {string} docId
+   * @param {ExcludeSchema<TValue, 'coreOwnership'>} value
+   * @returns {Promise<TDoc & DerivedDocFields>}
+   */
+  async [kCreateOrUpdateWithDocId](docId, value) {
+    const existing = await this.getByDocId(docId).catch(nullIfNotFound)
+    if (existing) {
+      return this.update(existing.versionId, value)
+    } else {
+      return this[kCreateWithDocId](docId, value, { checkExisting: false })
+    }
+  }
+
   /**
    * @param {string} docId
    * @param {ExcludeSchema<TValue, 'coreOwnership'> | CoreOwnershipWithSignaturesValue} value

src/errors.js

@@ -120,13 +120,6 @@ export const EncryptionKeysNotFoundError = createErrorClass({
   status: 400,
 })
 
-export const InvalidDeviceInfoError = createErrorClass({
-  code: 'INVALID_DEVICE_INFO_ERROR',
-  message:
-    'Invalid deviceInfo record, cannot write deviceInfo for another device',
-  status: 400,
-})
-
 export const RoleAssignError = createErrorClass({
   code: 'ROLE_ASSIGN_ERROR',
   message: '{message}',

src/generated/rpc.d.ts

@@ -10,6 +10,7 @@ export interface Invite {
     projectColor?: string | undefined;
     projectDescription?: string | undefined;
     sendStats: boolean;
+    invitorWroteDeviceInfo: boolean;
 }
 export interface InviteCancel {
     inviteId: Buffer;

src/generated/rpc.js

@@ -122,6 +122,7 @@ function createBaseInvite() {
         projectName: "",
         invitorName: "",
         sendStats: false,
+        invitorWroteDeviceInfo: false,
     };
 }
 export var Invite = {
@@ -154,6 +155,9 @@ export var Invite = {
         if (message.sendStats === true) {
             writer.uint32(72).bool(message.sendStats);
         }
+        if (message.invitorWroteDeviceInfo === true) {
+            writer.uint32(80).bool(message.invitorWroteDeviceInfo);
+        }
         return writer;
     },
     decode: function (input, length) {
@@ -217,6 +221,12 @@ export var Invite = {
                     }
                     message.sendStats = reader.bool();
                     continue;
+                case 10:
+                    if (tag !== 80) {
+                        break;
+                    }
+                    message.invitorWroteDeviceInfo = reader.bool();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -229,7 +239,7 @@ export var Invite = {
         return Invite.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial: function (object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         var message = createBaseInvite();
         message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
         message.projectInviteId = (_b = object.projectInviteId) !== null && _b !== void 0 ? _b : Buffer.alloc(0);
@@ -240,6 +250,7 @@ export var Invite = {
         message.projectColor = (_g = object.projectColor) !== null && _g !== void 0 ? _g : undefined;
         message.projectDescription = (_h = object.projectDescription) !== null && _h !== void 0 ? _h : undefined;
         message.sendStats = (_j = object.sendStats) !== null && _j !== void 0 ? _j : false;
+        message.invitorWroteDeviceInfo = (_k = object.invitorWroteDeviceInfo) !== null && _k !== void 0 ? _k : false;
         return message;
     },
 };

src/generated/rpc.ts

@@ -12,6 +12,7 @@ export interface Invite {
   projectColor?: string | undefined;
   projectDescription?: string | undefined;
   sendStats: boolean;
+  invitorWroteDeviceInfo: boolean;
 }
 
 export interface InviteCancel {
@@ -187,6 +188,7 @@ function createBaseInvite(): Invite {
     projectName: "",
     invitorName: "",
     sendStats: false,
+    invitorWroteDeviceInfo: false,
   };
 }
 
@@ -219,6 +221,9 @@ export const Invite = {
     if (message.sendStats === true) {
       writer.uint32(72).bool(message.sendStats);
     }
+    if (message.invitorWroteDeviceInfo === true) {
+      writer.uint32(80).bool(message.invitorWroteDeviceInfo);
+    }
     return writer;
   },
 
@@ -292,6 +297,13 @@ export const Invite = {
 
           message.sendStats = reader.bool();
           continue;
+        case 10:
+          if (tag !== 80) {
+            break;
+          }
+
+          message.invitorWroteDeviceInfo = reader.bool();
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -315,6 +327,7 @@ export const Invite = {
     message.projectColor = object.projectColor ?? undefined;
     message.projectDescription = object.projectDescription ?? undefined;
     message.sendStats = object.sendStats ?? false;
+    message.invitorWroteDeviceInfo = object.invitorWroteDeviceInfo ?? false;
     return message;
   },
 };

src/invite/invite-api.js

@@ -129,6 +129,7 @@ export class InviteApi extends TypedEmitter {
       projectColor,
       projectDescription,
       sendStats,
+      invitorWroteDeviceInfo,
     } = inviteRpcMessage
     const invite = { ...inviteRpcMessage, receivedAt: Date.now() }
 
@@ -169,6 +170,7 @@ export class InviteApi extends TypedEmitter {
               projectColor,
               projectDescription,
               sendStats,
+              invitorWroteDeviceInfo,
             })
           }),
         },

src/mapeo-manager.js

@@ -70,7 +70,7 @@ import { migrate } from './lib/drizzle-helpers.js'
 /** @import { ProjectSettings, ProjectSettingsValue } from '@comapeo/schema' */
 
 /** @typedef {SetNonNullable<ProjectKeys, 'encryptionKeys'>} ValidatedProjectKeys */
-/** @typedef {Pick<ProjectJoinDetails, 'projectKey' | 'encryptionKeys'> & { projectName: string, projectColor?: string, projectDescription?: string, sendStats?: boolean }} ProjectToAddDetails */
+/** @typedef {Pick<ProjectJoinDetails, 'projectKey' | 'encryptionKeys'> & { projectName: string, projectColor?: string, projectDescription?: string, sendStats?: boolean, invitorWroteDeviceInfo? : boolean }} ProjectToAddDetails */
 /** @typedef {Pick<ProjectSettings, 'createdAt' | 'updatedAt' | 'name' | 'projectColor' | 'projectDescription' | 'sendStats'>} ListedProjectSettings */
 /** @typedef {ListedProjectSettings & { status: 'joined', projectId: string } | ProjectInfo & { status: 'joining' | 'left', projectId: string }} ListedProject */
 
@@ -703,6 +703,7 @@ export class MapeoManager extends TypedEmitter {
       projectColor,
       projectDescription,
       sendStats = false,
+      invitorWroteDeviceInfo = false,
     },
     { waitForSync = true } = {}
   ) => {
@@ -785,18 +786,21 @@ export class MapeoManager extends TypedEmitter {
       this.#activeProjects.delete(projectPublicId)
     })
 
-    try {
-      const deviceInfo = this.getDeviceInfo()
-      if (hasSavedDeviceInfo(deviceInfo)) {
-        await project[kSetOwnDeviceInfo](deviceInfo)
+    // Only write info on invite if configured
+    if (!invitorWroteDeviceInfo) {
+      try {
+        const deviceInfo = this.getDeviceInfo()
+        if (hasSavedDeviceInfo(deviceInfo)) {
+          await project[kSetOwnDeviceInfo](deviceInfo)
+        }
+      } catch (e) {
+        // Can ignore an error trying to write device info
+        this.#l.log(
+          'ERROR: failed to write project %h deviceInfo %o',
+          projectKey,
+          e
+        )
       }
-    } catch (e) {
-      // Can ignore an error trying to write device info
-      this.#l.log(
-        'ERROR: failed to write project %h deviceInfo %o',
-        projectKey,
-        e
-      )
     }
 
     // 5. Wait for initial project sync

src/mapeo-project.js

@@ -3,7 +3,6 @@ import Database from 'better-sqlite3'
 import { decodeBlockPrefix, decode, parseVersionId } from '@comapeo/schema'
 import { drizzle } from 'drizzle-orm/better-sqlite3'
 import { sql, count, eq } from 'drizzle-orm'
-import { discoveryKey } from 'hypercore-crypto'
 import { TypedEmitter } from 'tiny-typed-emitter'
 import ZipArchive from 'zip-stream-promise'
 import * as b4a from 'b4a'
@@ -14,7 +13,11 @@ import { Readable, pipelinePromise } from 'streamx'
 import { NAMESPACES, NAMESPACE_SCHEMAS } from './constants.js'
 import { CoreManager } from './core-manager/index.js'
 import { DataStore } from './datastore/index.js'
-import { DataType, kCreateWithDocId } from './datatype/index.js'
+import {
+  DataType,
+  kCreateOrUpdateWithDocId,
+  kCreateWithDocId,
+} from './datatype/index.js'
 import { BlobStore } from './blob-store/index.js'
 import { BlobApi } from './blob-api.js'
 import { IndexWriter } from './index-writer/index.js'
@@ -66,7 +69,6 @@ import {
   CategoryFileNotFoundError,
   ensureKnownError,
   getErrorCode,
-  InvalidDeviceInfoError,
   NotFoundError,
   ExhaustivenessError,
   nullIfNotFound,
@@ -303,8 +305,6 @@ export class MapeoProject extends TypedEmitter {
         switch (doc.schemaName) {
           case 'coreOwnership':
             return mapAndValidateCoreOwnership(doc, version)
-          case 'deviceInfo':
-            return mapAndValidateDeviceInfo(doc, version)
           default:
             return doc
         }
@@ -892,29 +892,26 @@ export class MapeoProject extends TypedEmitter {
 
   /**
    * @param {Pick<import('@comapeo/schema').DeviceInfoValue, 'name' | 'deviceType' | 'selfHostedServerDetails'>} value
-   * @returns {Promise<import('@comapeo/schema').DeviceInfo>}
    */
   async [kSetOwnDeviceInfo](value) {
     const { deviceInfo } = this.#dataTypes
 
-    const configCoreId = this.#coreManager
-      .getWriterCore('config')
-      .key.toString('hex')
-
     const doc = {
       name: value.name,
       deviceType: value.deviceType,
       selfHostedServerDetails: value.selfHostedServerDetails,
       schemaName: /** @type {const} */ ('deviceInfo'),
     }
 
-    const existingDoc = await deviceInfo
-      .getByDocId(configCoreId)
-      .catch(nullIfNotFound)
-    if (existingDoc) {
-      return await deviceInfo.update(existingDoc.versionId, doc)
-    } else {
-      return await deviceInfo[kCreateWithDocId](configCoreId, doc)
+    // TODO: Remove configCore once we know everyone has deviceId
+    const configCoreId = this.#coreManager
+      .getWriterCore('config')
+      .key.toString('hex')
+
+    const docIds = [this.deviceId, configCoreId]
+
+    for (const docId of docIds) {
+      await deviceInfo[kCreateOrUpdateWithDocId](docId, doc)
     }
   }
 
@@ -1553,22 +1550,6 @@ function getCoreKeypairs({ projectKey, projectSecretKey, keyManager }) {
 }
 
 /**
- * Validate that a deviceInfo record is written by the device that is it about,
- * e.g. version.coreKey should equal docId
- *
- * @param {import('@comapeo/schema').DeviceInfo} doc
- * @param {import('@comapeo/schema').VersionIdObject} version
- * @returns {import('@comapeo/schema').DeviceInfo}
- */
-function mapAndValidateDeviceInfo(doc, { coreDiscoveryKey }) {
-  if (!coreDiscoveryKey.equals(discoveryKey(Buffer.from(doc.docId, 'hex')))) {
-    throw new InvalidDeviceInfoError()
-  }
-  return doc
-}
-
-/**
- *
  * @param {string} baseUrl
  * @param {string} projectPublicId
  * @returns {string}