Add yank_message field to API version responses (#9437)

Turbo87 · web-flow · commit 36785832af5e · 2024-09-12T23:07:46.000+02:00
This field can currently only be set directly in the database, but introducing it in a dedicated commit/PR makes the diff of the commit that introduces the update API much more manageable.
diff --git a/src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field-2.snap b/src/tests/krate/publish/snapshots/all__krate__publish__links__crate_with_links_field-2.snap
@@ -45,6 +45,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }
diff --git a/src/tests/krate/publish/snapshots/all__krate__publish__manifest__boolean_readme-2.snap b/src/tests/krate/publish/snapshots/all__krate__publish__manifest__boolean_readme-2.snap
@@ -45,6 +45,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": "1.69",
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }
diff --git a/src/tests/krate/publish/snapshots/all__krate__publish__manifest__lib_and_bin_crate-2.snap b/src/tests/krate/publish/snapshots/all__krate__publish__manifest__lib_and_bin_crate-2.snap
@@ -48,6 +48,7 @@ expression: response.json()
     "readme_path": "/api/v1/crates/foo/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__read__show.snap b/src/tests/routes/crates/snapshots/all__routes__crates__read__show.snap
@@ -71,6 +71,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/1.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -103,6 +104,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/0.5.1/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -135,6 +137,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_show/0.5.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__prerelease_versions_not_included_in_reverse_dependencies.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__prerelease_versions_not_included_in_reverse_dependencies.snap
@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c3/1.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies.snap
@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/1.1.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_includes_published_by_user_when_present.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_includes_published_by_user_when_present.snap
@@ -63,6 +63,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c3/3.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -89,6 +90,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_query_supports_u64_version_number_parts.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_query_supports_u64_version_number_parts.snap
@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/1.0.18446744073709551615/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_when_old_version_doesnt_depend_but_new_does.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__reverse_dependencies_when_old_version_doesnt_depend_but_new_does.snap
@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__yanked_versions_not_included_in_reverse_dependencies.snap b/src/tests/routes/crates/snapshots/all__routes__crates__reverse_dependencies__yanked_versions_not_included_in_reverse_dependencies.snap
@@ -51,6 +51,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/c2/2.0.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__list__versions.snap b/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__list__versions.snap
@@ -28,6 +28,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/1.0.0/readme",
       "rust_version": "1.64",
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -60,6 +61,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/0.5.1/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     },
     {
@@ -92,6 +94,7 @@ expression: response.json()
       "readme_path": "/api/v1/crates/foo_versions/0.5.0/readme",
       "rust_version": null,
       "updated_at": "[datetime]",
+      "yank_message": null,
       "yanked": false
     }
   ]
diff --git a/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_semver_no_published_by.snap b/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_semver_no_published_by.snap
@@ -27,6 +27,7 @@ expression: json
     "readme_path": "/api/v1/crates/foo_vers_show_no_pb/1.0.0/readme",
     "rust_version": null,
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }
diff --git a/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_version.snap b/src/tests/routes/crates/versions/snapshots/all__routes__crates__versions__read__show_by_crate_name_and_version.snap
@@ -33,6 +33,7 @@ expression: json
     "readme_path": "/api/v1/crates/foo_vers_show/2.0.0/readme",
     "rust_version": "1.64",
     "updated_at": "[datetime]",
+    "yank_message": null,
     "yanked": false
   }
 }
