Rough draft

Author: nficca

src/App/Fossa/Ficus/Analyze.hs

@@ -13,6 +13,7 @@ import App.Fossa.EmbeddedBinary (BinaryPaths, toPath, withFicusBinary)
 import App.Fossa.Ficus.Types (
   FicusAllFlag (..),
   FicusAnalysisFlag (..),
+  FicusAnalysisResults (..),
   FicusConfig (..),
   FicusDebug (..),
   FicusError (..),
@@ -229,14 +230,14 @@ runFicus maybeDebugDir ficusConfig = do
         logInfo $ pretty (Text.unlines stdErrLines)
         logInfo "\n==== END Ficus STDERR ====\n"
       else logInfo "[Ficus] Ficus exited successfully"
-    pure result
+    pure $ snippetScanResults result
   where
     currentTimeStamp :: IO String
     currentTimeStamp = do
       now <- getCurrentTime
       pure . formatTime defaultTimeLocale "%H:%M:%S.%3q" $ now
 
-    streamFicusOutput :: Handle -> Maybe Handle -> IO (Maybe FicusSnippetScanResults)
+    streamFicusOutput :: Handle -> Maybe Handle -> IO FicusAnalysisResults
     streamFicusOutput handle maybeFile =
       Conduit.runConduit $
         CC.sourceHandle handle
@@ -263,12 +264,13 @@ runFicus maybeDebugDir ficusConfig = do
                   FicusMessageFinding finding -> do
                     hPutStrLn stderr $ "[" ++ timestamp ++ "] FINDING " <> toString (displayFicusFinding finding)
                     let analysisFinding = findingToSnippetScanResult finding
-                    when (isJust acc && isJust analysisFinding) $
+                    let currentSnippetResults = snippetScanResults acc
+                    when (isJust currentSnippetResults && isJust analysisFinding) $
                       hPutStrLn stderr $
                         "[" ++ timestamp ++ "] ERROR " <> "Found multiple ficus analysis responses."
-                    pure $ acc <|> analysisFinding
+                    pure $ acc{snippetScanResults = currentSnippetResults <|> analysisFinding}
             )
-            Nothing
+            (FicusAnalysisResults{snippetScanResults = Nothing, vendoredDependencyScanResults = Nothing})
 
     consumeStderr :: Handle -> Maybe Handle -> IO [Text]
     consumeStderr handle maybeFile = do

src/App/Fossa/Ficus/Types.hs

@@ -15,6 +15,7 @@ module App.Fossa.Ficus.Types (
   FicusSnippetScanResults (..),
   FicusScanStats (..),
   FicusPerStrategyFlag (..),
+  FicusAnalysisResults (..),
 ) where
 
 import App.Types (ProjectRevision)
@@ -27,6 +28,13 @@ import Path (Abs, Dir, Path)
 import Text.URI
 import Types (GlobFilter)
 
