Update error message & expected error message

digital-asset · Jul 9, 2024 · 1ec643d · 1ec643d
1 parent e78ef35
commit 1ec643d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/sdk/compiler/daml-lf-tools/src/DA/Daml/LF/TypeChecker/Error.hs b/sdk/compiler/daml-lf-tools/src/DA/Daml/LF/TypeChecker/Error.hs
@@ -214,20 +214,24 @@ instance Pretty WarnableError where
   pPrint = \case
     WEUpgradeShouldDefineIfacesAndTemplatesSeparately ->
       vsep
-        [ "This package defines both interfaces and templates."
-        , "This is not recommended - templates are upgradeable, but interfaces are not, which means that this version of the package and its templates can never be uninstalled."
+        [ "This package defines both interfaces and templates. This may make this package and its dependents not upgradeable."
         , "It is recommended that interfaces are defined in their own package separate from their implementations."
+        , "Ignore this error message with the --warn-bad-interface-instances=yes flag."
         ]
     WEUpgradeShouldDefineIfaceWithoutImplementation iface implementingTemplates ->
       vsep $ concat
         [ [ "The interface " <> pPrint iface <> " was defined in this package and implemented in this package by the following templates:" ]
         , map (quotes . pPrint) implementingTemplates
-        , [ "However, it is recommended that interfaces are defined in their own package separate from their implementations." ]
+        , [ "This may make this package and its dependents not upgradeable." ]
+        , [ "It is recommended that interfaces are defined in their own package separate from their implementations." ]
+        , [ "Ignore this error message with the --warn-bad-interface-instances=yes flag." ]
         ]
     WEUpgradeShouldDefineTplInSeparatePackage tpl iface ->
       vsep
         [ "The template " <> pPrint tpl <> " has implemented interface " <> pPrint iface <> ", which is defined in a previous version of this package."
-        , "However, it is recommended that interfaces are defined in their own package separate from their implementations."
+        , "This may make this package and its dependents not upgradeable."
+        , "It is recommended that interfaces are defined in their own package separate from their implementations."
+        , "Ignore this error message with the --warn-bad-interface-instances=yes flag."
         ]
 
 data UpgradedRecordOrigin

diff --git a/sdk/compiler/damlc/tests/src/DA/Test/DamlcUpgrades.hs b/sdk/compiler/damlc/tests/src/DA/Test/DamlcUpgrades.hs
@@ -408,7 +408,7 @@ tests damlc =
                 [ testGeneral
                       (prefix <> "WhenAnInterfaceAndATemplateAreDefinedInTheSamePackage")
                       "WarnsWhenAnInterfaceAndATemplateAreDefinedInTheSamePackage"
-                      (expectation "type checking module Main:\n  This package defines both interfaces and templates.\n  \n  This is not recommended - templates are upgradeable, but interfaces are not, which means that this version of the package and its templates can never be uninstalled.\n  \n  It is recommended that interfaces are defined in their own package separate from their implementations.")
+                      (expectation "type checking module Main:\n  This package defines both interfaces and templates.")
                       LF.versionDefault
                       NoDependencies
                       warnBadInterfaceInstances
@@ -417,7 +417,7 @@ tests damlc =
                 , testGeneral
                       (prefix <> "WhenAnInterfaceIsUsedInThePackageThatItsDefinedIn")
                       "WarnsWhenAnInterfaceIsUsedInThePackageThatItsDefinedIn"
-                      (expectation "type checking interface Main.I :\n  The interface I was defined in this package and implemented in this package by the following templates:\n  \n  'T'\n  \n  However, it is recommended that interfaces are defined in their own package separate from their implementations.")
+                      (expectation "type checking interface Main.I :\n  The interface I was defined in this package and implemented in this package by the following templates:")
                       LF.versionDefault
                       NoDependencies
                       warnBadInterfaceInstances
@@ -473,6 +473,7 @@ tests damlc =
     testGeneral name location expectation lfVersion sharedDep warnBadInterfaceInstances setUpgradeField doTypecheck =
         let upgradeFieldTrailer = if not setUpgradeField then " (no upgrades field)" else ""
             doTypecheckTrailer = if not doTypecheck then " (disable typechecking)" else ""
+        in
         testCase (name <> upgradeFieldTrailer <> doTypecheckTrailer) $
         withTempDir $ \dir -> do
             let newDir = dir </> "newVersion"