Add new task endpoint

This commit is contained in:
2022-01-13 21:47:19 +01:00
parent b359b5123e
commit 46b29c28e4
7 changed files with 109 additions and 31 deletions

4
Cargo.lock generated
View File

@@ -329,9 +329,11 @@ dependencies = [
"configparser", "configparser",
"contextswitch-types", "contextswitch-types",
"dotenv", "dotenv",
"lazy_static",
"listenfd", "listenfd",
"mktemp", "mktemp",
"once_cell", "once_cell",
"regex",
"reqwest", "reqwest",
"serde", "serde",
"serde_json", "serde_json",
@@ -346,7 +348,7 @@ dependencies = [
[[package]] [[package]]
name = "contextswitch-types" name = "contextswitch-types"
version = "0.1.0" version = "0.1.0"
source = "git+https://github.com/dax/contextswitch-types.git#bde9fbc2e638c6cadad90702819bf5d4a324ace3" source = "git+https://github.com/dax/contextswitch-types.git#79b61a96b5ba708769715d603bb1cbe3c14a0045"
dependencies = [ dependencies = [
"chrono", "chrono",
"serde", "serde",

View File

@@ -28,7 +28,9 @@ tracing = { version = "0.1.0", features = ["log"] }
tracing-subscriber = { version = "0.3.0", features = ["std", "env-filter", "fmt", "json"] } tracing-subscriber = { version = "0.3.0", features = ["std", "env-filter", "fmt", "json"] }
tracing-log = "0.1.0" tracing-log = "0.1.0"
tracing-actix-web = "=0.5.0-beta.9" tracing-actix-web = "=0.5.0-beta.9"
regex = "1.5.0"
lazy_static = "1.4.0"
[dev-dependencies] [dev-dependencies]
once_cell = "1.0" once_cell = "1.0"
reqwest = "0.11.0" reqwest = { version = "0.11.0", features = ["json"] }

View File

@@ -43,3 +43,7 @@ pub fn export(filters: Vec<&str>) -> Result<Vec<Task>, Error> {
.collect(); .collect();
tasks tasks
} }
pub fn add(add_args: Vec<&str>) -> Result<u64, Error> {
taskwarrior::add(add_args)
}

View File

@@ -1,11 +1,15 @@
use actix_web::{dev::Server, middleware, web, App, HttpResponse, HttpServer}; use actix_web::{dev::Server, middleware, web, App, HttpResponse, HttpServer};
use listenfd::ListenFd; use listenfd::ListenFd;
use serde::Deserialize; use serde::{Deserialize, Serialize};
use serde_json::json;
use std::env; use std::env;
use std::io::Error; use std::io::Error;
use std::net::TcpListener; use std::net::TcpListener;
use tracing_actix_web::TracingLogger; use tracing_actix_web::TracingLogger;
#[macro_use]
extern crate lazy_static;
pub mod contextswitch; pub mod contextswitch;
pub mod observability; pub mod observability;
pub mod taskwarrior; pub mod taskwarrior;
@@ -15,7 +19,12 @@ struct TaskQuery {
filter: Option<String>, filter: Option<String>,
} }
#[tracing::instrument(level = "debug", skip(task_query))] #[derive(Deserialize, Serialize)]
pub struct TaskDefinition {
pub definition: String,
}
#[tracing::instrument(level = "debug", skip_all, fields(filter = %task_query.filter.as_ref().unwrap_or(&"".to_string())))]
async fn list_tasks(task_query: web::Query<TaskQuery>) -> Result<HttpResponse, Error> { async fn list_tasks(task_query: web::Query<TaskQuery>) -> Result<HttpResponse, Error> {
let filter = task_query let filter = task_query
.filter .filter
@@ -28,6 +37,15 @@ async fn list_tasks(task_query: web::Query<TaskQuery>) -> Result<HttpResponse, E
.body(serde_json::to_string(&tasks)?)) .body(serde_json::to_string(&tasks)?))
} }
#[tracing::instrument(level = "debug", skip_all, fields(definition = %task_definition.definition))]
async fn add_task(task_definition: web::Json<TaskDefinition>) -> Result<HttpResponse, Error> {
let task_id = contextswitch::add(task_definition.definition.split(' ').collect())?;
Ok(HttpResponse::Ok()
.content_type("application/json")
.body(json!({ "id": task_id }).to_string()))
}
async fn health_check() -> HttpResponse { async fn health_check() -> HttpResponse {
HttpResponse::Ok().finish() HttpResponse::Ok().finish()
} }
@@ -45,6 +63,7 @@ pub fn run(listener: TcpListener) -> Result<Server, std::io::Error> {
) )
.route("/ping", web::get().to(health_check)) .route("/ping", web::get().to(health_check))
.route("/tasks", web::get().to(list_tasks)) .route("/tasks", web::get().to(list_tasks))
.route("/tasks", web::post().to(add_task))
}) })
.keep_alive(60) .keep_alive(60)
.shutdown_timeout(60); .shutdown_timeout(60);

