Add RedisOperation and RedisOperationState

Creates groundwork for Redis State Manager implementation by introducing
two new structs. RedisOperation represents an operation stored in redis
and RedisOperationState represents the wrapped object which implements
the ActionStateResult trait.

nativelink-scheduler/Cargo.toml

@@ -29,6 +29,10 @@ tokio-stream = { version = "0.1.15", features = ["sync"] }
 tonic = { version = "0.11.0", features = ["gzip", "tls"] }
 tracing = "0.1.40"
 bitflags = "2.5.0"
+redis = { version = "0.25.2", features = ["aio", "tokio", "json"] }
+serde = "1.0.203"
+redis-macros = "0.3.0"
+serde_json = "1.0.117"
 
 [dev-dependencies]
 nativelink-macro = { path = "../nativelink-macro" }

nativelink-scheduler/src/lib.rs

@@ -19,6 +19,7 @@ pub mod grpc_scheduler;
 pub mod operation_state_manager;
 pub mod platform_property_manager;
 pub mod property_modifier_scheduler;
+pub mod redis_operation_state;
 pub mod scheduler_state;
 pub mod simple_scheduler;
 pub mod worker;

nativelink-scheduler/src/redis_operation_state.rs

@@ -0,0 +1,214 @@
+// Copyright 2024 The NativeLink Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::str::FromStr;
+use std::sync::Arc;
+use std::time::SystemTime;
+use futures::{join};
+use nativelink_util::buf_channel::make_buf_channel_pair;
+use nativelink_util::background_spawn;
+use tonic::async_trait;
+use nativelink_util::action_messages::{ActionInfo, ActionInfoHashKey, ActionResult, ActionStage, ActionState, OperationId, WorkerId};
+use nativelink_error::{make_input_err, Error};
+use tokio::sync::watch;
+use redis_macros::{FromRedisValue, ToRedisArgs};
+use serde::{Serialize, Deserialize};
+use crate::operation_state_manager::{ActionStateResult, OperationStageFlags};
+use nativelink_util::store_trait::StoreSubscription;
+
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
+enum OperationStage {
+    CacheCheck,
+    Queued,
+    Executing,
+    Completed,
+    Unknown,
+}
+
+fn _parse_stage_flags(flags: &OperationStageFlags) -> Vec<OperationStage> {
+    if flags.contains(OperationStageFlags::Any) {
+        return Vec::from([
+            OperationStage::CacheCheck,
+            OperationStage::Queued,
+            OperationStage::Executing,
+            OperationStage::Completed,
+            OperationStage::Unknown,
+        ]);
+    }
+    let mut stage_vec = Vec::new();
+    if flags.contains(OperationStageFlags::CacheCheck) {
+        stage_vec.push(OperationStage::CacheCheck)
+    }
+    if flags.contains(OperationStageFlags::Executing) {
+        stage_vec.push(OperationStage::Executing)
+    }
+    if flags.contains(OperationStageFlags::Completed) {
+        stage_vec.push(OperationStage::Completed)
+    }
+    if flags.contains(OperationStageFlags::Queued) {
+        stage_vec.push(OperationStage::Queued)
+    }
+    stage_vec
+}
+
+pub struct RedisOperationState {
+    rx: watch::Receiver<Arc<ActionState>>,
+    inner: RedisOperation,
+}
+
+impl RedisOperationState {
+    fn _new(inner: RedisOperation, mut subscription: Box<dyn StoreSubscription>) -> Self {
+        let (tx, rx) = watch::channel(inner.as_state().unwrap());
+
+        let _join_handle = background_spawn!("redis_subscription_watcher", async move {
+            loop {
+                let Ok(item) = subscription.changed().await else {
+                    return;
+                };
+                let (mut data_tx, mut data_rx) = make_buf_channel_pair();
+                // If get fails then we drop the tx.
+                let (res, data_res) = join!(async move { item.get(&mut data_tx).await }, data_rx.consume(None));
+                if let Err(_e) = res {
+                    todo!()
+                }
+                let Ok(data) = data_res else {
+                    todo!()
+                };
+                let slice = &data[..];
+                let state: Arc<ActionState> = RedisOperation::from_slice(slice).as_state().unwrap();
+                let _ = tx.send(state).map_err(|_| {
+                    todo!()
+                });
+
+            }
+        });
+        Self {
+            rx,
+            inner
+        }
+    }
+}
+
+#[async_trait]
+impl ActionStateResult for RedisOperationState {
+    async fn as_state(&self) -> Result<Arc<ActionState>, Error> {
+        Ok(Arc::new(self.inner.clone().try_into()?))
+    }
+    async fn as_receiver(&self) -> Result<&'_ watch::Receiver<Arc<ActionState>>, Error> {
+        Ok(&self.rx)
+    }
+    async fn as_action_info(&self) -> Result<Arc<ActionInfo>, Error> {
+        Ok(Arc::new(self.inner.info.clone()))
+    }
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, ToRedisArgs, FromRedisValue)]
+pub struct RedisOperation {
+    operation_id: OperationId,
+    info: ActionInfo,
+    worker_id: Option<WorkerId>,
+    result: Option<ActionResult>,
+    stage: OperationStage,
+    last_worker_update: Option<SystemTime>,
+    last_client_update: Option<SystemTime>,
+    last_error: Option<Error>,
+    completed_at: Option<SystemTime>
+}
+
+impl RedisOperation {
+    pub fn as_json(&self) -> String {
+        serde_json::json!(&self).to_string()
+    }
+    pub fn from_slice(s: &[u8]) -> Self {
+        serde_json::from_slice(s).unwrap()
+    }
+
+    pub fn new(info: ActionInfo, operation_id: OperationId) -> Self {
+        Self {
+            operation_id,
+            info,
+            worker_id: None,
+            result: None,
+            stage: OperationStage::CacheCheck,
+            last_worker_update: None,
+            last_client_update: None,
+            last_error: None,
+            completed_at: None
+        }
+    }
+
+    pub fn from_existing(existing: RedisOperation, operation_id: OperationId) -> Self {
+        Self {
+            operation_id,
+            info: existing.info,
+            worker_id: existing.worker_id,
+            result: existing.result,
+            stage: existing.stage,
+            last_worker_update: existing.last_worker_update,
+            last_client_update: existing.last_client_update,
+            last_error: existing.last_error,
+            completed_at: existing.completed_at
+        }
+    }
+
+    pub fn as_state(&self) -> Result<Arc<ActionState>, Error> {
+        let action_state = ActionState {
+            stage: self.action_stage()?,
+            id: self.operation_id.clone()
+        };
+        Ok(Arc::new(action_state))
+    }
+
+    pub fn action_stage(&self) -> Result<ActionStage, Error> {
+        match self.stage {
+            OperationStage::CacheCheck => Ok(ActionStage::CacheCheck),
+            OperationStage::Queued => Ok(ActionStage::Queued),
+            OperationStage::Executing => Ok(ActionStage::Executing),
+            OperationStage::Unknown => Ok(ActionStage::Unknown),
+            OperationStage::Completed => {
+                let Some(result) = &self.result else {
+                    return Err(
+                        make_input_err!(
+                            "Operation {} was marked as completed but has no result",
+                            self.operation_id.to_string()
+                        )
+                    )
+                };
+                Ok(ActionStage::Completed(result.clone()))
+            }
+        }
+    }
+    fn _unique_qualifier(&self) -> &ActionInfoHashKey {
+        &self.operation_id.unique_qualifier
+    }
+}
+
+impl FromStr for RedisOperation {
+    type Err = Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        serde_json::from_str(s).map_err(|e| {
+            make_input_err!("Decode string to RedisOperation failed with error: {}", e.to_string())
+        })
+    }
+}
+
+impl TryFrom<RedisOperation> for ActionState {
+    type Error = Error;
+    fn try_from(value: RedisOperation) -> Result<Self, Self::Error> {
+        Ok(ActionState {
+            id: value.operation_id.clone(),
+            stage: value.action_stage()?
+        })
+    }
+}

nativelink-store/src/redis_store.rs

@@ -116,7 +116,7 @@ impl<T: ConnectionLike + Unpin + Clone + Send + Sync> RedisStore<T> {
         }
     }
 
-    async fn get_conn(&self) -> Result<T, Error> {
+    pub async fn get_conn(&self) -> Result<T, Error> {
         let result = match self.lazy_conn.get().as_ref() {
             LazyConnection::Connection(conn_result) => return conn_result.clone(),
             LazyConnection::Future(fut) => fut.clone().await,

nativelink-util/src/store_trait.rs

@@ -151,7 +151,7 @@ pub enum StoreOptimizations {
 /// A key that has been subscribed to in the store. This can be used
 /// to wait for changes to the data for the key.
 #[async_trait]
-pub trait StoreSubscription {
+pub trait StoreSubscription: Send + Sync + Unpin {
     /// Get the current store subscription item.
     fn peek(&self) -> Result<Arc<dyn StoreSubscriptionItem>, Error>;