-
Notifications
You must be signed in to change notification settings - Fork 162
/
deps_dev.go
793 lines (693 loc) · 26.6 KB
/
deps_dev.go
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
//
// Copyright 2023 The GUAC Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package deps_dev
import (
"context"
"crypto/x509"
"fmt"
"strings"
"sync"
"time"
pb "deps.dev/api/v3"
model "github.com/guacsec/guac/pkg/assembler/clients/generated"
"github.com/guacsec/guac/pkg/assembler/helpers"
"github.com/guacsec/guac/pkg/collectsub/datasource"
"github.com/guacsec/guac/pkg/events"
"github.com/guacsec/guac/pkg/handler/processor"
"github.com/guacsec/guac/pkg/logging"
"github.com/guacsec/guac/pkg/metrics"
"github.com/guacsec/guac/pkg/version"
jsoniter "github.com/json-iterator/go"
"golang.org/x/exp/maps"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
)
var json = jsoniter.ConfigCompatibleWithStandardLibrary
const (
DepsCollector = "deps.dev"
goUpperCase = "GO"
golang = "golang"
maven = "maven"
sourceRepo = "SOURCE_REPO"
GetProjectDurationHistogram = "http_deps_dev_project_duration"
GetVersionErrorsCounter = "http_deps_dev_version_errors"
prometheusPrefix = "deps_dev"
)
type IsDepPackage struct {
CurrentPackageInput *model.PkgInputSpec
DepPackageInput *model.PkgInputSpec
IsDependency *model.IsDependencyInputSpec
}
type PackageComponent struct {
CurrentPackage *model.PkgInputSpec
Source *model.SourceInputSpec
Scorecard *model.ScorecardInputSpec
IsDepPackages []*IsDepPackage
DepPackages []*PackageComponent
UpdateTime time.Time
}
type depsCollector struct {
collectDataSource datasource.CollectSource
client pb.InsightsClient
poll bool
retrieveDependencies bool
interval time.Duration
Metrics metrics.MetricCollector
checkedPurls map[string]*PackageComponent
ingestedSource map[string]*model.SourceInputSpec
projectInfoMap map[string]*pb.Project
versions map[string]*pb.Version
dependencies map[string]*pb.Dependencies
}
var registerOnce sync.Once
func NewDepsCollector(ctx context.Context, collectDataSource datasource.CollectSource, poll, retrieveDependencies bool, interval time.Duration) (*depsCollector, error) {
ctx = metrics.WithMetrics(ctx, prometheusPrefix)
// Get the system certificates.
sysPool, err := x509.SystemCertPool()
if err != nil {
return nil, fmt.Errorf("failed to get system cert: %w", err)
}
// Connect to the service using TLS.
creds := credentials.NewClientTLSFromCert(sysPool, "")
conn, err := grpc.Dial("api.deps.dev:443",
grpc.WithTransportCredentials(creds),
grpc.WithUserAgent(version.UserAgent))
if err != nil {
return nil, fmt.Errorf("failed to connect to api.deps.dev: %w", err)
}
// Create a new Insights Client.
client := pb.NewInsightsClient(conn)
// Initialize the Metrics collector
metricsCollector := metrics.FromContext(ctx, prometheusPrefix)
if err := registerMetricsOnce(ctx, metricsCollector); err != nil {
return nil, fmt.Errorf("unable to register Metrics: %w", err)
}
return &depsCollector{
collectDataSource: collectDataSource,
client: client,
poll: poll,
retrieveDependencies: retrieveDependencies,
interval: interval,
checkedPurls: map[string]*PackageComponent{},
ingestedSource: map[string]*model.SourceInputSpec{},
projectInfoMap: map[string]*pb.Project{},
versions: map[string]*pb.Version{},
dependencies: map[string]*pb.Dependencies{},
Metrics: metricsCollector,
}, nil
}
// RetrieveArtifacts get the metadata from deps.dev based on the purl provided
func (d *depsCollector) RetrieveArtifacts(ctx context.Context, docChannel chan<- *processor.Document) error {
if d.poll {
for {
if err := d.populatePurls(ctx, docChannel); err != nil {
return fmt.Errorf("unable to retrieve purls from collector subscriber: %w", err)
}
select {
// If the context has been canceled it contains an err which we can throw.
case <-ctx.Done():
return ctx.Err() // nolint:wrapcheck
case <-time.After(d.interval):
}
}
} else {
if err := d.populatePurls(ctx, docChannel); err != nil {
return fmt.Errorf("unable to retrieve purls from collector subscriber: %w", err)
}
}
return nil
}
func (d *depsCollector) populatePurls(ctx context.Context, docChannel chan<- *processor.Document) error {
ds, err := d.collectDataSource.GetDataSources(ctx)
if err != nil {
return fmt.Errorf("unable to retrieve datasource: %w", err)
}
if !d.retrieveDependencies {
// do validation of and converting purls here, to remove duplicated work in next two calls
versionKeys, pkgInputs := d.validatePurls(ctx, ds.PurlDataSources)
d.retrieveVersionsAndProjects(ctx, maps.Values(versionKeys))
d.collectMetadata(ctx, docChannel, pkgInputs)
return nil
}
err = d.getAllDependencies(ctx, ds.PurlDataSources)
if err != nil {
return fmt.Errorf("failed to get all dependencies: %w", err)
}
for _, purl := range ds.PurlDataSources {
err := d.fetchDependencies(ctx, purl.Value, docChannel)
if err != nil {
return fmt.Errorf("failed to fetch dependencies: %w", err)
}
}
return nil
}
// returns mappings of purls to VersionKeys and PkgInputSpec, not including the purls that:
// - have already been queried
// - error when converting to PkgInputSpec
// - error when converting to VersionKey
// - don't contain a version
func (d *depsCollector) validatePurls(ctx context.Context, datasources []datasource.Source) (map[string]*pb.VersionKey, map[string]*model.PkgInputSpec) {
logger := logging.FromContext(ctx)
validVersionKeys := make(map[string]*pb.VersionKey)
validPackageInputs := make(map[string]*model.PkgInputSpec)
for _, ds := range datasources {
purl := ds.Value
if _, ok := d.checkedPurls[purl]; ok {
logger.Infof("purl %s already queried", purl)
continue
}
packageInput, err := helpers.PurlToPkg(purl)
if err != nil {
logger.Infof("failed to parse purl to pkg: %s", purl)
continue
}
// if version is not specified, cannot obtain accurate information from deps.dev. Log as info and skip the purl.
if *packageInput.Version == "" {
logger.Infof("purl does not contain version, skipping deps.dev query: %s", purl)
continue
}
versionKey, err := getVersionKey(packageInput.Type, packageInput.Namespace, packageInput.Name, packageInput.Version)
if err != nil {
logger.Debugf("failed to get VersionKey with the following error: %v", err)
continue
}
validPackageInputs[purl] = packageInput
validVersionKeys[purl] = versionKey
}
return validVersionKeys, validPackageInputs
}
// retrieves version and project information concurrently for all version keys
func (d *depsCollector) retrieveVersionsAndProjects(ctx context.Context, versionKeys []*pb.VersionKey) {
// channels to signal when the project and version info have been fetched
projectDone := make(chan bool)
versionDone := make(chan bool)
// channels to send the inputs to the goroutines
projectChan := make(chan *pb.ProjectKey)
versionChan := make(chan *pb.VersionKey)
// the projectChan and versionChan are used to send the project key and version key to the respective channels
go func() {
// this go routine has to be before the next go routine as it will be pushing into the project channel
// for each version that is fetched from the version channel it will check if the project has to be fetched
d.versions = d.getVersions(ctx, versionChan, projectChan) // the results are the stored in the versions map
versionDone <- true
}()
// the project channel is used to send the project key to the project channel
// these goroutines will be used to fetch the projects concurrently
go func() {
// this sets up the goroutine to fetch the projects concurrently for each input
d.projectInfoMap = d.getProjects(ctx, projectChan) // the results are the stored in the projectInfoMap map
// posts to the projectDone channel to signal that all projects have been fetched
projectDone <- true
}()
for _, versionKey := range versionKeys {
versionChan <- versionKey
}
close(versionChan)
<-versionDone
close(projectChan)
<-projectDone
}
// For each purl, generate a document containing scorecard and source metadata and write to docChannel.
// For performance, retrieveVersionsAndProjects should be called before to populate d.versions and d.projectInfoMap. Otherwise,
// blocking calls to deps.dev will be made for each purl
func (d *depsCollector) collectMetadata(ctx context.Context, docChannel chan<- *processor.Document, purls map[string]*model.PkgInputSpec) {
logger := logging.FromContext(ctx)
for purl, packageInput := range purls {
component := &PackageComponent{}
component.CurrentPackage = packageInput
err := d.collectAdditionalMetadata(ctx, packageInput.Type, packageInput.Namespace, packageInput.Name, packageInput.Version, component)
if err != nil {
logger.Debugf("failed to get additional metadata for package: %s, err: %v", purl, err)
continue
}
logger.Infof("obtained additional metadata for package: %s", purl)
d.checkedPurls[purl] = component
blob, err := json.Marshal(component)
if err != nil {
logger.Errorf("Error marshalling component to json: %s", err)
continue
}
doc := &processor.Document{
Blob: blob,
Type: processor.DocumentDepsDev,
Format: processor.FormatJSON,
SourceInformation: processor.SourceInformation{
Collector: DepsCollector,
Source: DepsCollector,
DocumentRef: events.GetDocRef(blob),
},
}
docChannel <- doc
}
}
// getAllDependencies gets all the dependencies for the purls provided in a concurrent manner.
func (d *depsCollector) getAllDependencies(ctx context.Context, purls []datasource.Source) error {
// channels to signal when the project and version info have been fetched
projectDone := make(chan bool)
versionDone := make(chan bool)
// channels to send the inputs to the goroutines
projectChan := make(chan *pb.ProjectKey)
versionChan := make(chan *pb.VersionKey)
logger := logging.FromContext(ctx)
// the projectChan and versionChan are used to send the project key and version key to the respective channels
go func() {
// this go routine has to be before the next go routine as it will be pushing into the project channel
// for each version that is fetched from the version channel it will check if the project has to be fetched
d.versions = d.getVersions(ctx, versionChan, projectChan) // the results are the stored in the versions map
versionDone <- true
}()
// the project channel is used to send the project key to the project channel
// these goroutines will be used to fetch the projects concurrently
go func() {
// this sets up the goroutine to fetch the projects concurrently for each input
d.projectInfoMap = d.getProjects(ctx, projectChan) // the results are the stored in the projectInfoMap map
// posts to the projectDone channel to signal that all projects have been fetched
projectDone <- true
}()
// TODO: Concurrently fetch the dependencies for each purl
for _, p := range purls {
purl := p.Value
packageInput, err := helpers.PurlToPkg(purl)
if err != nil {
logger.Infof("failed to parse purl to pkg: %s", purl)
return nil
}
// if version is not specified, cannot obtain accurate information from deps.dev. Log as info and skip the purl.
if packageInput != nil && *packageInput.Version == "" {
logger.Debugf("purl does not contain version, skipping deps.dev query: %s", purl)
return nil
}
// Make an RPC Request. The returned result is a stream of
// DependenciesResponse structs.
versionKey, err := getVersionKey(packageInput.Type, packageInput.Namespace, packageInput.Name, packageInput.Version)
if err != nil {
logger.Debugf("failed to getVersionKey with the following error: %v", err)
return nil
}
// send the version key to the version channel
versionChan <- versionKey
dependenciesReq := &pb.GetDependenciesRequest{
VersionKey: versionKey,
}
deps, err := d.client.GetDependencies(ctx, dependenciesReq)
if err != nil {
logger.Debugf("failed to get dependencies %v", err)
return nil
}
logger.Infof("Retrieved dependencies for %s", purl)
d.dependencies[versionKey.String()] = deps
for i, node := range deps.Nodes {
// the nodes of the dependency graph. The first node is the root of the graph, which is captured above so skip.
if i == 0 {
continue
}
pkgtype := ""
if node.VersionKey.System.String() == goUpperCase {
pkgtype = golang
} else {
pkgtype = strings.ToLower(node.VersionKey.System.String())
}
depPurl := "pkg:" + pkgtype + "/" + node.VersionKey.Name + "@" + node.VersionKey.Version
depPackageInput, err := helpers.PurlToPkg(depPurl)
if err != nil {
logger.Debugf("unable to parse purl: %v, error: %v", depPurl, err)
continue
}
depsVersionKey, err := getVersionKey(depPackageInput.Type, depPackageInput.Namespace, depPackageInput.Name, depPackageInput.Version)
if err != nil {
logger.Debugf("failed to getVersionKey with the following error: %v", err)
continue
}
versionChan <- depsVersionKey
}
}
close(versionChan)
<-versionDone
close(projectChan)
<-projectDone
return nil
}
func (d *depsCollector) fetchDependencies(ctx context.Context, purl string, docChannel chan<- *processor.Document) error {
logger := logging.FromContext(ctx)
component := &PackageComponent{}
// check if top level purl has already been queried
if _, ok := d.checkedPurls[purl]; ok {
logger.Infof("purl %s already queried", purl)
return nil
}
packageInput, err := helpers.PurlToPkg(purl)
if err != nil {
logger.Infof("failed to parse purl to pkg: %s", purl)
return nil
}
// if version is not specified, cannot obtain accurate information from deps.dev. Log as info and skip the purl.
if *packageInput.Version == "" {
logger.Infof("purl does not contain version, skipping deps.dev query: %s", purl)
return nil
}
component.CurrentPackage = packageInput
err = d.collectAdditionalMetadata(ctx, packageInput.Type, packageInput.Namespace, packageInput.Name, packageInput.Version, component)
if err != nil {
logger.Debugf("failed to get additional metadata for package: %s, err: %v", purl, err)
}
// Make an RPC Request. The returned result is a stream of
// DependenciesResponse structs.
versionKey, err := getVersionKey(packageInput.Type, packageInput.Namespace, packageInput.Name, packageInput.Version)
if err != nil {
logger.Infof("failed to getVersionKey with the following error: %v", err)
return nil
}
dependenciesReq := &pb.GetDependenciesRequest{
VersionKey: versionKey,
}
var deps *pb.Dependencies
if _, ok := d.dependencies[versionKey.String()]; ok {
deps = d.dependencies[versionKey.String()]
} else {
logger.Debugf("The version key was not found in the map: %v", versionKey)
deps, err = d.client.GetDependencies(ctx, dependenciesReq)
if err != nil {
logger.Debugf("failed to get dependencies: %v", err)
return nil
}
logger.Infof("Retrieved dependencies for %s", purl)
d.dependencies[versionKey.String()] = deps
}
dependencyNodes := []*PackageComponent{}
// append the i=0 node as the root node of the graph
dependencyNodes = append(dependencyNodes, component)
for i, node := range deps.Nodes {
// the nodes of the dependency graph. The first node is the root of the graph, which is captured above so skip.
if i == 0 {
continue
}
depComponent := &PackageComponent{}
pkgtype := ""
if node.VersionKey.System.String() == goUpperCase {
pkgtype = golang
} else {
pkgtype = strings.ToLower(node.VersionKey.System.String())
}
depPurl := "pkg:" + pkgtype + "/" + node.VersionKey.Name + "@" + node.VersionKey.Version
depPackageInput, err := helpers.PurlToPkg(depPurl)
if err != nil {
logger.Infof("unable to parse purl: %v, error: %v", depPurl, err)
continue
}
// check if dependent package purl has already been queried. If found, append to the list of dependent packages for top level package
if foundDepVal, ok := d.checkedPurls[depPurl]; ok {
// if found, return the source as nothing as it has already been ingested once
foundDepVal.Source = nil
logger.Debugf("dependant package purl %s already queried", depPurl)
dependencyNodes = append(dependencyNodes, foundDepVal)
continue
}
depComponent.CurrentPackage = depPackageInput
err = d.collectAdditionalMetadata(ctx, depPackageInput.Type, depPackageInput.Namespace, depPackageInput.Name, depPackageInput.Version, depComponent)
if err != nil {
logger.Debugf("failed to get additional metadata for package: %s, err: %v", depPurl, err)
}
dependencyNodes = append(dependencyNodes, depComponent)
d.checkedPurls[depPurl] = depComponent
}
component.DepPackages = append(component.DepPackages, dependencyNodes[1:]...)
for _, edge := range deps.Edges {
isDep := &model.IsDependencyInputSpec{
VersionRange: edge.Requirement,
DependencyType: model.DependencyTypeDirect,
Justification: "dependency data collected via deps.dev",
}
foundDepPackage := &IsDepPackage{
CurrentPackageInput: dependencyNodes[edge.FromNode].CurrentPackage,
DepPackageInput: dependencyNodes[edge.ToNode].CurrentPackage,
IsDependency: isDep,
}
component.IsDepPackages = append(component.IsDepPackages, foundDepPackage)
}
logger.Infof("obtained additional metadata for package: %s", purl)
d.checkedPurls[purl] = component
blob, err := json.Marshal(component)
if err != nil {
return err
}
doc := &processor.Document{
Blob: blob,
Type: processor.DocumentDepsDev,
Format: processor.FormatJSON,
SourceInformation: processor.SourceInformation{
Collector: DepsCollector,
Source: DepsCollector,
DocumentRef: events.GetDocRef(blob),
},
}
docChannel <- doc
return nil
}
func (d *depsCollector) collectAdditionalMetadata(ctx context.Context, pkgType string, namespace *string, name string, version *string, pkgComponent *PackageComponent) error {
logger := logging.FromContext(ctx)
versionKey, err := getVersionKey(pkgType, namespace, name, version)
if err != nil {
return fmt.Errorf("failed to getVersionKey with the following error: %w", err)
}
versionReq := &pb.GetVersionRequest{
VersionKey: versionKey,
}
var versionResponse *pb.Version
if _, ok := d.versions[versionKey.String()]; ok {
versionResponse = d.versions[versionKey.String()]
} else {
logger.Debugf("The version key was not found in the map: %v", versionKey)
versionResponse, err = d.client.GetVersion(ctx, versionReq)
if err != nil {
if metricsErr := d.Metrics.AddCounter(ctx, GetVersionErrorsCounter, 1, pkgType, *namespace, name); metricsErr != nil {
logger.Errorf("failed to add counter: %v", metricsErr)
}
return fmt.Errorf("failed to get version information: %w", err)
}
}
for _, link := range versionResponse.Links {
if link.Label == sourceRepo {
src, err := helpers.VcsToSrc(link.Url)
if err != nil {
logger.Infof("unable to parse source url: %v, error: %v", link.Url, err)
continue
}
// check if source has already been ingest for this package (without version), if not add source to be ingest for hasSourceAt
// HasSourceAt is done at the pkgName level for all entries from deps.dev as it does not specify a tag or commit for each version
// of the package being ingested
purlWithoutVersion := "pkg:" + pkgType + "/" + strings.TrimSuffix(*namespace, "/") + "/" + name
if _, ok := d.ingestedSource[purlWithoutVersion]; !ok {
pkgComponent.Source = src
d.ingestedSource[purlWithoutVersion] = src
}
projectReq := &pb.GetProjectRequest{
ProjectKey: &pb.ProjectKey{
Id: strings.TrimSuffix(src.Namespace, "/") + "/" + src.Name,
},
}
var project *pb.Project
if _, ok := d.projectInfoMap[projectReq.ProjectKey.String()]; ok {
project = d.projectInfoMap[projectReq.ProjectKey.String()]
} else {
logger.Debugf("The project key was not found in the map: %v", projectReq.ProjectKey)
project, err = d.client.GetProject(ctx, projectReq)
if err != nil {
logger.Debugf("unable to get project for: %v, error: %v", projectReq.ProjectKey.Id, err)
continue
}
}
if project.Scorecard != nil {
pkgComponent.Scorecard = &model.ScorecardInputSpec{}
pkgComponent.Scorecard.AggregateScore = float64(project.Scorecard.OverallScore)
pkgComponent.Scorecard.ScorecardCommit = project.Scorecard.Scorecard.Commit
pkgComponent.Scorecard.ScorecardVersion = project.Scorecard.Scorecard.Version
pkgComponent.Scorecard.TimeScanned = project.Scorecard.Date.AsTime().UTC()
inputChecks := []model.ScorecardCheckInputSpec{}
for _, check := range project.Scorecard.Checks {
inputCheck := model.ScorecardCheckInputSpec{
Check: check.Name,
Score: int(check.Score),
}
inputChecks = append(inputChecks, inputCheck)
}
pkgComponent.Scorecard.Checks = inputChecks
}
}
}
// add time when data was obtained
pkgComponent.UpdateTime = time.Now().UTC()
return nil
}
func getVersionKey(pkgType string, namespace *string, name string, version *string) (*pb.VersionKey, error) {
queryName := ""
if pkgType != maven {
if namespace != nil && *namespace != "" {
queryName = strings.TrimSuffix(*namespace, "/") + "/" + name
} else {
queryName = name
}
} else {
if namespace != nil && *namespace != "" {
queryName = strings.TrimSuffix(*namespace, ":") + ":" + name
} else {
queryName = name
}
}
sys, err := parseSystem(pkgType)
if err != nil {
return nil, err
}
versionKey := &pb.VersionKey{
System: sys,
Name: queryName,
Version: *version,
}
return versionKey, nil
}
// parseSystem returns the pb.System value represented by the argument string.
func parseSystem(name string) (pb.System, error) {
systemType := ""
if name == golang {
systemType = goUpperCase
} else {
systemType = strings.ToUpper(name)
}
sys, ok := pb.System_value[systemType]
if !ok {
return pb.System_SYSTEM_UNSPECIFIED, fmt.Errorf("unknown Insights system %q", name)
}
return pb.System(sys), nil
}
// Type returns the collector type
func (d *depsCollector) Type() string {
return DepsCollector
}
// getProjects fetches project info concurrently for a channel of Inputs.
// It returns a map of project URL to project info.
func (d *depsCollector) getProjects(ctx context.Context, inputChannel <-chan *pb.ProjectKey) map[string]*pb.Project {
projectMap := sync.Map{}
var waitGroup sync.WaitGroup
for input := range inputChannel {
go func(input *pb.ProjectKey) {
defer waitGroup.Done()
project, fetchErr := d.getProject(ctx, input)
if fetchErr != nil {
return
}
projectMap.Store(input, project)
}(input)
waitGroup.Add(1)
}
waitGroup.Wait() // wait for all goroutines to finish
projectMapCopy := make(map[string]*pb.Project)
projectMap.Range(func(projectURL, projectInfo interface{}) bool {
key := projectURL.(*pb.ProjectKey) //nolint:forcetypeassert
projectKey := key.String()
projectMapCopy[projectKey] = projectInfo.(*pb.Project) //nolint:forcetypeassert
return true
})
return projectMapCopy
}
// getVersions fetches version info concurrently for a channel of Inputs.
// It returns a map of version URL to version info.
func (d *depsCollector) getVersions(ctx context.Context, inputs <-chan *pb.VersionKey,
projectChan chan *pb.ProjectKey,
) map[string]*pb.Version {
// this function also sends the project key to the projectChan
versionsMap := sync.Map{}
var wg sync.WaitGroup
for input := range inputs {
input := input
wg.Add(1)
go func() {
defer wg.Done()
packageVersion, err := d.getVersion(ctx, input)
if err != nil {
return
}
projectKey := d.projectKey(packageVersion)
// if projectKey is nil, it means that the packageVersion does not have a source repo
if projectKey != nil {
// send the project key to the projectChan to be fetched concurrently
projectChan <- projectKey
}
versionsMap.Store(input, packageVersion)
}()
}
wg.Wait()
versionMapCopy := make(map[string]*pb.Version)
versionsMap.Range(func(packageName, versionInfo interface{}) bool {
key := packageName.(*pb.VersionKey) //nolint:forcetypeassert
pName := key.String()
versionMapCopy[pName] = versionInfo.(*pb.Version) //nolint:forcetypeassert
return true
})
return versionMapCopy
}
// getProject fetches project info for a given project URL.
func (d *depsCollector) getProject(ctx context.Context, v *pb.ProjectKey) (*pb.Project, error) {
defer d.Metrics.MeasureFunctionExecutionTime(ctx, GetProjectDurationHistogram) // nolint:errcheck
return d.client.GetProject(ctx, &pb.GetProjectRequest{
ProjectKey: v,
})
}
// getVersions fetches version info from deps.dev.
func (d *depsCollector) getVersion(ctx context.Context, v *pb.VersionKey) (*pb.Version, error) {
defer d.Metrics.MeasureFunctionExecutionTime(ctx, "getVersion") // nolint:errcheck
return d.client.GetVersion(ctx, &pb.GetVersionRequest{
VersionKey: v,
})
}
func (d *depsCollector) projectKey(versionResponse *pb.Version) *pb.ProjectKey {
// There will be a link with the label "SOURCE_REPO" which will contain the source URL.
// There cannot be more than one link with the same label.
for _, link := range versionResponse.Links {
if link.Label == sourceRepo {
src, err := helpers.VcsToSrc(link.Url)
if err != nil {
continue
}
projectReq := &pb.GetProjectRequest{
ProjectKey: &pb.ProjectKey{
Id: strings.TrimSuffix(src.Namespace, "/") + "/" + src.Name,
},
}
return projectReq.ProjectKey
}
}
return nil
}
// registerMetrics registers the Metrics for the collector.
func registerMetrics(ctx context.Context, m metrics.MetricCollector) error {
// Registering counter for get version errors
if _, err := m.RegisterCounter(ctx, GetVersionErrorsCounter, "pkgtype", "namespace", "name"); err != nil {
return fmt.Errorf("failed to register counter for get version errors: %w", err)
}
return nil
}
// DeregisterCollector deregisters the collector
func (d *depsCollector) DeregisterCollector(collectorType string) error {
// The DeregisterCollector is a placeholder for removing the metrics from the collector.
// This is also placeholder for removing state from the collector reference.
return nil
}
// registerMetricsOnce registers the Metrics for the collector once.
func registerMetricsOnce(ctx context.Context, metricsCollector metrics.MetricCollector) error {
var err error
registerOnce.Do(func() {
err = registerMetrics(ctx, metricsCollector)
})
return err
}