Skip to content

Commit

Permalink
feat: integrate sync and project invites (#362)
Browse files Browse the repository at this point in the history
* WIP initial work

* rename Rpc to LocalPeers

* Handle deviceInfo internally, id -> deviceId

* Tests for stream error handling

* remove unnecessary constructor

* return replication stream

* Attach protomux instance to peer info

* rename and re-organize

* revert changes outside scope of PR

* WIP initial work

* Tie everything together

* rename getProjectInstance

* feat: client.listLocalPeers() & `local-peers` evt

* feat: add $sync API methods

For now this simplifies the API (because we are only supporting local
sync, not remote sync over the internet) to:

- `project.$sync.getState()`
- `project.$sync.start()`
- `project.$sync.stop()`
- Events
    - `sync-state`

It's currently not possible to stop local discovery, nor is it possible
to stop sync of the metadata namespaces (auth, config, blobIndex). The
start and stop methods stop the sync of the data and blob namespaces.

Fixes #134. Stacked on #360, #358 and #356.

* feat: Add project.$waitForInitialSync() method

Fixes Add project method to download auth + config cores #233

Rather than call this inside the `client.addProject()` method, instead I
think it is better for the API consumer to call
`project.$waitForInitialSync()` after adding a project, since this
allows the implementer to give user feedback about what is happening.

* Wait for initial sync within  addProject()

* fix: don't add core bitfield until core is ready

* feat: expose deviceId on coreManager

* fix: wait for project.ready() in waitForInitialSync

* fix: skip waitForSync in tests

* don't enable/disable namespace if not needed

* start core download when created via sparse: false

* Add debug logging

This was a big lift, but necessary to be able to debug sync issues since
temporarily adding console.log statements was too much work, and
debugging requires knowing the deviceId associated with each message.

* fix timeout

* fix: Add new cores to the indexer (!!!)

This caused a day of work: a bug from months back

* remove unnecessary log stmt

* get capabilities.getMany() to include creator

* fix invite test

* keep blob cores sparse

* optional param for LocalPeers

* re-org sync and replication

Removes old replication code attached to CoreManager
Still needs tests to be updated

* update package-lock

* chore: Add debug logging

* Add new logger to discovery + dnssd

* Get invite test working

* fix manager logger

* cleanup invite test (and make it fail :(

* fix: handle duplicate connections to LocalPeers

* fix stream close before channel open

* send invite to non-existent peer

* fixed fake timers implementation for tests

* new tests for duplicate connections

* cleanup and small fix

* Better state debug logging

* chain of invites test

* fix max listeners and add skipped test

* fix: only request a core key from one peer

Reduces the number of duplicate requests for the same keys.

* cleanup members tests with new helprs

* wait for project ready when adding

* only create 4 clients for chain of invites test

* add e2e sync tests

* add published @mapeo/mock-data

* fix: don't open cores in sparse mode

Turns out this changes how core.length etc. work, which confuses things

* fix: option to skip auto download for tests

* e2e test for stop-start sync

* fix coreManager unit tests

* fix blob store tests

* fix discovery-key event

* add coreCount to sync state

* test sync with blocked peer & fix bugs

* fix datatype unit tests

* fix blobs server unit tests

* remote peer-sync-controller unit test

This is now tested in e2e tests

* fix type issues caused by bad lockfile

* ignore debug type errors

* fixes for review comments

* move utils-new into utils

* Add debug info to test that sometimes fails

* Update package-lock.json version

---------

Co-authored-by: Andrew Chou <[email protected]>
  • Loading branch information
gmaclennan and achou11 authored Nov 28, 2023
1 parent 46c0c52 commit aa30f75
Show file tree
Hide file tree
Showing 32 changed files with 1,618 additions and 1,088 deletions.
148 changes: 145 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"devDependencies": {
"@bufbuild/buf": "^1.26.1",
"@hyperswarm/testnet": "^3.1.2",
"@mapeo/mock-data": "^1.0.1",
"@sinonjs/fake-timers": "^10.0.2",
"@types/b4a": "^1.6.0",
"@types/debug": "^4.1.8",
Expand All @@ -92,6 +93,7 @@
"prettier": "^2.8.8",
"random-access-file": "^4.0.4",
"random-access-memory": "^6.2.0",
"random-bytes-readable-stream": "^3.0.0",
"rimraf": "^5.0.1",
"streamx": "^2.15.1",
"tempy": "^3.1.0",
Expand Down
10 changes: 8 additions & 2 deletions src/capabilities.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ export class Capabilities {
#projectCreatorAuthCoreId
#ownDeviceId

static NO_ROLE_CAPABILITIES = NO_ROLE_CAPABILITIES

/**
*
* @param {object} opts
Expand Down Expand Up @@ -209,17 +211,21 @@ export class Capabilities {
*/
async getAll() {
const roles = await this.#dataType.getMany()
/** @type {Record<string, Capability>} */
const capabilities = {}
let projectCreatorDeviceId
try {
projectCreatorDeviceId = await this.#coreOwnership.getOwner(
this.#projectCreatorAuthCoreId
)
// Default to creator capabilities, but can be overwritten if a different
// role is set below
capabilities[projectCreatorDeviceId] = CREATOR_CAPABILITIES
} catch (e) {
// Not found, we don't know who the project creator is so we can't include
// them in the returned map
}
/** @type {Record<string, Capability>} */
const capabilities = {}

for (const role of roles) {
const deviceId = role.docId
if (!isKnownRoleId(role.roleId)) continue
Expand Down
Loading

0 comments on commit aa30f75

Please sign in to comment.