fix: write own device info when creating and adding projects

src/mapeo-manager.js

@@ -215,6 +215,7 @@ export class MapeoManager {
       sharedDb: this.#db,
       sharedIndexWriter: this.#projectSettingsIndexWriter,
       rpc: this.#rpc,
+      getLocalDeviceInfo: this.getDeviceInfo.bind(this),
     })
 
     // 5. Write project name and any other relevant metadata to project instance
@@ -265,6 +266,7 @@ export class MapeoManager {
       sharedDb: this.#db,
       sharedIndexWriter: this.#projectSettingsIndexWriter,
       rpc: this.#rpc,
+      getLocalDeviceInfo: this.getDeviceInfo.bind(this),
     })
 
     // 3. Keep track of project instance as we know it's a properly existing project

src/mapeo-project.js

@@ -40,6 +40,7 @@ export const kCapabilities = Symbol('capabilities')
 
 export class MapeoProject {
   #projectId
+  #deviceId
   #coreManager
   #dataStores
   #dataTypes
@@ -48,6 +49,7 @@ export class MapeoProject {
   #coreOwnership
   #capabilities
   #ownershipWriteDone
+  #ownDeviceInfoWriteDone
   #memberApi
 
   /**
@@ -61,6 +63,7 @@ export class MapeoProject {
    * @param {IndexWriter} opts.sharedIndexWriter
    * @param {import('./types.js').CoreStorage} opts.coreStorage Folder to store all hypercore data
    * @param {import('./rpc/index.js').MapeoRPC} opts.rpc
+   * @param {() => Promise<Partial<Pick<import('@mapeo/schema').DeviceInfoValue, 'name'>>>} opts.getLocalDeviceInfo
    *
    */
   constructor({
@@ -73,6 +76,7 @@ export class MapeoProject {
     projectSecretKey,
     encryptionKeys,
     rpc,
+    getLocalDeviceInfo,
   }) {
     this.#projectId = projectKeyToId(projectKey)
 
@@ -103,13 +107,20 @@ export class MapeoProject {
       storage: coreManagerStorage,
       sqlite,
     })
+
+    // TODO: Use discovery key
+    this.#deviceId = this.#coreManager
+      .getWriterCore('config')
+      .key.toString('hex')
+
     const indexWriter = new IndexWriter({
       tables: [
         observationTable,
         presetTable,
         fieldTable,
         coreOwnershipTable,
         roleTable,
+        deviceInfoTable,
       ],
       sqlite,
       getWinner,
@@ -248,6 +259,54 @@ export class MapeoProject {
         .then(deferred.resolve)
         .catch(deferred.reject)
     })
+
+    ///////// 5. Write device info record for project instance instantiator
+
+    const deferredDeviceInfoWrite = pDefer()
+    // Avoid uncaught rejection. If this is rejected then project.ready() will reject
+    deferredDeviceInfoWrite.promise.catch(() => {})
+    this.#ownDeviceInfoWriteDone = deferredDeviceInfoWrite.promise
+
+    const configCore = this.#coreManager.getWriterCore('config').core
+    configCore.on('ready', async () => {
+      try {
+        const existing = await this.#dataTypes.deviceInfo.getByDocId(
+          this.#deviceId
+        )
+
+        if (existing) {
+          const { name } = await getLocalDeviceInfo()
+
+          // If the device info is different from what the project has, update it for the project
+          if (name && name !== existing.name) {
+            await this.#dataTypes.deviceInfo.update(existing.versionId, {
+              schemaName: 'deviceInfo',
+              name,
+            })
+          }
+
+          return deferredDeviceInfoWrite.resolve()
+        }
+      } catch (err) {
+        return deferredDeviceInfoWrite.reject(err)
+      }
+
+      // No existing device info record exists for instantiator in the project so attempt to write one
+      try {
+        const { name } = await getLocalDeviceInfo()
+
+        if (name) {
+          await this.#dataTypes.deviceInfo[kCreateWithDocId](this.#deviceId, {
+            schemaName: 'deviceInfo',
+            name,
+          })
+        }
+
+        return deferredDeviceInfoWrite.resolve()
+      } catch (err) {
+        return deferredDeviceInfoWrite.reject(err)
+      }
+    })
   }
 
   /**
@@ -268,7 +327,11 @@ export class MapeoProject {
    * Resolves when hypercores have all loaded
    */
   async ready() {
-    await Promise.all([this.#coreManager.ready(), this.#ownershipWriteDone])
+    await Promise.all([
+      this.#coreManager.ready(),
+      this.#ownershipWriteDone,
+      this.#ownDeviceInfoWriteDone,
+    ])
   }
 
   /**
@@ -318,6 +381,13 @@ export class MapeoProject {
     return this.#memberApi
   }
 
+  /**
+   * @returns {string} id representing the device using this project instance
+   */
+  get deviceId() {
+    return this.#deviceId
+  }
+
   /**
    * @param {Partial<EditableProjectSettings>} settings
    * @returns {Promise<EditableProjectSettings>}

test-e2e/device-info.js

@@ -1,8 +1,10 @@
 import { test } from 'brittle'
+import { randomBytes } from 'crypto'
 import { KeyManager } from '@mapeo/crypto'
-import { MapeoManager } from '../src/mapeo-manager.js'
 import RAM from 'random-access-memory'
 
+import { MapeoManager } from '../src/mapeo-manager.js'
+
 test('write and read deviceInfo', async (t) => {
   const rootKey = KeyManager.generateRootKey()
   const manager = new MapeoManager({
@@ -19,3 +21,52 @@ test('write and read deviceInfo', async (t) => {
   const readInfo2 = await manager.getDeviceInfo()
   t.alike(readInfo2, info2)
 })
+
+test('device info written to projects', async (t) => {
+  const manager = new MapeoManager({
+    rootKey: KeyManager.generateRootKey(),
+    dbFolder: ':memory:',
+    coreStorage: () => new RAM(),
+  })
+
+  await manager.setDeviceInfo({ name: 'mapeo' })
+
+  t.test('creating project', async (st) => {
+    const projectId = await manager.createProject()
+    const project = await manager.getProject(projectId)
+
+    await project.ready()
+
+    const members = await project.$member.getMany()
+
+    st.is(members.length, 1)
+
+    const member = members[0]
+
+    st.is(member.deviceId, project.deviceId)
+    st.is(member.name, (await manager.getDeviceInfo())?.name)
+  })
+
+  t.test('adding project', async (st) => {
+    const projectId = await manager.addProject({
+      projectKey: randomBytes(32),
+      encryptionKeys: { auth: randomBytes(32) },
+    })
+
+    const project = await manager.getProject(projectId)
+
+    await project.ready()
+
+    const members = await project.$member.getMany()
+
+    st.is(members.length, 1)
+
+    const member = members[0]
+
+    st.is(member.deviceId, project.deviceId)
+    st.is(member.name, (await manager.getDeviceInfo())?.name)
+  })
+
+  // TODO: Test changing device info and checking device info per project afterwards
+  // TODO: Test closing project, changing name, and getting project to see if device info for project is updated
+})

test-types/data-types.ts

@@ -37,6 +37,7 @@ const mapeoProject = new MapeoProject({
     sqlite,
   }),
   rpc: new MapeoRPC(),
+  getLocalDeviceInfo: async () => ({ name: 'foo' }),
 })
 
 ///// Observations