View File

@@ -1,9 +1,10 @@
use chrono::{DateTime, Utc}; use chrono::{DateTime, Utc};
use configparser::ini::Ini; use configparser::ini::Ini;
use regex::Regex;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use serde_json; use serde_json;
use std::env; use std::env;
use std::io::Error; use std::io::{Error, ErrorKind};
use std::path::Path; use std::path::Path;
use std::process::Command; use std::process::Command;
use std::str; use std::str;
@@ -13,7 +14,7 @@ use uuid::Uuid;
#[derive(Debug, Serialize, Deserialize, PartialEq)] #[derive(Debug, Serialize, Deserialize, PartialEq)]
pub struct Task { pub struct Task {
pub uuid: Uuid, pub uuid: Uuid,
pub id: u32, pub id: u64,
#[serde(with = "contextswitch_types::tw_date_format")] #[serde(with = "contextswitch_types::tw_date_format")]
pub entry: DateTime<Utc>, pub entry: DateTime<Utc>,
#[serde(with = "contextswitch_types::tw_date_format")] #[serde(with = "contextswitch_types::tw_date_format")]
@@ -99,11 +100,8 @@ pub fn load_config(task_data_location: Option<&str>) -> String {
#[tracing::instrument(level = "debug")] #[tracing::instrument(level = "debug")]
pub fn export(filters: Vec<&str>) -> Result<Vec<Task>, Error> { pub fn export(filters: Vec<&str>) -> Result<Vec<Task>, Error> {
let mut args = vec!["export"]; let args = [filters, vec!["export"]].concat();
args.extend(filters);
let export_output = Command::new("task").args(args).output()?; let export_output = Command::new("task").args(args).output()?;
let output = String::from_utf8(export_output.stdout.clone()).unwrap();
debug!("export output: {}", output);
let tasks: Vec<Task> = serde_json::from_slice(&export_output.stdout)?; let tasks: Vec<Task> = serde_json::from_slice(&export_output.stdout)?;
@@ -111,12 +109,31 @@ pub fn export(filters: Vec<&str>) -> Result<Vec<Task>, Error> {
} }
#[tracing::instrument(level = "debug")] #[tracing::instrument(level = "debug")]
pub fn add(add_args: Vec<&str>) -> Result<(), Error> { pub fn add(add_args: Vec<&str>) -> Result<u64, Error> {
let mut args = vec!["add"]; let mut args = vec!["add"];
args.extend(add_args); args.extend(add_args);
let add_output = Command::new("task").args(args).output()?; let add_output = Command::new("task").args(args).output()?;
let output = String::from_utf8(add_output.stdout).unwrap(); let output = String::from_utf8(add_output.stdout).unwrap();
debug!("add output: {}", output); lazy_static! {
static ref RE: Regex = Regex::new(r"Created task (?P<id>\d+).").unwrap();
Ok(()) }
let task_id_capture = RE.captures(&output).ok_or_else(|| {
Error::new(
ErrorKind::Other,
format!("Cannot extract task ID from: {}", &output),
)
})?;
let task_id_str = task_id_capture
.name("id")
.ok_or_else(|| {
Error::new(
ErrorKind::Other,
format!("Cannot extract task ID value from: {}", &output),
)
})?
.as_str();
task_id_str
.parse::<u64>()
.map_err(|_| Error::new(ErrorKind::Other, "Cannot parse task ID value"))
} }

View File

@@ -1,27 +1,53 @@
pub mod test_helper; pub mod test_helper;
use contextswitch_api::taskwarrior; use contextswitch_api::{taskwarrior, TaskDefinition};
use contextswitch_types::Task; use contextswitch_types::Task;
#[tokio::test] #[tokio::test]
async fn list_tasks() { async fn list_tasks() {
let address = test_helper::spawn_app(); let address = test_helper::spawn_app();
let task_data_path = test_helper::setup_tasks(); let task_id =
let client = reqwest::Client::new(); taskwarrior::add(vec!["test", "list_tasks", "contextswitch:'{\"test\": 1}'"]).unwrap();
taskwarrior::add(vec!["test1", "contextswitch:'{\"test\": 1}'"]).unwrap();
let response: reqwest::Response = client let tasks: Vec<Task> = reqwest::Client::new()
.get(&format!("{}/tasks", &address)) .get(&format!("{}/tasks?filter={}", &address, task_id))
.send() .send()
.await .await
.expect("Failed to execute request."); .expect("Failed to execute request")
.json()
.await
.expect("Cannot parse JSON result");
test_helper::clear_tasks(task_data_path);
let text_body = response.text_with_charset("utf-8").await.unwrap();
let tasks: Vec<Task> = serde_json::from_str(&text_body).unwrap();
assert_eq!(tasks.len(), 1); assert_eq!(tasks.len(), 1);
assert_eq!(tasks[0].description, "test1"); assert_eq!(tasks[0].description, "test list_tasks");
let cs_metadata = tasks[0].contextswitch.as_ref().unwrap(); let cs_metadata = tasks[0].contextswitch.as_ref().unwrap();
assert_eq!(cs_metadata.test, 1); assert_eq!(cs_metadata.test, 1);
} }
#[tokio::test]
async fn add_task() {
let address = test_helper::spawn_app();
println!("add_task address: {}", address);
let response: serde_json::Value = reqwest::Client::new()
.post(&format!("{}/tasks", &address))
.json(&TaskDefinition {
definition: "test add_task contextswitch:{\"test\":1}".to_string(),
})
.send()
.await
.expect("Failed to execute request")
.json()
.await
.expect("Cannot parse JSON result");
let new_task_id = response["id"].as_u64().unwrap();
let tasks = taskwarrior::export(vec![&new_task_id.to_string()]).unwrap();
assert_eq!(tasks.len(), 1);
assert_eq!(tasks[0].id, new_task_id);
assert_eq!(tasks[0].description, "test add_task");
assert_eq!(
tasks[0].contextswitch.as_ref().unwrap(),
&"{\"test\":1}".to_string()
);
}

View File

@@ -10,23 +10,31 @@ static TRACING: Lazy<()> = Lazy::new(|| {
init_subscriber(subscriber); init_subscriber(subscriber);
}); });
pub fn spawn_app() -> String { static SERVER_ADDRESS: Lazy<String> = Lazy::new(|| {
Lazy::force(&TRACING);
let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind random port"); let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind random port");
let port = listener.local_addr().unwrap().port(); let port = listener.local_addr().unwrap().port();
let server = contextswitch_api::run(listener).expect("Failed to bind address"); let server = contextswitch_api::run(listener).expect("Failed to bind address");
let _ = tokio::spawn(server); let _ = tokio::spawn(server);
format!("http://127.0.0.1:{}", port) format!("http://127.0.0.1:{}", port)
} });
pub fn setup_tasks() -> String { static TASK_DATA_LOCATION: Lazy<String> = Lazy::new(|| {
let tmp_dir = Temp::new_dir().unwrap(); let tmp_dir = Temp::new_dir().unwrap();
let task_data_location = taskwarrior::load_config(tmp_dir.to_str()); let task_data_location = taskwarrior::load_config(tmp_dir.to_str());
tmp_dir.release(); tmp_dir.release();
return task_data_location; task_data_location
});
pub fn spawn_app() -> String {
Lazy::force(&TRACING);
setup_tasks();
Lazy::force(&SERVER_ADDRESS).to_string()
}
pub fn setup_tasks() -> String {
Lazy::force(&TASK_DATA_LOCATION).to_string()
} }
pub fn clear_tasks(task_data_location: String) { pub fn clear_tasks(task_data_location: String) {