@dxos/protocols 0.1.0

package/src/proto/dxos/rpc.proto

@@ -0,0 +1,73 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+
+// TODO(burdon): Move to `dxos.mesh.rpc` (reconcile with @dxos/kube repo).
+package dxos.rpc;
+
+option go_package = "github.com/dxos/kube/go/dxrpc/pb";
+
+message RpcMessage {
+  oneof content {
+    Request request = 1;
+    Response response = 2;
+
+    /// Means that the node is trying to open the connection.
+    bool open = 3;
+    /// Means that the node has received the "open" message and is ready to perform requests.
+    bool open_ack = 4;
+
+    StreamClose stream_close = 5;
+  }
+}
+
+message Request {
+  int32 id = 1;
+  string method = 2;
+  google.protobuf.Any payload = 3;
+  bool stream = 4;
+}
+
+message Response {
+  int32 id = 1;
+  oneof content {
+    google.protobuf.Any payload = 2;
+    Error error = 3;
+    /// Sent when stream is closed without an error.
+    bool close = 4;
+
+    /**
+     * Sent when the server has processed a request with a streaming response.
+     * Can be skipped by the server.
+     * In this case the first payload should be treated as the server being ready.
+     */
+    bool stream_ready = 5;
+  }
+}
+
+// TODO(burdon): Generalize to event?
+// Sent by client to end the streaming response.
+message StreamClose {
+  int32 id = 1;
+}
+
+message Error {
+  optional string name = 1;
+  optional string message = 2;
+  optional string stack = 3;
+}
+
+// TODO(burdon): Rename Trace.
+message MessageTrace {
+  enum Direction {
+    INCOMING = 0;
+    OUTGOING = 1;
+  }
+
+  Direction direction = 1;
+  bytes data = 2;
+}

package/src/proto/dxos/service/publisher.proto

@@ -0,0 +1,35 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+import "dxos/config.proto";
+
+package dxos.service.publisher;
+
+option go_package = "github.com/dxos/kube/publisher/pb";
+
+message PublishRequest {
+  dxos.config.Package package = 1;
+}
+
+message PublishResponse {
+  dxos.config.Package package = 1;
+}
+
+message ListResponse {
+  repeated dxos.config.Module modules = 1;
+}
+
+message ResetResponse {
+  int32 count = 1;
+}
+
+service Publisher {
+  rpc Publish(PublishRequest) returns (PublishResponse);
+  rpc List(google.protobuf.Empty) returns (ListResponse);
+  rpc Reset(google.protobuf.Empty) returns (ResetResponse);
+}

package/src/proto/dxos/service/scheduler.proto

