Merge pull request #8945 from Turbo87/links-api

Expose `versions.links` column on the API

Author: Turbo87

src/tests/krate/publish/links.rs

@@ -0,0 +1,39 @@
+use crate::builders::PublishBuilder;
+use crate::util::insta::{self, assert_json_snapshot};
+use crate::util::{RequestHelper, TestApp};
+use http::StatusCode;
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_crate_with_links_field() {
+    let (app, anon, _, token) = TestApp::full().with_token();
+
+    let manifest = r#"
+    [package]
+    name = "foo"
+    version = "1.0.0"
+    description = "foo?!"
+    license = "MIT"
+    links = "git2"
+    "#;
+
+    let pb = PublishBuilder::new("foo", "1.0.0").custom_manifest(manifest);
+    let response = token.publish_crate(pb).await;
+    assert_json_snapshot!(response.json(), {
+        ".crate.created_at" => "[datetime]",
+        ".crate.updated_at" => "[datetime]",
+    });
+    assert_eq!(response.status(), StatusCode::OK);
+
+    let response = anon.get::<()>("/api/v1/crates/foo/1.0.0").await;
+    assert_json_snapshot!(response.json(), {
+        ".version.id" => insta::any_id_redaction(),
+        ".version.created_at" => "[datetime]",
+        ".version.updated_at" => "[datetime]",
+        ".version.audit_actions[].time" => "[datetime]",
+        ".version.published_by.id" => insta::any_id_redaction(),
+    });
+    assert_eq!(response.status(), StatusCode::OK);
+
+    let crates = app.crates_from_index_head("foo");
+    assert_json_snapshot!(crates);
+}

src/tests/krate/publish/mod.rs

@@ -9,6 +9,7 @@ mod features;
 mod git;
 mod inheritance;
 mod keywords;
+mod links;
 mod manifest;
 mod max_size;
 mod rate_limit;

src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field-2.snap

@@ -0,0 +1,50 @@
+---
+source: src/tests/krate/publish/links.rs
+expression: response.json()
+---
+{
+  "version": {
+    "audit_actions": [
+      {
+        "action": "publish",
+        "time": "[datetime]",
+        "user": {
+          "avatar": null,
+          "id": 1,
+          "login": "foo",
+          "name": null,
+          "url": "https://github.com/foo"
+        }
+      }
+    ],
+    "bin_names": [],
+    "checksum": "5631ca06d228e58274bbd8d6a3e81f7138a9e227a84bd63ecedb78afbc8144ea",
+    "crate": "foo",
+    "crate_size": 162,
+    "created_at": "[datetime]",
+    "dl_path": "/api/v1/crates/foo/1.0.0/download",
+    "downloads": 0,
+    "features": {},
+    "has_lib": false,
+    "id": "[id]",
+    "lib_links": "git2",
+    "license": "MIT",
+    "links": {
+      "authors": "/api/v1/crates/foo/1.0.0/authors",
+      "dependencies": "/api/v1/crates/foo/1.0.0/dependencies",
+      "version_downloads": "/api/v1/crates/foo/1.0.0/downloads"
+    },
+    "num": "1.0.0",
+    "published_by": {
+      "avatar": null,
+      "id": "[id]",
+      "login": "foo",
+      "name": null,
+      "url": "https://github.com/foo"
+    },
+    "readme_path": "/api/v1/crates/foo/1.0.0/readme",
+    "rust_version": null,
+    "updated_at": "[datetime]",
+    "yanked": false
+  }
+}

src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field-3.snap

@@ -0,0 +1,15 @@
+---
+source: src/tests/krate/publish/links.rs
+expression: crates
+---
+[
+  {
+    "name": "foo",
+    "vers": "1.0.0",
+    "deps": [],
+    "cksum": "5631ca06d228e58274bbd8d6a3e81f7138a9e227a84bd63ecedb78afbc8144ea",
+    "features": {},
+    "yanked": false,
+    "links": "git2"
+  }
+]

src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field.snap

@@ -0,0 +1,39 @@
+---
+source: src/tests/krate/publish/links.rs
+expression: response.json()
+---
+{
+  "crate": {
+    "badges": null,
+    "categories": null,
+    "created_at": "[datetime]",
+    "description": "foo?!",
+    "documentation": null,
+    "downloads": 0,
+    "exact_match": false,
+    "homepage": null,
+    "id": "foo",
+    "keywords": null,
+    "links": {
+      "owner_team": "/api/v1/crates/foo/owner_team",
+      "owner_user": "/api/v1/crates/foo/owner_user",
+      "owners": "/api/v1/crates/foo/owners",
+      "reverse_dependencies": "/api/v1/crates/foo/reverse_dependencies",
+      "version_downloads": "/api/v1/crates/foo/downloads",
+      "versions": "/api/v1/crates/foo/versions"
+    },
+    "max_stable_version": "1.0.0",
+    "max_version": "1.0.0",
+    "name": "foo",
+    "newest_version": "1.0.0",
+    "recent_downloads": null,
+    "repository": null,
+    "updated_at": "[datetime]",
+    "versions": null
+  },
+  "warnings": {
+    "invalid_badges": [],
+    "invalid_categories": [],
+    "other": []
+  }
+}

src/tests/krate/publish/snapshots/all__krate__publish__manifest__boolean_readme-2.snap

@@ -27,6 +27,7 @@ expression: response.json()
     "features": {},
     "has_lib": false,
     "id": "[id]",
+    "lib_links": null,
     "license": "MIT",
     "links": {
       "authors": "/api/v1/crates/foo/1.0.0/authors",

src/tests/krate/publish/snapshots/all__krate__publish__manifest__lib_and_bin_crate-2.snap

@@ -30,6 +30,7 @@ expression: response.json()
     "features": {},
     "has_lib": true,
     "id": "[id]",
+    "lib_links": null,
     "license": "MIT",
     "links": {
       "authors": "/api/v1/crates/foo/1.0.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__read__show.snap

@@ -59,6 +59,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 1,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_show/1.0.0/authors",
@@ -84,6 +85,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_show/0.5.1/authors",
@@ -115,6 +117,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 2,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_show/0.5.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__prerelease_versions_not_included_in_reverse_dependencies.snap

@@ -33,6 +33,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c3/1.0.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies.snap

@@ -33,6 +33,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c2/1.1.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_includes_published_by_user_when_present.snap

@@ -45,6 +45,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c3/3.0.0/authors",
@@ -76,6 +77,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 2,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c2/2.0.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_query_supports_u64_version_number_parts.snap

@@ -33,6 +33,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 2,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c2/1.0.18446744073709551615/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_when_old_version_doesnt_depend_but_new_does.snap

@@ -33,6 +33,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c2/2.0.0/authors",

src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__yanked_versions_not_included_in_reverse_dependencies.snap

@@ -33,6 +33,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/c2/2.0.0/authors",

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__list__versions.snap

@@ -16,6 +16,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 2,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_versions/1.0.0/authors",
@@ -41,6 +42,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 1,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_versions/0.5.1/authors",
@@ -72,6 +74,7 @@ expression: response.json()
       "features": {},
       "has_lib": null,
       "id": 3,
+      "lib_links": null,
       "license": null,
       "links": {
         "authors": "/api/v1/crates/foo_versions/0.5.0/authors",

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_semver_no_published_by.snap

@@ -15,6 +15,7 @@ expression: json
     "features": {},
     "has_lib": null,
     "id": "[id]",
+    "lib_links": null,
     "license": null,
     "links": {
       "authors": "/api/v1/crates/foo_vers_show_no_pb/1.0.0/authors",

src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_version.snap

@@ -15,6 +15,7 @@ expression: json
     "features": {},
     "has_lib": null,
     "id": "[id]",
+    "lib_links": null,
     "license": null,
     "links": {
       "authors": "/api/v1/crates/foo_vers_show/2.0.0/authors",

src/views.rs

@@ -558,6 +558,7 @@ pub struct EncodableVersion {
     pub downloads: i32,
     pub features: serde_json::Value,
     pub yanked: bool,
+    pub lib_links: Option<String>,
     // NOTE: Used by shields.io, altering `license` requires a PR with shields.io
     pub license: Option<String>,
     pub links: EncodableVersionLinks,
@@ -585,6 +586,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            links: lib_links,
             license,
             crate_size,
             checksum,
@@ -611,6 +613,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            lib_links,
             license,
             links,
             crate_size,
@@ -734,6 +737,7 @@ mod tests {
             features: serde_json::from_str("{}").unwrap(),
             yanked: false,
             license: None,
+            lib_links: None,
             links: EncodableVersionLinks {
                 dependencies: "".to_string(),
                 version_downloads: "".to_string(),