forked from denoland/deno
-
Notifications
You must be signed in to change notification settings - Fork 0
/
graph.rs
2748 lines (2620 loc) · 87.7 KB
/
graph.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
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::collections::HashMap;
use std::collections::VecDeque;
use std::sync::Arc;
use deno_core::anyhow::bail;
use deno_core::anyhow::Context;
use deno_core::error::AnyError;
use deno_core::futures;
use deno_core::parking_lot::Mutex;
use deno_core::parking_lot::MutexGuard;
use log::debug;
use crate::npm::cache::should_sync_download;
use crate::npm::registry::NpmDependencyEntry;
use crate::npm::registry::NpmDependencyEntryKind;
use crate::npm::registry::NpmPackageInfo;
use crate::npm::registry::NpmPackageVersionInfo;
use crate::npm::semver::NpmVersion;
use crate::npm::semver::NpmVersionReq;
use crate::npm::NpmRegistryApi;
use super::snapshot::NpmResolutionSnapshot;
use super::snapshot::SnapshotPackageCopyIndexResolver;
use super::NpmPackageId;
use super::NpmPackageReq;
use super::NpmResolutionPackage;
use super::NpmVersionMatcher;
/// A memory efficient path of visited name and versions in the graph
/// which is used to detect cycles.
///
/// note(dsherret): although this is definitely more memory efficient
/// than a HashSet, I haven't done any tests about whether this is
/// faster in practice.
#[derive(Default, Clone)]
struct VisitedVersionsPath {
previous_node: Option<Arc<VisitedVersionsPath>>,
visited_version_key: String,
}
impl VisitedVersionsPath {
pub fn new(id: &NpmPackageId) -> Arc<Self> {
Arc::new(Self {
previous_node: None,
visited_version_key: Self::id_to_key(id),
})
}
pub fn with_parent(
self: &Arc<VisitedVersionsPath>,
parent: &NodeParent,
) -> Option<Arc<Self>> {
match parent {
NodeParent::Node(id) => self.with_id(id),
NodeParent::Req => Some(self.clone()),
}
}
pub fn with_id(
self: &Arc<VisitedVersionsPath>,
id: &NpmPackageId,
) -> Option<Arc<Self>> {
if self.has_visited(id) {
None
} else {
Some(Arc::new(Self {
previous_node: Some(self.clone()),
visited_version_key: Self::id_to_key(id),
}))
}
}
pub fn has_visited(self: &Arc<Self>, id: &NpmPackageId) -> bool {
let mut maybe_next_node = Some(self);
let key = Self::id_to_key(id);
while let Some(next_node) = maybe_next_node {
if next_node.visited_version_key == key {
return true;
}
maybe_next_node = next_node.previous_node.as_ref();
}
false
}
fn id_to_key(id: &NpmPackageId) -> String {
format!("{}@{}", id.name, id.version)
}
}
/// A memory efficient path of the visited specifiers in the tree.
#[derive(Default, Clone)]
struct GraphSpecifierPath {
previous_node: Option<Arc<GraphSpecifierPath>>,
specifier: String,
}
impl GraphSpecifierPath {
pub fn new(specifier: String) -> Arc<Self> {
Arc::new(Self {
previous_node: None,
specifier,
})
}
pub fn with_specifier(self: &Arc<Self>, specifier: String) -> Arc<Self> {
Arc::new(Self {
previous_node: Some(self.clone()),
specifier,
})
}
pub fn pop(&self) -> Option<&Arc<Self>> {
self.previous_node.as_ref()
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
enum NodeParent {
/// These are top of the graph npm package requirements
/// as specified in Deno code.
Req,
/// A reference to another node, which is a resolved package.
Node(NpmPackageId),
}
/// A resolved package in the resolution graph.
#[derive(Debug)]
struct Node {
pub id: NpmPackageId,
/// If the node was forgotten due to having no parents.
pub forgotten: bool,
// Use BTreeMap and BTreeSet in order to create determinism
// when going up and down the tree
pub parents: BTreeMap<String, BTreeSet<NodeParent>>,
pub children: BTreeMap<String, NpmPackageId>,
pub deps: Arc<Vec<NpmDependencyEntry>>,
/// Whether the node has demonstrated to have no peer dependencies in its
/// descendants. If this is true then we can skip analyzing this node
/// again when we encounter it another time in the dependency tree, which
/// is much faster.
pub no_peers: bool,
}
impl Node {
pub fn add_parent(&mut self, specifier: String, parent: NodeParent) {
self.parents.entry(specifier).or_default().insert(parent);
}
pub fn remove_parent(&mut self, specifier: &str, parent: &NodeParent) {
if let Some(parents) = self.parents.get_mut(specifier) {
parents.remove(parent);
if parents.is_empty() {
self.parents.remove(specifier);
}
}
}
}
#[derive(Debug, Default)]
pub struct Graph {
package_reqs: HashMap<String, NpmPackageId>,
packages_by_name: HashMap<String, Vec<NpmPackageId>>,
// Ideally this value would be Rc<RefCell<Node>>, but we need to use a Mutex
// because the lsp requires Send and this code is executed in the lsp.
// Would be nice if the lsp wasn't Send.
packages: HashMap<NpmPackageId, Arc<Mutex<Node>>>,
// This will be set when creating from a snapshot, then
// inform the final snapshot creation.
packages_to_copy_index: HashMap<NpmPackageId, usize>,
}
impl Graph {
pub fn from_snapshot(snapshot: NpmResolutionSnapshot) -> Self {
fn fill_for_id(
graph: &mut Graph,
id: &NpmPackageId,
packages: &HashMap<NpmPackageId, NpmResolutionPackage>,
) -> Arc<Mutex<Node>> {
let resolution = packages.get(id).unwrap();
let (created, node) = graph.get_or_create_for_id(id);
if created {
for (name, child_id) in &resolution.dependencies {
let child_node = fill_for_id(graph, child_id, packages);
graph.set_child_parent_node(name, &child_node, id);
}
}
node
}
let mut graph = Self {
// Note: It might be more correct to store the copy index
// from past resolutions with the node somehow, but maybe not.
packages_to_copy_index: snapshot
.packages
.iter()
.map(|(id, p)| (id.clone(), p.copy_index))
.collect(),
..Default::default()
};
for (package_req, id) in &snapshot.package_reqs {
let node = fill_for_id(&mut graph, id, &snapshot.packages);
let package_req_text = package_req.to_string();
(*node)
.lock()
.add_parent(package_req_text.clone(), NodeParent::Req);
graph.package_reqs.insert(package_req_text, id.clone());
}
graph
}
pub fn has_package_req(&self, req: &NpmPackageReq) -> bool {
self.package_reqs.contains_key(&req.to_string())
}
fn get_or_create_for_id(
&mut self,
id: &NpmPackageId,
) -> (bool, Arc<Mutex<Node>>) {
if let Some(node) = self.packages.get(id) {
(false, node.clone())
} else {
let node = Arc::new(Mutex::new(Node {
id: id.clone(),
forgotten: false,
parents: Default::default(),
children: Default::default(),
deps: Default::default(),
no_peers: false,
}));
self
.packages_by_name
.entry(id.name.clone())
.or_default()
.push(id.clone());
self.packages.insert(id.clone(), node.clone());
(true, node)
}
}
fn borrow_node(&self, id: &NpmPackageId) -> MutexGuard<Node> {
(**self.packages.get(id).unwrap_or_else(|| {
panic!("could not find id {} in the tree", id.as_serialized())
}))
.lock()
}
fn forget_orphan(&mut self, node_id: &NpmPackageId) {
if let Some(node) = self.packages.remove(node_id) {
let mut node = (*node).lock();
node.forgotten = true;
assert_eq!(node.parents.len(), 0);
// Remove the id from the list of packages by name.
let packages_with_name =
self.packages_by_name.get_mut(&node.id.name).unwrap();
let remove_index = packages_with_name
.iter()
.position(|id| id == &node.id)
.unwrap();
packages_with_name.remove(remove_index);
let parent = NodeParent::Node(node.id.clone());
for (specifier, child_id) in &node.children {
let mut child = self.borrow_node(child_id);
child.remove_parent(specifier, &parent);
if child.parents.is_empty() {
drop(child); // stop borrowing from self
self.forget_orphan(child_id);
}
}
}
}
fn set_child_parent(
&mut self,
specifier: &str,
child: &Mutex<Node>,
parent: &NodeParent,
) {
match parent {
NodeParent::Node(parent_id) => {
self.set_child_parent_node(specifier, child, parent_id);
}
NodeParent::Req => {
let mut node = (*child).lock();
node.add_parent(specifier.to_string(), parent.clone());
self
.package_reqs
.insert(specifier.to_string(), node.id.clone());
}
}
}
fn set_child_parent_node(
&mut self,
specifier: &str,
child: &Mutex<Node>,
parent_id: &NpmPackageId,
) {
let mut child = (*child).lock();
assert_ne!(child.id, *parent_id);
let mut parent = (**self.packages.get(parent_id).unwrap_or_else(|| {
panic!(
"could not find {} in list of packages when setting child {}",
parent_id.as_serialized(),
child.id.as_serialized()
)
}))
.lock();
parent
.children
.insert(specifier.to_string(), child.id.clone());
child
.add_parent(specifier.to_string(), NodeParent::Node(parent.id.clone()));
}
fn remove_child_parent(
&mut self,
specifier: &str,
child_id: &NpmPackageId,
parent: &NodeParent,
) {
match parent {
NodeParent::Node(parent_id) => {
let mut node = self.borrow_node(parent_id);
if let Some(removed_child_id) = node.children.remove(specifier) {
assert_eq!(removed_child_id, *child_id);
}
}
NodeParent::Req => {
if let Some(removed_child_id) = self.package_reqs.remove(specifier) {
assert_eq!(removed_child_id, *child_id);
}
}
}
self.borrow_node(child_id).remove_parent(specifier, parent);
}
pub async fn into_snapshot(
self,
api: &impl NpmRegistryApi,
) -> Result<NpmResolutionSnapshot, AnyError> {
let mut copy_index_resolver =
SnapshotPackageCopyIndexResolver::from_map_with_capacity(
self.packages_to_copy_index,
self.packages.len(),
);
// Iterate through the packages vector in each packages_by_name in order
// to set the copy index as this will be deterministic rather than
// iterating over the hashmap below.
for packages in self.packages_by_name.values() {
if packages.len() > 1 {
for id in packages {
copy_index_resolver.resolve(id);
}
}
}
let mut packages = HashMap::with_capacity(self.packages.len());
for (id, node) in self.packages {
let dist = api
.package_version_info(&id.name, &id.version)
.await?
.unwrap()
.dist;
let node = node.lock();
packages.insert(
id.clone(),
NpmResolutionPackage {
copy_index: copy_index_resolver.resolve(&id),
id,
dist,
dependencies: node
.children
.iter()
.map(|(key, value)| (key.clone(), value.clone()))
.collect(),
},
);
}
Ok(NpmResolutionSnapshot {
package_reqs: self
.package_reqs
.into_iter()
.map(|(specifier, id)| {
(NpmPackageReq::from_str(&specifier).unwrap(), id)
})
.collect(),
packages_by_name: self.packages_by_name,
packages,
})
}
}
pub struct GraphDependencyResolver<'a, TNpmRegistryApi: NpmRegistryApi> {
graph: &'a mut Graph,
api: &'a TNpmRegistryApi,
pending_unresolved_nodes:
VecDeque<(Arc<VisitedVersionsPath>, Arc<Mutex<Node>>)>,
}
impl<'a, TNpmRegistryApi: NpmRegistryApi>
GraphDependencyResolver<'a, TNpmRegistryApi>
{
pub fn new(graph: &'a mut Graph, api: &'a TNpmRegistryApi) -> Self {
Self {
graph,
api,
pending_unresolved_nodes: Default::default(),
}
}
fn resolve_best_package_version_and_info<'info>(
&self,
version_matcher: &impl NpmVersionMatcher,
package_info: &'info NpmPackageInfo,
) -> Result<VersionAndInfo<'info>, AnyError> {
if let Some(version) =
self.resolve_best_package_version(package_info, version_matcher)?
{
match package_info.versions.get(&version.to_string()) {
Some(version_info) => Ok(VersionAndInfo {
version,
info: version_info,
}),
None => {
bail!(
"could not find version '{}' for '{}'",
version,
&package_info.name
)
}
}
} else {
// get the information
get_resolved_package_version_and_info(version_matcher, package_info, None)
}
}
fn resolve_best_package_version(
&self,
package_info: &NpmPackageInfo,
version_matcher: &impl NpmVersionMatcher,
) -> Result<Option<NpmVersion>, AnyError> {
let mut maybe_best_version: Option<&NpmVersion> = None;
if let Some(ids) = self.graph.packages_by_name.get(&package_info.name) {
for version in ids.iter().map(|id| &id.version) {
if version_req_satisfies(version_matcher, version, package_info, None)?
{
let is_best_version = maybe_best_version
.as_ref()
.map(|best_version| (*best_version).cmp(version).is_lt())
.unwrap_or(true);
if is_best_version {
maybe_best_version = Some(version);
}
}
}
}
Ok(maybe_best_version.cloned())
}
pub fn has_package_req(&self, req: &NpmPackageReq) -> bool {
self.graph.has_package_req(req)
}
pub fn add_package_req(
&mut self,
package_req: &NpmPackageReq,
package_info: &NpmPackageInfo,
) -> Result<(), AnyError> {
let (_, node) = self.resolve_node_from_info(
&package_req.name,
package_req,
package_info,
None,
)?;
self.graph.set_child_parent(
&package_req.to_string(),
&node,
&NodeParent::Req,
);
self.try_add_pending_unresolved_node(None, &node);
Ok(())
}
fn analyze_dependency(
&mut self,
entry: &NpmDependencyEntry,
package_info: &NpmPackageInfo,
parent_id: &NpmPackageId,
visited_versions: &Arc<VisitedVersionsPath>,
) -> Result<Arc<Mutex<Node>>, AnyError> {
let (id, node) = self.resolve_node_from_info(
&entry.name,
match entry.kind {
NpmDependencyEntryKind::Dep => &entry.version_req,
// when resolving a peer dependency as a dependency, it should
// use the "dependencies" entry version requirement if it exists
NpmDependencyEntryKind::Peer | NpmDependencyEntryKind::OptionalPeer => {
entry
.peer_dep_version_req
.as_ref()
.unwrap_or(&entry.version_req)
}
},
package_info,
Some(parent_id),
)?;
// Some packages may resolves to themselves as a dependency. If this occurs,
// just ignore adding these as dependencies because this is likely a mistake
// in the package.
if id != *parent_id {
self.graph.set_child_parent(
&entry.bare_specifier,
&node,
&NodeParent::Node(parent_id.clone()),
);
self.try_add_pending_unresolved_node(Some(visited_versions), &node);
}
Ok(node)
}
fn try_add_pending_unresolved_node(
&mut self,
maybe_previous_visited_versions: Option<&Arc<VisitedVersionsPath>>,
node: &Arc<Mutex<Node>>,
) {
let node_id = {
let node = node.lock();
if node.no_peers {
return; // skip, no need to analyze this again
}
node.id.clone()
};
let visited_versions = match maybe_previous_visited_versions {
Some(previous_visited_versions) => {
match previous_visited_versions.with_id(&node_id) {
Some(visited_versions) => visited_versions,
None => return, // circular, don't visit this node
}
}
None => VisitedVersionsPath::new(&node_id),
};
self
.pending_unresolved_nodes
.push_back((visited_versions, node.clone()));
}
fn resolve_node_from_info(
&mut self,
pkg_req_name: &str,
version_matcher: &impl NpmVersionMatcher,
package_info: &NpmPackageInfo,
parent_id: Option<&NpmPackageId>,
) -> Result<(NpmPackageId, Arc<Mutex<Node>>), AnyError> {
let version_and_info = self
.resolve_best_package_version_and_info(version_matcher, package_info)?;
let id = NpmPackageId {
name: package_info.name.to_string(),
version: version_and_info.version.clone(),
peer_dependencies: Vec::new(),
};
debug!(
"{} - Resolved {}@{} to {}",
match parent_id {
Some(id) => id.as_serialized(),
None => "<package-req>".to_string(),
},
pkg_req_name,
version_matcher.version_text(),
id.as_serialized(),
);
let (created, node) = self.graph.get_or_create_for_id(&id);
if created {
let mut node = (*node).lock();
let mut deps = version_and_info
.info
.dependencies_as_entries()
.with_context(|| format!("npm package: {}", id.display()))?;
// Ensure name alphabetical and then version descending
// so these are resolved in that order
deps.sort();
node.deps = Arc::new(deps);
node.no_peers = node.deps.is_empty();
}
Ok((id, node))
}
pub async fn resolve_pending(&mut self) -> Result<(), AnyError> {
while !self.pending_unresolved_nodes.is_empty() {
// now go down through the dependencies by tree depth
while let Some((visited_versions, parent_node)) =
self.pending_unresolved_nodes.pop_front()
{
let (mut parent_id, deps, existing_children) = {
let parent_node = parent_node.lock();
if parent_node.forgotten || parent_node.no_peers {
// todo(dsherret): we should try to reproduce this forgotten scenario and write a test
continue;
}
(
parent_node.id.clone(),
parent_node.deps.clone(),
parent_node.children.clone(),
)
};
// cache all the dependencies' registry infos in parallel if should
if !should_sync_download() {
let handles = deps
.iter()
.map(|dep| {
let name = dep.name.clone();
let api = self.api.clone();
tokio::task::spawn(async move {
// it's ok to call this without storing the result, because
// NpmRegistryApi will cache the package info in memory
api.package_info(&name).await
})
})
.collect::<Vec<_>>();
let results = futures::future::join_all(handles).await;
for result in results {
result??; // surface the first error
}
}
// resolve the dependencies
let mut found_peer = false;
for dep in deps.iter() {
let package_info = self.api.package_info(&dep.name).await?;
match dep.kind {
NpmDependencyEntryKind::Dep => {
let node = self.analyze_dependency(
dep,
&package_info,
&parent_id,
&visited_versions,
)?;
if !found_peer {
found_peer = !node.lock().no_peers;
}
}
NpmDependencyEntryKind::Peer
| NpmDependencyEntryKind::OptionalPeer => {
found_peer = true;
let maybe_new_parent_id = self.resolve_peer_dep(
&dep.bare_specifier,
&parent_id,
dep,
&package_info,
&visited_versions,
existing_children.get(&dep.bare_specifier),
)?;
if let Some(new_parent_id) = maybe_new_parent_id {
assert_eq!(
(&new_parent_id.name, &new_parent_id.version),
(&parent_id.name, &parent_id.version)
);
parent_id = new_parent_id;
}
}
}
}
if !found_peer {
self.graph.borrow_node(&parent_id).no_peers = true;
}
}
}
Ok(())
}
fn resolve_peer_dep(
&mut self,
specifier: &str,
parent_id: &NpmPackageId,
peer_dep: &NpmDependencyEntry,
peer_package_info: &NpmPackageInfo,
visited_ancestor_versions: &Arc<VisitedVersionsPath>,
existing_dep_id: Option<&NpmPackageId>,
) -> Result<Option<NpmPackageId>, AnyError> {
fn find_matching_child<'a>(
peer_dep: &NpmDependencyEntry,
peer_package_info: &NpmPackageInfo,
children: impl Iterator<Item = &'a NpmPackageId>,
) -> Result<Option<NpmPackageId>, AnyError> {
for child_id in children {
if child_id.name == peer_dep.name
&& version_req_satisfies(
&peer_dep.version_req,
&child_id.version,
peer_package_info,
None,
)?
{
return Ok(Some(child_id.clone()));
}
}
Ok(None)
}
// Peer dependencies are resolved based on its ancestors' siblings.
// If not found, then it resolves based on the version requirement if non-optional.
let mut pending_ancestors = VecDeque::new(); // go up the tree by depth
let path = GraphSpecifierPath::new(specifier.to_string());
let visited_versions = VisitedVersionsPath::new(parent_id);
// skip over the current node
for (specifier, grand_parents) in
self.graph.borrow_node(parent_id).parents.clone()
{
let path = path.with_specifier(specifier);
for grand_parent in grand_parents {
if let Some(visited_versions) =
visited_versions.with_parent(&grand_parent)
{
pending_ancestors.push_back((
grand_parent,
path.clone(),
visited_versions,
));
}
}
}
while let Some((ancestor, path, visited_versions)) =
pending_ancestors.pop_front()
{
match &ancestor {
NodeParent::Node(ancestor_node_id) => {
let maybe_peer_dep_id = if ancestor_node_id.name == peer_dep.name
&& version_req_satisfies(
&peer_dep.version_req,
&ancestor_node_id.version,
peer_package_info,
None,
)? {
Some(ancestor_node_id.clone())
} else {
let ancestor = self.graph.borrow_node(ancestor_node_id);
for (specifier, parents) in &ancestor.parents {
let new_path = path.with_specifier(specifier.clone());
for parent in parents {
if let Some(visited_versions) =
visited_versions.with_parent(parent)
{
pending_ancestors.push_back((
parent.clone(),
new_path.clone(),
visited_versions,
));
}
}
}
find_matching_child(
peer_dep,
peer_package_info,
ancestor.children.values(),
)?
};
if let Some(peer_dep_id) = maybe_peer_dep_id {
if existing_dep_id == Some(&peer_dep_id) {
return Ok(None); // do nothing, there's already an existing child dep id for this
}
// handle optional dependency that's never been set
if existing_dep_id.is_none() && peer_dep.kind.is_optional() {
self.set_previously_unresolved_optional_dependency(
&peer_dep_id,
parent_id,
peer_dep,
visited_ancestor_versions,
);
return Ok(None);
}
let parents =
self.graph.borrow_node(ancestor_node_id).parents.clone();
return Ok(Some(self.set_new_peer_dep(
parents,
ancestor_node_id,
&peer_dep_id,
&path,
visited_ancestor_versions,
)));
}
}
NodeParent::Req => {
// in this case, the parent is the root so the children are all the package requirements
if let Some(child_id) = find_matching_child(
peer_dep,
peer_package_info,
self.graph.package_reqs.values(),
)? {
if existing_dep_id == Some(&child_id) {
return Ok(None); // do nothing, there's already an existing child dep id for this
}
// handle optional dependency that's never been set
if existing_dep_id.is_none() && peer_dep.kind.is_optional() {
self.set_previously_unresolved_optional_dependency(
&child_id,
parent_id,
peer_dep,
visited_ancestor_versions,
);
return Ok(None);
}
let specifier = path.specifier.to_string();
let path = path.pop().unwrap(); // go back down one level from the package requirement
let old_id =
self.graph.package_reqs.get(&specifier).unwrap().clone();
return Ok(Some(self.set_new_peer_dep(
BTreeMap::from([(specifier, BTreeSet::from([NodeParent::Req]))]),
&old_id,
&child_id,
path,
visited_ancestor_versions,
)));
}
}
}
}
// We didn't find anything by searching the ancestor siblings, so we need
// to resolve based on the package info and will treat this just like any
// other dependency when not optional
if !peer_dep.kind.is_optional()
// prefer the existing dep id if it exists
&& existing_dep_id.is_none()
{
self.analyze_dependency(
peer_dep,
peer_package_info,
parent_id,
visited_ancestor_versions,
)?;
}
Ok(None)
}
/// Optional peer dependencies that have never been set before are
/// simply added to the existing peer dependency instead of affecting
/// the entire sub tree.
fn set_previously_unresolved_optional_dependency(
&mut self,
peer_dep_id: &NpmPackageId,
parent_id: &NpmPackageId,
peer_dep: &NpmDependencyEntry,
visited_ancestor_versions: &Arc<VisitedVersionsPath>,
) {
let (_, node) = self.graph.get_or_create_for_id(peer_dep_id);
self.graph.set_child_parent(
&peer_dep.bare_specifier,
&node,
&NodeParent::Node(parent_id.clone()),
);
self
.try_add_pending_unresolved_node(Some(visited_ancestor_versions), &node);
}
fn set_new_peer_dep(
&mut self,
previous_parents: BTreeMap<String, BTreeSet<NodeParent>>,
node_id: &NpmPackageId,
peer_dep_id: &NpmPackageId,
path: &Arc<GraphSpecifierPath>,
visited_ancestor_versions: &Arc<VisitedVersionsPath>,
) -> NpmPackageId {
let peer_dep_id = Cow::Borrowed(peer_dep_id);
let old_id = node_id;
let (new_id, mut old_node_children) =
if old_id.peer_dependencies.contains(&peer_dep_id)
|| *old_id == *peer_dep_id
{
// the parent has already resolved to using this peer dependency
// via some other path or the parent is the peer dependency,
// so we don't need to update its ids, but instead only make a link to it
(
old_id.clone(),
self.graph.borrow_node(old_id).children.clone(),
)
} else {
let mut new_id = old_id.clone();
new_id.peer_dependencies.push(peer_dep_id.as_ref().clone());
// remove the previous parents from the old node
let old_node_children = {
for (specifier, parents) in &previous_parents {
for parent in parents {
self.graph.remove_child_parent(specifier, old_id, parent);
}
}
let old_node = self.graph.borrow_node(old_id);
old_node.children.clone()
};
let (_, new_node) = self.graph.get_or_create_for_id(&new_id);
// update the previous parent to point to the new node
// and this node to point at those parents
for (specifier, parents) in previous_parents {
for parent in parents {
self.graph.set_child_parent(&specifier, &new_node, &parent);
}
}
// now add the previous children to this node
let new_id_as_parent = NodeParent::Node(new_id.clone());
for (specifier, child_id) in &old_node_children {
let child = self.graph.packages.get(child_id).unwrap().clone();
self
.graph
.set_child_parent(specifier, &child, &new_id_as_parent);
}
(new_id, old_node_children)
};
// this is the parent id found at the bottom of the path
let mut bottom_parent_id = new_id.clone();
// continue going down the path
let next_specifier = &path.specifier;
if let Some(path) = path.pop() {
let next_node_id = old_node_children.get(next_specifier).unwrap();
bottom_parent_id = self.set_new_peer_dep(
BTreeMap::from([(
next_specifier.to_string(),
BTreeSet::from([NodeParent::Node(new_id.clone())]),
)]),
next_node_id,
&peer_dep_id,
path,
visited_ancestor_versions,
);
} else {
// this means we're at the peer dependency now
debug!(
"Resolved peer dependency for {} in {} to {}",
next_specifier,
&new_id.as_serialized(),
&peer_dep_id.as_serialized(),
);
// handle this node having a previous child due to another peer dependency
if let Some(child_id) = old_node_children.remove(next_specifier) {
if let Some(node) = self.graph.packages.get(&child_id) {
let is_orphan = {
let mut node = node.lock();
node
.remove_parent(next_specifier, &NodeParent::Node(new_id.clone()));
node.parents.is_empty()
};
if is_orphan {
self.graph.forget_orphan(&child_id);
}
}
}
let node = self.graph.get_or_create_for_id(&peer_dep_id).1;
self.try_add_pending_unresolved_node(
Some(visited_ancestor_versions),
&node,
);
self
.graph
.set_child_parent_node(next_specifier, &node, &new_id);
}
// forget the old node at this point if it has no parents
if new_id != *old_id {
let old_node = self.graph.borrow_node(old_id);
if old_node.parents.is_empty() {
drop(old_node); // stop borrowing
self.graph.forget_orphan(old_id);
}
}
bottom_parent_id
}
}
#[derive(Clone)]
struct VersionAndInfo<'a> {
version: NpmVersion,
info: &'a NpmPackageVersionInfo,