Connection -> Client

Author: jyn514

src/db/add_package.rs

@@ -12,7 +12,7 @@ use crate::{
     utils::MetadataPackage,
 };
 use log::{debug, info};
-use postgres::Client as Connection;
+use postgres::Client;
 use regex::Regex;
 use serde_json::Value;
 use slug::slugify;
@@ -25,7 +25,7 @@ use slug::slugify;
 /// not the files generated by rustdoc.
 #[allow(clippy::too_many_arguments)]
 pub(crate) fn add_package_into_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     metadata_pkg: &MetadataPackage,
     source_dir: &Path,
     res: &BuildResult,
@@ -132,7 +132,7 @@ pub(crate) fn add_package_into_database(
 
 /// Adds a build into database
 pub(crate) fn add_build_into_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     release_id: i32,
     res: &BuildResult,
 ) -> Result<i32> {
@@ -154,7 +154,7 @@ pub(crate) fn add_build_into_database(
     Ok(rows[0].get(0))
 }
 
-fn initialize_package_in_database(conn: &mut Connection, pkg: &MetadataPackage) -> Result<i32> {
+fn initialize_package_in_database(conn: &mut Client, pkg: &MetadataPackage) -> Result<i32> {
     let mut rows = conn.query("SELECT id FROM crates WHERE name = $1", &[&pkg.name])?;
     // insert crate into database if it is not exists
     if rows.is_empty() {
@@ -250,7 +250,7 @@ fn read_rust_doc(file_path: &Path) -> Result<Option<String>> {
 
 /// Adds keywords into database
 fn add_keywords_into_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     pkg: &MetadataPackage,
     release_id: i32,
 ) -> Result<()> {
@@ -281,7 +281,7 @@ fn add_keywords_into_database(
 
 /// Adds authors into database
 fn add_authors_into_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     pkg: &MetadataPackage,
     release_id: i32,
 ) -> Result<()> {
@@ -326,7 +326,7 @@ fn add_authors_into_database(
 }
 
 pub fn update_crate_data_in_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     name: &str,
     registry_data: &CrateData,
 ) -> Result<()> {
@@ -340,7 +340,7 @@ pub fn update_crate_data_in_database(
 
 /// Adds owners into database
 fn update_owners_in_database(
-    conn: &mut Connection,
+    conn: &mut Client,
     owners: &[CrateOwner],
     crate_id: i32,
 ) -> Result<()> {
@@ -407,11 +407,7 @@ fn update_owners_in_database(
 }
 
 /// Add the compression algorithms used for this crate to the database
-fn add_compression_into_database<I>(
-    conn: &mut Connection,
-    algorithms: I,
-    release_id: i32,
-) -> Result<()>
+fn add_compression_into_database<I>(conn: &mut Client, algorithms: I, release_id: i32) -> Result<()>
 where
     I: Iterator<Item = CompressionAlgorithm>,
 {

src/db/blacklist.rs

@@ -1,5 +1,5 @@
 use failure::{Error, Fail};
-use postgres::Client as Connection;
+use postgres::Client;
 
 #[derive(Debug, Fail)]
 enum BlacklistError {
@@ -11,7 +11,7 @@ enum BlacklistError {
 }
 
 /// Returns whether the given name is blacklisted.
-pub fn is_blacklisted(conn: &mut Connection, name: &str) -> Result<bool, Error> {
+pub fn is_blacklisted(conn: &mut Client, name: &str) -> Result<bool, Error> {
     let rows = conn.query(
         "SELECT COUNT(*) FROM blacklisted_crates WHERE crate_name = $1;",
         &[&name],
@@ -22,7 +22,7 @@ pub fn is_blacklisted(conn: &mut Connection, name: &str) -> Result<bool, Error>
 }
 
 /// Returns the crate names on the blacklist, sorted ascending.
-pub fn list_crates(conn: &mut Connection) -> Result<Vec<String>, Error> {
+pub fn list_crates(conn: &mut Client) -> Result<Vec<String>, Error> {
     let rows = conn.query(
         "SELECT crate_name FROM blacklisted_crates ORDER BY crate_name asc;",
         &[],
@@ -32,7 +32,7 @@ pub fn list_crates(conn: &mut Connection) -> Result<Vec<String>, Error> {
 }
 
 /// Adds a crate to the blacklist.
-pub fn add_crate(conn: &mut Connection, name: &str) -> Result<(), Error> {
+pub fn add_crate(conn: &mut Client, name: &str) -> Result<(), Error> {
     if is_blacklisted(conn, name)? {
         return Err(BlacklistError::CrateAlreadyOnBlacklist(name.into()).into());
     }
@@ -46,7 +46,7 @@ pub fn add_crate(conn: &mut Connection, name: &str) -> Result<(), Error> {
 }
 
 /// Removes a crate from the blacklist.
-pub fn remove_crate(conn: &mut Connection, name: &str) -> Result<(), Error> {
+pub fn remove_crate(conn: &mut Client, name: &str) -> Result<(), Error> {
     if !is_blacklisted(conn, name)? {
         return Err(BlacklistError::CrateNotOnBlacklist(name.into()).into());
     }

src/db/delete.rs

@@ -1,6 +1,6 @@
 use crate::Storage;
 use failure::{Error, Fail};
-use postgres::Client as Connection;
+use postgres::Client;
 
 /// List of directories in docs.rs's underlying storage (either the database or S3) containing a
 /// subdirectory named after the crate. Those subdirectories will be deleted.
@@ -12,7 +12,7 @@ enum CrateDeletionError {
     MissingCrate(String),
 }
 
-pub fn delete_crate(conn: &mut Connection, storage: &Storage, name: &str) -> Result<(), Error> {
+pub fn delete_crate(conn: &mut Client, storage: &Storage, name: &str) -> Result<(), Error> {
     let crate_id = get_id(conn, name)?;
     delete_crate_from_database(conn, name, crate_id)?;
 
@@ -24,7 +24,7 @@ pub fn delete_crate(conn: &mut Connection, storage: &Storage, name: &str) -> Res
 }
 
 pub fn delete_version(
-    conn: &mut Connection,
+    conn: &mut Client,
     storage: &Storage,
     name: &str,
     version: &str,
@@ -38,7 +38,7 @@ pub fn delete_version(
     Ok(())
 }
 
-fn get_id(conn: &mut Connection, name: &str) -> Result<i32, Error> {
+fn get_id(conn: &mut Client, name: &str) -> Result<i32, Error> {
     let crate_id_res = conn.query("SELECT id FROM crates WHERE name = $1", &[&name])?;
     if let Some(row) = crate_id_res.into_iter().next() {
         Ok(row.get("id"))
@@ -56,11 +56,7 @@ const METADATA: &[(&str, &str)] = &[
     ("compression_rels", "release"),
 ];
 
-fn delete_version_from_database(
-    conn: &mut Connection,
-    name: &str,
-    version: &str,
-) -> Result<(), Error> {
+fn delete_version_from_database(conn: &mut Client, name: &str, version: &str) -> Result<(), Error> {
     let crate_id = get_id(conn, name)?;
     let mut transaction = conn.transaction()?;
     for &(table, column) in METADATA {
@@ -92,11 +88,7 @@ fn delete_version_from_database(
     transaction.commit().map_err(Into::into)
 }
 
-fn delete_crate_from_database(
-    conn: &mut Connection,
-    name: &str,
-    crate_id: i32,
-) -> Result<(), Error> {
+fn delete_crate_from_database(conn: &mut Client, name: &str, crate_id: i32) -> Result<(), Error> {
     let mut transaction = conn.transaction()?;
 
     transaction.execute(
@@ -128,15 +120,15 @@ mod tests {
     use super::*;
     use crate::test::{assert_success, wrapper};
     use failure::Error;
-    use postgres::Client as Connection;
+    use postgres::Client;
 
-    fn crate_exists(conn: &mut Connection, name: &str) -> Result<bool, Error> {
+    fn crate_exists(conn: &mut Client, name: &str) -> Result<bool, Error> {
         Ok(!conn
             .query("SELECT * FROM crates WHERE name = $1;", &[&name])?
             .is_empty())
     }
 
-    fn release_exists(conn: &mut Connection, id: i32) -> Result<bool, Error> {
+    fn release_exists(conn: &mut Client, id: i32) -> Result<bool, Error> {
         Ok(!conn
             .query("SELECT * FROM releases WHERE id = $1;", &[&id])?
             .is_empty())
@@ -187,7 +179,7 @@ mod tests {
     #[test]
     fn test_delete_version() {
         wrapper(|env| {
-            fn authors(conn: &mut Connection, crate_id: i32) -> Result<Vec<String>, Error> {
+            fn authors(conn: &mut Client, crate_id: i32) -> Result<Vec<String>, Error> {
                 Ok(conn
                     .query(
                         "SELECT name FROM authors

src/db/migrate.rs

@@ -2,7 +2,7 @@
 
 use crate::error::Result as CratesfyiResult;
 use log::info;
-use postgres::{Client as Connection, Error as PostgresError, Transaction};
+use postgres::{Client, Error as PostgresError, Transaction};
 use schemamama::{Migration, Migrator, Version};
 use schemamama_postgres::{PostgresAdapter, PostgresMigration};
 
@@ -50,7 +50,7 @@ macro_rules! migration {
     }};
 }
 
-pub fn migrate(version: Option<Version>, conn: &mut Connection) -> CratesfyiResult<()> {
+pub fn migrate(version: Option<Version>, conn: &mut Client) -> CratesfyiResult<()> {
     conn.execute(
         "CREATE TABLE IF NOT EXISTS database_versions (version BIGINT PRIMARY KEY);",
         &[],

src/db/mod.rs

@@ -5,7 +5,7 @@ pub(crate) use self::add_package::{add_build_into_database, add_package_into_dat
 pub use self::delete::{delete_crate, delete_version};
 pub use self::file::add_path_into_database;
 pub use self::migrate::migrate;
-pub(crate) use self::pool::PoolConnection;
+pub(crate) use self::pool::PoolClient;
 pub use self::pool::{Pool, PoolError};
 
 mod add_package;

src/db/pool.rs

@@ -1,8 +1,8 @@
 use crate::Config;
-use postgres::{Client as Connection, NoTls};
+use postgres::{Client, NoTls};
 use r2d2_postgres::PostgresConnectionManager;
 
-pub(crate) type PoolConnection = r2d2::PooledConnection<PostgresConnectionManager<NoTls>>;
+pub(crate) type PoolClient = r2d2::PooledConnection<PostgresConnectionManager<NoTls>>;
 
 const DEFAULT_SCHEMA: &str = "public";
 
@@ -39,12 +39,12 @@ impl Pool {
         Ok(Pool { pool })
     }
 
-    pub fn get(&self) -> Result<PoolConnection, PoolError> {
+    pub fn get(&self) -> Result<PoolClient, PoolError> {
         match self.pool.get() {
             Ok(conn) => Ok(conn),
             Err(err) => {
                 crate::web::metrics::FAILED_DB_CONNECTIONS.inc();
-                Err(PoolError::ConnectionError(err))
+                Err(PoolError::ClientError(err))
             }
         }
     }
@@ -71,8 +71,8 @@ impl SetSchema {
     }
 }
 
-impl r2d2::CustomizeConnection<Connection, postgres::Error> for SetSchema {
-    fn on_acquire(&self, conn: &mut Connection) -> Result<(), postgres::Error> {
+impl r2d2::CustomizeConnection<Client, postgres::Error> for SetSchema {
+    fn on_acquire(&self, conn: &mut Client) -> Result<(), postgres::Error> {
         if self.schema != DEFAULT_SCHEMA {
             conn.execute(
                 format!("SET search_path TO {}, {};", self.schema, DEFAULT_SCHEMA).as_str(),
@@ -92,5 +92,5 @@ pub enum PoolError {
     PoolCreationFailed(#[fail(cause)] r2d2::Error),
 
     #[fail(display = "failed to get a database connection")]
-    ConnectionError(#[fail(cause)] r2d2::Error),
+    ClientError(#[fail(cause)] r2d2::Error),
 }

src/docbuilder/limits.rs

@@ -1,5 +1,5 @@
 use crate::error::Result;
-use postgres::Client as Connection;
+use postgres::Client;
 use serde::Serialize;
 use std::time::Duration;
 
@@ -25,7 +25,7 @@ impl Default for Limits {
 }
 
 impl Limits {
-    pub(crate) fn for_crate(conn: &mut Connection, name: &str) -> Result<Self> {
+    pub(crate) fn for_crate(conn: &mut Client, name: &str) -> Result<Self> {
         let mut limits = Self::default();
 
         let res = conn.query(

src/storage/database.rs

@@ -65,18 +65,18 @@ impl DatabaseBackend {
         }
     }
 
-    pub(super) fn start_connection(&self) -> Result<DatabaseConnection, Error> {
-        Ok(DatabaseConnection {
+    pub(super) fn start_connection(&self) -> Result<DatabaseClient, Error> {
+        Ok(DatabaseClient {
             conn: self.pool.get()?,
         })
     }
 }
 
-pub(super) struct DatabaseConnection {
-    conn: crate::db::PoolConnection,
+pub(super) struct DatabaseClient {
+    conn: crate::db::PoolClient,
 }
 
-impl DatabaseConnection {
+impl DatabaseClient {
     pub(super) fn start_storage_transaction(
         &mut self,
     ) -> Result<DatabaseStorageTransaction<'_>, Error> {

src/test/mod.rs

@@ -1,14 +1,14 @@
 mod fakes;
 
-use crate::db::{Pool, PoolConnection};
+use crate::db::{Pool, PoolClient};
 use crate::storage::Storage;
 use crate::web::Server;
 use crate::BuildQueue;
 use crate::Config;
 use failure::Error;
 use log::error;
 use once_cell::unsync::OnceCell;
-use postgres::Client as Connection;
+use postgres::Client;
 use reqwest::{
     blocking::{Client, RequestBuilder},
     Method,
@@ -229,7 +229,7 @@ impl TestDatabase {
         // test to create a fresh instance of the database to run within.
         let schema = format!("docs_rs_test_schema_{}", rand::random::<u64>());
 
-        let mut conn = Connection::connect(config.database_url.as_str(), postgres::TlsMode::None)?;
+        let mut conn = Client::connect(config.database_url.as_str(), postgres::TlsMode::None)?;
         conn.batch_execute(&format!(
             "
                 CREATE SCHEMA {0};
@@ -272,7 +272,7 @@ impl TestDatabase {
         self.pool.clone()
     }
 
-    pub(crate) fn conn(&self) -> PoolConnection {
+    pub(crate) fn conn(&self) -> PoolClient {
         self.pool
             .get()
             .expect("failed to get a connection out of the pool")

src/utils/github_updater.rs

@@ -3,7 +3,7 @@ use crate::{db::Pool, Config};
 use chrono::{DateTime, Utc};
 use failure::err_msg;
 use log::{debug, warn};
-use postgres::Client as Connection;
+use postgres::Client;
 use regex::Regex;
 use reqwest::header::{HeaderValue, ACCEPT, AUTHORIZATION, USER_AGENT};
 use serde::Deserialize;
@@ -120,12 +120,7 @@ impl GithubUpdater {
         Ok(response.resources.core.remaining == 0)
     }
 
-    fn update_crate(
-        &self,
-        conn: &mut Connection,
-        crate_id: i32,
-        repository_url: &str,
-    ) -> Result<()> {
+    fn update_crate(&self, conn: &mut Client, crate_id: i32, repository_url: &str) -> Result<()> {
         let path =
             get_github_path(repository_url).ok_or_else(|| err_msg("Failed to get github path"))?;
         let fields = self.get_github_fields(&path)?;