-
Notifications
You must be signed in to change notification settings - Fork 526
Expand file tree
/
Copy pathPackageResolver.fs
More file actions
1557 lines (1364 loc) · 74.7 KB
/
PackageResolver.fs
File metadata and controls
1557 lines (1364 loc) · 74.7 KB
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
/// Contains logic which helps to resolve the dependency graph.
module Paket.PackageResolver
open Paket
open Paket.Domain
open Paket.Requirements
open Paket.Logging
open System.Collections.Generic
open System
open System.Diagnostics
open Paket.PackageSources
open System.Threading.Tasks
open System.Threading
open FSharp.Polyfill
type DependencySet = Set<PackageName * VersionRequirement * FrameworkRestrictions>
/// Represents package details
[<StructuredFormatDisplay "{Display}">]
type PackageDetails = {
Name : PackageName
Source : PackageSource
DownloadLink : string
LicenseUrl : string
Unlisted : bool
DirectDependencies : DependencySet
}
type SourcePackageInfo =
{ Sources : PackageSource list
GroupName : GroupName
PackageName : PackageName }
static member ofParams sources groupName packageName =
{ Sources = sources; GroupName = groupName; PackageName = packageName }
type GetPackageDetailsParameters =
{ Package : SourcePackageInfo
VersionIsAssumed : bool
Version : SemVerInfo }
static member ofParamsEx isAssumed sources groupName packageName version =
SourcePackageInfo.ofParams sources groupName packageName
|> fun p -> { Package = p; Version = version; VersionIsAssumed = isAssumed }
static member ofParams sources groupName packageName version =
GetPackageDetailsParameters.ofParamsEx false sources groupName packageName version
type GetPackageVersionsParameters =
{ Package : SourcePackageInfo
MinVersion : SemVerInfo option }
static member ofParams sources groupName packageName minVersion =
SourcePackageInfo.ofParams sources groupName packageName
|> fun p -> { Package = p; MinVersion = minVersion }
type PackageDetailsFunc = GetPackageDetailsParameters -> Async<PackageDetails>
type PackageDetailsSyncFunc = GetPackageDetailsParameters -> PackageDetails
type PackageVersionsFunc = GetPackageVersionsParameters -> Async<seq<SemVerInfo * PackageSource list>>
type PackageVersionsSyncFunc = GetPackageVersionsParameters -> seq<SemVerInfo * PackageSource list>
/// Represents data about resolved packages
[<StructuredFormatDisplay "{Display}">]
type ResolvedPackage = {
Name : PackageName
Version : SemVerInfo
Dependencies : DependencySet
Unlisted : bool
IsRuntimeDependency : bool
Kind : ResolvedPackageKind
Settings : InstallSettings
Source : PackageSource
} with
override this.ToString () = sprintf "%O %O" this.Name this.Version
member self.HasFrameworkRestrictions =
getExplicitRestriction self.Settings.FrameworkRestrictions <> FrameworkRestriction.NoRestriction
member private self.Display
with get() =
let deps =
self.Dependencies
|> Seq.map (fun (name,ver,restrict) ->
sprintf " <%A - %A - %A>\n" name ver restrict)
|> String.Concat
sprintf
"%A\nDependencies -\n%s\nSource - %A\nInstall Settings\n%A"
self.Name deps self.Source self.Settings
and [<RequireQualifiedAccess>] ResolvedPackageKind =
| Package
| DotnetCliTool
type PackageResolution = Map<PackageName, ResolvedPackage>
/// Caches information retrieved by GetVersions until it is required by GetDetails
type VersionCache =
{ Version : SemVerInfo; Sources : PackageSource list; AssumedVersion : bool }
static member ofParams version sources isAssumed =
{ Version = version; Sources = sources |> List.distinctBy (fun s -> s.Url); AssumedVersion = isAssumed }
type ResolverStep =
{ Relax: bool
FilteredVersions : Map<PackageName, (VersionCache list * bool)>
CurrentResolution : Map<PackageName,ResolvedPackage>
ClosedRequirements : Set<PackageRequirement>
OpenRequirements : Set<PackageRequirement> }
member this.RequirementDisplay =
let newline = Environment.NewLine
let opened = String.Join(newline + " ", this.OpenRequirements |> Seq.sort)
let closed = String.Join(newline + " ", this.ClosedRequirements |> Seq.sort)
sprintf "-- CLOSED --%s %s%s-- OPEN ----%s %s" newline closed newline newline opened
module DependencySetFilter =
let isIncluded (restriction:FrameworkRestriction) (dependency:PackageName * VersionRequirement * FrameworkRestrictions) =
let _,_,dependencyRestrictions = dependency
let dependencyRestrictions = dependencyRestrictions |> getExplicitRestriction
if dependencyRestrictions = FrameworkRestriction.NoRestriction then true else
// While the dependency specifies the framework restrictions of the dependency ([ >= netstandard13 ])
// we need to take the dependency, when the combination still contains packages.
// NOTE: This is not forwards compatible...
//let combined = FrameworkRestriction.And [ restriction; dependencyRestrictions ]
//not combined.RepresentedFrameworks.IsEmpty
// "And" is not cheap therefore we use this,
// because we don't want to pay the price of calculating a "simplified" formula
Set.intersect restriction.RepresentedFrameworks dependencyRestrictions.RepresentedFrameworks
|> Set.isEmpty
|> not
let filterByRestrictions (restrictions:FrameworkRestrictions) (dependencies:DependencySet) : DependencySet =
match getExplicitRestriction restrictions with
| FrameworkRestriction.HasNoRestriction -> dependencies
| restrictions ->
dependencies
|> Set.filter (isIncluded restrictions)
let findFirstIncompatibility (currentStep:ResolverStep) (lockedPackages: Set<_>) (dependencies:DependencySet) (package:ResolvedPackage) =
dependencies
// exists any non-matching stuff
|> Seq.filter (fun (name, _, _) -> name = package.Name)
|> Seq.filter (fun (name, _, _) -> lockedPackages.Contains name |> not)
|> Seq.filter (fun (name, requirement, restriction) ->
let allowTransitivePreleases =
(currentStep.ClosedRequirements |> Set.exists (fun r -> r.TransitivePrereleases && r.Name = name)) ||
(currentStep.OpenRequirements |> Set.exists (fun r -> r.TransitivePrereleases && r.Name = name))
not (requirement.IsInRange (package.Version, allowTransitivePreleases)))
|> Seq.tryHead
let cleanupNames (model : PackageResolution) : PackageResolution =
model
|> Map.map (fun _ package ->
{ package with
Dependencies =
package.Dependencies
|> Set.map (fun (name, v, d) -> model.[name].Name, v, d) })
type ConflictInfo =
{ ResolveStep : ResolverStep
RequirementSet : PackageRequirement Set
Requirement : PackageRequirement
GetPackageVersions : (PackageName -> (SemVerInfo * PackageSource list) seq) }
[<RequireQualifiedAccess>]
[<DebuggerDisplay "{DebugDisplay()}">]
type ResolutionRaw =
| OkRaw of PackageResolution
| ConflictRaw of ConflictInfo
member internal self.DebugDisplay() =
match self with
| OkRaw pkgres ->
pkgres |> Seq.map (fun kvp -> kvp.Key, kvp.Value)
|> Array.ofSeq |> sprintf "Ok - %A"
| ConflictRaw { ResolveStep = resolveStep; RequirementSet = reqSet; Requirement = req } ->
sprintf "%A\n%A\n%A\n" resolveStep reqSet req
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
module ResolutionRaw =
open System.Text
let getConflicts (res:ResolutionRaw) =
match res with
| ResolutionRaw.OkRaw _ -> Set.empty
| ResolutionRaw.ConflictRaw { ResolveStep = currentStep; Requirement = lastPackageRequirement } ->
(currentStep.ClosedRequirements |> Set.filter (fun x -> x.Name = lastPackageRequirement.Name))
|> Set.union (currentStep.OpenRequirements |> Set.filter (fun x -> x.Name = lastPackageRequirement.Name))
|> Set.add lastPackageRequirement
let buildConflictReport (errorReport:StringBuilder) (conflicts:PackageRequirement Set) =
let formatVR (vr:VersionRequirement) =
vr.ToString()
|> fun s -> if String.IsNullOrWhiteSpace s then ">= 0" else sprintf "%O" vr
let formatPR (vr:VersionRequirement) =
match vr.PreReleases with
| PreReleaseStatus.All -> " prerelease"
| PreReleaseStatus.Concrete [x] -> sprintf " (%s)" x
| PreReleaseStatus.Concrete x -> sprintf " %A" x
| _ -> ""
match conflicts with
| s when s.IsEmpty -> errorReport
| conflicts ->
errorReport.AddLine (sprintf " Conflict detected:")
let getConflictMessage (req:PackageRequirement) =
let vr = formatVR req.VersionRequirement
let pr = formatPR req.VersionRequirement
let tp = if req.TransitivePrereleases then "*" else ""
match req.Parent with
| RuntimeDependency ->
sprintf " - Runtime Dependency requested package %O: %s%s%s" req.Name vr pr tp
| DependenciesFile _ ->
sprintf " - Dependencies file requested package %O: %s%s%s" req.Name vr pr tp
| DependenciesLock(_,path) ->
let lock = try IO.Path.GetFileName(path) with | ex -> path
sprintf " - External \"%s\" requested package %O: %s%s%s" lock req.Name vr pr tp
| Package (parentName,version,_) ->
sprintf " - %O %O requested package %O: %s%s%s" parentName version req.Name vr pr tp
conflicts
|> Seq.fold (fun (errorReport:StringBuilder) conflict ->
errorReport.AppendLine (getConflictMessage conflict)) errorReport
let getErrorText showResolvedPackages (res:ResolutionRaw) =
match res with
| ResolutionRaw.OkRaw _ -> ""
| ResolutionRaw.ConflictRaw { ResolveStep = currentStep; GetPackageVersions = getVersionF } ->
let errorText =
if showResolvedPackages && not currentStep.CurrentResolution.IsEmpty then
( StringBuilder().AppendLine " Resolved packages:"
, currentStep.CurrentResolution)
||> Map.fold (fun sb _ resolvedPackage ->
sb.AppendLinef " - %O %O" resolvedPackage.Name resolvedPackage.Version)
else StringBuilder()
match getConflicts res with
| c when c.IsEmpty ->
errorText.AppendLinef
" Could not resolve package %O. Unknown resolution error."
(Seq.head currentStep.OpenRequirements)
| cfs when cfs.Count = 1 ->
let c = cfs.MinimumElement
let errorText = buildConflictReport errorText cfs
match getVersionF c.Name |> Seq.toList with
| [] -> errorText.AppendLinef " - No versions available."
| avalaibleVersions ->
( errorText.AppendLinef " - Available versions:"
, avalaibleVersions )
||> List.fold (fun sb elem -> sb.AppendLinef " - %O" elem)
| conflicts -> buildConflictReport errorText conflicts
|> string
let isDone (res:ResolutionRaw) =
match res with
| ResolutionRaw.OkRaw _ -> true
| _ -> false
type ResolutionRaw with
member self.GetConflicts () = ResolutionRaw.getConflicts self
member self.GetErrorText showResolvedPackages = ResolutionRaw.getErrorText showResolvedPackages self
member self.IsDone = ResolutionRaw.isDone self
[<RequireQualifiedAccess>]
[<DebuggerDisplay "{DebugDisplay()}">]
type Resolution =
private { Raw : ResolutionRaw; Errors : Exception list }
static member ofRaw errors resolution =
{ Raw = resolution; Errors = errors }
member private self.DebugDisplay() = self.Raw.DebugDisplay()
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
module Resolution =
let getConflicts (res:Resolution) = ResolutionRaw.getConflicts res.Raw
let getErrorText showResolvedPackages (res:Resolution) = ResolutionRaw.getErrorText showResolvedPackages res.Raw
let isDone (res:Resolution) = ResolutionRaw.isDone res.Raw
let addError error (res:Resolution) =
{ res with Errors = error :: res.Errors }
let addErrors errors (res:Resolution) =
{ res with Errors = errors @ res.Errors }
let getModelOrFail (res:Resolution) =
match res.Raw with
| ResolutionRaw.OkRaw model -> model
| ResolutionRaw.ConflictRaw _ ->
let msg =
sprintf "There was a version conflict during package resolution.\n\
%s\n Please try to relax some conditions or resolve the conflict manually (see http://fsprojects.github.io/Paket/nuget-dependencies.html#Use-exactly-this-version-constraint)." (getErrorText true res)
raise (AggregateException(msg, res.Errors))
let (|Ok|Conflict|) (res:Resolution) =
match res.Raw with
| ResolutionRaw.OkRaw res -> Ok res
| ResolutionRaw.ConflictRaw conf -> Conflict conf
let Ok resolution =
Resolution.ofRaw [] (ResolutionRaw.OkRaw resolution)
type Resolution with
member self.GetConflicts () = Resolution.getConflicts self
member self.GetErrors () = self.Errors
member self.GetErrorText showResolvedPackages = Resolution.getErrorText showResolvedPackages self
member self.GetModelOrFail () = Resolution.getModelOrFail self
member self.IsDone = Resolution.isDone self
member self.IsOk = self.IsDone
member self.IsConflict = not self.IsDone
let isIncludedIn (set:Set<PackageRequirement>) (packageRequirement:PackageRequirement) =
set
|> Set.exists (fun x ->
x.Name = packageRequirement.Name &&
x.ResolverStrategyForDirectDependencies = packageRequirement.ResolverStrategyForDirectDependencies &&
x.ResolverStrategyForTransitives = packageRequirement.ResolverStrategyForTransitives &&
x.Settings.FrameworkRestrictions = packageRequirement.Settings.FrameworkRestrictions &&
(x = packageRequirement ||
x.VersionRequirement.Range.IsIncludedIn packageRequirement.VersionRequirement.Range ||
x.VersionRequirement.Range.IsGlobalOverride))
let calcOpenRequirements (exploredPackage:ResolvedPackage,lockedPackages:Set<_>,globalFrameworkRestrictions,(verCache:VersionCache),currentRequirement:PackageRequirement,resolverStep:ResolverStep) =
let dependenciesByName =
// there are packages which define multiple dependencies to the same package
// we compress these here - see #567
let dict = Dictionary<_,_>()
let openDeps =
exploredPackage.Dependencies
|> Seq.filter (fun (name,_,_) -> lockedPackages.Contains name |> not)
for ((name,v,r) as dep) in openDeps do
match dict.TryGetValue name with
| true,(_,v2,r2) ->
match v,v2 with
| VersionRequirement(ra1,p1),VersionRequirement(ra2,p2) when p1 = p2 ->
let newRestrictions =
match r with
| ExplicitRestriction r ->
match r2 with
| ExplicitRestriction r2 ->
FrameworkRestriction.combineRestrictionsWithOr r r2 |> ExplicitRestriction
| AutoDetectFramework -> ExplicitRestriction r
| AutoDetectFramework -> r
if ra1.IsIncludedIn ra2 then
dict.[name] <- (name,v,newRestrictions)
elif ra2.IsIncludedIn ra1 then
dict.[name] <- (name,v2,newRestrictions)
else dict.[name] <- dep
| _ -> dict.[name] <- dep
| _ -> dict.Add(name,dep)
dict.Values
|> Set.ofSeq
let rest =
resolverStep.OpenRequirements
|> Set.remove currentRequirement
let candidates =
dependenciesByName
|> Set.map (fun (n, v, restriction) ->
let newRestrictions =
filterRestrictions restriction exploredPackage.Settings.FrameworkRestrictions
|> filterRestrictions globalFrameworkRestrictions
|> fun xs -> if xs = ExplicitRestriction FrameworkRestriction.NoRestriction then exploredPackage.Settings.FrameworkRestrictions else xs
{ currentRequirement with
Name = n
VersionRequirement = v
Parent = Package(currentRequirement.Name, verCache.Version, exploredPackage.Source)
Graph = Set.add currentRequirement currentRequirement.Graph
TransitivePrereleases = currentRequirement.TransitivePrereleases && exploredPackage.Version.PreRelease.IsSome
Settings = { currentRequirement.Settings with FrameworkRestrictions = newRestrictions } })
|> Set.filter (fun d -> not (isIncludedIn resolverStep.ClosedRequirements d || isIncludedIn resolverStep.OpenRequirements d))
rest
|> Set.filter (isIncludedIn candidates >> not)
|> Set.union candidates
type Resolved = {
ResolvedPackages : Resolution
ResolvedSourceFiles : ModuleResolver.ResolvedSourceFile list
}
let getResolverStrategy globalStrategyForDirectDependencies globalStrategyForTransitives (rootDependencies:IDictionary<PackageName,PackageRequirement>) (allRequirementsOfCurrentPackage:Set<PackageRequirement>) (currentRequirement:PackageRequirement) =
let strategy =
if (currentRequirement.Parent.IsRootRequirement()) then
currentRequirement.ResolverStrategyForDirectDependencies ++ globalStrategyForDirectDependencies
elif (currentRequirement.Parent.IsRuntimeRequirement() && Set.count allRequirementsOfCurrentPackage = 1) then
currentRequirement.ResolverStrategyForDirectDependencies ++ globalStrategyForDirectDependencies
else
match rootDependencies.TryGetValue currentRequirement.Name with
| true, r when r.ResolverStrategyForDirectDependencies <> None ->
r.ResolverStrategyForDirectDependencies
| _ ->
(allRequirementsOfCurrentPackage
|> Seq.filter (fun x -> x.Depth > 0)
|> Seq.sortBy (fun x -> x.Depth, x.ResolverStrategyForTransitives <> globalStrategyForTransitives, x.ResolverStrategyForTransitives <> Some ResolverStrategy.Max)
|> Seq.map (fun x -> x.ResolverStrategyForTransitives)
|> Seq.fold (++) None)
++ globalStrategyForTransitives
defaultArg strategy ResolverStrategy.Max
type UpdateMode =
| UpdateGroup of GroupName
| UpdateFiltered of GroupName * PackageFilter
| Install
| InstallGroup of GroupName
| UpdateAll
type private PackageConfig = {
Dependency : PackageRequirement
GroupName : GroupName
GlobalRestrictions : FrameworkRestrictions
RootDependencies : IDictionary<PackageName,PackageRequirement>
CliTools : Set<PackageName>
VersionCache : VersionCache
UpdateMode : UpdateMode
} with
member self.HasGlobalRestrictions =
getExplicitRestriction self.GlobalRestrictions <> FrameworkRestriction.NoRestriction
member self.HasDependencyRestrictions =
getExplicitRestriction self.Dependency.Settings.FrameworkRestrictions <> FrameworkRestriction.NoRestriction
let private updateRestrictions (pkgConfig:PackageConfig) (package:ResolvedPackage) =
let newRestrictions =
if not pkgConfig.HasGlobalRestrictions
&& (FrameworkRestriction.NoRestriction = (package.Settings.FrameworkRestrictions |> getExplicitRestriction)
|| not pkgConfig.HasDependencyRestrictions )
then
FrameworkRestriction.NoRestriction
else
// Setting in the dependencies file
let globalPackageSettings =
match pkgConfig.RootDependencies.TryGetValue package.Name with
| true, r ->
match r.Settings.FrameworkRestrictions with
| ExplicitRestriction r -> r
| _ -> FrameworkRestriction.NoRestriction
| _ -> FrameworkRestriction.NoRestriction
// Settings required for the current resolution
let packageSettings = package.Settings.FrameworkRestrictions |> getExplicitRestriction
// Settings required for this current dependency
let dependencySettings = pkgConfig.Dependency.Settings.FrameworkRestrictions |> getExplicitRestriction
// Settings defined globally
let globalSettings = pkgConfig.GlobalRestrictions |> getExplicitRestriction
let isRequired =
FrameworkRestriction.Or
[ packageSettings
FrameworkRestriction.And [dependencySettings;globalSettings]]
// We assume the user knows what he is doing
FrameworkRestriction.And [ globalPackageSettings;isRequired ]
{ package with
Settings = { package.Settings with FrameworkRestrictions = ExplicitRestriction newRestrictions }
}
let private explorePackageConfig (getPackageDetailsBlock:PackageDetailsSyncFunc) (pkgConfig:PackageConfig) =
let dependency, version = pkgConfig.Dependency, pkgConfig.VersionCache.Version
let packageSources = pkgConfig.VersionCache.Sources
let isAssumedVersion = pkgConfig.VersionCache.AssumedVersion
match pkgConfig.UpdateMode with
| Install -> tracefn " - %O %A" dependency.Name version
| InstallGroup _ -> tracefn " - %O %A" dependency.Name version
| _ ->
match dependency.VersionRequirement.Range with
| OverrideAll _ when dependency.Parent.IsRootRequirement() ->
traceWarnfn " - %O is locked to %O" dependency.Name version
| Specific _ when dependency.Parent.IsRootRequirement() ->
traceWarnfn " - %O is pinned to %O" dependency.Name version
| _ ->
tracefn " - %O %A" dependency.Name version
let newRestrictions = filterRestrictions dependency.Settings.FrameworkRestrictions pkgConfig.GlobalRestrictions
try
let packageDetails : PackageDetails = getPackageDetailsBlock (GetPackageDetailsParameters.ofParamsEx isAssumedVersion packageSources pkgConfig.GroupName dependency.Name version)
let filteredDependencies = DependencySetFilter.filterByRestrictions newRestrictions packageDetails.DirectDependencies
let settings =
match dependency.Parent with
| DependenciesFile _ | DependenciesLock _ | RuntimeDependency -> dependency.Settings
| Package _ ->
match pkgConfig.RootDependencies.TryGetValue packageDetails.Name with
| true, r -> r.Settings + dependency.Settings
| _ -> dependency.Settings
|> fun x -> x.AdjustWithSpecialCases packageDetails.Name
Result.Ok
{ Name = packageDetails.Name
Version = version
Dependencies = filteredDependencies
Unlisted = packageDetails.Unlisted
Settings = { settings with FrameworkRestrictions = newRestrictions }
Source = packageDetails.Source
Kind = if Set.contains packageDetails.Name pkgConfig.CliTools then ResolvedPackageKind.DotnetCliTool
else ResolvedPackageKind.Package
IsRuntimeDependency = false
}
with
| exn ->
traceWarnfn " Package not available.%s Message: %s" Environment.NewLine exn.Message
Result.Error (System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture exn)
type StackPack = {
ExploredPackages : Dictionary<PackageName*SemVerInfo,ResolvedPackage>
KnownConflicts : HashSet<Set<PackageRequirement> * (VersionCache list * bool) option>
ConflictHistory : Dictionary<PackageName, int>
}
let private getExploredPackage (pkgConfig:PackageConfig) (getPackageDetailsBlock:PackageDetailsSyncFunc) (stackpack:StackPack) =
let key = (pkgConfig.Dependency.Name, pkgConfig.VersionCache.Version)
match stackpack.ExploredPackages.TryGetValue key with
| true, package ->
let package = updateRestrictions pkgConfig package
stackpack.ExploredPackages.[key] <- package
if verbose then
verbosefn " Retrieved Explored Package %O" package
stackpack, Result.Ok(true, package)
| false,_ ->
match explorePackageConfig getPackageDetailsBlock pkgConfig with
| Result.Ok explored ->
if verbose then
verbosefn " Found Explored Package %O" explored
stackpack.ExploredPackages.Add(key,explored)
stackpack, Result.Ok(false, explored)
| Result.Error err ->
stackpack, Result.Error err
let private getCompatibleVersions
(currentStep:ResolverStep)
groupName
(currentRequirement:PackageRequirement)
(rootDependencies:IDictionary<PackageName,PackageRequirement>)
(getVersionsF: ResolverStrategy -> PackageVersionsSyncFunc)
globalOverride
globalStrategyForDirectDependencies
globalStrategyForTransitives =
if verbose then
verbosefn " Trying to resolve %O" currentRequirement
match Map.tryFind currentRequirement.Name currentStep.FilteredVersions with
| None ->
let allRequirementsOfCurrentPackage =
currentStep.OpenRequirements
|> Set.filter (fun r -> currentRequirement.Name = r.Name)
// we didn't select a version yet so all versions are possible
let isInRange mapF (cache:VersionCache) =
match rootDependencies.TryGetValue currentRequirement.Name with
| true, p ->
allRequirementsOfCurrentPackage
|> Set.forall (fun r ->
let mapped : PackageRequirement = mapF r
mapped.VersionRequirement.IsInRange cache.Version ||
mapped.IncludingPrereleases(p.VersionRequirement.PreReleases).VersionRequirement.IsInRange cache.Version)
| _ ->
allRequirementsOfCurrentPackage
|> Set.forall (fun r -> (mapF r).VersionRequirement.IsInRange cache.Version)
let getSingleVersion v =
let sources =
match currentRequirement.Parent with
| PackageRequirementSource.Package(_,_,parentSource) ->
parentSource :: currentRequirement.Sources |> List.distinct
| _ ->
currentRequirement.Sources
|> List.sortBy (fun x -> not x.IsLocalFeed, String.containsIgnoreCase "nuget.org" x.Url |> not)
Seq.singleton (VersionCache.ofParams v sources true)
let availableVersions =
let resolverStrategy = getResolverStrategy globalStrategyForDirectDependencies globalStrategyForTransitives rootDependencies allRequirementsOfCurrentPackage currentRequirement
let allVersions =
let versionParams = GetPackageVersionsParameters.ofParams currentRequirement.Sources groupName currentRequirement.Name currentRequirement.MinVersionSetting
getVersionsF resolverStrategy versionParams
|> Seq.map (fun (v, sources) -> VersionCache.ofParams v sources false)
match currentRequirement.VersionRequirement.Range with
| Specific v
| OverrideAll v ->
let results =
allVersions
|> Seq.filter (fun cache -> cache.Version = v)
if Seq.isEmpty results then
getSingleVersion v
else
results
| _ -> allVersions
let compatibleVersions = Seq.filter (isInRange id) availableVersions |> Seq.cache
let compatibleVersions, globalOverride =
if currentRequirement.VersionRequirement.Range.IsGlobalOverride then
compatibleVersions, true
elif Seq.isEmpty compatibleVersions && currentRequirement.TransitivePrereleases && not (currentRequirement.Parent.IsRootRequirement()) then
Seq.filter (isInRange (fun r -> r.IncludingPrereleases(PreReleaseStatus.All))) availableVersions |> Seq.cache, globalOverride
elif Seq.isEmpty compatibleVersions then
let prereleaseStatus (r:PackageRequirement) =
if r.Parent.IsRootRequirement() && r.VersionRequirement <> VersionRequirement.AllReleases then
r.VersionRequirement.PreReleases
else
PreReleaseStatus.All
let available = availableVersions |> Seq.toList
let allPrereleases = available |> List.filter (fun (cache:VersionCache) -> cache.Version.PreRelease <> None) = available
let prereleases = List.filter (isInRange (fun r -> r.IncludingPrereleases(prereleaseStatus r))) available
if allPrereleases then
Seq.ofList prereleases, globalOverride
else
compatibleVersions, globalOverride
else
compatibleVersions, globalOverride
compatibleVersions, globalOverride, false
| Some(versions,globalOverride) ->
// we already selected a version so we can't pick a different
let compatibleVersions, tryRelaxed =
if globalOverride then List.toSeq versions, false else
let compat =
versions
|> Seq.filter (fun (cache) -> currentRequirement.VersionRequirement.IsInRange(cache.Version,currentRequirement.Parent.IsRootRequirement() |> not))
if Seq.isEmpty compat then
let withPrereleases =
versions
|> Seq.filter (fun (cache) -> currentRequirement.IncludingPrereleases().VersionRequirement.IsInRange(cache.Version,currentRequirement.Parent.IsRootRequirement() |> not))
if currentStep.Relax || Seq.isEmpty withPrereleases then
withPrereleases, false
else
withPrereleases, true
else
compat, false
compatibleVersions, false, tryRelaxed
let private getConflicts (currentStep:ResolverStep) (currentRequirement:PackageRequirement) (knownConflicts:HashSet<Set<PackageRequirement> * (VersionCache list * bool) option>) =
let allRequirements =
currentStep.OpenRequirements
|> Set.filter (fun r -> r.Graph |> Set.contains currentRequirement |> not)
|> Set.union currentStep.ClosedRequirements
knownConflicts
|> Seq.map (fun (conflicts,selectedVersion) ->
let isSubset = conflicts.IsSubsetOf allRequirements
match selectedVersion with
| None when isSubset -> conflicts
| Some(selectedVersion,_) ->
let n = (Seq.head conflicts).Name
match currentStep.FilteredVersions |> Map.tryFind n with
| Some(v,_) when v = selectedVersion && isSubset -> conflicts
| _ -> Set.empty
| _ -> Set.empty)
|> Seq.collect id
|> HashSet
let private getCurrentRequirement packageFilter (openRequirements:Set<PackageRequirement>) (conflictHistory:Dictionary<_,_>) =
let initialMin = Seq.head openRequirements
let boost (d:PackageRequirement) =
match conflictHistory.TryGetValue d.Name with
| true,c -> -c
| _ -> 0
let initialBoost = boost initialMin
let currentMin, _ =
((initialMin,initialBoost),openRequirements)
||> Seq.fold (fun (cmin,cboost) d ->
let boost = boost d
if PackageRequirement.Compare(d,cmin,packageFilter,boost,cboost) = -1 then
d, boost
else
cmin, cboost)
currentMin
[<StructuredFormatDisplay "{Display}">]
type ConflictState = {
Errors : Exception list
Status : ResolutionRaw
LastConflictReported : DateTime
TryRelaxed : bool
Conflicts : Set<PackageRequirement>
VersionsToExplore : seq<VersionCache>
GlobalOverride : bool
} with
member x.AddError exn =
{ x with Errors = exn :: x.Errors }
member private self.Display
with get () =
let conflicts = self.Conflicts |> Seq.map (printfn "%A\n") |> String.Concat
let explore = self.VersionsToExplore |> Seq.map (printfn "%A\n") |> String.Concat
sprintf
"[< ConflictState >]\n\
| Status - %A\n\
| Conflicts - %A\n\
| ExploreVers - %A\n\
| TryRelaxed - %A\n
| LastReport - %A\n"
self.Status conflicts explore
self.TryRelaxed self.LastConflictReported.ToLocalTime
let inline boostConflicts
(filteredVersions:Map<PackageName, (VersionCache list * bool)>)
(currentRequirement:PackageRequirement)
(stackpack:StackPack)
(conflictState:ConflictState) =
let conflictStatus = conflictState.Status
let isNewConflict =
match stackpack.ConflictHistory.TryGetValue currentRequirement.Name with
| true,count ->
stackpack.ConflictHistory.[currentRequirement.Name] <- count + 1
false
| _ ->
stackpack.ConflictHistory.Add(currentRequirement.Name, 1)
true
let conflicts = conflictStatus.GetConflicts()
for c in conflicts do
match c.Parent with
| PackageRequirementSource.Package(parentName,_,_) ->
match stackpack.ConflictHistory.TryGetValue parentName with
| true,count ->
stackpack.ConflictHistory.[parentName] <- count + 2
| _ ->
stackpack.ConflictHistory.Add(parentName, 2)
| _ -> ()
let isKnownConflict =
match conflicts with
| _ when not conflicts.IsEmpty ->
let c = conflicts |> Seq.minBy (fun c -> c.Parent)
let selectedVersion = Map.tryFind c.Name filteredVersions
let key = conflicts |> Set,selectedVersion
not (stackpack.KnownConflicts.Add key) // true if known
| _ -> false
let reportThatResolverIsTakingLongerThanExpected =
if isNewConflict then isKnownConflict
else DateTime.UtcNow - conflictState.LastConflictReported > TimeSpan.FromSeconds 10.
if reportThatResolverIsTakingLongerThanExpected then
let lastConflictReported =
match conflicts with
| _ when not conflicts.IsEmpty ->
traceWarnfn "%s" (conflictStatus.GetErrorText false)
traceWarn "The process is taking longer than expected."
traceWarn "Paket may still find a valid resolution, but this might take a while."
DateTime.UtcNow
| _ -> conflictState.LastConflictReported
{ conflictState with
LastConflictReported = lastConflictReported }, stackpack
else
conflictState, stackpack
[<Struct>]
type private StepFlags = {
Ready : bool
UseUnlisted : bool
HasUnlisted : bool
ForceBreak : bool
FirstTrial : bool
UnlistedSearch : bool
} with
override self.ToString () =
sprintf
"""[< FLAGS >]\n\
| Ready - %b\n\
| UseUnlisted - %b\n\
| HasUnlisted - %b\n\
| ForceBreak - %b\n\
| FirstTrial - %b\n\
| UnlistedSearch - %b\n"""
self.Ready self.UseUnlisted self.HasUnlisted self.ForceBreak self.FirstTrial self.UnlistedSearch
type private Stage =
| Step of currentConflict : (ConflictState * ResolverStep * PackageRequirement) * priorConflictSteps : (ConflictState * ResolverStep * PackageRequirement * seq<VersionCache> * StepFlags) list
| Outer of currentConflict : (ConflictState * ResolverStep * PackageRequirement) * priorConflictSteps : (ConflictState * ResolverStep * PackageRequirement * seq<VersionCache> * StepFlags) list
| Inner of currentConflict : (ConflictState * ResolverStep * PackageRequirement) * priorConflictSteps : (ConflictState * ResolverStep * PackageRequirement * seq<VersionCache> * StepFlags) list
type WorkPriority =
| BackgroundWork = 10
| MightBeRequired = 5
| LikelyRequired = 3
| BlockingWork = 1
type RequestWork =
private
{ StartWork : CancellationToken -> Task
mutable Priority : WorkPriority }
type WorkHandle<'a> = private { Work : RequestWork; TaskSource : TaskCompletionSource<'a> }
and ResolverRequestQueue =
private { DynamicQueue : ResizeArray<RequestWork>; Lock : obj; WaitingWorker : ResizeArray<TaskCompletionSource<RequestWork option>> }
// callback in a lock is bad practice -> private
member private x.With callback =
lock x.Lock (fun () ->
callback x.DynamicQueue x.WaitingWorker
)
member x.AddWork w =
x.With (fun queue workers ->
if workers.Count > 0 then
let worker = workers.[0]
workers.RemoveAt(0)
worker.TrySetResult (Some w) |> ignore
else
queue.Add(w)
)
member x.GetWork (ct:CancellationToken) =
let tcs = new TaskCompletionSource<_>()
let registration = ct.Register(fun () -> tcs.TrySetResult None |> ignore)
tcs.Task.ContinueWith (fun (t:Task) ->
registration.Dispose()) |> ignore
x.With (fun queue workers ->
if queue.Count = 0 then
workers.Add(tcs)
else
let (index, work) = queue |> Seq.mapi (fun i w -> i,w) |> Seq.minBy (fun (_,w) -> w.Priority)
queue.RemoveAt index
tcs.TrySetResult (Some work) |> ignore
tcs.Task
)
module ResolverRequestQueue =
open System.Threading
let Create() = { DynamicQueue = new ResizeArray<RequestWork>(); Lock = new obj(); WaitingWorker = new ResizeArray<_>() }
let addWork prio (f: CancellationToken -> Task<'a>) (q:ResolverRequestQueue) =
let tcs = new TaskCompletionSource<_>("WorkTask")
let work =
{ StartWork = (fun tok ->
// When someone is actually starting the work we need to ensure we finish it...
let registration = tok.Register(fun () ->
async {
do! Async.Sleep 1000
if not tcs.Task.IsCompleted then
tcs.TrySetException (TimeoutException "Cancellation was requested, but wasn't honered after 1 second. We finish the task forcefully (requests might still run in the background).")
|> ignore
} |> Async.Start)
let t =
try
f tok
with e ->
//Task.FromException (e)
let tcs = new TaskCompletionSource<_>()
tcs.SetException e
tcs.Task
t.ContinueWith(fun (t:Task<'a>) ->
registration.Dispose()
if t.IsCanceled then
tcs.TrySetException(new TaskCanceledException(t))
elif t.IsFaulted then
tcs.TrySetException(t.Exception)
else tcs.TrySetResult (t.Result))
|> ignore
// Important to not wait on the ContinueWith result,
// because that one will never finish in the cancellation case
// tcs.Task should always finish
tcs.Task :> Task)
Priority = prio }
q.AddWork work
{ Work = work; TaskSource = tcs }
let startProcessing (ct:CancellationToken) ({ DynamicQueue = queue } as q) =
let linked = new CancellationTokenSource()
async {
use _reg = ct.Register(fun () ->
linked.CancelAfter(500))
while not ct.IsCancellationRequested do
let! work = q.GetWork(ct) |> Async.AwaitTask
match work with
| Some work ->
do! work.StartWork(ct).ContinueWith(fun (_:Task) -> ()) |> Async.AwaitTask
| None -> ()
}
|> fun a -> Async.StartAsTaskProperCancel(a, TaskCreationOptions.None, linked.Token)
type WorkHandle<'a> with
member x.TryReprioritize onlyHigher prio =
let { Work = work } = x
if not onlyHigher || work.Priority > prio then
work.Priority <- prio
member x.Reprioritize prio =
x.TryReprioritize false prio
member x.Task =
let { TaskSource = task } = x
task.Task
type ResolverTaskMemory<'a> =
{ Work : WorkHandle<'a>; mutable WaitedAlready : bool }
member x.Wait (timeout: int)=
if x.WaitedAlready then
true, x.Work.Task.IsCompleted
else
x.WaitedAlready <- true
false, x.Work.Task.Wait timeout
module ResolverTaskMemory =
let ofWork w = { Work = w; WaitedAlready = false }
let selectVersionsToPreload (verReq:VersionRequirement) f versions =
let versions = HashSet<_>()
seq {
match versions |> Seq.tryFind (fun v -> verReq.IsInRange(f v, true)) with
| Some verToPreload ->
if versions.Add verToPreload then
yield verToPreload, WorkPriority.LikelyRequired
| None -> ()
match versions |> Seq.tryFind (f >> verReq.IsInRange) with
| Some verToPreload ->
if versions.Add verToPreload then
yield verToPreload, WorkPriority.LikelyRequired
| None -> ()
for v in versions |> Seq.filter (fun v -> verReq.IsInRange(f v, true)) |> Seq.tryTake 3 do
if versions.Add v then
yield v, WorkPriority.MightBeRequired
for v in versions |> Seq.filter (f >> verReq.IsInRange) |> Seq.tryTake 3 do
if versions.Add v then
yield v, WorkPriority.MightBeRequired
}
let RequestTimeout = 180000
let WorkerCount = 6
type PreferredVersionsFunc = ResolverStrategy -> GetPackageVersionsParameters -> list<SemVerInfo * PackageSource list>
/// Resolves all direct and transitive dependencies
let Resolve (getVersionsRaw : PackageVersionsFunc, getPreferredVersionsRaw : PreferredVersionsFunc, getPackageDetailsRaw : PackageDetailsFunc, groupName:GroupName, globalStrategyForDirectDependencies, globalStrategyForTransitives, globalFrameworkRestrictions, (rootDependencies:PackageRequirement Set), updateMode : UpdateMode) =
tracefn "Resolving packages for group %O:" groupName
let cliToolSettings =
rootDependencies
|> Seq.choose (fun r ->
match r.Parent with
| PackageRequirementSource.DependenciesFile _ | PackageRequirementSource.DependenciesLock _
when (r.Kind = PackageRequirementKind.DotnetCliTool) ->
Some r.Name
| _ -> None)
|> Set.ofSeq
use d = Profile.startCategory Profile.Category.ResolverAlgorithm
use cts = new CancellationTokenSource()
let workerQueue = ResolverRequestQueue.Create()
let workerCount =
match Environment.GetEnvironmentVariable("PAKET_RESOLVER_WORKERS") with
| a when System.String.IsNullOrWhiteSpace a -> WorkerCount
| a ->
match System.Int32.TryParse a with
| true, v when v > 0 -> v
| _ -> traceWarnfn "PAKET_RESOLVER_WORKERS is not set to a number > 0, ignoring the value and defaulting to %d" WorkerCount
WorkerCount
let workers =
// start maximal 8 requests at the same time.
[ 1 .. workerCount ]
|> List.map (fun _ -> ResolverRequestQueue.startProcessing cts.Token workerQueue)
// mainly for failing unit-tests to be faster
let taskTimeout =
match Environment.GetEnvironmentVariable("PAKET_RESOLVER_TASK_TIMEOUT") with
| a when System.String.IsNullOrWhiteSpace a -> RequestTimeout
| a ->
match System.Int32.TryParse a with
| true, v -> v
| _ -> traceWarnfn "PAKET_RESOLVER_TASK_TIMEOUT is not set to an interval in milliseconds, ignoring the value and defaulting to %d" RequestTimeout
RequestTimeout
let loopTimeout =
match Environment.GetEnvironmentVariable("PAKET_RESOLVER_TIMEOUT") with
| a when System.String.IsNullOrWhiteSpace a -> Timeout.InfiniteTimeSpan
| a ->
match System.Int32.TryParse a with
| true, msecs when msecs >= -1 ->
tracefn "PAKET_RESOLVER_TIMEOUT is set to %d milliseconds" msecs
TimeSpan.FromMilliseconds (float(msecs))
| _ ->
match System.TimeSpan.TryParse a with
| true, timeSpan when timeSpan > TimeSpan.Zero ->
tracefn "PAKET_RESOLVER_TIMEOUT is set to timespan of %A" timeSpan
timeSpan