Initial commit, with minimal gRPC server

Author: ekzhang

.editorconfig

@@ -0,0 +1,10 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.rs]
+tab_width = 4
+
+[*.{js,jsx,ts,tsx,html,css,svelte,proto}]
+tab_width = 2

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  rustfmt:
+    name: Rust format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          components: rustfmt
+
+      - run: cargo fmt -- --check
+
+  rust:
+    name: Rust lint and test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+
+      - run: cargo clippy --all-targets -- -D warnings
+
+      - run: cargo test

.gitignore

@@ -0,0 +1,2 @@
+/target
+.vscode/

Cargo.lock

@@ -0,0 +1,2 @@
+[workspace]
+members = ["crates/*"]

Cargo.toml

@@ -0,0 +1,3 @@
+# sshx
+
+Visit [sshx.io](https://sshx.io) to learn more about this tool.

README.md

@@ -0,0 +1,11 @@
+[package]
+name = "sshx-core"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+prost = "0.9.0"
+tonic = "0.6.2"
+
+[build-dependencies]
+tonic-build = "0.6.2"

crates/sshx-core/Cargo.toml

@@ -0,0 +1,10 @@
+use std::{env, path::PathBuf};
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let descriptor_path = PathBuf::from(env::var("OUT_DIR").unwrap()).join("sshx.bin");
+    tonic_build::configure()
+        .file_descriptor_set_path(&descriptor_path)
+        .format(true)
+        .compile(&["proto/sshx.proto"], &["proto/"])?;
+    Ok(())
+}

crates/sshx-core/build.rs

@@ -0,0 +1,19 @@
+syntax = "proto3";
+package sshx;
+
+service Greeter {
+  // Our SayHello rpc accepts HelloRequests and returns HelloReplies
+  rpc SayHello(HelloRequest) returns (HelloReply);
+}
+
+// A request for the SayHello rpc.
+message HelloRequest {
+  // Request message contains the name to be greeted
+  string name = 1;
+}
+
+// A reply for the SayHello rpc.
+message HelloReply {
+  // Reply contains the greeting message
+  string message = 1;
+}

crates/sshx-core/proto/sshx.proto

@@ -0,0 +1,12 @@
+//! The core crate for shared code used in the sshx application.
+
+#![forbid(unsafe_code)]
+#![warn(missing_docs)]
+
+/// Protocol buffer and gRPC definitions, automatically generated by Tonic.
+pub mod proto {
+    tonic::include_proto!("sshx");
+
+    /// File descriptor set used for gRPC reflection.
+    pub const FILE_DESCRIPTOR_SET: &[u8] = tonic::include_file_descriptor_set!("sshx");
+}

crates/sshx-core/src/lib.rs

@@ -0,0 +1,11 @@
+[package]
+name = "sshx-server"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+anyhow = "1.0.53"
+sshx-core = { path = "../sshx-core" }
+tokio = { version = "1.16.1", features = ["full"] }
+tonic = "0.6.2"
+tonic-reflection = "0.3.0"

crates/sshx-server/Cargo.toml

@@ -0,0 +1,23 @@
+//! Defines gRPC routes and application request logic.
+
+use sshx_core::proto::{greeter_server::Greeter, HelloReply, HelloRequest};
+use tonic::{Request, Response, Status};
+
+/// Server that handles gRPC requests from the sshx command-line client.
+pub struct GrpcServer;
+
+#[tonic::async_trait]
+impl Greeter for GrpcServer {
+    async fn say_hello(
+        &self,
+        request: Request<HelloRequest>,
+    ) -> Result<Response<HelloReply>, Status> {
+        println!("Got a request: {:?}", request);
+
+        let reply = HelloReply {
+            message: format!("Hello {}!", request.get_ref().name),
+        };
+
+        Ok(Response::new(reply))
+    }
+}

crates/sshx-server/src/grpc.rs

@@ -0,0 +1,34 @@
+//! The sshx server, which coordinates terminal sharing.
+//!
+//! Requests are communicated to the server via gRPC (for command-line sharing
+//! clients) and WebSocket connections (for web listeners). The server is built
+//! using a hybrid Hyper service, split between a Tonic gRPC handler and an Axum
+//! web listener.
+//!
+//! Most web requests are routed directly to static files located in the `dist/`
+//! folder relative to where this binary is running, allowing the frontend to be
+//! separately developed from the server.
+
+#![forbid(unsafe_code)]
+#![warn(missing_docs)]
+
+pub mod grpc;
+
+#[cfg(test)]
+mod tests {
+    use tonic::Request;
+
+    #[tokio::test]
+    async fn test_rpc() -> Result<(), Box<dyn std::error::Error>> {
+        use sshx_core::proto::*;
+
+        let req = Request::new(HelloRequest {
+            name: "adam".into(),
+        });
+        let _ = req;
+        // let mut client = greeter_client::GreeterClient::connect("http://[::1]:8051").await?;
+        // let resp = client.say_hello(req).await?;
+        // println!("resp={:?}", resp);
+        Ok(())
+    }
+}

crates/sshx-server/src/lib.rs

@@ -0,0 +1,20 @@
+use sshx_core::proto::{greeter_server::GreeterServer, FILE_DESCRIPTOR_SET};
+use sshx_server::grpc::GrpcServer;
+use tonic::transport::Server;
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    let grpc_service = GreeterServer::new(GrpcServer);
+    let reflection_service = tonic_reflection::server::Builder::configure()
+        .register_encoded_file_descriptor_set(FILE_DESCRIPTOR_SET)
+        .build()
+        .unwrap();
+
+    let addr = "[::1]:8051".parse()?;
+    Server::builder()
+        .add_service(grpc_service)
+        .add_service(reflection_service)
+        .serve(addr)
+        .await?;
+    Ok(())
+}

crates/sshx-server/src/main.rs

@@ -0,0 +1,7 @@
+[package]
+name = "sshx"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+sshx-core = { path = "../sshx-core" }

crates/sshx/Cargo.toml

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

crates/sshx/src/main.rs

@@ -0,0 +1,6 @@
+unstable_features = true
+group_imports = "StdExternalCrate"
+wrap_comments = true
+format_strings = true
+normalize_comments = true
+reorder_impl_items = true