Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade validation warnings to errors flag #19259

Merged
merged 11 commits into from
Jul 10, 2024
Merged

Upgrade validation warnings to errors flag #19259

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cd426f5
Split errors into errors that can turn into warnings (or vice versa)
dylant-da May 23, 2024
9642e1b
Add warn-bad-interface-instances flag
dylant-da May 23, 2024
c32977c
fix compilation errors, finish implementation of swap
dylant-da May 24, 2024
783728f
Add tests for warn-bad-interface-instances flag
dylant-da May 24, 2024
572f119
Bump - try to rebuild?
dylant-da May 27, 2024
4d02b07
Don't do single-package checks if typecheck-upgrades: true
dylant-da May 28, 2024
2662ac4
Fix tests that break on warn-bad-interface-instances
dylant-da Jul 2, 2024
7173442
Lint
dylant-da Jul 5, 2024
ca465fc
Move WEWarningToError to Error type, remove commented code
dylant-da Jul 9, 2024
e78ef35
Check errors & warns aren't emitted when upgrades/typechecking disabled
dylant-da Jul 9, 2024
1ec643d
Update error message & expected error message
dylant-da Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update error message & expected error message
  • Loading branch information
@dylant-da
dylant-da committed Jul 9, 2024
commit 1ec643d9a8bfb6e86ee1add9ea124b72bac3f84b
12 changes: 8 additions & 4 deletions sdk/compiler/daml-lf-tools/src/DA/Daml/LF/TypeChecker/Error.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions sdk/compiler/damlc/tests/src/DA/Test/DamlcUpgrades.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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"
Expand Down