@comapeo/core 5.4.1 → 6.0.0

package/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'
@@ -43,9 +46,7 @@ import {
   INACTIVE_MEMBER_ROLE_IDS,
 } from './roles.js'
 import {
-  assert,
   buildBlobId,
-  ExhaustivenessError,
   getDeviceId,
   projectKeyToId,
   projectKeyToPublicId,
@@ -64,9 +65,21 @@ import { Logger } from './logger.js'
 import { IconApi } from './icon-api.js'
 import { importCategories } from './import-categories.js'
 import TranslationApi from './translation-api.js'
-import { NotFoundError, nullIfNotFound } from './errors.js'
+import {
+  CategoryFileNotFoundError,
+  ensureKnownError,
+  getErrorCode,
+  NotFoundError,
+  ExhaustivenessError,
+  nullIfNotFound,
+  GeoJSONExportError,
+  InvalidMapShareError,
+  MultipleCategoryImportsError,
+  UnexpectedDocSchemaError,
+} from './errors.js'
 import { WebSocket } from 'ws'
-import { createWriteStream } from 'fs'
+import fs from 'node:fs'
+
 import ensureError from 'ensure-error'
 /** @import { MapShareExtension } from './generated/extensions.js' */
 /** @import { ProjectSettingsValue, Observation, Track } from '@comapeo/schema' */
@@ -123,10 +136,15 @@ const VARIANT_EXPORT_ORDER = ['original', 'preview', 'thumbnail']
  * @property {number} mapShareReceivedAt - Timestamp when the map share was received.
  * @property {string} senderDeviceId - The ID of the device that sent the map share.
  * @property {string} [senderDeviceName] - The name of the device that sent the map share.
+ * @property {string} receiverDeviceId - The deviceId of the peer the map share was sent to
+ */
+
+/**
+ * @typedef {Omit<MapShareExtension, 'bounds' | 'mapShareUrls' | 'receiverDeviceKey'> & AugmentedMapShareProperties} MapShare
  */
 
 /**
- * @typedef {Omit<MapShareExtension, 'bounds' | 'mapShareUrls'> & AugmentedMapShareProperties} MapShare
+ * @typedef {Omit<MapShare, 'mapShareReceivedAt' | 'senderDeviceId' | 'senderDeviceName'>} MapShareSend
  */
 
 /**
@@ -230,7 +248,7 @@ export class MapeoProject extends TypedEmitter {
         reindex = true
         break
       default:
-        throw new ExhaustivenessError(migrationResult)
+        throw new ExhaustivenessError({ value: migrationResult })
     }
 
     const indexedTables = [
@@ -287,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
         }
@@ -444,12 +460,12 @@ export class MapeoProject extends TypedEmitter {
       logger: this.#l,
     })
 
-    this.#blobStore.on('error', (err) => {
+    this.#blobStore.on('error', (e) => {
       // Ignore hypercore inflight request cancellation
-      if (ensureError(err).message.includes('REQUEST_CANCELLED')) return
+      if (ensureError(e).message.includes('REQUEST_CANCELLED')) return
       // TODO: Handle this error in some way - this error will come from an
       // unexpected error with background blob downloads
-      console.error('BlobStore error', err)
+      console.error('BlobStore error', e)
     })
 
     this.$blobs = new BlobApi({
@@ -653,7 +669,13 @@ export class MapeoProject extends TypedEmitter {
             index: entry.index,
           })
 
-          assert(doc.schemaName === 'translation', 'expected a translation doc')
+          if (doc.schemaName !== 'translation') {
+            throw new UnexpectedDocSchemaError({
+              gotSchema: doc.schemaName,
+              expectedSchema: 'translation',
+            })
+          }
+
           this.#translationApi.index(doc)
           otherEntries.push(entry)
         } else {
@@ -739,7 +761,7 @@ export class MapeoProject extends TypedEmitter {
       return extractEditableProjectSettings(
         await this.#dataTypes.projectSettings.getByDocId(this.#projectId)
       )
-    } catch (e) {
+    } catch {
       // if (e instanceof Error && e.name !== 'NotFoundError') throw e
       // If the project has not completed an initial sync, project settings will
       // not be available, so use fallback project info which is set from the
@@ -757,7 +779,7 @@ export class MapeoProject extends TypedEmitter {
       // Should error if we haven't synced before
       await this.#dataTypes.projectSettings.getByDocId(this.#projectId)
       return true
-    } catch (e) {
+    } catch {
       return false
     }
   }
@@ -795,17 +817,26 @@ export class MapeoProject extends TypedEmitter {
     const sender = await this.$member.getById(senderDeviceId)
 
     if (INACTIVE_MEMBER_ROLE_IDS.includes(sender.role.roleId)) {
-      throw new Error(
+      throw new InvalidMapShareError(
         `Map Share Sender is not an active member of the project (role: ${sender.role.name})`
       )
     }
 
+    const { receiverDeviceKey, ...mapShareData } = mapShareBase
+
+    const receiverDeviceId = receiverDeviceKey.toString('hex')
+
+    if (receiverDeviceId !== this.#deviceId) {
+      throw new Error('Got map share intended for a different peer')
+    }
+
     /** @type {MapShare} */
     const mapShare = {
-      ...mapShareBase,
+      ...mapShareData,
       senderDeviceId,
       senderDeviceName: sender.name,
       mapShareReceivedAt,
+      receiverDeviceId,
     }
 
     this.emit('map-share', mapShare)
@@ -861,15 +892,10 @@ 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,
@@ -877,13 +903,15 @@ export class MapeoProject extends TypedEmitter {
       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)
     }
   }
 
@@ -1191,10 +1219,16 @@ export class MapeoProject extends TypedEmitter {
     const fileName = await this[kGeoJSONFileName](observations, tracks)
     const filePath = path.join(exportFolder, fileName)
     const source = this.#exportGeoJSONStream({ observations, tracks, lang })
-    const sink = createWriteStream(filePath)
-    await pipelinePromise(source, sink)
 
-    return filePath
+    const sink = fs.createWriteStream(filePath)
+
+    try {
+      await pipelinePromise(source, sink)
+
+      return filePath
+    } catch (e) {
+      throw new GeoJSONExportError({ cause: e })
+    }
   }
 
   /**
@@ -1228,12 +1262,11 @@ export class MapeoProject extends TypedEmitter {
         }
         return { blobId, mimeType }
       } catch (e) {
-        if (!(e instanceof Error)) throw e
         this.#l.log(
           'Error loading blob id for attachment',
           attachment,
           variant,
-          e.message
+          ensureError(e).message
         )
         continue
       }
@@ -1336,7 +1369,7 @@ export class MapeoProject extends TypedEmitter {
       tracks,
       attachments,
       lang,
-    }).catch((e) => archive.emit('error', e))
+    }).catch((e) => archive.emit('error', ensureError(e)))
 
     // @ts-expect-error
     return archive
@@ -1364,10 +1397,14 @@ export class MapeoProject extends TypedEmitter {
       attachments,
       lang,
     })
-    const sink = createWriteStream(filePath)
-    await pipelinePromise(source, sink)
+    const sink = fs.createWriteStream(filePath)
+    try {
+      await pipelinePromise(source, sink)
 
-    return filePath
+      return filePath
+    } catch (e) {
+      throw new GeoJSONExportError({ cause: e })
+    }
   }
 
   async [kProjectLeave]() {
@@ -1436,17 +1473,19 @@ export class MapeoProject extends TypedEmitter {
    * @returns {Promise<void>}
    */
   async $importCategories({ filePath }) {
-    assert(
-      !this.#importingCategories,
-      'Cannot run multiple category imports at the same time'
-    )
+    if (this.#importingCategories) {
+      throw new MultipleCategoryImportsError()
+    }
     this.#importingCategories = true
 
     try {
       await importCategories(this, { filePath, logger: this.#l })
     } catch (e) {
-      this.#l.log('error loading config', e)
-      throw e
+      if (getErrorCode(e) === 'ENOENT') {
+        throw new CategoryFileNotFoundError({ filePath })
+      }
+      this.#l.log('ERROR: could not load config', e)
+      throw ensureKnownError(e)
     } finally {
       this.#importingCategories = false
     }
@@ -1455,16 +1494,24 @@ export class MapeoProject extends TypedEmitter {
   /**
    * Send a map share offer to the peer with device ID `mapShare.receiverDeviceId`
    *
-   * @param {MapShareExtension} mapShare
+   * @param {MapShareSend} mapShare
    * @param {object} [options]
    * @param {boolean} [options.__testOnlyBypassValidation=false] Warning: Do not use!
    */
   async $sendMapShare(mapShare, { __testOnlyBypassValidation = false } = {}) {
+    const { receiverDeviceId, ...mapShareData } = mapShare
+    const receiverDeviceKey = Buffer.from(receiverDeviceId, 'hex')
+
+    /** @type {MapShareExtension} */
+    // @ts-expect-error readonly fields being assigned as mutable
+    const shareExtension = {
+      ...mapShareData,
+      receiverDeviceKey,
+    }
     if (!__testOnlyBypassValidation) {
-      validateMapShareExtension(mapShare)
+      validateMapShareExtension(shareExtension)
     }
-    const peerId = Buffer.from(mapShare.receiverDeviceId, 'hex')
-    await this.#coreManager.sendMapShare(mapShare, peerId)
+    await this.#coreManager.sendMapShare(shareExtension)
   }
 }
 
@@ -1503,24 +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 Error(
-      'Invalid deviceInfo record, cannot write deviceInfo for another device'
-    )
-  }
-  return doc
-}
-
-/**
- *
  * @param {string} baseUrl
  * @param {string} projectPublicId
  * @returns {string}