@dxos/protocols 0.1.23 → 0.1.24-next.6b1f434

package/src/proto/dxos/config.proto

@@ -5,6 +5,7 @@
 syntax = "proto3";
 
 import "google/protobuf/any.proto";
+import "google/protobuf/struct.proto";
 
 package dxos.config;
 
@@ -43,11 +44,14 @@ message Module {
     optional string outdir = 2;
     optional string version = 3;
     optional string tag = 4;
+
+    optional google.protobuf.Struct env = 10;
   }
 
-  // TODO(burdon): Requires publicKey.
-  optional string name = 1;
-  optional string type = 2;
+  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
+  optional string id = 8;     // TODO(burdon): Ensured FQ (e.g., 'dxos.app.xxx')
+  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos:type/frame' vs. 'dxos.type.frame')
+
   optional string display_name = 3;
   optional string description = 4;
   repeated string tags = 5;
@@ -83,7 +87,12 @@ message Runtime {
       optional string path = 4;                   // TODO(burdon): Rename data_path.
     }
 
-    optional string debug = 1 [(env) = "DEBUG"];  // TODO(burdon): Change to LOG.
+    message Log {
+      optional string filter = 1 [(env) = "LOG_FILTER"];
+      optional string prefix = 2 [(env) = "LOG_PREFIX"];
+    }
+
+    optional Log log = 1;
     optional Storage storage = 2;
 
     // TODO(burdon): Structure snapshot/epoch related props.
@@ -95,15 +104,26 @@ message Runtime {
     /// Milliseconds
     optional int32 invitation_expiration = 5;
 
-    // TODO(burdon): Remove?
+    /// Location of the remote client host.
     optional string remote_source = 6;
   }
 
   message App {
+    message BuildInfo {
+      /// RFC-3339 datetime string.
+      optional string timestamp = 1;
+      optional string commit_hash = 2;
+      /// Version from package.json.
+      optional string version = 3;
+    }
+
     optional string org = 1;
     optional string theme = 2;
     optional string website = 3;
     optional string public_url = 4 [(env) = "PUBLIC_URL"];
+
+    optional BuildInfo build = 100;
+    optional google.protobuf.Struct env = 101;
   }
 
   // CLI configuration
@@ -303,6 +323,11 @@ message Runtime {
     optional Publisher publisher = 9;
   }
 
+  message Keys {
+    optional string name = 1;
+    optional string value = 2;
+  }
+
   optional Client client = 1;
   optional App app = 2;
   optional CLI cli = 3;
@@ -310,4 +335,5 @@ message Runtime {
   optional Services services = 5;
   optional System system = 6;
   optional Kube kube = 7;
+  repeated Keys keys = 8;
 }

package/src/proto/dxos/devtools/host.proto

@@ -4,14 +4,17 @@
 
 syntax = "proto3";
 
-import "dxos/echo/timeframe.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
 
+import "dxos/devtools/swarm.proto";
 import "dxos/echo/feed.proto";
 import "dxos/echo/snapshot.proto";
+import "dxos/echo/timeframe.proto";
 import "dxos/halo/keyring.proto";
 import "dxos/halo/signed.proto";
 import "dxos/keys.proto";
+import "dxos/mesh/signal.proto";
 import "dxos/rpc.proto";
 
 package dxos.devtools.host;