diff --git a/src/views.rs b/src/views.rs
@@ -558,6 +558,7 @@ pub struct EncodableVersion {
     pub downloads: i32,
     pub features: serde_json::Value,
     pub yanked: bool,
+    pub yank_message: Option<String>,
     pub lib_links: Option<String>,
     // NOTE: Used by shields.io, altering `license` requires a PR with shields.io
     pub license: Option<String>,
@@ -586,6 +587,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            yank_message,
             links: lib_links,
             license,
             crate_size,
@@ -613,6 +615,7 @@ impl EncodableVersion {
             downloads,
             features,
             yanked,
+            yank_message,
             lib_links,
             license,
             links,
@@ -736,6 +739,7 @@ mod tests {
             downloads: 0,
             features: serde_json::from_str("{}").unwrap(),
             yanked: false,
+            yank_message: None,
             license: None,
             lib_links: None,
             links: EncodableVersionLinks {

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ expression: response.json()`
`45`	`45`	`"readme_path": "/api/v1/crates/foo/1.0.0/readme",`
`46`	`46`	`"rust_version": null,`
`47`	`47`	`"updated_at": "[datetime]",`
	`48`	`+ "yank_message": null,`
`48`	`49`	`"yanked": false`
`49`	`50`	`}`
`50`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ expression: response.json()`
`48`	`48`	`"readme_path": "/api/v1/crates/foo/1.0.0/readme",`
`49`	`49`	`"rust_version": null,`
`50`	`50`	`"updated_at": "[datetime]",`
	`51`	`+ "yank_message": null,`
`51`	`52`	`"yanked": false`
`52`	`53`	`}`
`53`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ expression: response.json()`
`71`	`71`	`"readme_path": "/api/v1/crates/foo_show/1.0.0/readme",`
`72`	`72`	`"rust_version": null,`
`73`	`73`	`"updated_at": "[datetime]",`
	`74`	`+ "yank_message": null,`
`74`	`75`	`"yanked": false`
`75`	`76`	`},`
`76`	`77`	`{`
`@@ -103,6 +104,7 @@ expression: response.json()`
`103`	`104`	`"readme_path": "/api/v1/crates/foo_show/0.5.1/readme",`
`104`	`105`	`"rust_version": null,`
`105`	`106`	`"updated_at": "[datetime]",`
	`107`	`+ "yank_message": null,`
`106`	`108`	`"yanked": false`
`107`	`109`	`},`
`108`	`110`	`{`
`@@ -135,6 +137,7 @@ expression: response.json()`
`135`	`137`	`"readme_path": "/api/v1/crates/foo_show/0.5.0/readme",`
`136`	`138`	`"rust_version": null,`
`137`	`139`	`"updated_at": "[datetime]",`
	`140`	`+ "yank_message": null,`
`138`	`141`	`"yanked": false`
`139`	`142`	`}`
`140`	`143`	`]`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ expression: response.json()`
`51`	`51`	`"readme_path": "/api/v1/crates/c3/1.0.0/readme",`
`52`	`52`	`"rust_version": null,`
`53`	`53`	`"updated_at": "[datetime]",`
	`54`	`+ "yank_message": null,`
`54`	`55`	`"yanked": false`
`55`	`56`	`}`
`56`	`57`	`]`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ expression: response.json()`
`63`	`63`	`"readme_path": "/api/v1/crates/c3/3.0.0/readme",`
`64`	`64`	`"rust_version": null,`
`65`	`65`	`"updated_at": "[datetime]",`
	`66`	`+ "yank_message": null,`
`66`	`67`	`"yanked": false`
`67`	`68`	`},`
`68`	`69`	`{`
`@@ -89,6 +90,7 @@ expression: response.json()`
`89`	`90`	`"readme_path": "/api/v1/crates/c2/2.0.0/readme",`
`90`	`91`	`"rust_version": null,`
`91`	`92`	`"updated_at": "[datetime]",`
	`93`	`+ "yank_message": null,`
`92`	`94`	`"yanked": false`
`93`	`95`	`}`
`94`	`96`	`]`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ expression: response.json()`
`28`	`28`	`"readme_path": "/api/v1/crates/foo_versions/1.0.0/readme",`
`29`	`29`	`"rust_version": "1.64",`
`30`	`30`	`"updated_at": "[datetime]",`
	`31`	`+ "yank_message": null,`
`31`	`32`	`"yanked": false`
`32`	`33`	`},`
`33`	`34`	`{`
`@@ -60,6 +61,7 @@ expression: response.json()`
`60`	`61`	`"readme_path": "/api/v1/crates/foo_versions/0.5.1/readme",`
`61`	`62`	`"rust_version": null,`
`62`	`63`	`"updated_at": "[datetime]",`
	`64`	`+ "yank_message": null,`
`63`	`65`	`"yanked": false`
`64`	`66`	`},`
`65`	`67`	`{`
`@@ -92,6 +94,7 @@ expression: response.json()`
`92`	`94`	`"readme_path": "/api/v1/crates/foo_versions/0.5.0/readme",`
`93`	`95`	`"rust_version": null,`
`94`	`96`	`"updated_at": "[datetime]",`
	`97`	`+ "yank_message": null,`
`95`	`98`	`"yanked": false`
`96`	`99`	`}`
`97`	`100`	`]`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ expression: json`
`27`	`27`	`"readme_path": "/api/v1/crates/foo_vers_show_no_pb/1.0.0/readme",`
`28`	`28`	`"rust_version": null,`
`29`	`29`	`"updated_at": "[datetime]",`
	`30`	`+ "yank_message": null,`
`30`	`31`	`"yanked": false`
`31`	`32`	`}`
`32`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ expression: json`
`33`	`33`	`"readme_path": "/api/v1/crates/foo_vers_show/2.0.0/readme",`
`34`	`34`	`"rust_version": "1.64",`
`35`	`35`	`"updated_at": "[datetime]",`
	`36`	`+ "yank_message": null,`
`36`	`37`	`"yanked": false`
`37`	`38`	`}`
`38`	`39`	`}`