use super::PathInfoService;
use crate::composition::{
with_registry, CompositionContext, DeserializeWithRegistry, ServiceBuilder, REG,
};
use std::sync::Arc;
use tvix_castore::Error;
use url::Url;
/// Constructs a new instance of a [PathInfoService] from an URI.
///
/// The following URIs are supported:
/// - `memory:`
/// Uses a in-memory implementation.
/// - `redb:`
/// Uses a in-memory redb implementation.
/// - `redb:///absolute/path/to/somewhere`
/// Uses redb, using a path on the disk for persistency. Can be only opened
/// from one process at the same time.
/// - `nix+https://cache.nixos.org?trusted-public-keys=cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=`
/// Exposes the Nix binary cache as a PathInfoService, ingesting NARs into the
/// {Blob,Directory}Service. You almost certainly want to use this with some cache.
/// The `trusted-public-keys` URL parameter can be provided, which will then
/// enable signature verification.
/// - `grpc+unix:///absolute/path/to/somewhere`
/// Connects to a local tvix-store gRPC service via Unix socket.
/// - `grpc+http://host:port`, `grpc+https://host:port`
/// Connects to a (remote) tvix-store gRPC service.
///
/// As the [PathInfoService] needs to talk to [BlobService] and [DirectoryService],
/// these also need to be passed in.
pub async fn from_addr(
uri: &str,
context: Option<&CompositionContext<'_>>,
) -> Result<Arc<dyn PathInfoService>, Box<dyn std::error::Error + Send + Sync>> {
#[allow(unused_mut)]
let mut url =
Url::parse(uri).map_err(|e| Error::StorageError(format!("unable to parse url: {}", e)))?;
let path_info_service_config = with_registry(®, || {
<DeserializeWithRegistry<Box<dyn ServiceBuilder<Output = dyn PathInfoService>>>>::try_from(
url,
)
})?
.0;
let path_info_service = path_info_service_config
.build(
"anonymous",
context.unwrap_or(&CompositionContext::blank(®)),
)
.await?;
Ok(path_info_service)
}
#[cfg(test)]
mod tests {
use super::from_addr;
use crate::composition::{Composition, DeserializeWithRegistry, ServiceBuilder, REG};
use rstest::rstest;
use std::sync::LazyLock;
use tempfile::TempDir;
use tvix_castore::blobservice::{BlobService, MemoryBlobServiceConfig};
use tvix_castore::directoryservice::{DirectoryService, MemoryDirectoryServiceConfig};
static TMPDIR_REDB_1: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
static TMPDIR_REDB_2: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
// the gRPC tests below don't fail, because we connect lazily.
#[rstest]
/// This uses a unsupported scheme.
#[case::unsupported_scheme("http://foo.example/test", false)]
/// This correctly sets the scheme, and doesn't set a path.
#[case::memory_valid("memory://", true)]
/// This sets a memory url host to `foo`
#[case::memory_invalid_host("memory://foo", false)]
/// This sets a memory url path to "/", which is invalid.
#[case::memory_invalid_root_path("memory:///", false)]
/// This sets a memory url path to "/foo", which is invalid.
#[case::memory_invalid_root_path_foo("memory:///foo", false)]
/// redb with a host, and a valid path path, which should fail.
#[case::redb_invalid_host_with_valid_path(&format!("redb://foo.example{}", &TMPDIR_REDB_1.path().join("bar").to_str().unwrap()), false)]
/// redb with / as path, which should fail.
#[case::redb_invalid_root("redb:///", false)]
/// This configures redb with a valid path, which should succeed.
#[case::redb_valid_path(&format!("redb://{}", &TMPDIR_REDB_2.path().join("foo").to_str().unwrap()), true)]
/// redb using the in-memory backend, which should succeed.
#[case::redb_valid_in_memory("redb://", true)]
/// Correct Scheme for the cache.nixos.org binary cache.
#[case::correct_nix_https("nix+https://cache.nixos.org", true)]
/// Correct Scheme for the cache.nixos.org binary cache (HTTP URL).
#[case::correct_nix_http("nix+http://cache.nixos.org", true)]
/// Correct Scheme for Nix HTTP Binary cache, with a subpath.
#[case::correct_nix_http_with_subpath("nix+http://192.0.2.1/foo", true)]
/// Correct Scheme for Nix HTTP Binary cache, with a subpath and port.
#[case::correct_nix_http_with_subpath_and_port("nix+http://[::1]:8080/foo", true)]
/// Correct Scheme for the cache.nixos.org binary cache, and correct trusted public key set
#[case::correct_nix_https_with_trusted_public_key("nix+https://cache.nixos.org?trusted-public-keys=cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=", true)]
/// Correct Scheme for the cache.nixos.org binary cache, and two correct trusted public keys set
#[case::correct_nix_https_with_two_trusted_public_keys("nix+https://cache.nixos.org?trusted-public-keys=cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=%20foo:jp4fCEx9tBEId/L0ZsVJ26k0wC0fu7vJqLjjIGFkup8=", true)]
/// Correct scheme to connect to a unix socket.
#[case::grpc_valid_unix_socket("grpc+unix:///path/to/somewhere", true)]
/// Correct scheme for unix socket, but setting a host too, which is invalid.
#[case::grpc_invalid_unix_socket_and_host("grpc+unix://host.example/path/to/somewhere", false)]
/// Correct scheme to connect to localhost, with port 12345
#[case::grpc_valid_ipv6_localhost_port_12345("grpc+http://[::1]:12345", true)]
/// Correct scheme to connect to localhost over http, without specifying a port.
#[case::grpc_valid_http_host_without_port("grpc+http://localhost", true)]
/// Correct scheme to connect to localhost over http, without specifying a port.
#[case::grpc_valid_https_host_without_port("grpc+https://localhost", true)]
/// Correct scheme to connect to localhost over http, but with additional path, which is invalid.
#[case::grpc_invalid_host_and_path("grpc+http://localhost/some-path", false)]
/// A valid example for Bigtable.
#[cfg_attr(
all(feature = "cloud", feature = "integration"),
case::bigtable_valid(
"bigtable://instance-1?project_id=project-1&table_name=table-1&family_name=cf1",
true
)
)]
/// An invalid example for Bigtable, missing fields
#[cfg_attr(
all(feature = "cloud", feature = "integration"),
case::bigtable_invalid_missing_fields("bigtable://instance-1", false)
)]
#[tokio::test]
async fn test_from_addr_tokio(#[case] uri_str: &str, #[case] exp_succeed: bool) {
let mut comp = Composition::new(®);
comp.extend(vec![(
"default".into(),
DeserializeWithRegistry(Box::new(MemoryBlobServiceConfig {})
as Box<dyn ServiceBuilder<Output = dyn BlobService>>),
)]);
comp.extend(vec![(
"default".into(),
DeserializeWithRegistry(Box::new(MemoryDirectoryServiceConfig {})
as Box<dyn ServiceBuilder<Output = dyn DirectoryService>>),
)]);
let resp = from_addr(uri_str, Some(&comp.context())).await;
if exp_succeed {
resp.expect("should succeed");
} else {
assert!(resp.is_err(), "should fail");
}
}
}
