@comapeo/core 3.0.0 → 3.1.1

package/src/member-api.js

@@ -17,9 +17,19 @@ import { abortSignalAny } from './lib/ponyfills.js'
 import timingSafeEqual from 'string-timing-safe-equal'
 import { isHostnameIpAddress } from './lib/is-hostname-ip-address.js'
 import { ErrorWithCode, getErrorMessage } from './lib/error.js'
-import { InviteAbortedError } from './errors.js'
+import {
+  InviteAbortedError,
+  InviteInitialSyncFailError,
+  ProjectDetailsSendFailError,
+} from './errors.js'
 import { wsCoreReplicator } from './lib/ws-core-replicator.js'
-import { MEMBER_ROLE_ID, ROLES, isRoleIdForNewInvite } from './roles.js'
+import {
+  BLOCKED_ROLE_ID,
+  FAILED_ROLE_ID,
+  MEMBER_ROLE_ID,
+  ROLES,
+  isRoleIdForNewInvite,
+} from './roles.js'
 /**
  * @import {
  *   DeviceInfo,
@@ -57,6 +67,7 @@ export class MemberApi extends TypedEmitter {
   #getProjectName
   #projectKey
   #rpc
+  #makeWebsocket
   #getReplicationStream
   #waitForInitialSyncWithPeer
   #dataTypes
@@ -73,6 +84,7 @@ export class MemberApi extends TypedEmitter {
    * @param {() => Promisable<undefined | string>} opts.getProjectName
    * @param {Buffer} opts.projectKey
    * @param {import('./local-peers.js').LocalPeers} opts.rpc
+   * @param {(url: string) => WebSocket} [opts.makeWebsocket]
    * @param {() => ReplicationStream} opts.getReplicationStream
    * @param {(deviceId: string, abortSignal: AbortSignal) => Promise<void>} opts.waitForInitialSyncWithPeer
    * @param {Object} opts.dataTypes
@@ -87,6 +99,7 @@ export class MemberApi extends TypedEmitter {
     getProjectName,
     projectKey,
     rpc,
+    makeWebsocket = (url) => new WebSocket(url),
     getReplicationStream,
     waitForInitialSyncWithPeer,
     dataTypes,
@@ -99,6 +112,7 @@ export class MemberApi extends TypedEmitter {
     this.#getProjectName = getProjectName
     this.#projectKey = projectKey
     this.#rpc = rpc
+    this.#makeWebsocket = makeWebsocket
     this.#getReplicationStream = getReplicationStream
     this.#waitForInitialSyncWithPeer = waitForInitialSyncWithPeer
     this.#dataTypes = dataTypes
@@ -157,12 +171,17 @@ export class MemberApi extends TypedEmitter {
       const projectName = project.name
       assert(projectName, 'Project must have a name to invite people')
 
+      const projectColor = project.projectColor
+      const projectDescription = project.projectDescription
+
       abortSignal.throwIfAborted()
 
       const invite = {
         inviteId,
         projectInviteId,
         projectName,
+        projectColor,
+        projectDescription,
         roleName,
         roleDescription,
         invitorName,
@@ -186,17 +205,33 @@ export class MemberApi extends TypedEmitter {
         case InviteResponse_Decision.DECISION_UNSPECIFIED:
           return InviteResponse_Decision.REJECT
         case InviteResponse_Decision.ACCEPT:
-          // We should assign the role locally *before* sharing the project details
-          // so that they're part of the project even if they don't receive the
-          // project details message.
-
+          // Technically we can assign after sending project details
+          // This lets us test role removal
           await this.#roles.assignRole(deviceId, roleId)
 
-          await this.#rpc.sendProjectJoinDetails(deviceId, {
-            inviteId,
-            projectKey: this.#projectKey,
-            encryptionKeys: this.#encryptionKeys,
-          })
+          try {
+            await this.#rpc.sendProjectJoinDetails(deviceId, {
+              inviteId,
+              projectKey: this.#projectKey,
+              encryptionKeys: this.#encryptionKeys,
+            })
+          } catch {
+            try {
+              // Mark them as "failed" so we can retry the flow
+              await this.#roles.assignRole(deviceId, FAILED_ROLE_ID)
+            } catch (e) {
+              console.error(e)
+            }
+            throw new ProjectDetailsSendFailError()
+          }
+
+          try {
+            await this.#waitForInitialSyncWithPeer(deviceId, abortSignal)
+          } catch {
+            // Mark them as "failed" so we can retry the flow
+            await this.#roles.assignRole(deviceId, FAILED_ROLE_ID)
+            throw new InviteInitialSyncFailError()
+          }
 
           return inviteResponse.decision
         default:
@@ -314,6 +349,46 @@ export class MemberApi extends TypedEmitter {
     })
   }
 
+  /**
+   * Remove a server peer. Only works when the peer is reachable
+   *
+   * @param {string} serverDeviceId
+   * @param {object} [options]
+   * @param {boolean} [options.dangerouslyAllowInsecureConnections] Allow insecure network connections. Should only be used in tests.
+   * @returns {Promise<void>}
+   */
+  async removeServerPeer(
+    serverDeviceId,
+    { dangerouslyAllowInsecureConnections = false } = {}
+  ) {
+    // Get device ID for URL
+    // Parse through URL to ensure end pathname if missing
+    const member = await this.getById(serverDeviceId)
+
+    if (!member.selfHostedServerDetails) {
+      throw new ErrorWithCode(
+        'DEVICE_ID_NOT_FOR_SERVER',
+        'DeviceId is not for a server peer'
+      )
+    }
+
+    if (member.role.roleId === BLOCKED_ROLE_ID) {
+      throw new ErrorWithCode('ALREADY_BLOCKED', 'Server peer already blocked')
+    }
+
+    const { baseUrl } = member.selfHostedServerDetails
+
+    // Add blocked role to project
+    await this.#roles.assignRole(serverDeviceId, BLOCKED_ROLE_ID)
+
+    // TODO: Catch fail and sync with server after
+    await this.#waitForInitialSyncWithServer({
+      baseUrl,
+      serverDeviceId,
+      dangerouslyAllowInsecureConnections,
+    })
+  }
+
   /**
    * @param {string} baseUrl Server base URL. Should already be validated.
    * @returns {Promise<{ serverDeviceId: string }>}
@@ -378,7 +453,7 @@ export class MemberApi extends TypedEmitter {
         ? 'ws:'
         : 'wss:'
 
-    const websocket = new WebSocket(websocketUrl)
+    const websocket = this.#makeWebsocket(websocketUrl.href)
 
     try {
       await pEvent(websocket, 'open', { rejectionEvents: ['error'] })
@@ -400,7 +475,7 @@ export class MemberApi extends TypedEmitter {
     const onErrorPromise = pEvent(websocket, 'error')
 
     const replicationStream = this.#getReplicationStream()
-    wsCoreReplicator(websocket, replicationStream)
+    const streamPromise = wsCoreReplicator(websocket, replicationStream)
 
     const syncAbortController = new AbortController()
     const syncPromise = this.#waitForInitialSyncWithPeer(
@@ -408,7 +483,11 @@ export class MemberApi extends TypedEmitter {
       syncAbortController.signal
     )
 
-    const errorEvent = await Promise.race([onErrorPromise, syncPromise])
+    const errorEvent = await Promise.race([
+      onErrorPromise,
+      syncPromise,
+      streamPromise,
+    ])
 
     if (errorEvent) {
       syncAbortController.abort()
@@ -445,6 +524,7 @@ export class MemberApi extends TypedEmitter {
       result.name = deviceInfo.name
       result.deviceType = deviceInfo.deviceType
       result.joinedAt = deviceInfo.createdAt
+      result.selfHostedServerDetails = deviceInfo.selfHostedServerDetails
     } catch (err) {
       // Attempting to get someone else may throw because sync hasn't occurred or completed
       // Only throw if attempting to get themself since the relevant information should be available

package/src/roles.js

@@ -12,6 +12,7 @@ export const COORDINATOR_ROLE_ID = 'f7c150f5a3a9a855'
 export const MEMBER_ROLE_ID = '012fd2d431c0bf60'
 export const BLOCKED_ROLE_ID = '9e6d29263cba36c9'
 export const LEFT_ROLE_ID = '8ced989b1904606b'
+export const FAILED_ROLE_ID = 'a24eaca65ab5d5d0'
 export const NO_ROLE_ID = '08e4251e36f6e7ed'
 
 /**
@@ -27,6 +28,7 @@ const ROLE_IDS = new Set(
     MEMBER_ROLE_ID,
     BLOCKED_ROLE_ID,
     LEFT_ROLE_ID,
+    FAILED_ROLE_ID,
     NO_ROLE_ID,
   ])
 )
@@ -51,6 +53,7 @@ const ROLE_IDS_ASSIGNABLE_TO_ANYONE = new Set(
     MEMBER_ROLE_ID,
     BLOCKED_ROLE_ID,
     LEFT_ROLE_ID,
+    FAILED_ROLE_ID,
   ])
 )
 const isRoleIdAssignableToAnyone = setHas(ROLE_IDS_ASSIGNABLE_TO_ANYONE)
@@ -126,6 +129,34 @@ const BLOCKED_ROLE = {
   },
 }
 
+/**
+ * This role is used for devices that failed to sync after accepting an invite and being added
+ * @type {Role<typeof FAILED_ROLE_ID>}
+ */
+const FAILED_ROLE = {
+  roleId: FAILED_ROLE_ID,
+  name: 'Failed',
+  docs: mapObject(currentSchemaVersions, (key) => {
+    return [
+      key,
+      {
+        readOwn: false,
+        writeOwn: false,
+        readOthers: false,
+        writeOthers: false,
+      },
+    ]
+  }),
+  roleAssignment: [],
+  sync: {
+    auth: 'blocked',
+    config: 'blocked',
+    data: 'blocked',
+    blobIndex: 'blocked',
+    blob: 'blocked',
+  },
+}
+
 /**
  * This is the role assumed for a device when no role record can be found. This
  * can happen when an invited device did not manage to sync with the device that
@@ -219,6 +250,7 @@ export const ROLES = {
     },
   },
   [NO_ROLE_ID]: NO_ROLE,
+  [FAILED_ROLE_ID]: FAILED_ROLE,
 }
 
 /**
@@ -380,6 +412,11 @@ export class Roles extends TypedEmitter {
       if (deviceId !== this.#ownDeviceId) {
         throw new Error('Cannot assign LEFT role to another device')
       }
+    } else if (roleId === FAILED_ROLE_ID) {
+      const ownRole = await this.getRole(this.#ownDeviceId)
+      if (!ownRole.roleAssignment.includes(COORDINATOR_ROLE_ID)) {
+        throw new Error('Lacks permission to assign role ' + roleId)
+      }
     } else {
       const ownRole = await this.getRole(this.#ownDeviceId)
       if (!ownRole.roleAssignment.includes(roleId)) {

package/src/schema/client.js

@@ -7,9 +7,10 @@ import { jsonSchemaToDrizzleColumns as toColumns } from './schema-to-drizzle.js'
 import { backlinkTable, customJson } from './utils.js'
 
 /**
+ * @import { ProjectSettings } from '@comapeo/schema'
+ *
  * @internal
- * @typedef {object} ProjectInfo
- * @prop {string} [name]
+ * @typedef {Pick<ProjectSettings, 'name' | 'projectColor' | 'projectDescription'>} ProjectInfo
  */
 
 const projectInfoColumn =

