Merge branch 'main' into optional-liblzma

Author: brianheineman

Cargo.lock

@@ -31,7 +31,7 @@ axum = "0.8.4"
 criterion = "0.6.0"
 diesel = "2.2.10"
 diesel_migrations = "2.2.0"
-flate2 = "1.1.1"
+flate2 = "1.1.2"
 futures-util = "0.3.31"
 hex = "0.4.3"
 indicatif = "0.17.11"
@@ -45,10 +45,10 @@ quick-xml = "0.37.5"
 r2d2_postgres = "0.18.2"
 rand = "0.9.1"
 regex-lite = "0.1.6"
-reqwest = { version = "0.12.18", default-features = false }
+reqwest = { version = "0.12.20", default-features = false }
 reqwest-middleware = "0.4.2"
 reqwest-retry = "0.7.0"
-reqwest-tracing = "0.5.7"
+reqwest-tracing = "0.5.8"
 semver = "1.0.26"
 serde = "1.0.219"
 serde_json = "1.0.140"
@@ -65,7 +65,7 @@ tracing = "0.1.41"
 tracing-indicatif = "0.3.9"
 tracing-subscriber = "0.3.19"
 url = "2.5.4"
-zip = { version = "4.0.0", default-features = false, features = ["deflate"] }
+zip = { version = "4.1.0", default-features = false, features = ["deflate"] }
 
 [workspace.metadata.release]
 shared-version = true

Cargo.toml

@@ -45,7 +45,7 @@ pub async fn extract(url: &str, bytes: &Vec<u8>, out_dir: &Path) -> Result<Vec<P
     let extractor_fn = extractor::registry::get(url)?;
     let mut extract_directories = extractor::ExtractDirectories::default();
     extract_directories.add_mapping(Regex::new(".*")?, out_dir.to_path_buf());
-    extractor_fn(bytes, extract_directories)
+    extractor_fn(bytes, &extract_directories)
 }
 
 #[cfg(test)]

postgresql_archive/src/archive.rs

@@ -13,7 +13,7 @@ use tracing::{debug, instrument, warn};
 /// # Errors
 /// Returns an error if the extraction fails.
 #[instrument(skip(bytes))]
-pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Result<Vec<PathBuf>> {
+pub fn extract(bytes: &Vec<u8>, extract_directories: &ExtractDirectories) -> Result<Vec<PathBuf>> {
     let out_dir = extract_directories.get_path(".")?;
 
     let parent_dir = if let Some(parent) = out_dir.parent() {
@@ -41,7 +41,7 @@ pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Resu
     debug!("Extracting archive to {}", extract_dir.to_string_lossy());
     let mut archive_extract_directories = ExtractDirectories::default();
     archive_extract_directories.add_mapping(Regex::new(".*")?, extract_dir.clone());
-    let files = tar_gz_extract(bytes, archive_extract_directories)?;
+    let files = tar_gz_extract(bytes, &archive_extract_directories)?;
 
     if out_dir.exists() {
         debug!(

postgresql_archive/src/configuration/theseus/extractor.rs

@@ -16,7 +16,7 @@ use zip::ZipArchive;
 /// Returns an error if the extraction fails.
 #[expect(clippy::case_sensitive_file_extension_comparisons)]
 #[instrument(skip(bytes))]
-pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Result<Vec<PathBuf>> {
+pub fn extract(bytes: &Vec<u8>, extract_directories: &ExtractDirectories) -> Result<Vec<PathBuf>> {
     let out_dir = extract_directories.get_path(".")?;
     let parent_dir = if let Some(parent) = out_dir.parent() {
         parent
@@ -63,7 +63,7 @@ pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Resu
 
     let mut archive_extract_directories = ExtractDirectories::default();
     archive_extract_directories.add_mapping(Regex::new(".*")?, extract_dir.clone());
-    let files = tar_xz_extract(&archive_bytes, archive_extract_directories)?;
+    let files = tar_xz_extract(&archive_bytes, &archive_extract_directories)?;
 
     if out_dir.exists() {
         debug!(

postgresql_archive/src/configuration/zonky/extractor.rs

@@ -12,7 +12,7 @@ static REGISTRY: LazyLock<Arc<Mutex<RepositoryRegistry>>> =
     LazyLock::new(|| Arc::new(Mutex::new(RepositoryRegistry::default())));
 
 type SupportsFn = fn(&str) -> Result<bool>;
-type ExtractFn = fn(&Vec<u8>, ExtractDirectories) -> Result<Vec<PathBuf>>;
+type ExtractFn = fn(&Vec<u8>, &ExtractDirectories) -> Result<Vec<PathBuf>>;
 
 /// Singleton struct to store extractors
 #[expect(clippy::type_complexity)]
@@ -107,7 +107,7 @@ mod tests {
         let extractor = get(url)?;
         let mut extract_directories = ExtractDirectories::default();
         extract_directories.add_mapping(Regex::new(".*")?, PathBuf::from("test"));
-        assert!(extractor(&Vec::new(), extract_directories).is_ok());
+        assert!(extractor(&Vec::new(), &extract_directories).is_ok());
         Ok(())
     }
 

postgresql_archive/src/extractor/registry.rs

@@ -14,7 +14,7 @@ use tracing::{debug, instrument, warn};
 /// # Errors
 /// Returns an error if the extraction fails.
 #[instrument(skip(bytes))]
-pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Result<Vec<PathBuf>> {
+pub fn extract(bytes: &Vec<u8>, extract_directories: &ExtractDirectories) -> Result<Vec<PathBuf>> {
     let mut files = Vec::new();
     let input = BufReader::new(Cursor::new(bytes));
     let decoder = GzDecoder::new(input);

postgresql_archive/src/extractor/tar_gz_extractor.rs

@@ -14,7 +14,7 @@ use tracing::{debug, instrument, warn};
 /// # Errors
 /// Returns an error if the extraction fails.
 #[instrument(skip(bytes))]
-pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Result<Vec<PathBuf>> {
+pub fn extract(bytes: &Vec<u8>, extract_directories: &ExtractDirectories) -> Result<Vec<PathBuf>> {
     let mut files = Vec::new();
     let input = BufReader::new(Cursor::new(bytes));
     let decoder = XzDecoder::new(input);

postgresql_archive/src/extractor/tar_xz_extractor.rs

@@ -13,7 +13,7 @@ use zip::ZipArchive;
 /// # Errors
 /// Returns an error if the extraction fails.
 #[instrument(skip(bytes))]
-pub fn extract(bytes: &Vec<u8>, extract_directories: ExtractDirectories) -> Result<Vec<PathBuf>> {
+pub fn extract(bytes: &Vec<u8>, extract_directories: &ExtractDirectories) -> Result<Vec<PathBuf>> {
     let mut files = Vec::new();
     let reader = Cursor::new(bytes);
     let mut archive = ZipArchive::new(reader).map_err(|_| io::Error::other("Zip error"))?;

postgresql_archive/src/extractor/zip_extractor.rs

@@ -110,6 +110,30 @@ The following features are available:
 | `tokio`      | Enables using tokio for async                            | No       |
 | `zonky`      | Enables zonky PostgreSQL binaries                        | No       |
 
+## Bundling PostgreSQL
+
+To bundle PostgreSQL with your application, you can enable the `bundled` feature. This will download the PostgreSQL
+archive at compile time and include it in your binary. You should specify the version of PostgreSQL to bundle by
+setting the environment variable `POSTGRESQL_VERSION` to a specific version, e.g. `=17.2.0`. In order to use the bundled
+PostgreSQL, you will also need to set an explicit matching version at runtime in `Settings`:
+
+```rust
+use postgresql_embedded::{Result, Settings, VersionReq};
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let settings = Settings {
+        version: VersionReq::from_str("=17.2.0")?,
+        ..Default::default()
+    };
+    Ok(())
+}
+```
+
+The PostgreSQL binaries can also be obtained from a different GitHub source by setting the `POSTGRESQL_RELEASES_URL`
+environment variable. The repository must contain the releases with archives in same structure as
+[theseus-rs/postgresql_binaries](https://github.com/theseus-rs/postgresql-binaries).
+
 ## Safety
 
 This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% safe Rust.