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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use crate::{pkg, source, DepKind, Edge};
use anyhow::{anyhow, Result};
use petgraph::{visit::EdgeRef, Direction};
use serde::{Deserialize, Serialize};
use std::{
borrow::Cow,
collections::{BTreeSet, HashMap, HashSet},
fs,
path::Path,
str::FromStr,
};
use sway_core::fuel_prelude::fuel_tx;
#[derive(Debug, Default, Deserialize, Serialize)]
pub struct Lock {
pub(crate) package: BTreeSet<PkgLock>,
}
pub struct Diff<'a> {
pub removed: BTreeSet<&'a PkgLock>,
pub added: BTreeSet<&'a PkgLock>,
}
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct PkgLock {
pub(crate) name: String,
version: Option<semver::Version>,
source: String,
dependencies: Option<Vec<PkgDepLine>>,
contract_dependencies: Option<Vec<PkgDepLine>>,
}
pub type PkgDepLine = String;
impl PkgLock {
pub fn from_node(graph: &pkg::Graph, node: pkg::NodeIx, disambiguate: &HashSet<&str>) -> Self {
let pinned = &graph[node];
let name = pinned.name.clone();
let version = pinned.source.semver();
let source = pinned.source.to_string();
let all_dependencies: Vec<(String, DepKind)> = graph
.edges_directed(node, Direction::Outgoing)
.map(|edge| {
let dep_edge = edge.weight();
let dep_node = edge.target();
let dep_pkg = &graph[dep_node];
let dep_name = if *dep_edge.name != dep_pkg.name {
Some(&dep_edge.name[..])
} else {
None
};
let dep_kind = &dep_edge.kind;
let disambiguate = disambiguate.contains(&dep_pkg.name[..]);
(
pkg_dep_line(
dep_name,
&dep_pkg.name,
&dep_pkg.source,
dep_kind,
disambiguate,
),
dep_kind.clone(),
)
})
.collect();
let mut dependencies: Vec<String> = all_dependencies
.iter()
.filter(|(_, dep_kind)| *dep_kind == DepKind::Library)
.map(|(dep_pkg, _)| dep_pkg.clone())
.collect();
let mut contract_dependencies: Vec<String> = all_dependencies
.iter()
.filter(|(_, dep_kind)| matches!(*dep_kind, DepKind::Contract { .. }))
.map(|(dep_pkg, _)| dep_pkg.clone())
.collect();
dependencies.sort();
contract_dependencies.sort();
let dependencies = if !dependencies.is_empty() {
Some(dependencies)
} else {
None
};
let contract_dependencies = if !contract_dependencies.is_empty() {
Some(contract_dependencies)
} else {
None
};
Self {
name,
version,
source,
dependencies,
contract_dependencies,
}
}
pub fn unique_string(&self) -> String {
pkg_unique_string(&self.name, &self.source)
}
pub fn name_disambiguated(&self, disambiguate: &HashSet<&str>) -> Cow<str> {
let disambiguate = disambiguate.contains(&self.name[..]);
pkg_name_disambiguated(&self.name, &self.source, disambiguate)
}
}
enum UnparsedDepKind {
Library,
Contract,
}
impl Lock {
pub fn from_path(path: &Path) -> Result<Self> {
let string = fs::read_to_string(path)
.map_err(|e| anyhow!("failed to read {}: {}", path.display(), e))?;
toml::de::from_str(&string).map_err(|e| anyhow!("failed to parse lock file: {}", e))
}
pub fn from_graph(graph: &pkg::Graph) -> Self {
let names = graph.node_indices().map(|n| &graph[n].name[..]);
let disambiguate: HashSet<_> = names_requiring_disambiguation(names).collect();
let package: BTreeSet<_> = graph
.node_indices()
.map(|node| PkgLock::from_node(graph, node, &disambiguate))
.collect();
Self { package }
}
pub fn to_graph(&self) -> Result<pkg::Graph> {
let mut graph = pkg::Graph::new();
let names = self.package.iter().map(|pkg| &pkg.name[..]);
let disambiguate: HashSet<_> = names_requiring_disambiguation(names).collect();
let mut pkg_to_node: HashMap<String, pkg::NodeIx> = HashMap::new();
for pkg in &self.package {
let key = pkg.name_disambiguated(&disambiguate).into_owned();
let name = pkg.name.clone();
let source: source::Pinned = pkg.source.parse().map_err(|e| {
anyhow!("invalid 'source' entry for package {} lock: {:?}", name, e)
})?;
let pkg = pkg::Pinned { name, source };
let node = graph.add_node(pkg);
pkg_to_node.insert(key, node);
}
for pkg in &self.package {
let key = pkg.name_disambiguated(&disambiguate);
let node = pkg_to_node[&key[..]];
let contract_deps = pkg
.contract_dependencies
.as_ref()
.into_iter()
.flatten()
.map(|contract_dep| (contract_dep, UnparsedDepKind::Contract));
let lib_deps = pkg
.dependencies
.as_ref()
.into_iter()
.flatten()
.map(|lib_dep| (lib_dep, UnparsedDepKind::Library));
for (dep_line, dep_kind) in lib_deps.chain(contract_deps) {
let (dep_name, dep_key, dep_salt) = parse_pkg_dep_line(dep_line)
.map_err(|e| anyhow!("failed to parse dependency \"{}\": {}", dep_line, e))?;
let dep_node = pkg_to_node
.get(dep_key)
.cloned()
.ok_or_else(|| anyhow!("found dep {} without node entry in graph", dep_key))?;
let dep_name = dep_name.unwrap_or(&graph[dep_node].name).to_string();
let dep_kind = match dep_kind {
UnparsedDepKind::Library => DepKind::Library,
UnparsedDepKind::Contract => {
let dep_salt = dep_salt.unwrap_or_default();
DepKind::Contract { salt: dep_salt }
}
};
let dep_edge = Edge::new(dep_name, dep_kind);
graph.update_edge(node, dep_node, dep_edge);
}
}
Ok(graph)
}
pub fn diff<'a>(&'a self, old: &'a Self) -> Diff<'a> {
let added = self.package.difference(&old.package).collect();
let removed = old.package.difference(&self.package).collect();
Diff { added, removed }
}
}
fn names_requiring_disambiguation<'a, I>(names: I) -> impl Iterator<Item = &'a str>
where
I: IntoIterator<Item = &'a str>,
{
let mut visited = BTreeSet::default();
names.into_iter().filter(move |&name| !visited.insert(name))
}
fn pkg_name_disambiguated<'a>(name: &'a str, source: &'a str, disambiguate: bool) -> Cow<'a, str> {
match disambiguate {
true => Cow::Owned(pkg_unique_string(name, source)),
false => Cow::Borrowed(name),
}
}
fn pkg_unique_string(name: &str, source: &str) -> String {
format!("{name} {source}")
}
fn pkg_dep_line(
dep_name: Option<&str>,
name: &str,
source: &source::Pinned,
dep_kind: &DepKind,
disambiguate: bool,
) -> PkgDepLine {
let source_string = source.to_string();
let pkg_string = pkg_name_disambiguated(name, &source_string, disambiguate);
let pkg_string = match dep_name {
None => pkg_string.into_owned(),
Some(dep_name) => format!("({dep_name}) {pkg_string}"),
};
match dep_kind {
DepKind::Library => pkg_string,
DepKind::Contract { salt } => {
if *salt == fuel_tx::Salt::zeroed() {
pkg_string
} else {
format!("{pkg_string} ({salt})")
}
}
}
}
type ParsedPkgLine<'a> = (Option<&'a str>, &'a str, Option<fuel_tx::Salt>);
fn parse_pkg_dep_line(pkg_dep_line: &str) -> anyhow::Result<ParsedPkgLine> {
let s = pkg_dep_line.trim();
let (dep_name, s) = match s.starts_with('(') {
false => (None, s),
true => {
let s = &s["(".len()..];
let mut iter = s.split(')');
let dep_name = iter
.next()
.ok_or_else(|| anyhow!("missing closing parenthesis"))?;
let s = &s[dep_name.len() + ")".len()..];
(Some(dep_name), s)
}
};
let mut iter = s.split('(');
let pkg_str = iter
.next()
.ok_or_else(|| anyhow!("missing pkg string"))?
.trim();
let salt_str = iter.next().map(|s| s.trim()).map(|s| &s[..s.len() - 1]);
let salt = match salt_str {
Some(salt_str) => Some(
fuel_tx::Salt::from_str(salt_str)
.map_err(|e| anyhow!("invalid salt in lock file: {e}"))?,
),
None => None,
};
Ok((dep_name, pkg_str, salt))
}
pub fn print_diff(member_names: &HashSet<String>, diff: &Diff) {
print_removed_pkgs(member_names, diff.removed.iter().cloned());
print_added_pkgs(member_names, diff.added.iter().cloned());
}
pub fn print_removed_pkgs<'a, I>(member_names: &HashSet<String>, removed: I)
where
I: IntoIterator<Item = &'a PkgLock>,
{
for pkg in removed {
if !member_names.contains(&pkg.name) {
let src = match pkg.source.starts_with(source::git::Pinned::PREFIX) {
true => format!(" {}", pkg.source),
false => "".to_string(),
};
tracing::info!(
" {} {}{src}",
ansi_term::Colour::Red.bold().paint("Removing"),
ansi_term::Style::new().bold().paint(&pkg.name)
);
}
}
}
pub fn print_added_pkgs<'a, I>(member_names: &HashSet<String>, removed: I)
where
I: IntoIterator<Item = &'a PkgLock>,
{
for pkg in removed {
if !member_names.contains(&pkg.name) {
let src = match pkg.source.starts_with(source::git::Pinned::PREFIX) {
true => format!(" {}", pkg.source),
false => "".to_string(),
};
tracing::info!(
" {} {}{src}",
ansi_term::Colour::Green.bold().paint("Adding"),
ansi_term::Style::new().bold().paint(&pkg.name)
);
}
}
}
#[cfg(test)]
mod tests {
use sway_core::fuel_prelude::fuel_tx;
use super::parse_pkg_dep_line;
#[test]
fn test_parse_pkg_line_with_salt_with_dep_name() {
let pkg_dep_line = "(std2) std path+from-root (0000000000000000000000000000000000000000000000000000000000000000)";
let (dep_name, pkg_string, salt) = parse_pkg_dep_line(pkg_dep_line).unwrap();
assert_eq!(salt, Some(fuel_tx::Salt::zeroed()));
assert_eq!(dep_name, Some("std2"));
assert_eq!(pkg_string, "std path+from-root");
}
#[test]
fn test_parse_pkg_line_with_salt_without_dep_name() {
let pkg_dep_line =
"std path+from-root (0000000000000000000000000000000000000000000000000000000000000000)";
let (dep_name, pkg_string, salt) = parse_pkg_dep_line(pkg_dep_line).unwrap();
assert_eq!(salt, Some(fuel_tx::Salt::zeroed()));
assert_eq!(dep_name, None);
assert_eq!(pkg_string, "std path+from-root");
}
#[test]
fn test_parse_pkg_line_without_salt_with_dep_name() {
let pkg_dep_line = "(std2) std path+from-root";
let (dep_name, pkg_string, salt) = parse_pkg_dep_line(pkg_dep_line).unwrap();
assert_eq!(salt, None);
assert_eq!(dep_name, Some("std2"));
assert_eq!(pkg_string, "std path+from-root");
}
#[test]
fn test_parse_pkg_line_without_salt_without_dep_name() {
let pkg_dep_line = "std path+from-root";
let (dep_name, pkg_string, salt) = parse_pkg_dep_line(pkg_dep_line).unwrap();
assert_eq!(salt, None);
assert_eq!(dep_name, None);
assert_eq!(pkg_string, "std path+from-root");
}
#[test]
#[should_panic]
fn test_parse_pkg_line_invalid_salt() {
let pkg_dep_line = "std path+from-root (1)";
parse_pkg_dep_line(pkg_dep_line).unwrap();
}
}