Extract crates_io_diesel_helpers crate (#10291)

This makes it possible to compile them concurrently and also makes them potentially usable in other workspace crates.

Author: Turbo87

Cargo.lock

@@ -58,6 +58,7 @@ colored = "=2.2.0"
 crates_io_cdn_logs = { path = "crates/crates_io_cdn_logs" }
 crates_io_database = { path = "crates/crates_io_database" }
 crates_io_database_dump = { path = "crates/crates_io_database_dump" }
+crates_io_diesel_helpers = { path = "crates/crates_io_diesel_helpers" }
 crates_io_env_vars = { path = "crates/crates_io_env_vars" }
 crates_io_github = { path = "crates/crates_io_github" }
 crates_io_index = { path = "crates/crates_io_index" }

Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "crates_io_diesel_helpers"
+version = "0.0.0"
+license = "MIT OR Apache-2.0"
+edition = "2021"
+
+[lints]
+workspace = true
+
+[dependencies]
+diesel = { version = "=2.2.6", features = ["postgres"] }
+semver = "=1.0.24"
+serde = { version = "=1.0.217", features = ["derive"] }
+
+[dev-dependencies]
+crates_io_database = { path = "../crates_io_database" }

crates/crates_io_diesel_helpers/Cargo.toml

@@ -0,0 +1,16 @@
+# `crates_io_diesel_helpers`
+
+This package contains a set of helper functions for working with the
+[`diesel`](https://crates.io/crates/diesel) database crate.
+
+Specifically, it contains:
+
+- various `define_sql_function!()` calls to define SQL functions to be used in
+  Diesel queries (e.g. `lower()`, `floor()`, etc.)
+
+- a deserialization helper for `semver::Version`
+
+- a `pg_enum!()` macro to define an enum based on a PostgreSQL integer column
+
+This package was extracted from the main application to avoid repeated 
+recompilation of these macros when the main application is recompiled.

crates/crates_io_diesel_helpers/README.md

@@ -0,0 +1,16 @@
+use diesel::define_sql_function;
+use diesel::sql_types::{Date, Double, Integer, Interval, SingleValue, Text, Timestamp};
+
+define_sql_function!(#[aggregate] fn array_agg<T: SingleValue>(x: T) -> Array<T>);
+define_sql_function!(fn canon_crate_name(x: Text) -> Text);
+define_sql_function!(fn to_char(a: Date, b: Text) -> Text);
+define_sql_function!(fn lower(x: Text) -> Text);
+define_sql_function!(fn date_part(x: Text, y: Timestamp) -> Double);
+define_sql_function! {
+    #[sql_name = "date_part"]
+    fn interval_part(x: Text, y: Interval) -> Double;
+}
+define_sql_function!(fn floor(x: Double) -> Integer);
+define_sql_function!(fn greatest<T: SingleValue>(x: T, y: T) -> T);
+define_sql_function!(fn least<T: SingleValue>(x: T, y: T) -> T);
+define_sql_function!(fn split_part(string: Text, delimiter: Text, n: Integer) -> Text);

crates/crates_io_diesel_helpers/src/fns.rs

@@ -0,0 +1,8 @@
+#![doc = include_str!("../README.md")]
+
+mod fns;
+mod pg_enum;
+mod semver;
+
+pub use self::fns::*;
+pub use self::semver::SemverVersion;

crates/crates_io_diesel_helpers/src/lib.rs

@@ -1,30 +1,11 @@
-use diesel::sql_types::{Date, Double, Integer, Interval, SingleValue, Text, Timestamp};
-
-mod semver;
-
-pub use semver::SemverVersion;
-
-define_sql_function!(#[aggregate] fn array_agg<T: SingleValue>(x: T) -> Array<T>);
-define_sql_function!(fn canon_crate_name(x: Text) -> Text);
-define_sql_function!(fn to_char(a: Date, b: Text) -> Text);
-define_sql_function!(fn lower(x: Text) -> Text);
-define_sql_function!(fn date_part(x: Text, y: Timestamp) -> Double);
-define_sql_function! {
-    #[sql_name = "date_part"]
-    fn interval_part(x: Text, y: Interval) -> Double;
-}
-define_sql_function!(fn floor(x: Double) -> Integer);
-define_sql_function!(fn greatest<T: SingleValue>(x: T, y: T) -> T);
-define_sql_function!(fn least<T: SingleValue>(x: T, y: T) -> T);
-define_sql_function!(fn split_part(string: Text, delimiter: Text, n: Integer) -> Text);
-
+#[macro_export]
 macro_rules! pg_enum {
     (
         $vis:vis enum $name:ident {
             $($item:ident = $int:expr,)*
         }
     ) => {
-        #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, FromSqlRow, AsExpression)]
+        #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize, diesel::FromSqlRow, diesel::AsExpression)]
         #[diesel(sql_type = diesel::sql_types::Integer)]
         #[serde(rename_all = "snake_case")]
         #[repr(i32)]
@@ -55,5 +36,3 @@ macro_rules! pg_enum {
         }
     }
 }
-
-pub(crate) use pg_enum;

src/sql.rs renamed to crates/crates_io_diesel_helpers/src/pg_enum.rs

@@ -7,8 +7,8 @@ use diesel::Queryable;
 /// ## Example
 ///
 /// ```rust
-/// # use crates_io::sql::SemverVersion;
-/// # use crates_io::schema::versions;
+/// # use crates_io_diesel_helpers::SemverVersion;
+/// # use crates_io_database::schema::versions;
 /// # use diesel::prelude::*;
 /// #
 /// #[derive(Clone, Debug, Queryable, Selectable)]

src/sql/semver.rs renamed to crates/crates_io_diesel_helpers/src/semver.rs

@@ -7,6 +7,7 @@
 use anyhow::Result;
 use crates_io::worker::jobs;
 use crates_io::{db, schema::*};
+use crates_io_diesel_helpers::canon_crate_name;
 use crates_io_env_vars::{required_var, var, var_parsed};
 use crates_io_pagerduty as pagerduty;
 use crates_io_pagerduty::PagerdutyClient;
@@ -131,8 +132,6 @@ async fn check_spam_attack(
     conn: &mut AsyncPgConnection,
     pagerduty: &PagerdutyClient,
 ) -> Result<()> {
-    use crates_io::sql::canon_crate_name;
-
     const EVENT_KEY: &str = "spam_attack";
 
     println!("Checking for crates indicating someone is spamming us");

src/bin/monitor.rs

@@ -7,11 +7,11 @@ use crate::app::AppState;
 use crate::controllers::krate::CratePath;
 use crate::models::{Version, VersionDownload};
 use crate::schema::{version_downloads, versions};
-use crate::sql::to_char;
 use crate::util::errors::AppResult;
 use crate::views::EncodableVersionDownload;
 use axum_extra::json;
 use axum_extra::response::ErasedJson;
+use crates_io_diesel_helpers::to_char;
 use diesel::prelude::*;
 use diesel_async::RunQueryDsl;
 use std::cmp;