package/src/sync/sync-api.js

@@ -99,12 +99,14 @@ export class SyncApi extends TypedEmitter {
   #getReplicationStream
   /** @type {Map<string, WebSocket>} */
   #serverWebsockets = new Map()
+  #makeWebsocket
 
   /**
    * @param {object} opts
    * @param {import('../core-manager/index.js').CoreManager} opts.coreManager
    * @param {CoreOwnership} opts.coreOwnership
    * @param {import('../roles.js').Roles} opts.roles
+   * @param {(url: string) => WebSocket} [opts.makeWebsocket]
    * @param {() => Promise<Iterable<string>>} opts.getServerWebsocketUrls
    * @param {() => ReplicationStream} opts.getReplicationStream
    * @param {import('../blob-store/index.js').BlobStore} opts.blobStore
@@ -115,6 +117,7 @@ export class SyncApi extends TypedEmitter {
     coreManager,
     throttleMs = 200,
     roles,
+    makeWebsocket = (url) => new WebSocket(url),
     getServerWebsocketUrls,
     getReplicationStream,
     logger,
@@ -126,6 +129,7 @@ export class SyncApi extends TypedEmitter {
     this.#coreManager = coreManager
     this.#coreOwnership = coreOwnership
     this.#roles = roles
+    this.#makeWebsocket = makeWebsocket
     this.#getServerWebsocketUrls = getServerWebsocketUrls
     this.#getReplicationStream = getReplicationStream
     this[kSyncState] = new SyncState({
@@ -332,7 +336,7 @@ export class SyncApi extends TypedEmitter {
             continue
           }
 
-          const websocket = new WebSocket(url)
+          const websocket = this.#makeWebsocket(url)
 
           /** @param {Error} err */
           const onWebsocketError = (err) => {
@@ -354,7 +358,7 @@ export class SyncApi extends TypedEmitter {
           websocket.on('unexpected-response', onWebsocketUnexpectedResponse)
 
           const replicationStream = this.#getReplicationStream()
-          wsCoreReplicator(websocket, replicationStream)
+          wsCoreReplicator(websocket, replicationStream).catch(noop)
 
           this.#serverWebsockets.set(url, websocket)
           websocket.once('close', () => {