feat: add project.leave() #410
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,14 +6,15 @@ import { drizzle } from 'drizzle-orm/better-sqlite3' | |
| import { migrate } from 'drizzle-orm/better-sqlite3/migrator' | ||
| import { discoveryKey } from 'hypercore-crypto' | ||
| import { TypedEmitter } from 'tiny-typed-emitter' | ||
| import { eq } from 'drizzle-orm' | ||
|
|
||
| import { CoreManager, NAMESPACES } from './core-manager/index.js' | ||
| import { DataStore } from './datastore/index.js' | ||
| import { DataType, 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' | ||
| import { projectKeysTable, projectSettingsTable } from './schema/client.js' | ||
| import { | ||
| coreOwnershipTable, | ||
| deviceInfoTable, | ||
|
|
@@ -28,9 +29,17 @@ import { | |
| getWinner, | ||
| mapAndValidateCoreOwnership, | ||
| } from './core-ownership.js' | ||
| import { | ||
| BLOCKED_ROLE_ID, | ||
| COORDINATOR_ROLE_ID, | ||
| CREATOR_CAPABILITIES, | ||
| Capabilities, | ||
| DEFAULT_CAPABILITIES, | ||
| LEFT_ROLE_ID, | ||
| } from './capabilities.js' | ||
| import { | ||
| getDeviceId, | ||
| projectIdToNonce, | ||
| projectKeyToId, | ||
| projectKeyToPublicId, | ||
| valueOf, | ||
|
|
@@ -39,6 +48,7 @@ import { MemberApi } from './member-api.js' | |
| import { SyncApi, kHandleDiscoveryKey } from './sync/sync-api.js' | ||
| import { Logger } from './logger.js' | ||
| import { IconApi } from './icon-api.js' | ||
| import { ProjectKeys } from './generated/keys.js' | ||
|
|
||
| /** @typedef {Omit<import('@mapeo/schema').ProjectSettingsValue, 'schemaName'>} EditableProjectSettings */ | ||
|
|
||
|
|
@@ -71,6 +81,10 @@ export class MapeoProject extends TypedEmitter { | |
| #iconApi | ||
| #syncApi | ||
| #l | ||
| #sharedDb | ||
| #keyManager | ||
| #projectSecretKey | ||
| #encryptionKeys | ||
|
|
||
| static EMPTY_PROJECT_SETTINGS = EMPTY_PROJECT_SETTINGS | ||
|
|
||
|
|
@@ -81,7 +95,7 @@ export class MapeoProject extends TypedEmitter { | |
| * @param {import('@mapeo/crypto').KeyManager} opts.keyManager mapeo/crypto KeyManager instance | ||
| * @param {Buffer} opts.projectKey 32-byte public key of the project creator core | ||
| * @param {Buffer} [opts.projectSecretKey] 32-byte secret key of the project creator core | ||
| * @param {import('./generated/keys.js').EncryptionKeys} opts.encryptionKeys Encryption keys for each namespace | ||
| * @param {import('drizzle-orm/better-sqlite3').BetterSQLite3Database} opts.sharedDb | ||
| * @param {IndexWriter} opts.sharedIndexWriter | ||
| * @param {import('./types.js').CoreStorage} opts.coreStorage Folder to store all hypercore data | ||
|
|
@@ -108,7 +122,11 @@ export class MapeoProject extends TypedEmitter { | |
|
|
||
| this.#l = Logger.create('project', logger) | ||
| this.#deviceId = getDeviceId(keyManager) | ||
| this.#keyManager = keyManager | ||
| this.#projectId = projectKeyToId(projectKey) | ||
| this.#projectSecretKey = projectSecretKey | ||
| this.#encryptionKeys = encryptionKeys | ||
| this.#sharedDb = sharedDb | ||
|
|
||
| ///////// 1. Setup database | ||
| this.#sqlite = new Database(dbPath) | ||
|
|
@@ -250,7 +268,6 @@ export class MapeoProject extends TypedEmitter { | |
| deviceId: this.#deviceId, | ||
| capabilities: this.#capabilities, | ||
| coreOwnership: this.#coreOwnership, | ||
| encryptionKeys, | ||
| projectKey, | ||
| rpc: localPeers, | ||
|
|
@@ -548,6 +565,59 @@ export class MapeoProject extends TypedEmitter { | |
| get $icons() { | ||
| return this.#iconApi | ||
| } | ||
|
|
||
| async $leave() { | ||
| await assertDeviceCanLeaveProject(this.#deviceId, this.#capabilities) | ||
|
|
||
| // update client database (delete all encryption keys except auth) | ||
| const encoded = ProjectKeys.encode({ | ||
| projectKey: Buffer.from(this.#projectId, 'hex'), | ||
| projectSecretKey: this.#projectSecretKey, | ||
| encryptionKeys: { auth: this.#encryptionKeys.auth }, | ||
| }).finish() | ||
|
|
||
| const nonce = projectIdToNonce(this.#projectId) | ||
|
|
||
| // 1. Update relevant shared database tables | ||
| this.#sharedDb | ||
| .update(projectKeysTable) | ||
| .set({ | ||
| keysCipher: this.#keyManager.encryptLocalMessage( | ||
| Buffer.from(encoded.buffer, encoded.byteOffset, encoded.byteLength), | ||
| nonce | ||
| ), | ||
| }) | ||
| .where(eq(projectKeysTable.projectId, this.#projectId)) | ||
| .run() | ||
|
|
||
| this.#sharedDb | ||
| .delete(projectSettingsTable) | ||
| .where(eq(projectSettingsTable.docId, this.#projectId)) | ||
| .run() | ||
|
There was a problem hiding this comment. I think this makes sense but not entirely sure. My assumption is that once you leave a project, you shouldn't be able to access this kind of information, but maybe that's too strict in this case? |
||
|
|
||
| // 2. Clear data from cores | ||
| // TODO: only clear synced data | ||
| const namespacesWithoutAuth = | ||
| /** @satisfies {Exclude<import('./core-manager/index.js').Namespace, 'auth'>[]} */ ([ | ||
| 'config', | ||
| 'data', | ||
| 'blob', | ||
| 'blobIndex', | ||
| ]) | ||
|
|
||
| await Promise.all( | ||
| namespacesWithoutAuth.map((namespace) => | ||
| this.#coreManager.deleteData(namespace, { deleteOwn: true }) | ||
| ) | ||
| ) | ||
|
|
||
| // 3. Clear data from project database | ||
|
There was a problem hiding this comment. Haven't implemented yet because I have questions about how this should be done. Is it just a naive Wondering if the deletion of data in sqlite should be handled by something like |
||
|
|
||
| // TODO: update sync mode to "unsynced-data-background-sync"? | ||
|
|
||
| // 4. Assign LEFT role for device | ||
| await this.#capabilities.assignRole(this.#deviceId, LEFT_ROLE_ID) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -603,3 +673,43 @@ function mapAndValidateDeviceInfo(doc, { coreDiscoveryKey }) { | |
| } | ||
| return doc | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} deviceId | ||
| * @param {import('./capabilities.js').Capabilities} capabilities | ||
| */ | ||
| async function assertDeviceCanLeaveProject(deviceId, capabilities) { | ||
| const deviceIdToCaps = await capabilities.getAll() | ||
|
|
||
| const deviceIdToCapsList = Object.entries(deviceIdToCaps) | ||
|
|
||
| if (deviceId in deviceIdToCaps) { | ||
| if (deviceIdToCapsList.length === 1) { | ||
| throw new Error('Cannot leave a project as the only device') | ||
| } | ||
|
|
||
| if ( | ||
| deviceIdToCaps[deviceId].name === | ||
|
There was a problem hiding this comment. Doing this comparison on I think what we need here is to do There was a problem hiding this comment. this is getting trickier than expected. feels like I'm doing some logic that's done by There was a problem hiding this comment. never mind, I figured it out 😄 addressed via 5fab0af |
||
| DEFAULT_CAPABILITIES[BLOCKED_ROLE_ID].name | ||
achou11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) { | ||
| throw new Error('Cannot leave a project as a blocked device') | ||
| } | ||
| } | ||
|
|
||
| for (const [id, cap] of deviceIdToCapsList) { | ||
| // Skip check for device of interest, which is done prior to this loop | ||
| if (id === deviceId) continue | ||
|
|
||
| // Device is only allowed to leave a project | ||
| // if some other known creator or coordinator exists | ||
| const isCoordinator = | ||
| cap.name === DEFAULT_CAPABILITIES[COORDINATOR_ROLE_ID].name | ||
| const isCreator = cap.name === CREATOR_CAPABILITIES.name | ||
|
|
||
| if (isCoordinator || isCreator) return | ||
| } | ||
|
|
||
| throw new Error( | ||
| 'Cannot leave a project that does not have an external creator or another coordinator' | ||
| ) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The more I'm looking at this, the more it seems that this change isn't necessary (i.e. NO_ROLE being able to assign LEFT), but would like confirmation before undoing