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.

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

lib/types: prioritise coercedType in coercedTo #77691

Merged
merged 1 commit into from Jan 14, 2020

Conversation

arcnmx
Copy link
Member

@arcnmx arcnmx commented Jan 14, 2020

This more intuitively matches types.either and allows paths to be coerced to submodules again.

Motivation for this change

#76861's changes allowed strings to typecheck as submodules when they appear to be a path (start with a slash). A somewhat common use of coercedTo is to turn single values into an attrset/submodule: with types; coercedTo str (value: { inherit value; }) valueSubmodule. coercedTo currently will prioritise the final type if possible, and now that submodules can be set from paths this causes havoc when the module system tries to import what was previously meant to be just a config value.

A similar issue occurs with types.either, and #76861 suggests changing the order of the types as a solution. That approach isn't possible here and coercedTo feels backward in comparison, so this change reverses its behaviour.

cc @infinisil who made the original submodule change and suggested this patch

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

This more intuitively matches `types.either` and allows paths to be
coerced to submodules again, which was inhibited by NixOS#76861
@infinisil
Copy link
Member

Another reason why this change makes sense: Often coercedTo is used to have backwards compatibility with a more restrictive previous type (the left type) which gets converted to a submodule (the right type). The old behavior was that in case a value is of both types, the right one gets chosen. But this would make such a coercedTo change backwards incompatible. Not so with this PR which makes it choose the left one.

@infinisil infinisil merged commit 42cc5c2 into NixOS:master Jan 14, 2020
@arcnmx arcnmx deleted the coercedto-priority branch January 14, 2020 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants