Merge pull request #9932 from Turbo87/edition-column

Add `versions.edition` column to the database and expose it on the API

Author: Turbo87

crates/crates_io_database/src/schema.rs

@@ -1011,6 +1011,8 @@ diesel::table! {
         yank_message -> Nullable<Text>,
         /// This is the same as `num` without the optional "build metadata" part (except for some versions that were published before we started validating this).
         num_no_build -> Varchar,
+        /// The declared Rust Edition required to compile this version of the crate.
+        edition -> Nullable<Text>,
     }
 }
 

crates/crates_io_database_dump/src/dump-db.toml

@@ -246,6 +246,7 @@ rust_version = "public"
 has_lib = "public"
 bin_names = "public"
 yank_message = "private"
+edition = "public"
 
 [versions_published_by.columns]
 version_id = "private"

crates/crates_io_database_dump/src/snapshots/[email protected]

@@ -18,7 +18,7 @@ BEGIN ISOLATION LEVEL REPEATABLE READ, READ ONLY;
     \copy "crates_keywords" ("crate_id", "keyword_id") TO 'data/crates_keywords.csv' WITH CSV HEADER
     \copy (SELECT "crate_id", "created_at", "created_by", "owner_id", "owner_kind" FROM "crate_owners" WHERE NOT deleted) TO 'data/crate_owners.csv' WITH CSV HEADER
 
-    \copy "versions" ("bin_names", "checksum", "crate_id", "crate_size", "created_at", "downloads", "features", "has_lib", "id", "license", "links", "num", "published_by", "rust_version", "updated_at", "yanked") TO 'data/versions.csv' WITH CSV HEADER
+    \copy "versions" ("bin_names", "checksum", "crate_id", "crate_size", "created_at", "downloads", "edition", "features", "has_lib", "id", "license", "links", "num", "published_by", "rust_version", "updated_at", "yanked") TO 'data/versions.csv' WITH CSV HEADER
     \copy "default_versions" ("crate_id", "version_id") TO 'data/default_versions.csv' WITH CSV HEADER
     \copy "dependencies" ("crate_id", "default_features", "explicit_name", "features", "id", "kind", "optional", "req", "target", "version_id") TO 'data/dependencies.csv' WITH CSV HEADER
     \copy "version_downloads" ("date", "downloads", "version_id") TO 'data/version_downloads.csv' WITH CSV HEADER

crates/crates_io_database_dump/src/snapshots/[email protected]

@@ -60,7 +60,7 @@ BEGIN;
     \copy "crates_categories" ("category_id", "crate_id") FROM 'data/crates_categories.csv' WITH CSV HEADER
     \copy "crates_keywords" ("crate_id", "keyword_id") FROM 'data/crates_keywords.csv' WITH CSV HEADER
     \copy "crate_owners" ("crate_id", "created_at", "created_by", "owner_id", "owner_kind") FROM 'data/crate_owners.csv' WITH CSV HEADER
-    \copy "versions" ("bin_names", "checksum", "crate_id", "crate_size", "created_at", "downloads", "features", "has_lib", "id", "license", "links", "num", "published_by", "rust_version", "updated_at", "yanked") FROM 'data/versions.csv' WITH CSV HEADER
+    \copy "versions" ("bin_names", "checksum", "crate_id", "crate_size", "created_at", "downloads", "edition", "features", "has_lib", "id", "license", "links", "num", "published_by", "rust_version", "updated_at", "yanked") FROM 'data/versions.csv' WITH CSV HEADER
     \copy "default_versions" ("crate_id", "version_id") FROM 'data/default_versions.csv' WITH CSV HEADER
     \copy "dependencies" ("crate_id", "default_features", "explicit_name", "features", "id", "kind", "optional", "req", "target", "version_id") FROM 'data/dependencies.csv' WITH CSV HEADER
     \copy "version_downloads" ("date", "downloads", "version_id") FROM 'data/version_downloads.csv' WITH CSV HEADER

migrations/2024-11-14-124312_add-edition-column/down.sql

