wip

Author: syphar

src/config/server.rs

@@ -87,6 +87,9 @@ pub struct Server {
     pub html_render_cache_max_capacity: u64,
 
     pub content_security_policy: Option<HeaderValue>,
+
+    pub docs_rs_url: url::Url,
+    pub docs_rs_api_token: Option<String>,
 }
 
 impl Server {
@@ -233,6 +236,9 @@ impl Server {
             og_image_base_url: var_parsed("OG_IMAGE_BASE_URL")?,
             html_render_cache_max_capacity: var_parsed("HTML_RENDER_CACHE_CAP")?.unwrap_or(1024),
             content_security_policy: Some(content_security_policy.parse()?),
+            docs_rs_url: var_parsed("DOCS_RS_HOSTNAME")?
+                .unwrap_or_else(|| url::Url::parse("https://docs.rs").unwrap()),
+            docs_rs_api_token: var("DOCS_RS_API_TOKEN")?,
         })
     }
 }

src/controllers/version.rs

@@ -1,5 +1,6 @@
 pub mod authors;
 pub mod dependencies;
+pub mod docs;
 pub mod downloads;
 pub mod metadata;
 pub mod readme;

src/controllers/version/docs.rs

@@ -0,0 +1,71 @@
+//! Endpoint for triggering a docs.rs rebuild
+
+use super::update::authenticate;
+use super::CrateVersionPath;
+use crate::app::AppState;
+use crate::controllers::helpers::ok_true;
+use crate::rate_limiter::LimitedAction;
+use crate::util::errors::{forbidden, AppResult};
+use axum::response::Response;
+use http::request::Parts;
+
+/// Trigger a rebuild for the crate documentation on docs.rs.
+#[utoipa::path(
+    post,
+    path = "/api/v1/crates/{name}/{version}/rebuild_docs",
+    params(CrateVersionPath),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
+    tag = "versions",
+    responses((status = 201, description = "Successful Response")),
+)]
+pub async fn rebuild_version_docs(
+    app: AppState,
+    path: CrateVersionPath,
+    req: Parts,
+) -> AppResult<Response> {
+    let Some(ref docs_rs_api_token) = app.config.docs_rs_api_token else {
+        return Err(forbidden("docs.rs integration is not configured"));
+    };
+
+    let mut conn = app.db_read().await?;
+    // FIXME: which scope to use?
+    let auth = authenticate(&req, &mut conn, &path.name).await?;
+
+    // FIXME: rate limiting needed here? which Action?
+    app.rate_limiter
+        .check_rate_limit(auth.user_id(), LimitedAction::YankUnyank, &mut conn)
+        .await?;
+
+    let target_url = app
+        .config
+        .docs_rs_url
+        .join(&format!("/crate/{}/{}/rebuild", path.name, path.version))
+        .unwrap(); // FIXME: handle error
+
+    let client = reqwest::Client::new();
+    let response = client
+        .post(target_url.as_str())
+        .bearer_auth(docs_rs_api_token)
+        .send()
+        .await?;
+
+    let status= = response.status();
+
+    // reqwest::
+
+    // perform_version_yank_update(
+    //     &state,
+    //     &mut conn,
+    //     &mut version,
+    //     &krate,
+    //     &auth,
+    //     Some(yanked),
+    //     None,
+    // )
+    // .await?;
+
+    ok_true()
+}