Unverified Commit 987a0963 authored by Silvan Mosberger's avatar Silvan Mosberger Committed by GitHub
Browse files

lib/types: types deprecate functor.wrapped in favor of... 

lib/types: types deprecate functor.wrapped in favor of functor.payload.elemType for trivial cases (#375084)
parents 59050a6f 4f123107

doc/release-notes/rl-2505.section.md

+4 −0
Original line number Diff line number Diff line
@@ -75,6 +75,10 @@ 
  - `functor.wrapped` is now deprecated for some types and using it will give a warning with migration instructions. It is deprecated for these types:

    - `lib.types.attrsWith`

    - `lib.types.listOf`

    - `lib.types.unique` and `lib.types.uniq`

    - `lib.types.nullOr`

    - `lib.types.functionTo`

    - `lib.types.coercedTo`



- Plasma 5 and Qt 5 based versions of associated software are deprecated in NixOS 25.05, and will be removed in NixOS 25.11. Users are encouraged to upgrade to Plasma 6.

lib/tests/modules.sh

+24 −0
Original line number Diff line number Diff line
@@ -415,6 +415,30 @@ NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribu 


NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.listOf.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedListOf.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

# unique / uniq

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.unique.type.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedUnique.type.functor.wrapped ./deprecated-wrapped.nix



NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.unique.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedUnique.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

# nullOr

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.nullOr.type.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedNullOr.type.functor.wrapped ./deprecated-wrapped.nix



NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.nullOr.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedNullOr.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

# functionTo

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.functionTo.type.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedFunctionTo.type.functor.wrapped ./deprecated-wrapped.nix



NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.functionTo.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.mergedFunctionTo.type.nestedTypes.elemType.functor.wrapped ./deprecated-wrapped.nix



# coercedTo

# Note: test 'nestedTypes.finalType' and 'nestedTypes.coercedType'

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.coercedTo.type.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.coercedTo.type.nestedTypes.finalType.functor.wrapped ./deprecated-wrapped.nix

NIX_ABORT_ON_WARN=1 checkConfigError 'The deprecated `.*functor.wrapped` attribute .*is accessed, use `.*nestedTypes.elemType` instead.' options.coercedTo.type.nestedTypes.coercedType.functor.wrapped ./deprecated-wrapped.nix



# Even with multiple assignments, a type error should be thrown if any of them aren't valid

checkConfigError 'A definition for option .* is not of type .*' \

lib/tests/modules/deprecated-wrapped.nix

+39 −0
Original line number Diff line number Diff line
@@ -6,6 +6,10 @@ let 
    # attrsOf uses attrsWith internally

    attrsOf

    listOf

    unique

    nullOr

    functionTo

    coercedTo

    ;

in

{
@@ -26,6 +30,32 @@ in 
        options.mergedListOf = mkOption {

          type = listOf (listOf types.str);

        };

        # unique

        options.unique = mkOption {

          type = unique { message = ""; } (listOf types.str);

        };

        options.mergedUnique = mkOption {

          type = unique { message = ""; } (listOf types.str);

        };

        # nullOr

        options.nullOr = mkOption {

          type = nullOr (listOf types.str);

        };

        options.mergedNullOr = mkOption {

          type = nullOr (listOf types.str);

        };

        # functionTo

        options.functionTo = mkOption {

          type = functionTo (listOf types.str);

        };

        options.mergedFunctionTo = mkOption {

          type = functionTo (listOf types.str);

        };

        # coercedTo

        # Note: coercedTo is a non-mergeable option-type

        options.coercedTo = mkOption {

          type = coercedTo (listOf types.str) lib.id (listOf types.str);

        };

      }

    )

    # Module B
@@ -38,6 +68,15 @@ in 
        options.mergedListOf = mkOption {

          type = listOf (listOf types.str);

        };

        options.mergedUnique = mkOption {

          type = unique { message = ""; } (listOf types.str);

        };

        options.mergedNullOr = mkOption {

          type = nullOr (listOf types.str);

        };

        options.mergedFunctionTo = mkOption {

          type = functionTo (listOf types.str);

        };

      }

    )

  ];

lib/types.nix

+16 −7
Original line number Diff line number Diff line
@@ -75,6 +75,7 @@ let 
  # Note that individual attributes can be overriden if needed.

  elemTypeFunctor = name: { elemType, ... }@payload: {

    inherit name payload;

    wrappedDeprecationMessage = makeWrappedDeprecationMessage payload;

    type    = outer_types.types.${name};

    binOp   = a: b:

      let
@@ -85,10 +86,10 @@ let 
          null

        else

          { elemType = merged; };

    wrappedDeprecationMessage = { loc }: lib.warn ''

  };

  makeWrappedDeprecationMessage = payload: { loc }: lib.warn ''

    The deprecated `${lib.optionalString (loc != null) "type."}functor.wrapped` attribute ${lib.optionalString (loc != null) "of the option `${showOption loc}` "}is accessed, use `${lib.optionalString (loc != null) "type."}nestedTypes.elemType` instead.

  '' payload.elemType;

  };





  outer_types =
@@ -853,7 +854,9 @@ rec { 
      getSubOptions = type.getSubOptions;

      getSubModules = type.getSubModules;

      substSubModules = m: uniq (type.substSubModules m);

      functor = (defaultFunctor name) // { wrapped = type; };

      functor = elemTypeFunctor name { elemType = type; } // {

        type = payload: types.unique { inherit message; } payload.elemType;

      };

      nestedTypes.elemType = type;

    };
@@ -873,7 +876,9 @@ rec { 
      getSubOptions = elemType.getSubOptions;

      getSubModules = elemType.getSubModules;

      substSubModules = m: nullOr (elemType.substSubModules m);

      functor = (defaultFunctor name) // { wrapped = elemType; };

      functor = (elemTypeFunctor name { inherit elemType; }) // {

        type = payload: types.nullOr payload.elemType;

      };

      nestedTypes.elemType = elemType;

    };
@@ -892,7 +897,9 @@ rec { 
      getSubOptions = prefix: elemType.getSubOptions (prefix ++ [ "<function body>" ]);

      getSubModules = elemType.getSubModules;

      substSubModules = m: functionTo (elemType.substSubModules m);

      functor = (defaultFunctor "functionTo") // { wrapped = elemType; };

      functor = (elemTypeFunctor "functionTo" { inherit elemType; }) // {

        type = payload: types.functionTo payload.elemType;

      };

      nestedTypes.elemType = elemType;

    };
@@ -1166,7 +1173,9 @@ rec { 
        getSubModules = finalType.getSubModules;

        substSubModules = m: coercedTo coercedType coerceFunc (finalType.substSubModules m);

        typeMerge = t: null;

        functor = (defaultFunctor name) // { wrapped = finalType; };

        functor = (defaultFunctor name) // {

          wrappedDeprecationMessage = makeWrappedDeprecationMessage { elemType = finalType; };

        };

        nestedTypes.coercedType = coercedType;

        nestedTypes.finalType = finalType;

      };