@dxos/client-services 0.5.9-main.bdf733d → 0.5.9-main.bf0ae3e

package/src/packlets/spaces/data-space-manager.ts

@@ -4,7 +4,8 @@
 
 import { Event, synchronized, trackLeaks } from '@dxos/async';
 import { type Doc } from '@dxos/automerge/automerge';
-import { type AutomergeUrl } from '@dxos/automerge/automerge-repo';
+import { type DocHandle, type AutomergeUrl } from '@dxos/automerge/automerge-repo';
+import { PropertiesType } from '@dxos/client-protocol';
 import { cancelWithContext, Context } from '@dxos/context';
 import {
   type CredentialSigner,
@@ -21,7 +22,8 @@ import {
   type SpaceProtocol,
   type SpaceProtocolSession,
 } from '@dxos/echo-pipeline';
-import { type SpaceDoc } from '@dxos/echo-protocol';
+import { encodeReference, type ObjectStructure, type SpaceDoc } from '@dxos/echo-protocol';
+import { getTypeReference } from '@dxos/echo-schema';
 import { type FeedStore } from '@dxos/feed-store';
 import { invariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
@@ -37,7 +39,7 @@ import { type PeerState } from '@dxos/protocols/proto/dxos/mesh/presence';
 import { Gossip, Presence } from '@dxos/teleport-extension-gossip';
 import { type Timeframe } from '@dxos/timeframe';
 import { trace } from '@dxos/tracing';
-import { ComplexMap, deferFunction, forEachAsync } from '@dxos/util';
+import { assignDeep, ComplexMap, deferFunction, forEachAsync } from '@dxos/util';
 
 import { DataSpace, findPropertiesObject } from './data-space';
 import { spaceGenesis } from './genesis';
@@ -47,6 +49,9 @@ import { type InvitationsManager } from '../invitations';
 const PRESENCE_ANNOUNCE_INTERVAL = 10_000;
 const PRESENCE_OFFLINE_TIMEOUT = 20_000;
 
+// Space properties key for default metadata.
+const DEFAULT_SPACE_KEY = '__DEFAULT__';
+
 export interface SigningContext {
   identityKey: PublicKey;
   deviceKey: PublicKey;
@@ -88,8 +93,6 @@ export class DataSpaceManager {
 
   private _isOpen = false;
   private readonly _instanceId = PublicKey.random().toHex();
-  private readonly _spaceMemberPresenceAnnounceInterval: number;
-  private readonly _spaceMemberPresenceOfflineTimeout: number;
 
   constructor(
     private readonly _spaceManager: SpaceManager,
@@ -99,15 +102,8 @@ export class DataSpaceManager {
     private readonly _feedStore: FeedStore<FeedMessage>,
     private readonly _echoHost: EchoHost,
     private readonly _invitationsManager: InvitationsManager,
-    params?: DataSpaceManagerRuntimeParams,
+    private readonly _params?: DataSpaceManagerRuntimeParams,
   ) {
-    const {
-      spaceMemberPresenceAnnounceInterval = PRESENCE_ANNOUNCE_INTERVAL,
-      spaceMemberPresenceOfflineTimeout = PRESENCE_OFFLINE_TIMEOUT,
-    } = params ?? {};
-    this._spaceMemberPresenceAnnounceInterval = spaceMemberPresenceAnnounceInterval;
-    this._spaceMemberPresenceOfflineTimeout = spaceMemberPresenceOfflineTimeout;
-
     trace.diagnostic({
       id: 'spaces',
       name: 'Spaces',
@@ -157,12 +153,6 @@ export class DataSpaceManager {
     this._isOpen = true;
     this.updated.emit();
 
-    for (const space of this._spaces.values()) {
-      if (space.state !== SpaceState.INACTIVE) {
-        space.initializeDataPipelineAsync();
-      }
-    }
-
     log.trace('dxos.echo.data-space-manager.open', Trace.end({ id: this._instanceId }));
   }
 
@@ -174,6 +164,7 @@ export class DataSpaceManager {
     for (const space of this._spaces.values()) {
       await space.close();
     }
+    this._spaces.clear();
   }
 
   /**
@@ -197,6 +188,7 @@ export class DataSpaceManager {
 
     const root = await this._echoHost.createSpaceRoot(spaceKey);
     const space = await this._constructSpace(metadata);
+    await space.open();
 
     const credentials = await spaceGenesis(this._keyring, this._signingContext, space.inner, root.url);
     await this._metadataStore.addSpace(metadata);
@@ -211,6 +203,46 @@ export class DataSpaceManager {
     return space;
   }
 
+  async isDefaultSpace(space: DataSpace): Promise<boolean> {
+    const rootDoc = await this._getSpaceRootDocument(space);
+    const [_, properties] = findPropertiesObject(rootDoc.docSync()) ?? [];
+    return properties?.data?.[DEFAULT_SPACE_KEY] === this._signingContext.identityKey.toHex();
+  }
+
+  async createDefaultSpace() {
+    const space = await this.createSpace();
+    const document = await this._getSpaceRootDocument(space);
+
+    // TODO(dmaretskyi): Better API for low-level data access.
+    const properties: ObjectStructure = {
+      system: {
+        type: encodeReference(getTypeReference(PropertiesType)!),
+      },
+      data: {
+        [DEFAULT_SPACE_KEY]: this._signingContext.identityKey.toHex(),
+      },
+      meta: {
+        keys: [],
+      },
+    };
+
+    const propertiesId = PublicKey.random().toHex();
+    document.change((doc: SpaceDoc) => {
+      assignDeep(doc, ['objects', propertiesId], properties);
+    });
+
+    await this._echoHost.flush();
+    return space;
+  }
+
+  private async _getSpaceRootDocument(space: DataSpace): Promise<DocHandle<SpaceDoc>> {
+    const automergeIndex = space.automergeSpaceState.rootUrl;
+    invariant(automergeIndex);
+    const document = this._echoHost.automergeRepo.find<SpaceDoc>(automergeIndex as any);
+    await document.whenReady();
+    return document;
+  }
+
   // TODO(burdon): Rename join space.
   @synchronized
   async acceptSpace(opts: AcceptSpaceOptions): Promise<DataSpace> {
@@ -226,6 +258,7 @@ export class DataSpaceManager {
     };
 
     const space = await this._constructSpace(metadata);
+    await space.open();
     await this._metadataStore.addSpace(metadata);
     space.initializeDataPipelineAsync();
 
@@ -254,8 +287,8 @@ export class DataSpaceManager {
       localPeerId: this._signingContext.deviceKey,
     });
     const presence = new Presence({
-      announceInterval: this._spaceMemberPresenceAnnounceInterval,
-      offlineTimeout: this._spaceMemberPresenceOfflineTimeout,
+      announceInterval: this._params?.spaceMemberPresenceAnnounceInterval ?? PRESENCE_ANNOUNCE_INTERVAL,
+      offlineTimeout: this._params?.spaceMemberPresenceOfflineTimeout ?? PRESENCE_OFFLINE_TIMEOUT,
       identityKey: this._signingContext.identityKey,
       gossip,
     });
@@ -336,10 +369,6 @@ export class DataSpaceManager {
       }
     });
 
-    if (metadata.state !== SpaceState.INACTIVE) {
-      await dataSpace.open();
-    }
-
     if (metadata.controlTimeframe) {
       dataSpace.inner.controlPipeline.state.setTargetTimeframe(metadata.controlTimeframe);
     }

package/src/packlets/spaces/data-space.ts

@@ -76,6 +76,7 @@ export type DataSpaceParams = {
 
 export type CreateEpochOptions = {
   migration?: CreateEpochRequest.Migration;
+  newAutomergeRoot?: string;
 };
 
 @trackLeaks('open', 'close')
@@ -192,10 +193,13 @@ export class DataSpace {
 
   @synchronized
   async open() {
-    await this._open();
+    if (this._state === SpaceState.CLOSED) {
+      await this._open();
+    }
   }
 
   private async _open() {
+    await this._presence.open();
     await this._gossip.open();
     await this._notarizationPlugin.open();
     await this._inner.spaceState.addCredentialProcessor(this._notarizationPlugin);
@@ -227,7 +231,7 @@ export class DataSpace {
     await this._inner.spaceState.removeCredentialProcessor(this._notarizationPlugin);
     await this._notarizationPlugin.close();
 
-    await this._presence.destroy();
+    await this._presence.close();
     await this._gossip.close();
   }
 
@@ -452,6 +456,7 @@ export class DataSpace {
           const rootHandle = this._echoHost.automergeRepo.find(currentRootUrl as any);
           await cancelWithContext(this._ctx, asyncTimeout(rootHandle.whenReady(), 10_000));
           const newRoot = this._echoHost.automergeRepo.create(rootHandle.docSync());
+          await this._echoHost.automergeRepo.flush([newRoot.documentId]);
           invariant(typeof newRoot.url === 'string' && newRoot.url.length > 0);
           // TODO(dmaretskyi): Unify epoch construction.
           epoch = {
@@ -507,6 +512,18 @@ export class DataSpace {
           };
         }
         break;
+      case CreateEpochRequest.Migration.REPLACE_AUTOMERGE_ROOT:
+        {
+          invariant(options.newAutomergeRoot);
+          // TODO(dmaretskyi): Unify epoch construction.
+          epoch = {
+            previousId: this._automergeSpaceState.lastEpoch?.id,
+            number: (this._automergeSpaceState.lastEpoch?.subject.assertion.number ?? -1) + 1,
+            timeframe: this._automergeSpaceState.lastEpoch?.subject.assertion.timeframe ?? new Timeframe(),
+            automergeRoot: options.newAutomergeRoot,
+          };
+        }
+        break;
     }
 
     if (!epoch) {
@@ -526,11 +543,12 @@ export class DataSpace {
     });
 
     await this.inner.controlPipeline.state.waitUntilTimeframe(new Timeframe([[receipt.feedKey, receipt.seq]]));
+    await this._echoHost.updateIndexes();
   }
 
   @synchronized
   async activate() {
-    if (this._state !== SpaceState.INACTIVE) {
+    if (![SpaceState.CLOSED, SpaceState.INACTIVE].includes(this._state)) {
       return;
     }
 
@@ -544,10 +562,11 @@ export class DataSpace {
     if (this._state === SpaceState.INACTIVE) {
       return;
     }
-
     // Unregister from data service.
     await this._metadataStore.setSpaceState(this.key, SpaceState.INACTIVE);
-    await this._close();
+    if (this._state !== SpaceState.CLOSED) {
+      await this._close();
+    }
     this._state = SpaceState.INACTIVE;
     log('new state', { state: SpaceState[this._state] });
     this.stateUpdate.emit();

package/src/packlets/spaces/spaces-service.ts

@@ -208,10 +208,10 @@ export class SpacesServiceImpl implements SpacesService {
     }
   }
 
-  async createEpoch({ spaceKey, migration }: CreateEpochRequest) {
+  async createEpoch({ spaceKey, migration, automergeRootUrl }: CreateEpochRequest) {
     const dataSpaceManager = await this._getDataSpaceManager();
     const space = dataSpaceManager.spaces.get(spaceKey) ?? raise(new SpaceNotFoundError(spaceKey));
-    await space.createEpoch({ migration });
+    await space.createEpoch({ migration, newAutomergeRoot: automergeRootUrl });
   }
 
   private _serializeSpace(space: DataSpace): Space {

package/src/packlets/testing/test-builder.ts

@@ -19,8 +19,8 @@ import { createStorage, StorageType, type Storage } from '@dxos/random-access-st
 import { BlobStore } from '@dxos/teleport-extension-object-sync';
 
 import { InvitationsHandler, InvitationsManager, SpaceInvitationProtocol } from '../invitations';
-import { ClientServicesHost, ServiceContext } from '../services';
-import { DataSpaceManager, type SigningContext } from '../spaces';
+import { ClientServicesHost, ServiceContext, type ServiceContextRuntimeParams } from '../services';
+import { DataSpaceManager, type DataSpaceManagerRuntimeParams, type SigningContext } from '../spaces';
 
 //
 // TODO(burdon): Replace with test builder.
@@ -37,9 +37,11 @@ export const createServiceHost = (config: Config, signalManagerContext: MemorySi
 export const createServiceContext = async ({
   signalContext = new MemorySignalManagerContext(),
   storage = createStorage({ type: StorageType.RAM }),
+  runtimeParams,
 }: {
   signalContext?: MemorySignalManagerContext;
   storage?: Storage;
+  runtimeParams?: ServiceContextRuntimeParams;
 } = {}) => {
   const signalManager = new MemorySignalManager(signalContext);
   const networkManager = new SwarmNetworkManager({
@@ -51,6 +53,7 @@ export const createServiceContext = async ({
 
   return new ServiceContext(storage, level, networkManager, signalManager, {
     invitationConnectionDefaultParams: { controlHeartbeatInterval: 200 },
+    ...runtimeParams,
   });
 };
 
@@ -88,6 +91,7 @@ export class TestBuilder {
 
 export type TestPeerOpts = {
   dataStore?: StorageType;
+  dataSpaceParams?: DataSpaceManagerRuntimeParams;
 };
 
 export type TestPeerProps = {
@@ -110,8 +114,8 @@ export class TestPeer {
   private _props: TestPeerProps = {};
 
   constructor(
-    private readonly signalContext: MemorySignalManagerContext,
-    private readonly opts: TestPeerOpts = { dataStore: StorageType.RAM },
+    private readonly _signalContext: MemorySignalManagerContext,
+    private readonly _opts: TestPeerOpts = { dataStore: StorageType.RAM },
   ) {}
 
   get props() {
@@ -119,7 +123,7 @@ export class TestPeer {
   }
 
   get storage() {
-    return (this._props.storage ??= createStorage({ type: this.opts.dataStore }));
+    return (this._props.storage ??= createStorage({ type: this._opts.dataStore }));
   }
 
   get keyring() {
@@ -156,7 +160,7 @@ export class TestPeer {
 
   get networkManager() {
     return (this._props.networkManager ??= new SwarmNetworkManager({
-      signalManager: new MemorySignalManager(this.signalContext),
+      signalManager: new MemorySignalManager(this._signalContext),
       transportFactory: MemoryTransportFactory,
     }));
   }
@@ -176,10 +180,7 @@ export class TestPeer {
   }
 
   get echoHost() {
-    return (this._props.echoHost ??= new EchoHost({
-      kv: this.level,
-      storage: this.storage,
-    }));
+    return (this._props.echoHost ??= new EchoHost({ kv: this.level }));
   }
 
   get dataSpaceManager(): DataSpaceManager {
@@ -191,6 +192,7 @@ export class TestPeer {
       this.feedStore,
       this.echoHost,
       this.invitationsManager,
+      this._opts.dataSpaceParams,
     ));
   }
 

package/src/version.ts

@@ -1 +1 @@
-export const DXOS_VERSION = "0.5.9-main.bdf733d";
+export const DXOS_VERSION = "0.5.9-main.bf0ae3e";