- Notifications
You must be signed in to change notification settings - Fork963
Fix #3112 serve docs on localhost:{random port}#3697
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| @@ -12,13 +12,13 @@ build = "build.rs" | |||
| [features] | |||
| curl-backend = ["download/curl-backend"] | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Please avoid making unrelated changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Sorry. Will avoid
| @@ -86,6 +86,7 @@ termcolor.workspace = true | |||
| thiserror.workspace = true | |||
| threadpool = "1" | |||
| tokio = { workspace = true, optional = true } | |||
| tiny_http = "0.11" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Given that we're already depending on hyper for the reqwest download backend, I think we should be using hyper (0.14) for the server, too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Too easy, will do
| @@ -725,6 +726,9 @@ pub(crate) fn cli() -> Command { | |||
| .value_parser(partial_toolchain_desc_parser), | |||
| ) | |||
| .arg(Arg::new("topic").help(TOPIC_ARG_HELP)) | |||
| .subcommand( | |||
| Command::new("servedoc") | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think this should probably bedoc --serve rather than a new command.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Alright, so this would be instead of a specific doc flag and just do base docs or in addition to specific flag "doc --nomicon --serve"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
It should be a new--serve flag on the existingdoc command, that works orthogonally to other flags. Maybe it should take an optional port number orSocketAddr (like192.168.0.1:3112) as argument?
| let doc_path_index = toolchain.doc_path(doc_url)?; | ||
| let doc_path_base = toolchain.doc_path("")?; | ||
| let doc_path_str = doc_path_base.to_string_lossy().into_owned(); | ||
| loop { | ||
| let server = Server::http("127.0.0.1:0").unwrap(); | ||
| println!("Serving documentation at {}", server.server_addr()); | ||
| for request in server.incoming_requests() { | ||
| //TODO get request path and serve filebased on that | ||
| let request_path = request.url().strip_prefix('/'); | ||
| match request_path { | ||
| Some(mut request_path) => { | ||
| println!("doc url: {:?}", &doc_url); | ||
| println!("Req file: {:?}", &request_path); | ||
| let base_string = doc_path_str.clone(); | ||
| if request_path == "" { | ||
| request_path = doc_url; | ||
| } | ||
| //strip search params | ||
| if let Some(index) = request_path.find('?') { | ||
| request_path = &request_path[..index]; | ||
| } | ||
| //ignore favicon requests | ||
| if request_path == "favicon.ico" { | ||
| continue; | ||
| } | ||
| let path = String::from(base_string + &request_path); | ||
| println!("Serving file: {:?}", &path); | ||
| let file = std::fs::File::open(path).unwrap(); | ||
| request.respond(Response::from_file(file)).unwrap(); | ||
| } | ||
| None => { | ||
| let file = std::fs::File::open(&doc_path_index).unwrap(); | ||
| request.respond(Response::from_file(file)).unwrap(); | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This should be outlined into a separate function.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Too easy, will do
(Also please make sure to run |
A starting implementation looking for feedback and whether I am on the right path