feat: add frontend-backend file synchronization (#14)

Author: Brayan-724

Cargo.lock

@@ -10,8 +10,8 @@ actix = "0.13"
 actix-cors = "0.7.1"
 actix_error_proc = { version = "1.1.4", features = ["thiserror"] }
 actix-web = "4"
+actix-ws = "0.3.0"
 chrono = "0.4"
-cola = "0.5.0"
 dotenv = "0.15.0"
 env_logger = "0.11.7"
 futures = "0.3"
@@ -26,9 +26,9 @@ tokio.workspace = true
 uuid = { version = "1.3", features = ["serde", "v4"] }
 
 # Para los tests de integracion
+[dev-dependencies]
 awc = "3" # Cliente HTTP y WebSocket para Actix
 actix-rt = { version = "2.10.0", features = ["macros"] }
 futures-util = "0.3"
 lazy_static = "1.4"
 once_cell = "1.17"
-actix-ws = "0.3.0"

backend/Cargo.toml

@@ -17,7 +17,8 @@ cargo run --bin backend
 ```
 para ejecutar los tests
 ```
-cargo test --test integration_test
+cargo test --no-fail-fast --test integration_test
+cargo test --no-fail-fast --bin backend --verbose
 ```
 
 ## Things to know

backend/README.md

@@ -7,7 +7,6 @@ use crate::utils::expect_var;
 #[derive(Deserialize, Debug)]
 pub struct GitHubUser {
     pub login: String,
-    pub name: Option<String>,
     pub avatar_url: String,
 }
 

backend/src/auth/github.rs

@@ -1,13 +1,14 @@
 use std::sync::LazyLock;
 
 use actix_web::HttpRequest;
-use chrono::{Duration, Utc};
+use chrono::{Duration, TimeDelta, Utc};
 use serde::{Deserialize, Serialize};
 
 use crate::expect_var;
 use crate::http_errors::HttpErrors;
 
 pub static JWT_SECRET: LazyLock<String> = LazyLock::new(|| expect_var!("JWT_SECRET"));
+const JWT_EXP: TimeDelta = Duration::hours(12);
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct RgUserData {
@@ -19,7 +20,7 @@ pub struct RgUserData {
 
 impl RgUserData {
     pub fn new(id: String, name: String, is_guest: bool) -> Self {
-        let exp = Utc::now() + Duration::hours(12);
+        let exp = Utc::now() + JWT_EXP;
 
         Self {
             id,

backend/src/auth/jwt.rs

@@ -1,3 +1,3 @@
 pub mod github;
-pub mod handlers;
 pub mod jwt;
+pub mod routes;

backend/src/auth/mod.rs

@@ -1,5 +1,5 @@
 use actix_error_proc::{proof_route, HttpResult};
-use actix_web::{get, web, HttpResponse, Responder};
+use actix_web::{get, web, HttpRequest, HttpResponse, Responder};
 use oauth2::{AuthorizationCode, CsrfToken, Scope, TokenResponse};
 use serde::Deserialize;
 use uuid::Uuid;
@@ -18,7 +18,7 @@ pub struct AuthRequest {
 }
 
 #[get("/auth")]
-pub async fn oauth(oauth: web::Data<OAuthData>) -> impl Responder {
+pub async fn auth(oauth: web::Data<OAuthData>) -> impl Responder {
     let (auth_url, _csrf_token) = oauth
         .client
         .authorize_url(CsrfToken::new_random)
@@ -30,8 +30,15 @@ pub async fn oauth(oauth: web::Data<OAuthData>) -> impl Responder {
         .finish()
 }
 
+#[get("/auth/me")]
+pub async fn me(req: HttpRequest) -> HttpResult<HttpErrors> {
+    let user_info = jwt::get_user_info(&req)?;
+
+    Ok(HttpResponse::Ok().json(user_info))
+}
+
 #[get("/auth/callback")]
-async fn auth_callback(
+async fn callback(
     query: web::Query<AuthRequest>,
     oauth_data: web::Data<OAuthData>,
 ) -> HttpResult<HttpErrors> {
@@ -69,8 +76,8 @@ struct GuestLoginRequest {
     guest_name: String,
 }
 
-#[proof_route(post("/login-guest"))]
-async fn guest_jwt(body: web::Json<GuestLoginRequest>) -> HttpResult<HttpErrors> {
+#[proof_route(post("/auth/guest"))]
+async fn login_guest(body: web::Json<GuestLoginRequest>) -> HttpResult<HttpErrors> {
     let guest_name = &body.guest_name;
     let guest_uuid = Uuid::new_v4().to_string();
     let jwt = RgUserData::new(guest_uuid.clone(), guest_name.clone(), true).encode()?;
@@ -87,7 +94,7 @@ struct UpdateNameRequest {
     new_name: String,
 }
 
-#[proof_route(post("/update-name"))]
+#[proof_route(post("/auth/update"))]
 async fn update_name(
     body: web::Json<UpdateNameRequest>,
     req: actix_web::HttpRequest,

backend/src/auth/handlers.rs backend/src/auth/routes.rsbackend/src/auth/handlers.rs renamed to backend/src/auth/routes.rs

@@ -0,0 +1,16 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(tag = "kind", rename_all = "snake_case")]
+pub enum Action {
+    Insertion {
+        from: usize,
+        text: String,
+        owner: String,
+    },
+    Deletion {
+        from: usize,
+        to: usize,
+        owner: String,
+    },
+}

backend/src/collab/action.rs

@@ -0,0 +1,89 @@
+use std::collections::HashMap;
+
+use serde::Serialize;
+use tokio::sync::Notify;
+
+use super::ot::{apply_actions, transform_actions};
+use super::Action;
+
+#[derive(Debug)]
+pub struct Document {
+    pub buffer: String,
+    /// Users can subscribe to document events
+    pub notify: Notify,
+    pub history: Vec<Action>,
+    pub cursors: HashMap<String, Vec<(usize, usize)>>,
+}
+
+#[derive(Clone, Debug, Serialize)]
+pub struct DocumentInfo {
+    pub text: String,
+    pub revision: usize,
+}
+
+impl From<&Document> for DocumentInfo {
+    fn from(value: &Document) -> Self {
+        Self {
+            text: value.buffer.clone(),
+            revision: value.history.len(),
+        }
+    }
+}
+
+impl Document {
+    pub fn new() -> Self {
+        Document {
+            buffer: String::new(),
+            notify: Notify::new(),
+            history: Vec::new(),
+            cursors: HashMap::new(),
+        }
+    }
+
+    pub fn new_with(buffer: String) -> Self {
+        Document {
+            buffer,
+            notify: Notify::new(),
+            history: Vec::new(),
+            cursors: HashMap::new(),
+        }
+    }
+
+    pub fn fork(&self) -> Self {
+        Document {
+            buffer: self.buffer.clone(),
+            history: self.history.clone(),
+            notify: Notify::new(),
+            cursors: HashMap::new(),
+        }
+    }
+
+    pub fn revision(&self) -> usize {
+        self.history.len()
+    }
+
+    /// Add actions to document history.
+    /// - Transform desynchorized actions
+    /// - Notify to document listeners
+    pub fn compose(&mut self, revision: usize, mut actions: Vec<Action>) -> Vec<Action> {
+        if revision == self.revision() {
+            self.buffer = apply_actions(&self.buffer, &actions);
+            self.history.extend(actions.iter().cloned());
+            self.notify.notify_waiters();
+            return actions;
+        } else if revision > self.history.len() {
+            log::warn!("Someone comes from the future");
+            return Vec::new();
+        }
+
+        let desynchronized_history = &self.history[revision..];
+
+        transform_actions(actions.as_mut_slice(), desynchronized_history);
+
+        self.buffer = apply_actions(&self.buffer, &actions);
+        self.history.extend_from_slice(&actions);
+        self.notify.notify_waiters();
+
+        actions
+    }
+}

backend/src/collab/document.rs

@@ -0,0 +1,6 @@
+mod action;
+mod document;
+pub mod ot;
+
+pub use action::Action;
+pub use document::{Document, DocumentInfo};