Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: init workspace api #542

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/keck/src/server/api/blocks/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ fn block_apis(router: Router) -> Router {

fn workspace_apis(router: Router) -> Router {
router
.route("/block/:workspace/init", post(workspace::init_workspace))
.route("/block/:workspace/client", get(clients::workspace_client))
.route("/block/:workspace/clients", get(clients::workspace_clients))
.route("/block/:workspace/history", get(history::history_workspace))
Expand Down
60 changes: 59 additions & 1 deletion apps/keck/src/server/api/blocks/workspace.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
use axum::{
extract::{Path, Query},
extract::{BodyStream, Path, Query},
response::Response,
};
use futures::{
future,
stream::{iter, StreamExt},
};
use jwst_core::DocStorage;
use jwst_storage::JwstStorageError;
use utoipa::IntoParams;

use super::*;
Expand Down Expand Up @@ -32,6 +37,59 @@ pub async fn get_workspace(Extension(context): Extension<Arc<Context>>, Path(wor
}
}

/// Init a `Workspace` by id
/// - Return 200 Ok and `Workspace`'s data if init success.
/// - Return 304 Not Modified if `Workspace` is exists.
/// - Return 500 Internal Server Error if init failed.
#[utoipa::path(
post,
tag = "Workspace",
context_path = "/api/block",
path = "/{workspace}/init",
params(
("workspace", description = "workspace id"),
),
request_body(
content = BodyStream,
content_type="application/octet-stream"
),
responses(
(status = 200, description = "Workspace init success"),
(status = 304, description = "Workspace is exists"),
(status = 500, description = "Failed to init a workspace")
)
)]
pub async fn init_workspace(
Extension(context): Extension<Arc<Context>>,
Path(workspace): Path<String>,
body: BodyStream,
) -> Response {
info!("init_workspace: {}", workspace);

let mut has_error = false;
let data = body
.take_while(|x| {
has_error = x.is_err();
future::ready(x.is_ok())
})
.filter_map(|data| future::ready(data.ok()))
.flat_map(|buffer| iter(buffer))

Check warning

Code scanning / clippy

redundant closure

redundant closure
.collect::<Vec<u8>>()
.await;

if has_error {
StatusCode::INTERNAL_SERVER_ERROR.into_response()
} else if let Err(e) = context.init_workspace(workspace, data).await {
if matches!(e, JwstStorageError::WorkspaceExists(_)) {
return StatusCode::NOT_MODIFIED.into_response();
}
warn!("failed to init workspace: {}", e.to_string());
StatusCode::INTERNAL_SERVER_ERROR.into_response()
} else {
StatusCode::OK.into_response()
}
}

/// Create a `Workspace` by id
/// - Return 200 Ok and `Workspace`'s data if init success or `Workspace` is
/// exists.
Expand Down
1 change: 1 addition & 0 deletions apps/keck/src/server/api/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use super::{
history::history_workspace,
subscribe::subscribe_workspace,
subscribe::subscribe_test_hook,
workspace::init_workspace,
workspace::get_workspace,
workspace::set_workspace,
workspace::delete_workspace,
Expand Down
10 changes: 10 additions & 0 deletions apps/keck/src/server/api/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ impl Context {
let webhook = self.webhook.clone();
let ws_id = workspace.id();
workspace.subscribe_doc(move |_, history| {
if history.is_empty() {
return;
}
let webhook = webhook.read().unwrap();
if webhook.is_empty() {
return;
Expand Down Expand Up @@ -127,6 +130,13 @@ impl Context {
.map(|w| self.register_webhook(w))
}

pub async fn init_workspace<S>(&self, workspace_id: S, data: Vec<u8>) -> JwstStorageResult
where
S: AsRef<str>,
{
self.storage.init_workspace(workspace_id, data).await
}

pub async fn create_workspace<S>(&self, workspace_id: S) -> JwstStorageResult<Workspace>
where
S: AsRef<str>,
Expand Down
24 changes: 23 additions & 1 deletion libs/jwst-storage/src/storage/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ impl JwstStorage {
Ok(storage)
}

async fn db_migrate(&self) -> JwstStorageResult<()> {
async fn db_migrate(&self) -> JwstStorageResult {
Migrator::up(&self.pool, None).await?;
Ok(())
}
Expand Down Expand Up @@ -143,6 +143,28 @@ impl JwstStorage {
}
}

pub async fn init_workspace<S>(&self, workspace_id: S, data: Vec<u8>) -> JwstStorageResult
where
S: AsRef<str>,
{
let workspace_id = workspace_id.as_ref();
info!("init_workspace: {}", workspace_id);
if !self
.docs
.detect_workspace(workspace_id)
.await
.map_err(|_err| JwstStorageError::Crud(format!("failed to check workspace {}", workspace_id)))?
{
self.docs
.flush_workspace(workspace_id.into(), data)
.await
.map_err(|_err| JwstStorageError::Crud(format!("failed to init workspace {}", workspace_id)))?;
Ok(())
} else {
Err(JwstStorageError::WorkspaceExists(workspace_id.into()))
}
}

pub async fn full_migrate(&self, workspace_id: String, update: Option<Vec<u8>>, force: bool) -> bool {
let mut map = self.last_migrate.lock().await;
let ts = map.entry(workspace_id.clone()).or_insert(Instant::now());
Expand Down
4 changes: 3 additions & 1 deletion libs/jwst-storage/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ pub enum JwstStorageError {
DocMerge(tokio::task::JoinError),
#[error("workspace {0} not found")]
WorkspaceNotFound(String),
#[error("workspace {0} exists")]
WorkspaceExists(String),
#[error("jwst error")]
Jwst(#[from] jwst_core::JwstError),
#[error("failed to process blob")]
Expand All @@ -29,4 +31,4 @@ pub enum JwstStorageError {
DotEnvy(#[from] dotenvy::Error),
}

pub type JwstStorageResult<T> = Result<T, JwstStorageError>;
pub type JwstStorageResult<T = ()> = Result<T, JwstStorageError>;