Add support for using as a library

[edena-legit]

Hi 👋
Currently, it seems that the only way to use this tool is by command line.
It seems that the DI registration is using AsSingleton for all the components and not a scoped instance, leading to errors between calls because of the states the detectors are using.
It will be very appreciated if docs on how to use this tool as a library will be added (as it states in the README.md that it could)

AB#2097602

[Justin Perez (melotic)]

Hi,

CD is supported as using a library. You'd have to use DI to resolve a IBcdeScanExecutionService and run ExecuteScanAsync.

You can use the extension method AddComponentDetection to your ServiceCollection to register all dependencies.

component-detection/src/Microsoft.ComponentDetection.Orchestrator/Extensions/ServiceCollectionExtensions.cs

Line 41 in 74fae32

public static IServiceCollection AddComponentDetection(this IServiceCollection services)

It seems that the DI registration is using AsSingleton for all the components and not a scoped instance, leading to errors between calls because of the states the detectors are using.

Can you share the exact error?

[edena-legit]

Seems like there are detectors that holds state which leads to errors between calling such as:

   at System.Collections.Generic.Dictionary`2.TryInsert(TKey key, TValue value, InsertionBehavior behavior)
   at System.Collections.Generic.Dictionary`2.Add(TKey key, TValue value)
   at Microsoft.ComponentDetection.Detectors.NuGet.NuGetProjectModelProjectCentricComponentDetector.OnDetectionFinishedAsync()
   at Microsoft.ComponentDetection.Contracts.FileComponentDetector.ProcessAsync(IObservable`1 processRequests, IDictionary`2 detectorArgs)
   at Microsoft.ComponentDetection.Contracts.FileComponentDetector.ExecuteDetectorAsync(ScanRequest request)
   at Microsoft.ComponentDetection.Orchestrator.Services.DetectorProcessingService.WithExperimentalScanGuardsAsync(Func`1 detectionTaskGenerator, Boolean isExperimentalDetector, DetectorExecutionTelemetryRecord telemetryRecord)
   at Microsoft.ComponentDetection.Orchestrator.Services.DetectorProcessingService.<>c__DisplayClass4_0.<<ProcessDetectorsAsync>b__0>d.MoveNext()
--- End of stack trace from previous location ---
   at Microsoft.ComponentDetection.Orchestrator.Services.DetectorProcessingService.ProcessDetectorsAsync(IDetectionArguments detectionArguments, IEnumerable`1 detectors, DetectorRestrictions detectorRestrictions)
   at Microsoft.ComponentDetection.Orchestrator.Services.BcdeScanExecutionService.ExecuteScanAsync(IDetectionArguments detectionArguments)

[edena-legit]

I'm receiving the following error as well:

Base path has not yet been initialized in File Writing Service! 

Microsoft.ComponentDetection.Commonexception.StackTraceString: 
at Microsoft.ComponentDetection.Common.FileWritingService.EnsureInit()
at Microsoft.ComponentDetection.Common.FileWritingService.ResolveFilePath(String relativeFilePath)
at Microsoft.ComponentDetection.Orchestrator.Experiments.DefaultExperimentProcessor.ProcessExperimentAsync(IExperimentConfiguration config, ExperimentDiff diff)
at Microsoft.ComponentDetection.Orchestrator.Experiments.ExperimentService.FinishAsync()

Running as a library, I don't expect the file-writing service to do anything, right?

[edena-legit]

Justin Perez (@melotic), Anything on that?

[Justin Perez (melotic)]

I'm receiving the following error as well:

Base path has not yet been initialized in File Writing Service! 

Microsoft.ComponentDetection.Commonexception.StackTraceString: 
at Microsoft.ComponentDetection.Common.FileWritingService.EnsureInit()
at Microsoft.ComponentDetection.Common.FileWritingService.ResolveFilePath(String relativeFilePath)
at Microsoft.ComponentDetection.Orchestrator.Experiments.DefaultExperimentProcessor.ProcessExperimentAsync(IExperimentConfiguration config, ExperimentDiff diff)
at Microsoft.ComponentDetection.Orchestrator.Experiments.ExperimentService.FinishAsync()

Running as a library, I don't expect the file-writing service to do anything, right?

Call Init in the file writer service, or register a service that does nothing.

component-detection/src/Microsoft.ComponentDetection.Orchestrator/Orchestrator.cs

Line 165 in 2b86e05

this.fileWritingService.Init(argumentSet.Output);

[edena-legit]

what about the detectors state?