-
-
Notifications
You must be signed in to change notification settings - Fork 51
/
client.rs
288 lines (263 loc) · 10.6 KB
/
client.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use async_std::sync::Arc;
use oro_client::OroClient;
use oro_common::{CorgiManifest, CorgiPackument, CorgiVersionMetadata, Packument, VersionMetadata};
use url::Url;
pub use oro_package_spec::{PackageSpec, VersionSpec};
use crate::entries::Entries;
use crate::error::Result;
#[cfg(not(target_arch = "wasm32"))]
use crate::fetch::DirFetcher;
#[cfg(not(target_arch = "wasm32"))]
use crate::fetch::GitFetcher;
use crate::fetch::{DummyFetcher, NpmFetcher, PackageFetcher};
use crate::package::Package;
use crate::resolver::{PackageResolution, PackageResolver};
use crate::tarball::Tarball;
/// Build a new Nassun instance with specified options.
#[derive(Clone, Debug, PartialEq, Eq, Default)]
pub struct NassunOpts {
#[cfg(not(target_arch = "wasm32"))]
cache: Option<PathBuf>,
base_dir: Option<PathBuf>,
default_tag: Option<String>,
registries: HashMap<Option<String>, Url>,
memoize_metadata: bool,
}
impl NassunOpts {
pub fn new() -> Self {
Default::default()
}
/// Cache directory to use for requests.
#[cfg(not(target_arch = "wasm32"))]
pub fn cache(mut self, cache: impl AsRef<Path>) -> Self {
self.cache = Some(PathBuf::from(cache.as_ref()));
self
}
pub fn registry(mut self, registry: Url) -> Self {
self.registries.insert(None, registry);
self
}
/// Adds a registry to use for a specific scope.
pub fn scope_registry(mut self, scope: impl AsRef<str>, registry: Url) -> Self {
self.registries
.insert(Some(scope.as_ref().into()), registry);
self
}
/// Base directory to use for resolving relative paths. Defaults to `"."`.
pub fn base_dir(mut self, base_dir: impl AsRef<Path>) -> Self {
self.base_dir = Some(PathBuf::from(base_dir.as_ref()));
self
}
/// Default tag to use when resolving package versions. Defaults to `latest`.
pub fn default_tag(mut self, default_tag: impl AsRef<str>) -> Self {
self.default_tag = Some(default_tag.as_ref().into());
self
}
/// Whether to memoize package metadata. This will keep any processed
/// packuments in memory for the lifetime of this `Nassun` instance.
/// Setting this to `true` may increase performance when fetching many
/// packages, at the cost of significant additional memory usage.
pub fn memoize_metadata(mut self, memoize: bool) -> Self {
self.memoize_metadata = memoize;
self
}
/// Build a new Nassun instance from this options object.
pub fn build(self) -> Nassun {
let registry = self
.registries
.get(&None)
.cloned()
.unwrap_or_else(|| "https://registry.npmjs.org/".parse().unwrap());
#[cfg(target_arch = "wasm32")]
let client_builder = OroClient::builder().registry(registry);
#[cfg(not(target_arch = "wasm32"))]
let mut client_builder = OroClient::builder().registry(registry);
#[cfg(not(target_arch = "wasm32"))]
let cache = if let Some(cache) = self.cache {
client_builder = client_builder.cache(cache.clone());
Arc::new(Some(cache))
} else {
Arc::new(None)
};
let client = client_builder.build();
Nassun {
#[cfg(not(target_arch = "wasm32"))]
cache,
#[cfg(target_arch = "wasm32")]
cache: Arc::new(None),
resolver: PackageResolver {
#[cfg(target_arch = "wasm32")]
base_dir: PathBuf::from("."),
#[cfg(not(target_arch = "wasm32"))]
base_dir: self
.base_dir
.unwrap_or_else(|| std::env::current_dir().expect("failed to get cwd.")),
default_tag: self.default_tag.unwrap_or_else(|| "latest".into()),
},
#[cfg(target_arch = "wasm32")]
prefer_copy: false,
npm_fetcher: Arc::new(NpmFetcher::new(
#[allow(clippy::redundant_clone)]
client.clone(),
self.registries,
self.memoize_metadata,
)),
#[cfg(not(target_arch = "wasm32"))]
dir_fetcher: Arc::new(DirFetcher::new()),
#[cfg(not(target_arch = "wasm32"))]
git_fetcher: Arc::new(GitFetcher::new(client)),
}
}
}
/// Toplevel client for making package requests.
#[derive(Clone)]
pub struct Nassun {
cache: Arc<Option<PathBuf>>,
resolver: PackageResolver,
npm_fetcher: Arc<dyn PackageFetcher>,
#[cfg(not(target_arch = "wasm32"))]
dir_fetcher: Arc<dyn PackageFetcher>,
#[cfg(not(target_arch = "wasm32"))]
git_fetcher: Arc<dyn PackageFetcher>,
}
impl Default for Nassun {
fn default() -> Self {
NassunOpts::new().build()
}
}
impl Nassun {
/// Creates a new `Nassun` instance with default settings. To configure
/// `Nassun`, use [`NassunOpts`].
pub fn new() -> Self {
Default::default()
}
/// Resolves a [`Packument`] for the given package `spec`.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::packument` instead].
pub async fn packument(spec: impl AsRef<str>) -> Result<Arc<Packument>> {
Self::new().resolve(spec.as_ref()).await?.packument().await
}
/// Resolves a partial (corgi) version of the [`Packument`] for the given
/// package `spec`.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::packument` instead].
pub async fn corgi_packument(spec: impl AsRef<str>) -> Result<Arc<CorgiPackument>> {
Self::new()
.resolve(spec.as_ref())
.await?
.corgi_packument()
.await
}
/// Resolves a [`VersionMetadata`] from the given package `spec`, using
/// the default resolution algorithm.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::metadata` instead].
pub async fn metadata(spec: impl AsRef<str>) -> Result<VersionMetadata> {
Self::new().resolve(spec.as_ref()).await?.metadata().await
}
/// Resolves a partial (corgi) version of the [`VersionMetadata`] from the
/// given package `spec`, using the default resolution algorithm.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::metadata` instead].
pub async fn corgi_metadata(spec: impl AsRef<str>) -> Result<CorgiVersionMetadata> {
Self::new()
.resolve(spec.as_ref())
.await?
.corgi_metadata()
.await
}
/// Resolves a [`Tarball`] from the given package `spec`, using the
/// default resolution algorithm. This tarball will have its data checked
/// if the package metadata fetched includes integrity information.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::tarball`] instead.
pub async fn tarball(spec: impl AsRef<str>) -> Result<Tarball> {
Self::new().resolve(spec.as_ref()).await?.tarball().await
}
/// Resolves [`Entries`] from the given package `spec`, using the
/// default resolution algorithm. The source tarball will have its data
/// checked if the package metadata fetched includes integrity
/// information.
///
/// This uses default [`Nassun`] settings and does not cache the result.
/// To configure `Nassun`, and/or enable more efficient caching/reuse,
/// look at [`Package::entries`] instead.
pub async fn entries(spec: impl AsRef<str>) -> Result<Entries> {
Self::new().resolve(spec.as_ref()).await?.entries().await
}
/// Resolve a spec (e.g. `foo@^1.2.3`, `github:foo/bar`, etc), to a
/// [`Package`] that can be used for further operations.
pub async fn resolve(&self, spec: impl AsRef<str>) -> Result<Package> {
let spec = spec.as_ref().parse()?;
let fetcher = self.pick_fetcher(&spec);
let name = fetcher.name(&spec, &self.resolver.base_dir).await?;
self.resolver
.resolve(name, spec, fetcher, self.cache.clone())
.await
}
/// Resolves a package directly from a previously-calculated
/// [`PackageResolution`]. This is meant to be a lower-level call that
/// expects the caller to have already done any necessary parsing work on
/// its arguments.
pub fn resolve_from(
&self,
name: String,
from: PackageSpec,
resolved: PackageResolution,
) -> Package {
let fetcher = self.pick_fetcher(&from);
self.resolver
.resolve_from(name, from, resolved, fetcher, self.cache.clone())
}
/// Creates a "resolved" package from a plain [`oro_common::Manifest`].
/// This is useful for, say, creating dummy packages for top-level
/// projects.
pub fn dummy_from_manifest(manifest: CorgiManifest) -> Package {
Package {
cache: Arc::new(None),
from: PackageSpec::Dir {
path: PathBuf::from("."),
},
name: manifest.name.clone().unwrap_or_else(|| "dummy".to_string()),
resolved: PackageResolution::Dir {
name: manifest.name.clone().unwrap_or_else(|| "dummy".to_string()),
path: PathBuf::from("."),
},
base_dir: PathBuf::from("."),
fetcher: Arc::new(DummyFetcher(manifest)),
}
}
fn pick_fetcher(&self, arg: &PackageSpec) -> Arc<dyn PackageFetcher> {
use PackageSpec::*;
match *arg {
Alias { ref spec, .. } => self.pick_fetcher(spec),
Npm { .. } => self.npm_fetcher.clone(),
#[cfg(not(target_arch = "wasm32"))]
Dir { .. } => self.dir_fetcher.clone(),
#[cfg(target_arch = "wasm32")]
Dir { .. } => panic!(
"Directory dependencies are not enabled. (While trying to process {})",
arg
),
#[cfg(not(target_arch = "wasm32"))]
Git(..) => self.git_fetcher.clone(),
#[cfg(target_arch = "wasm32")]
Git(..) => panic!(
"Git dependencies are not enabled. (While trying to process {})",
arg
),
}
}
}