Working example of the chat using quic,protobuf and actix

.github/workflows/rust.yml

@@ -0,0 +1,52 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Install protoc
+      run: sudo apt-get update && sudo apt-get install -y protobuf-compiler
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Start Chat Server
+      run: |
+        cargo run --bin server -- --listen 0.0.0.0:4433 > server.log &
+        SERVER_PID=$!
+        sleep 5
+        if ! ps -p $SERVER_PID > /dev/null; then
+          echo "Server failed to start."
+          exit 1
+        fi
+      env:
+        RUST_LOG: debug
+    - name: wait server to start
+      run: sleep 5
+    - name: Run tests
+      run: cargo test --verbose
+    - name: Test Chat Client with Interactive Input
+      run: |
+        cargo run --bin chat-client -- --server-addr 127.0.0.1:4433 --server-name localhost --name test-client
+        if [ $? -ne 0 ]; then
+          echo "Client exited with a failure."
+          exit 1
+        fi
+      env:
+        RUST_LOG: debug
+    - name: Check Logs for Specific String
+      run: |
+        if ! grep "User test-client joined" server.log; then
+          echo "String not found in logs. No evidence to client messages to the server. Halting workflow."
+          exit 1
+        fi

.hooks/pre-commit

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -e
+
+echo "Running cargo fmt..."
+cargo fmt -- --check
+
+echo "Running cargo check..."
+cargo check
+
+echo "Running cargo clippy..."
+cargo clippy -- -D warnings

.vscode/launch.json

@@ -0,0 +1,133 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in library 'server'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--lib",
+                    "--package=server"
+                ],
+                "filter": {
+                    "name": "server",
+                    "kind": "lib"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in library 'chat_contract'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--lib",
+                    "--package=chat-contract"
+                ],
+                "filter": {
+                    "name": "chat_contract",
+                    "kind": "lib"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug executable 'server'",
+            "cargo": {
+                "args": [
+                    "build",
+                    "--bin=server",
+                    "--package=chat-server",
+                ],
+                "filter": {
+                    "name": "server",
+                    "kind": "bin"
+                }
+            },
+            "args": [
+                "--listen",
+                "127.0.0.1:4433"
+            ],
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "RUST_LOG": "debug" // Set the RUST_LOG environment variable
+            }
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug executable 'client'",
+            "cargo": {
+                "args": [
+                    "build",
+                    "--bin=chat-client",
+                    "--package=chat-client"
+                ],
+                "filter": {
+                    "name": "chat-client",
+                    "kind": "bin"
+                }
+            },
+            "args": [
+                "--server-addr",
+                "127.0.0.1:4433",
+                "--server-name",
+                "localhost",
+                "--name",
+                "test-client-debugger",
+            ],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in executable 'client-cli'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--bin=client-cli",
+                    "--package=client-cli"
+                ],
+                "filter": {
+                    "name": "client-cli",
+                    "kind": "bin"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in library 'common'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--lib",
+                    "--package=common"
+                ],
+                "filter": {
+                    "name": "common",
+                    "kind": "lib"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

Cargo.toml

@@ -0,0 +1,7 @@
+[workspace]
+resolver = "2"
+members = [
+    "server",
+    "client",
+    "chat-contract"
+]

README.md

@@ -69,3 +69,48 @@ without error, and is free of clippy errors.
 send a message to the server from the client. Make sure that niether the server
 or client exit with a failure. This action should be run anytime new code
 is pushed to a branch or landed on the main branch.
+
+### Demo
+![Demo](assets/example-server-clients.gif)
+
+## Getting Started
+
+### 1. Install Git Pre-Commit Hook
+
+To ensure all code is formatted, compiles correctly, and passes Clippy checks before committing, run the following script once after cloning the repository:
+
+```bash
+bash scripts/install-hooks.sh
+```
+### 2. Install Protocol Buffers (protoc)
+This project uses Protocol Buffers (Protobuf) for serializing structured data. In order to compile .proto files, you need to have the protoc compiler installed.
+
+Follow the instructions for your operating system here:
+https://protobuf.dev/installation/
+
+Make sure protoc is available in your PATH:
+```bash
+protoc --version
+```
+Should output something like: libprotoc 3.21.12
+
+Note: Some components of this project might auto-generate code from .proto files during the build process. Ensure protoc is installed and accessible before building or running the project.
+
+### 3. Run Server
+```bash
+cargo run --bin server
+```
+
+### 4. Run Client
+```bash
+cargo run --bin chat-client -- --server-addr 127.0.0.1:4433 --server-name localhost --name test-client
+```
+
+### 4. Run Tests
+```bash
+cargo run --bin server
+```
+In other terminal
+```bash
+cargo test
+```

chat-contract/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "chat-contract"
+version = "0.1.0"
+edition = "2021"
+authors = ["Ron Zigelman <[email protected]>"]
+
+[dependencies]
+prost = "0.12"
+prost-types = "0.12"
+uuid = { version = "1.16.0", features = ["v4"] }
+
+[build-dependencies]
+prost-build = "0.12"

chat-contract/build.rs

@@ -0,0 +1,5 @@
+use std::io::Result;
+fn main() -> Result<()> {
+    prost_build::compile_protos(&["../proto/chat.proto"], &["../proto/"])?;
+    Ok(())
+}