scenario-service: run no validation, when called from ide (#3003)

Author: remyhaemmerle-da

compiler/damlc/daml-ide-core/src/Development/IDE/Core/Rules/Daml.hs

@@ -286,9 +286,7 @@ contextForFile file = do
         { ctxModules = Map.fromList encodedModules
         , ctxPackages = [(dalfPackageId pkg, dalfPackageBytes pkg) | pkg <- Map.elems pkgMap]
         , ctxDamlLfVersion = lfVersion
-        , ctxLightValidation = case envScenarioValidation of
-              ScenarioValidationFull -> SS.LightValidation False
-              ScenarioValidationLight -> SS.LightValidation True
+        , ctxSkipValidation = SS.SkipValidation (getSkipScenarioValidation envSkipScenarioValidation)
         }
 
 worldForFile :: NormalizedFilePath -> Action LF.World
@@ -328,9 +326,10 @@ createScenarioContextRule =
 dalfForScenario :: NormalizedFilePath -> Action LF.Module
 dalfForScenario file = do
     DamlEnv{..} <- getDamlServiceEnv
-    case envScenarioValidation of
-        ScenarioValidationLight -> use_ GenerateRawDalf file
-        ScenarioValidationFull -> use_ GenerateDalf file
+    if getSkipScenarioValidation envSkipScenarioValidation then
+        use_ GenerateRawDalf file
+    else
+        use_ GenerateDalf file
 
 runScenariosRule :: Rules ()
 runScenariosRule =

compiler/damlc/daml-ide-core/src/Development/IDE/Core/Service/Daml.hs

@@ -66,7 +66,7 @@ data DamlEnv = DamlEnv
   -- ^ The scenario contexts we used as GC roots in the last iteration.
   -- This is used to avoid unnecessary GC calls.
   , envDamlLfVersion :: LF.Version
-  , envScenarioValidation :: ScenarioValidation
+  , envSkipScenarioValidation :: SkipScenarioValidation
   }
 
 instance IsIdeGlobal DamlEnv
@@ -82,7 +82,7 @@ mkDamlEnv opts scenarioService = do
         , envScenarioContexts = scenarioContextsVar
         , envPreviousScenarioContexts = previousScenarioContextsVar
         , envDamlLfVersion = optDamlLfVersion opts
-        , envScenarioValidation = optScenarioValidation opts
+        , envSkipScenarioValidation = optSkipScenarioValidation opts
         }
 
 getDamlServiceEnv :: Action DamlEnv

compiler/damlc/daml-opts/daml-opts-types/DA/Daml/Options/Types.hs