+data FicusAnalysisResults = FicusAnalysisResults
+  { snippetScanResults :: Maybe FicusSnippetScanResults
+  , vendoredDependencyScanResults :: Maybe FicusVendoredDependencyScanResults
+  }
+
+newtype FicusVendoredDependencyScanResults = FicusVendoredDependencyScanResults ()
+
 data FicusSnippetScanResults = FicusSnippetScanResults
   { ficusSnippetScanResultsAnalysisId :: Int
   , ficusSnippetScanResultsBucketId :: Int

src/App/Fossa/ManualDeps.hs

@@ -358,7 +358,7 @@ mkLinuxPackage :: Text -> Text -> Text -> Text
 mkLinuxPackage depName os osVersion = depName <> "#" <> os <> "#" <> osVersion
 
 addEmptyDep :: Locator -> SourceUnitDependency
-addEmptyDep loc = SourceUnitDependency loc []
+addEmptyDep loc = SourceUnitDependency loc [] Data.Aeson.Null
 
 toAdditionalData :: Maybe (NE.NonEmpty CustomDependency) -> Maybe (NE.NonEmpty RemoteDependency) -> Maybe AdditionalDepData
 toAdditionalData customDeps remoteDeps =

src/Srclib/Converter.hs

@@ -15,6 +15,7 @@ import Prelude
 import Algebra.Graph.AdjacencyMap qualified as AM
 import App.Fossa.Analyze.Project (ProjectResult (..))
 import Control.Applicative ((<|>))
+import Data.Aeson qualified as Aeson
 import Data.Set qualified as Set
 import Data.String.Conversion (toText)
 import Data.Text (Text)
@@ -35,6 +36,7 @@ import Graphing qualified
 import Path (toFilePath)
 import Srclib.Types (
   Locator (..),
+  LocatorWithMetadata (..),
   OriginPath,
   SourceUnit (..),
   SourceUnitBuild (
@@ -91,17 +93,21 @@ toSourceUnit leaveUnfiltered path dependencies projectType graphBreadth originPa
     locatorAdjacent :: AM.AdjacencyMap Locator
     locatorAdjacent = Graphing.toAdjacencyMap locatorGraph
 
+    locatorsWithMetadata :: [LocatorWithMetadata]
+    locatorsWithMetadata = map (\dep -> LocatorWithMetadata{locatorWithMetadataLocator = (toLocator dep), locatorWithMetadataData = Aeson.Null}) (Graphing.directList filteredGraph)
+
     deps :: [SourceUnitDependency]
-    deps = map (mkSourceUnitDependency locatorAdjacent) (AM.vertexList locatorAdjacent)
+    deps = map (mkSourceUnitDependency locatorAdjacent) locatorsWithMetadata
 
     imports :: [Locator]
     imports = Graphing.directList locatorGraph
 
-mkSourceUnitDependency :: AM.AdjacencyMap Locator -> Locator -> SourceUnitDependency
-mkSourceUnitDependency gr locator =
+mkSourceUnitDependency :: AM.AdjacencyMap Locator -> LocatorWithMetadata -> SourceUnitDependency
+mkSourceUnitDependency gr (LocatorWithMetadata{..}) =
   SourceUnitDependency
-    { sourceDepLocator = locator
-    , sourceDepImports = Set.toList $ AM.postSet locator gr
+    { sourceDepLocator = locatorWithMetadataLocator
+    , sourceDepImports = Set.toList $ AM.postSet locatorWithMetadataLocator gr
+    , sourceDepData = locatorWithMetadataData
     }
 
 shouldPublishDep :: Dependency -> Bool

src/Srclib/Types.hs

@@ -9,6 +9,7 @@ module Srclib.Types (
   AdditionalDepData (..),
   SourceUserDefDep (..),
   SourceRemoteDep (..),
+  LocatorWithMetadata (..),
   Locator (..),
   LicenseSourceUnit (..),
   LicenseScanType (..),
@@ -409,7 +410,7 @@ data SourceUnitBuild = SourceUnitBuild
 data SourceUnitDependency = SourceUnitDependency
   { sourceDepLocator :: Locator
   , sourceDepImports :: [Locator] -- omitempty
-  -- , sourceDepData :: Aeson.Value
+  , sourceDepData :: Data.Aeson.Value
   }
   deriving (Eq, Ord, Show)
 
@@ -476,6 +477,12 @@ parseProvidedPackageLabelScope "org" = ProvidedPackageLabelScopeOrg
 parseProvidedPackageLabelScope "project" = ProvidedPackageLabelScopeProject
 parseProvidedPackageLabelScope _ = ProvidedPackageLabelScopeRevision
 
+data LocatorWithMetadata = LocatorWithMetadata
+  { locatorWithMetadataLocator :: Locator
+  , locatorWithMetadataData :: Data.Aeson.Value
+  }
+  deriving (Eq, Ord, Show)
+
 data Locator = Locator
   { locatorFetcher :: Text
   , locatorProject :: Text
@@ -551,13 +558,15 @@ instance ToJSON SourceUnitDependency where
     object
       [ "locator" .= sourceDepLocator
       , "imports" .= sourceDepImports
+      , "metadata" .= sourceDepData
       ]
 
 instance FromJSON SourceUnitDependency where
   parseJSON = withObject "SourceUnitDependency" $ \obj ->
     SourceUnitDependency
       <$> obj .: "locator"
       <*> obj .: "imports"
+      <*> obj .: "metadata"
 
 instance ToJSON AdditionalDepData where
   toJSON AdditionalDepData{..} =

test/App/Fossa/Container/AnalyzeNativeSpec.hs

@@ -15,6 +15,7 @@ import Control.Carrier.Telemetry (IgnoreTelemetryC, withoutTelemetry)
 import Control.Effect.DockerEngineApi (
   DockerEngineApiF (GetImageSize, IsDockerEngineAccessible),
  )
+import Data.Aeson qualified as Aeson
 import Data.Flag (toFlag')
 import Data.Map qualified as Map
 import Data.Maybe (mapMaybe)
@@ -241,6 +242,7 @@ jarsInContainerSpec = describe "Jars in Containers" $ do
                         [ SourceUnitDependency
                             { sourceDepLocator = depLocator
                             , sourceDepImports = []
+                            , sourceDepData = Aeson.Null
                             }
                         ]
                     }

test/Test/Fixtures.hs

@@ -75,6 +75,7 @@ import App.Types (Mode (..), OverrideDynamicAnalysisBinary (..))
 import App.Types qualified as App
 import Control.Effect.FossaApiClient qualified as App
 import Control.Timeout (Duration (MilliSeconds))
+import Data.Aeson qualified as Aeson
 import Data.ByteString.Lazy qualified as LB
 import Data.Flag (toFlag)
 import Data.List.NonEmpty (NonEmpty)
@@ -337,12 +338,13 @@ sourceUnitBuildMaven =
     [ ipAddr
     , spotBugs
     ]
-    [ SourceUnitDependency logger []
-    , SourceUnitDependency ipAddr []
+    [ SourceUnitDependency logger [] Aeson.Null
+    , SourceUnitDependency ipAddr [] Aeson.Null
     , SourceUnitDependency
         spotBugs
         [ logger
         ]
+        Aeson.Null
     ]
   where
     ipAddr :: Locator
@@ -387,6 +389,7 @@ vsiSourceUnit =
                           , locatorRevision = Just "1.2.3"
                           }
                     , sourceDepImports = []
+                    , sourceDepData = Aeson.Null
                     }
                 ]
             }