From 4ff0b855f7024f8a93695fbf1d21c6d71e2a21a6 Mon Sep 17 00:00:00 2001 From: "John D. Corbett" Date: Wed, 27 Jul 2022 09:39:03 -0700 Subject: [PATCH] Created issues for TODOs. Added links here. --- api/api.toml | 2 +- src/app.rs | 7 +++---- src/lib.rs | 6 +++--- src/main.rs | 2 -- src/route.rs | 2 +- src/signal.rs | 4 +--- 6 files changed, 9 insertions(+), 14 deletions(-) diff --git a/api/api.toml b/api/api.toml index 7349b928..32f3423a 100644 --- a/api/api.toml +++ b/api/api.toml @@ -39,7 +39,7 @@ PARAMETER_TABLE_CLOSE = "\n\n" PARAMETER_ROW = "{{NAME}}{{TYPE}}\n" PARAMETER_NONE = "
None
" -# TODO Maybe refactor to eliminate redundancy with HTML_TOP and HTML_BOTTOM +# TODO https://github.com/EspressoSystems/tide-disco/issues/52 MINIMAL_HTML = """ diff --git a/src/app.rs b/src/app.rs index b0f3c194..eac2728c 100644 --- a/src/app.rs +++ b/src/app.rs @@ -262,11 +262,11 @@ impl App>| async move { - // TODO invoke disco_web_handler with the URL, etc. Ok(format!("help /\n{:?}", req.url())) }); } @@ -274,13 +274,12 @@ impl App>| async move { - // TODO invoke disco_web_handler with the URL, etc. Ok(format!("help /*\n{:?}", req.url())) }); } - // TODO add a call to serve_dir + // TODO https://github.com/EspressoSystems/tide-disco/issues/55 { - // TODO This path is not found for address-book + // This path is not found for address-book //server.at("/public").serve_dir("public/media/")?; } diff --git a/src/lib.rs b/src/lib.rs index db0cc224..904e8584 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -619,7 +619,7 @@ impl UrlSegment { } } -// TODO Associate a handler with a pattern somehow. +// TODO https://github.com/EspressoSystems/tide-disco/issues/54 pub async fn disco_dispatch( req: Request, bindings: HashMap, @@ -789,7 +789,7 @@ pub async fn init_web_server( .allow_credentials(true), ); - // TODO Replace these hardcoded routes with api.toml routes + // TODO https://github.com/EspressoSystems/tide-disco/issues/58 web_server.at("/help").get(compose_reference_documentation); web_server.at("/help/").get(compose_reference_documentation); web_server.at("/healthcheck").get(healthcheck); @@ -877,7 +877,7 @@ pub fn compose_settings( // keys lower case. This is a config-rs bug. See https://github.com/mehcode/config-rs/issues/340 let mut builder = Config::builder() .set_default(DiscoKey::base_url.as_ref(), "http://localhost:65535")? - .set_default(DiscoKey::disco_toml.as_ref(), "disco.toml")? // TODO path to share config + .set_default(DiscoKey::disco_toml.as_ref(), "disco.toml")? .set_default( DiscoKey::app_toml.as_ref(), app_api_path(org_name, app_name) diff --git a/src/main.rs b/src/main.rs index 31f12822..4acbeff0 100644 --- a/src/main.rs +++ b/src/main.rs @@ -15,7 +15,6 @@ mod signal; impl Interrupt for InterruptHandle { fn signal_action(signal: i32) { - // TOOD modify web_state based on the signal. println!("\nReceived signal {}", signal); process::exit(1); } @@ -23,7 +22,6 @@ impl Interrupt for InterruptHandle { // This demonstrates the older way of configuring the web server. What's valuable here is that it // shows the bare bones of discoverability from a TOML file. -// TODO integrate discoverability into the new method of wrapping Tide. #[async_std::main] async fn main() -> Result<(), ConfigError> { let api_path = current_dir().unwrap().join("api").join("api.toml"); diff --git a/src/route.rs b/src/route.rs index 065e23d4..499b8ff5 100644 --- a/src/route.rs +++ b/src/route.rs @@ -194,7 +194,7 @@ impl Route { for path in paths.iter() { for seg in path.split('/') { if seg.starts_with(':') { - // TODO also accept a structure with param_type and required + // TODO https://github.com/EspressoSystems/tide-disco/issues/56 let ptype = RequestParamType::from_str( spec[seg] .as_str() diff --git a/src/signal.rs b/src/signal.rs index 85587b5a..bc1f5b98 100644 --- a/src/signal.rs +++ b/src/signal.rs @@ -40,9 +40,7 @@ impl InterruptHandle { // Stop waiting for an interrupt. self.handle.close(); - // TODO This is here to mimic the example in the documentation, but - // it doesn't seem to make any difference whether or not it's here. Why? - // https://docs.rs/signal-hook-async-std/latest/signal_hook_async_std/ + // TODO https://github.com/EspressoSystems/tide-disco/issues/57 if let Some(task) = &mut self.task.take() { task.await }