@@ -0,0 +1,2 @@
+alter table versions
+    drop column edition;

migrations/2024-11-14-124312_add-edition-column/up.sql

@@ -0,0 +1,4 @@
+alter table versions
+    add column edition text;
+
+comment on column versions.edition is 'The declared Rust Edition required to compile this version of the crate.';

src/controllers/krate/publish.rs

@@ -181,6 +181,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
         let documentation = package.documentation.map(|it| it.as_local().unwrap());
         let repository = package.repository.map(|it| it.as_local().unwrap());
         let rust_version = package.rust_version.map(|rv| rv.as_local().unwrap());
+        let edition = package.edition.map(|rv| rv.as_local().unwrap());
 
         // Make sure required fields are provided
         fn empty(s: Option<&String>) -> bool {
@@ -384,6 +385,8 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
                 .filter_map(|bin| bin.name.as_deref())
                 .collect::<Vec<_>>();
 
+            let edition = edition.map(|edition| edition.as_str());
+
             // Read tarball from request
             let hex_cksum: String = Sha256::digest(&tarball_bytes).encode_hex();
 
@@ -400,6 +403,7 @@ pub async fn publish(app: AppState, req: BytesRequest) -> AppResult<Json<GoodCra
                 .maybe_rust_version(rust_version.as_deref())
                 .has_lib(tarball_info.manifest.lib.is_some())
                 .bin_names(bin_names.as_slice())
+                .maybe_edition(edition)
                 .build();
 
             let version = new_version.save(conn, &verified_email_address).map_err(|error| {

src/models/version.rs

@@ -33,6 +33,7 @@ pub struct Version {
     pub bin_names: Option<Vec<Option<String>>>,
     pub yank_message: Option<String>,
     pub num_no_build: String,
+    pub edition: Option<String>,
 }
 
 impl Version {
@@ -96,6 +97,7 @@ pub struct NewVersion<'a> {
     rust_version: Option<&'a str>,
     pub has_lib: Option<bool>,
     pub bin_names: Option<&'a [&'a str]>,
+    edition: Option<&'a str>,
 }
 
 impl NewVersion<'_> {

src/tests/krate/publish/edition.rs

@@ -0,0 +1,38 @@
+use crate::tests::builders::PublishBuilder;
+use crate::tests::util::insta::{any_id_redaction, id_redaction};
+use crate::tests::util::{RequestHelper, TestApp};
+use http::StatusCode;
+use insta::assert_json_snapshot;
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_edition_is_saved() {
+    let (_app, _, _, token) = TestApp::full().with_token().await;
+
+    let manifest = r#"
+        [package]
+        name = "foo"
+        version = "1.0.0"
+        description = "description"
+        license = "MIT"
+        edition = "2021"
+        rust-version = "1.0"
+    "#;
+    let pb = PublishBuilder::new("foo", "1.0.0").custom_manifest(manifest);
+    let response = token.publish_crate(pb).await;
+    assert_eq!(response.status(), StatusCode::OK);
+    assert_json_snapshot!(response.json(), {
+        ".crate.created_at" => "[datetime]",
+        ".crate.updated_at" => "[datetime]",
+    });
+
+    let response = token.get::<()>("/api/v1/crates/foo/1.0.0").await;
+    assert_eq!(response.status(), StatusCode::OK);
+    assert_json_snapshot!(response.json(), {
+        ".version.id" => any_id_redaction(),
+        ".version.created_at" => "[datetime]",
+        ".version.updated_at" => "[datetime]",
+        ".version.published_by.id" => id_redaction(token.as_model().user_id),
+        ".version.audit_actions[].time" => "[datetime]",
+        ".version.audit_actions[].user.id" => id_redaction(token.as_model().user_id),
+    });
+}

src/tests/krate/publish/mod.rs

@@ -5,6 +5,7 @@ mod build_metadata;
 mod categories;
 mod deleted_crates;
 mod dependencies;
+mod edition;
 mod emails;
 mod features;
 mod git;