@@ -0,0 +1,171 @@
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+import "dxos/config.proto";
+
+package dxos.service.scheduler;
+
+option go_package = "github.com/dxos/kube/scheduler/pb";
+
+enum State {
+  INVALID = 0;
+  STOPPED = 1;
+  STARTING = 2;
+  RUNNING = 3;
+  FAILING = 4;
+}
+
+message Bot {
+  message Spec {
+    message Echo {
+      bytes party_key = 1;
+
+      google.protobuf.Any invitation = 2;
+    }
+
+    /// URL to the bot executable. KUBEs support file:// and ipfs:// urls.
+    string executable = 1;
+
+    Echo echo = 2;
+  }
+
+  message Stats {
+    message NetworkUsage {
+    }
+
+    message CPUUsage {
+      double cores = 1;
+    }
+
+    message MemoryUsage {
+      int64 bytes = 1;
+    }
+
+    message DiskUsage {
+      int64 bytes = 1;
+    }
+
+    /// Echo stats.
+    message Echo {
+
+    }
+
+    optional int64 pid = 1;
+
+    optional google.protobuf.Timestamp executable_downloaded = 10;
+    optional google.protobuf.Timestamp created = 11;
+    optional google.protobuf.Timestamp started = 12;
+    optional google.protobuf.Timestamp stopped = 13;
+    optional google.protobuf.Timestamp last_ping_time = 14;
+
+    optional int32 exit_code = 30;
+    optional string error_message = 31;
+
+    CPUUsage cpu_usage = 40;
+    MemoryUsage memory_usage = 41;
+    DiskUsage disk_usage = 42;
+    NetworkUsage network_usage = 43;
+    Echo echo = 44;
+  }
+
+  /// Scheduler
+  bytes id = 1;
+
+  /// Current state.
+  State state = 2;
+
+  /// Desired state.
+  State desired_state = 3;
+
+  /// Omitted when returned from the Query RPC.
+  optional Spec spec = 4;
+
+  /// Omitted when returned from the Query RPC.
+  optional Stats stats = 5;
+
+  /// Identity key of the bot profile.
+  optional bytes identity_key = 6;
+}
+
+message QueryResponse {
+  repeated Bot services = 1;
+}
+
+message ServiceRequest {
+  bytes service_id = 1;
+}
+
+message Request {
+  bytes service_id = 1;
+  google.protobuf.Any payload = 2;
+}
+
+message Reply {
+  google.protobuf.Any payload = 1;
+}
+
+message CreateRequest {
+  Bot.Spec spec = 1;
+  optional State desired_state = 2;
+}
+
+message Progress {
+  Bot state = 1;
+}
+
+/// Exposed by bot controller to clients. Allows creation and management of bots.
+service BotController {
+  /// Enumerate all services.
+  rpc Query(google.protobuf.Empty) returns (QueryResponse);
+
+  /// Query information about a specific service
+  rpc Describe(ServiceRequest) returns (Bot);
+
+  /// Create a new service.
+  rpc Create(CreateRequest) returns (stream Progress);
+
+  /// Remove a service with its identity and persistent storage.
+  rpc Remove(ServiceRequest) returns (google.protobuf.Empty);
+
+  /// Start the bot.
+  rpc Start(ServiceRequest) returns (stream Progress);
+
+  /// Start the bot.
+  rpc Stop(ServiceRequest) returns (stream Progress);
+
+  /// Start the bot.
+  rpc Restart(ServiceRequest) returns (stream Progress);
+
+  // TODO: Upgrade to streaming request to support bi-directional streams.
+  /// Issue an RPC request to the bot instance.
+  rpc Call(Request) returns (stream Reply);
+}
+
+message BotConfig {
+  Bot.Spec.Echo spec = 1;
+
+  dxos.config.Config client_config = 2;
+}
+
+/// Internal service exposed by bot to the bot controller.
+service BotService {
+  /// Issue an RPC request to the bot instance.
+  rpc Call(Request) returns (stream Reply);
+
+  /// Called by the bot controller to verify that the bot is functional.
+  rpc Healthcheck(google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+message Report {
+  /// Identity key of the bot profile.
+  optional bytes identity_key = 1;
+}
+
+/// Internal service exposed by bot controller to the bot.
+service BotHost {
+  rpc GetConfig(google.protobuf.Empty) returns (BotConfig);
+
+  rpc SendReport(Report) returns (google.protobuf.Empty);
+}

package/src/proto/dxos/type.proto

@@ -0,0 +1,166 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+syntax = "proto3";
+
+import "dxos/registry.proto";
+
+// TODO(burdon): Rename `dxos.registry.type`.
+package dxos.type;
+
+// TODO(wittjosiah): Shared with config. Factor out?
+message Repo {
+  string name = 1;
+  string url = 2;
+  string version = 3;
+}
+
+//
+// Records
+//
+
+//
+// Registered as `type.app`.
+//
+message App {
+  /**
+   * Optional **semver 2.0** compliant record version.
+   * Should conform to the semver regex (see https://semver.org/).
+   */
+  optional string version = 1;
+
+  optional string license = 2;
+
+  repeated Repo repos = 3;
+
+  /// App bundle content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+  optional bytes bundle = 4;
+
+  message Web {
+    /// Relative path in resource to entrypoint, defaults to index.html.
+    optional string index_file = 1;
+
+    /// Relative path in resource to entrypoint, defaults to main.js.
+    optional string entry_point = 2;
+  }
+
+  oneof kind {
+    Web web = 100;
+  }
+
+  optional dxos.registry.Record.Extension extension = 200;
+}
+
+//
+// Registered as `type.bot`.
+//
+message Bot {
+  /**
+   * Optional **semver 2.0** compliant record version.
+   * Should conform to the semver regex (see https://semver.org/).
+   */
+  string version = 1;
+
+  string license = 2;
+
+  repeated Repo repos = 3;
+
+  /// Bot bundle content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+  bytes bundle = 4;
+
+  /// Only for spawning bots that are expected to be vendored with bot-factory.
+  /// This would be the path to the bot executable in bot-factory's file-system.
+  string local_path = 5;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.state-machine`.
+//
+message StateMachine {
+  /// Set of protobuf messages encoded in JSON.
+  string mutation_protobuf_defs = 1;
+
+  /// Set of protobuf messages encoded in JSON.
+  string snapshot_protobuf_defs = 2;
+
+  bytes code_ipfs_cid = 3;
+}
+
+//
+// Registered as `type.file`.
+//
+message File {
+  // MIME type of the file content: https://developer.mozilla.org/en-US/docs/Glossary/MIME_type.
+  string content_type = 1;
+  string file_name = 2;
+
+  /// File content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+  bytes bundle = 3;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.kube`.
+//
+message KUBE {
+  string url = 1;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.service`.
+//
+message Service {
+  // TODO(dmaretskyi): How are service type's defined?
+  string type = 1;
+
+  // KUBE record's CID that hosts this service.
+  bytes kube = 2;
+
+  // Extension field's payload depends on service type and has extra data specific to that service.
+  // Within this schema extension might be `type.service.ipfs` or `type.service.bot-factory`.
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.service.ipfs`.
+//
+message IPFS {
+  string protocol = 1;
+  repeated string addresses = 2;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.service.bot-factory`.
+//
+message BotFactory {
+  string topic = 1;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.service.signal`.
+//
+message Signal {
+  string bootstrap = 1;
+  string url = 2;
+
+  dxos.registry.Record.Extension extension = 100;
+}
+
+//
+// Registered as `type.service.app-server`.
+//
+message AppServer {
+  string url = 1;
+
+  dxos.registry.Record.Extension extension = 100;
+}

package/src/proto/example/testing/data.proto

@@ -0,0 +1,20 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+package example.testing.data;
+
+message TestItemMutation {
+  string key = 1;
+  string value = 2;
+}
+
+message TestListMutation {
+  string data = 1;
+}
+
+message TestItemSnapshot {
+  repeated TestItemMutation keys = 1;
+}

package/src/proto/example/testing/rpc.proto

@@ -0,0 +1,47 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "google/protobuf/empty.proto";
+
+package example.testing.rpc;
+
+message TestRpcRequest {
+  string data = 1;
+}
+
+message TestRpcResponse {
+  string data = 1;
+}
+
+service TestService {
+  rpc TestCall (TestRpcRequest) returns (TestRpcResponse);
+  rpc VoidCall (google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+service TestStreamService {
+  rpc TestCall (TestRpcRequest) returns (stream TestRpcResponse);
+}
+
+message PingRequest {
+  int32 nonce = 1;
+}
+
+message PingReponse {
+  int32 nonce = 1;
+}
+
+service PingService {
+  rpc Ping (PingRequest) returns (PingReponse);
+}
+
+message MessageWithAny {
+  google.protobuf.Any payload = 1;
+}
+
+service TestAnyService {
+  rpc TestCall (MessageWithAny) returns (MessageWithAny);
+}