@@ -33,6 +36,7 @@ service DevtoolsHost {
 
   rpc ResetStorage(ResetStorageRequest) returns (google.protobuf.Empty);
 
+  // TODO(burdon): Single RPC with action.
   rpc EnableDebugLogging(EnableDebugLoggingRequest) returns (EnableDebugLoggingResponse);
   rpc DisableDebugLogging(EnableDebugLoggingRequest) returns (EnableDebugLoggingResponse);
 
@@ -41,7 +45,6 @@ service DevtoolsHost {
   //
 
   rpc SubscribeToKeyringKeys(SubscribeToKeyringKeysRequest) returns (stream SubscribeToKeyringKeysResponse);
-
   rpc SubscribeToCredentialMessages(SubscribeToCredentialMessagesRequest) returns (stream SubscribeToCredentialMessagesResponse);
 
   //
@@ -64,7 +67,7 @@ service DevtoolsHost {
   rpc GetNetworkPeers(GetNetworkPeersRequest) returns (GetNetworkPeersResponse);
   rpc SubscribeToNetworkTopics(google.protobuf.Empty) returns (stream SubscribeToNetworkTopicsResponse);
   rpc SubscribeToSignalStatus(google.protobuf.Empty) returns (stream SubscribeToSignalStatusResponse);
-  rpc SubscribeToSignalTrace(google.protobuf.Empty) returns (stream SubscribeToSignalTraceResponse);
+  rpc SubscribeToSignal(google.protobuf.Empty) returns (stream SignalResponse);
   rpc SubscribeToSwarmInfo(SubscribeToSwarmInfoRequest) returns (stream SubscribeToSwarmInfoResponse);
 }
 
@@ -81,7 +84,9 @@ message GetConfigResponse {
   string config = 1;
 }
 
-// EnableDebugLogging
+//
+// Logging
+//
 
 message EnableDebugLoggingRequest {
   optional string namespaces = 1;
@@ -91,8 +96,6 @@ message EnableDebugLoggingResponse {
   optional string enabled_namespaces = 1;
 }
 
-// DisableDebugLogging
-
 message DisableDebugLoggingRequest {
   optional string namespaces = 1;
 }
@@ -101,7 +104,9 @@ message DisableDebugLoggingResponse {
   optional string enabled_namespaces = 1;
 }
 
-// SubscribeToKeyringKeys
+//
+// Keys
+//
 
 message SubscribeToKeyringKeysRequest {}
 
@@ -109,7 +114,9 @@ message SubscribeToKeyringKeysResponse {
   repeated dxos.halo.keyring.KeyRecord keys = 1;
 }
 
-// SubscribeToCredential
+//
+// Credentials
+//
 
 message SubscribeToCredentialMessagesRequest {
   optional dxos.keys.PublicKey space_key = 1;
@@ -119,30 +126,15 @@ message SubscribeToCredentialMessagesResponse {
   repeated dxos.halo.signed.SignedMessage messages = 1;
 }
 
-// ResetStorage
+//
+// Storage
+//
 
 message ResetStorageRequest {}
 
-// GetNetworkPeers
-
-message GetNetworkPeersRequest {
-  bytes topic = 1;
-}
-
-message GetNetworkPeersResponse {
-  message PeerInfo {
-   dxos.keys.PublicKey id = 1;
-
-    // PeerState enum.
-    string state = 2;
-
-    repeated bytes connections = 3;
-  }
-
-  repeated PeerInfo peers = 1;
-}
-
-// SubscribeToSpaces
+//
+// Spaces
+//
 
 message SubscribeToSpacesRequest {
   repeated dxos.keys.PublicKey space_keys = 1;
@@ -153,15 +145,18 @@ message SubscribeToSpacesResponse {
     dxos.keys.PublicKey key = 1;
     bool is_open = 2;
     optional dxos.echo.timeframe.TimeframeVector timeframe = 3;
-    dxos.keys.PublicKey genesisFeed = 4;
-    dxos.keys.PublicKey controlFeed = 5;
-    dxos.keys.PublicKey dataFeed = 6;
+    dxos.keys.PublicKey genesis_feed = 4;
+    dxos.keys.PublicKey control_feed = 5;
+    dxos.keys.PublicKey data_feed = 6;
+
   }
 
   repeated SpaceInfo spaces = 1;
 }
 
-// SubscribeToItems
+//
+// Items
+//
 
 message SubscribeToItemsRequest {}
 
@@ -170,23 +165,24 @@ message SubscribeToItemsResponse {
   string data = 1;
 }
 
-// SubscribeToFeeds
+//
+// Feeds
+//
 
+// TODO(burdon): How to filter by space?
 message SubscribeToFeedsRequest {
   repeated dxos.keys.PublicKey feed_keys = 1;
 }
 
 message SubscribeToFeedsResponse {
   message Feed {
-   dxos.keys.PublicKey feed_key = 1;
+    dxos.keys.PublicKey feed_key = 1;
     int32 length = 2;
   }
 
   repeated Feed feeds = 1;
 }
 
-// SubscribeToFeedMessages
-
 message SubscribeToFeedBlocksRequest {
   optional dxos.keys.PublicKey space_key = 1;
   optional dxos.keys.PublicKey feed_key = 2;
@@ -203,7 +199,9 @@ message SubscribeToFeedBlocksResponse {
   repeated Block blocks = 1;
 }
 
-// GetSpaceSnapshot
+//
+// Snapshots
+//
 
 message GetSpaceSnapshotRequest {
   dxos.keys.PublicKey space_key = 1;
@@ -213,8 +211,6 @@ message GetSpaceSnapshotResponse {
   optional dxos.echo.snapshot.SpaceSnapshot snapshot = 1;
 }
 
-// SaveSpaceSnapshot
-
 message SaveSpaceSnapshotRequest {
   dxos.keys.PublicKey space_key = 1;
 }
@@ -223,11 +219,28 @@ message SaveSpaceSnapshotResponse {
   optional dxos.echo.snapshot.SpaceSnapshot snapshot = 1;
 }
 
-// ClearSnapshots
-
 message ClearSnapshotsRequest {}
 
-// SubscribeToNetworkTopics
+//
+// Network
+//
+
+message GetNetworkPeersRequest {
+  bytes topic = 1;
+}
+
+message GetNetworkPeersResponse {
+  message PeerInfo {
+    dxos.keys.PublicKey id = 1;
+
+    // PeerState enum.
+    string state = 2;
+
+    repeated bytes connections = 3;
+  }
+
+  repeated PeerInfo peers = 1;
+}
 
 message SubscribeToNetworkTopicsResponse {
   message Topic {
@@ -238,7 +251,9 @@ message SubscribeToNetworkTopicsResponse {
   repeated Topic topics = 1;
 }
 
-// SubscribeToSignalStatus
+//
+// Signaling
+//
 
 message SubscribeToSignalStatusResponse {
   message SignalServer {
@@ -253,27 +268,29 @@ message SubscribeToSignalStatusResponse {
     // TODO(dmaretskyi): Represent as absolute timestamp.
     int32 reconnect_in = 4;
 
-    // TODO(dmaretskyi): Change to timestamp.
-    int32 connection_started = 5;
-    int32 last_state_change = 6;
+    google.protobuf.Timestamp connection_started = 5;
+    google.protobuf.Timestamp last_state_change = 6;
   }
 
   repeated SignalServer servers = 1;
 }
 
-// SubscribeToSignalTrace
-
-message SubscribeToSignalTraceResponse {
-  // JSON-encoded events.
-  repeated string events = 1;
+message SignalResponse {
+  oneof data {
+    dxos.mesh.signal.SwarmEvent swarm_event = 1;
+    dxos.mesh.signal.Message message = 2;
+  }
+  google.protobuf.Timestamp received_at = 3;
 }
 
-// SubscribeToSwarmInfo
+//
+// Swarm
+//
 
 message SubscribeToSwarmInfoRequest {}
 
 message SubscribeToSwarmInfoResponse {
-  repeated SwarmInfo data = 1;
+  repeated dxos.devtools.swarm.SwarmInfo data = 1;
 }
 
 //
@@ -285,8 +302,6 @@ service TracingService {
   rpc SubscribeToRpcTrace (google.protobuf.Empty) returns (stream dxos.rpc.RpcMessage);
 }
 
-// SetTracingOptions
-
 message SetTracingOptionsRequest {
   bool enable = 1;
 }

package/src/proto/dxos/devtools/swarm.proto

@@ -27,6 +27,6 @@ message ConnectionInfo {
 
 message ConnectionEvent {
   string type = 1;
-  optional string newState = 2;
+  optional string new_state = 2;
   optional string error = 3;
 }

package/src/proto/dxos/echo/feed.proto

@@ -9,6 +9,7 @@ import "google/protobuf/any.proto";
 import "dxos/halo/credentials.proto";
 import "dxos/echo/snapshot.proto";
 import "dxos/echo/timeframe.proto";
+import "dxos/echo/object.proto";
 
 // TODO(burdon): Standardize position of "package" (i.e., before/after imports).
 // TODO(burdon): Move Item specific to echo.item?
@@ -20,7 +21,14 @@ package dxos.echo.feed;
  */
 message FeedMessage {
   dxos.echo.timeframe.TimeframeVector timeframe = 1;
-  google.protobuf.Any payload = 2;
+
+  message Payload{
+    oneof payload {
+      CredentialsMessage credential = 10;
+      DataMessage data = 11;
+    }
+  }
+  Payload payload = 2;
 }
 
 /**
@@ -31,53 +39,9 @@ message CredentialsMessage {
 }
 
 /**
- * Wrapper for all ECHO messages.
- */
-// TODO(burdon): Reconcile with HaloMessage (and other "Message" types).
-message EchoEnvelope {
-  string item_id = 1;
-
-  // Create item.
-  optional ItemGenesis genesis = 10;
-
-  // Item system mutations.
-  optional ItemMutation item_mutation = 11;
-
-  // Model-specific mutations.
-  optional bytes mutation = 12;
-
-  /// Set the model to the provided snapshot.
-  optional snapshot.ModelSnapshot snapshot = 13;
-}
-
-// TODO(burdon): Document (different from parent/child).?
-// TODO(dmaretskyi): Refactor so that entity mutation message is oneof between item mutation and link mutation: items have parents, and links have from/to.
-message LinkData {
-  string source = 1;
-  string target = 2;
-}
-
-/**
- * Item creation.
+ * A container ECHO database messages in data feeds.
  */
-// TODO(burdon): EntityGenesis?
-message ItemGenesis {
-  optional string item_type = 1;
-  string model_type = 2;
-  optional string model_version = 3;
-  optional LinkData link = 4;
-}
-
-/**
- * Item mutation.
- */
-message ItemMutation {
-  enum Action {
-    NOOP = 0;
-    DELETE = 1;
-    RESTORE = 2;
-  }
-
-  optional string parent_id = 1;  // TODO(burdon): Define Action type?
-  optional Action action = 2;
+message DataMessage {
+  // TODO(dmaretskyi): Batch.
+  dxos.echo.object.EchoObject object = 1;
 }

package/src/proto/dxos/echo/metadata.proto

@@ -46,8 +46,12 @@ message SpaceMetadata {
   /// Key of the wriatable data feed.
   optional dxos.keys.PublicKey data_feed_key = 3;
 
-  // Latest timeframe reached while processing space messages.
-  optional timeframe.TimeframeVector latest_timeframe = 5;
+
+  // Latest control timeframe reached while processing space messages.
+  optional timeframe.TimeframeVector control_timeframe = 8;
+
+  // Latest data timeframe reached while processing space messages.
+  optional timeframe.TimeframeVector data_timeframe = 5;
 
   optional string snapshot = 7;
 }

package/src/proto/dxos/echo/model/{object.proto → document.proto}

@@ -4,7 +4,7 @@
 
 syntax = "proto3";
 
-package dxos.echo.model.object;
+package dxos.echo.model.document;
 
 //
 // Object mutation messages.
@@ -106,7 +106,8 @@ message Query {
  * State snapshot.
  */
 message ObjectSnapshot {
-  Value root                          = 1;
+  optional string type                = 1;
+  Value root                          = 2;
 }
 
 /**
@@ -138,5 +139,6 @@ message YJS {
  * Set of mutations.
  */
 message ObjectMutationSet {
-  repeated ObjectMutation mutations   = 1;
+  optional string type = 1;
+  repeated ObjectMutation mutations   = 2;
 }

package/src/proto/dxos/echo/object.proto

@@ -0,0 +1,79 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+
+import "dxos/halo/credentials.proto";
+import "dxos/echo/timeframe.proto";
+
+package dxos.echo.object;
+
+/**
+ * Wrapper for all ECHO messages.
+ */
+message EchoObject {
+  message Genesis {
+    string model_type = 2;
+
+    optional string model_version = 3;
+  }
+
+  message Snapshot {
+    // TODO(dmaretskyi): Change to enum?
+    optional bool deleted = 1; 
+
+    optional string parent_id = 2;
+
+    /// Set the model to the provided snapshot.
+    optional google.protobuf.Any model = 10 [preserve_any = true]; 
+  }
+
+  message Mutation {
+    optional MutationMeta meta = 1;
+
+    enum Action {
+      NOOP = 0;
+      DELETE = 1;
+      RESTORE = 2;
+    }
+
+    /// Set parent id
+    optional string parent_id = 10;
+    
+    optional Action action = 11;
+
+    // Encoded model mutation, format is defined by model's codec.
+    optional google.protobuf.Any model = 12 [preserve_any = true];
+  }
+
+  string object_id = 1;
+
+  /// Metadata for the genesis mutation.
+  optional MutationMeta meta = 2;
+
+  /// Present in mutations creating new items and snapshots. 
+  optional Genesis genesis = 10;
+
+  optional Snapshot snapshot = 13;
+  
+  /// May be present in snapshots. In that case the mutations must be applied on top of the snapshot.
+  repeated Mutation mutations = 14;
+}
+
+message MutationMeta {
+  optional dxos.keys.PublicKey feed_key = 1;
+  optional int32 seq = 2;
+  optional dxos.keys.PublicKey member_key = 3;
+
+  optional timeframe.TimeframeVector timeframe = 4;
+
+  /// If this mutation was created by this client, this field will be set to the tag in the mutation.
+  optional string client_tag = 5;
+}
+
+message EchoObjectBatch {
+  repeated EchoObject objects = 1;
+}

package/src/proto/dxos/echo/service.proto

@@ -4,51 +4,35 @@
 
 syntax = "proto3";
 
-import "dxos/echo/feed.proto";
+import "dxos/echo/object.proto";
 import "dxos/echo/snapshot.proto";
 import "dxos/echo/timeframe.proto";
 import "dxos/keys.proto";
 
 package dxos.echo.service;
 
-message SubscribeEntitySetRequest {
+message SubscribeRequest {
   dxos.keys.PublicKey space_key = 1;
 }
 
-message SubscribeEntitySetResponse {
-  // TODO(dmaretskyi): This is wrong, the first one should use item snapshot, and deleted should be just list of ids.
-  repeated feed.EchoEnvelope added = 1;
-  repeated feed.EchoEnvelope deleted = 2;
-}
+message EchoEvent {
+  /// If this event comes as a response to this client wirting the mutation, this field will be set to the tag in the mutation.
+  optional string client_tag = 1;
 
-message SubscribeEntityStreamRequest {
-  dxos.keys.PublicKey space_key = 1;
-  string item_id = 2;
-}
+  /// For mutations read from the feed store those fields will be set to the position of the mutation in the feed.
+  optional dxos.keys.PublicKey feed_key = 2;
+  optional int32 seq = 3;
 
-message SubscribeEntityStreamResponse {
-  message Mutation {
-    message Metadata {
-     dxos.keys.PublicKey feed_key = 1;
-     dxos.keys.PublicKey member_key = 2;
-      int32 seq = 3;
-      timeframe.TimeframeVector timeframe = 4;
-    }
-
-    feed.EchoEnvelope data = 1;
-    Metadata meta = 2;
-  }
-
-  oneof kind {
-    // TODO(dmaretskyi): Move snapshot into EchoEnvelope?
-    snapshot.ItemSnapshot snapshot = 1;
-    Mutation mutation = 2;
-  }
+  dxos.echo.object.EchoObjectBatch batch = 10;
 }
 
 message WriteRequest {
   dxos.keys.PublicKey space_key = 1;
-  feed.EchoEnvelope mutation = 2;
+  
+  /// Ephermal tag to correlate events in the subscription.
+  optional string client_tag = 2;
+
+  dxos.echo.object.EchoObjectBatch batch = 10;
 }
 
 message MutationReceipt {
@@ -57,7 +41,6 @@ message MutationReceipt {
 }
 
 service DataService {
-  rpc SubscribeEntitySet(SubscribeEntitySetRequest) returns (stream SubscribeEntitySetResponse);
-  rpc SubscribeEntityStream(SubscribeEntityStreamRequest) returns (stream SubscribeEntityStreamResponse);
+  rpc Subscribe(SubscribeRequest) returns (stream EchoEvent);
   rpc Write(WriteRequest) returns (MutationReceipt); // TODO(burdon): Rename SubmitMutation.
 }