@@ -4,7 +4,7 @@
 module DA.Daml.Options.Types
     ( Options(..)
     , EnableScenarioService(..)
-    , ScenarioValidation(..)
+    , SkipScenarioValidation(..)
     , DlintUsage(..)
     , Haddock(..)
     , defaultOptionsIO
@@ -55,10 +55,9 @@ data Options = Options
     -- ^ custom options, parsed by GHC option parser, overriding DynFlags
   , optScenarioService :: EnableScenarioService
     -- ^ Controls whether the scenario service is started.
-  , optScenarioValidation :: ScenarioValidation
-    -- ^ Controls whether the scenario service server runs all checks
-    -- or only a subset of them. This is mostly used to run additional
-    -- checks on CI while keeping the IDE fast.
+  , optSkipScenarioValidation :: SkipScenarioValidation
+    -- ^ Controls whether the scenario service server run package validations.
+    -- This is mostly used to run additional checks on CI while keeping the IDE fast.
   , optDlintUsage :: DlintUsage
   -- ^ Information about dlint usage.
   , optIsGenerated :: Bool
@@ -85,10 +84,8 @@ data DlintUsage
   | DlintDisabled
   deriving Show
 
-data ScenarioValidation
-    = ScenarioValidationLight
-    | ScenarioValidationFull
-    deriving Show
+newtype SkipScenarioValidation = SkipScenarioValidation { getSkipScenarioValidation :: Bool }
+  deriving Show
 
 newtype EnableScenarioService = EnableScenarioService { getEnableScenarioService :: Bool }
     deriving Show
@@ -161,7 +158,7 @@ defaultOptions mbVersion =
         , optDebug = False
         , optGhcCustomOpts = []
         , optScenarioService = EnableScenarioService True
-        , optScenarioValidation = ScenarioValidationFull
+        , optSkipScenarioValidation = SkipScenarioValidation False
         , optDlintUsage = DlintDisabled
         , optIsGenerated = False
         , optDflagCheck = True

compiler/damlc/lib/DA/Cli/Damlc.hs

@@ -353,7 +353,7 @@ execIde telemetry (Debug debug) enableScenarioService ghcOpts mbProfileDir = Com
           opts <- defaultOptionsIO Nothing
           opts <- pure $ opts
               { optScenarioService = enableScenarioService
-              , optScenarioValidation = ScenarioValidationLight
+              , optSkipScenarioValidation = SkipScenarioValidation True
               , optShakeProfiling = mbProfileDir
               , optThreads = 0
               , optDlintUsage = DlintEnabled dlintDataDir True

compiler/damlc/lib/DA/Cli/Options.hs

@@ -386,7 +386,7 @@ optionsParser numProcessors enableScenarioService parsePkgName = Options
     <*> optDebugLog
     <*> optGhcCustomOptions
     <*> pure enableScenarioService
-    <*> pure (optScenarioValidation $ defaultOptions Nothing)
+    <*> pure (optSkipScenarioValidation $ defaultOptions Nothing)
     <*> dlintUsageOpt
     <*> pure False
     <*> optNoDflagCheck

compiler/damlc/tests/src/DA/Test/DamlcIntegration.hs

@@ -126,7 +126,7 @@ getIntegrationTests registerTODO scenarioService version = do
     opts <- defaultOptionsIO (Just version)
     opts <- pure $ opts
         { optThreads = 0
-        , optScenarioValidation = ScenarioValidationFull
+        , optSkipScenarioValidation = SkipScenarioValidation False
         , optCoreLinting = True
         }
 

compiler/scenario-service/client/src/DA/Daml/LF/ScenarioServiceClient.hs

@@ -11,7 +11,7 @@ module DA.Daml.LF.ScenarioServiceClient
   , Handle
   , withScenarioService
   , Context(..)
-  , LowLevel.LightValidation(..)
+  , LowLevel.SkipValidation(..)
   , LowLevel.ContextId
   , getNewCtx
   , deleteCtx
@@ -118,7 +118,7 @@ data Context = Context
   { ctxModules :: MS.Map Hash (LF.ModuleName, BS.ByteString)
   , ctxPackages :: [(LF.PackageId, BS.ByteString)]
   , ctxDamlLfVersion :: LF.Version
-  , ctxLightValidation :: LowLevel.LightValidation
+  , ctxSkipValidation :: LowLevel.SkipValidation
   }
 
 getNewCtx :: Handle -> Context -> IO (Either LowLevel.BackendError LowLevel.ContextId)
@@ -141,7 +141,7 @@ getNewCtx Handle{..} Context{..} = withLock hContextLock $ withSem hConcurrencyS
       loadPackages
       (S.toList unloadPackages)
       ctxDamlLfVersion
-      ctxLightValidation
+      ctxSkipValidation
   writeIORef hLoadedPackages newLoadedPackages
   writeIORef hLoadedModules ctxModules
   res <- LowLevel.updateCtx hLowLevelHandle hContextId ctxUpdate

compiler/scenario-service/client/src/DA/Daml/LF/ScenarioServiceClient/LowLevel.hs

@@ -18,7 +18,7 @@ module DA.Daml.LF.ScenarioServiceClient.LowLevel
   , deleteCtx
   , gcCtxs
   , ContextUpdate(..)
-  , LightValidation(..)
+  , SkipValidation(..)
   , updateCtx
   , runScenario
   , SS.ScenarioResult(..)
@@ -81,16 +81,17 @@ data Handle = Handle
 newtype ContextId = ContextId { getContextId :: Int64 }
   deriving (NFData, Eq, Show)
 
--- | If true, the scenario service server only runs a subset of validations.
-newtype LightValidation = LightValidation { getLightValidation :: Bool }
+-- | If true, the scenario service server do not run package validations.
+newtype SkipValidation = SkipValidation { getSkipValidation :: Bool }
+  deriving Show
 
 data ContextUpdate = ContextUpdate
   { updLoadModules :: ![(LF.ModuleName, BS.ByteString)]
   , updUnloadModules :: ![LF.ModuleName]
   , updLoadPackages :: ![(LF.PackageId, BS.ByteString)]
   , updUnloadPackages :: ![LF.PackageId]
   , updDamlLfVersion :: LF.Version
-  , updLightValidation :: LightValidation
+  , updSkipValidation :: SkipValidation
   }
 
 encodeModule :: LF.Version -> LF.Module -> BS.ByteString
@@ -293,7 +294,7 @@ updateCtx Handle{..} (ContextId ctxId) ContextUpdate{..} = do
           ctxId
           (Just updModules)
           (Just updPackages)
-          (getLightValidation updLightValidation)
+          (getSkipValidation updSkipValidation)
   pure (void res)
   where
     updModules =

compiler/scenario-service/protos/scenario_service.proto

@@ -98,7 +98,7 @@ message UpdateContextRequest {
   int64 context_id = 1;
   UpdateModules update_modules = 2;
   UpdatePackages update_packages = 3;
-  bool lightValidation = 4; // if true runs only a subset of the validations
+  bool noValidation = 4; // if true, does not run the package validations
 }
 
 message UpdateContextResponse {

compiler/scenario-service/server/src/main/scala/com/digitalasset/daml/lf/ScenarioServiceMain.scala

@@ -201,7 +201,7 @@ class ScenarioService extends ScenarioServiceGrpc.ScenarioServiceImplBase {
             loadModules,
             unloadPackages,
             loadPackages,
-            req.getLightValidation
+            req.getNoValidation
           )
 
           resp.addAllLoadedModules(ctx.loadedModules().map(_.toString).asJava)

compiler/scenario-service/server/src/main/scala/com/digitalasset/daml/lf/scenario/Context.scala

@@ -17,7 +17,7 @@ import com.digitalasset.daml.lf.speedy.SValue
 import com.digitalasset.daml.lf.types.Ledger.Ledger
 import com.digitalasset.daml.lf.PureCompiledPackages
 import com.digitalasset.daml.lf.speedy.SExpr.{LfDefRef, SDefinitionRef}
-import com.digitalasset.daml.lf.validation.{Validation, ValidationError}
+import com.digitalasset.daml.lf.validation.Validation
 import com.google.protobuf.ByteString
 import com.digitalasset.daml.lf.transaction.VersionTimeline
 
@@ -85,15 +85,10 @@ class Context(val contextId: Context.ContextId) {
     dop.decodeScenarioModule(homePackageId, lfMod)
   }
 
-  private def validate(pkgIds: Traversable[PackageId], forScenarioService: Boolean): Unit = {
-    val validator: PackageId => Either[ValidationError, Unit] =
-      if (forScenarioService)
-        Validation.checkPackageForScenarioService(allPackages, _)
-      else
-        Validation.checkPackage(allPackages, _)
-
-    pkgIds.foreach(validator(_).left.foreach(e => throw ParseError(e.pretty)))
-  }
+  private def validate(pkgIds: Traversable[PackageId]): Unit =
+    pkgIds.foreach(
+      Validation.checkPackage(allPackages, _).left.foreach(e => throw ParseError(e.pretty))
+    )
 
   @throws[ParseError]
   def update(
@@ -137,7 +132,8 @@ class Context(val contextId: Context.ContextId) {
     })
     modules ++= lfModules.map(m => m.name -> m)
 
-    validate(newPackages.keys ++ Iterable(homePackageId), forScenarioService)
+    if (!forScenarioService)
+      validate(newPackages.keys ++ Iterable(homePackageId))
 
     // At this point 'allPackages' is consistent and we can
     // compile the new modules.

daml-lf/validation/src/main/scala/com/digitalasset/daml/lf/validation/Validation.scala

@@ -35,23 +35,4 @@ object Validation {
     Serializability.checkModule(world, pkgId, mod)
     PartyLiterals.checkModule(world, pkgId, mod)
   }
-
-  /*
-    checkPackageForScenarioService runs a subset of the validation for the scenario service.
-
-    We do not want type check because it is slow and duplicated in Haskell side
-    We do not want serializability check because the inference is not properly propagate to the engine (in case of scenario)
-    We want collision check because it is not done on Haskell side.
-   */
-  def checkPackageForScenarioService(
-      pkgs: PartialFunction[PackageId, Package],
-      pkgId: PackageId
-  ): Either[ValidationError, Unit] =
-    try {
-      val world = new World(pkgs)
-      Right(Collision.checkPackage(pkgId, world.lookupPackage(NoContext, pkgId).modules))
-    } catch {
-      case e: ValidationError =>
-        Left(e)
-    }
 }