From 05958f27e2b9a99a058ef5db5f2be1d73c4afd96 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sun, 19 Jan 2025 16:07:39 +0100 Subject: [PATCH 1/4] lib/types: types.{unique,uniq} deprecate functor.wrapped in favor of functor.payload.elemType --- doc/release-notes/rl-2505.section.md | 1 + lib/tests/modules.sh | 10 ++++++++-- lib/tests/modules/deprecated-wrapped.nix | 11 +++++++++++ lib/types.nix | 4 +++- 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/doc/release-notes/rl-2505.section.md b/doc/release-notes/rl-2505.section.md index 58bb1371f1bce..2a44045fecb3d 100644 --- a/doc/release-notes/rl-2505.section.md +++ b/doc/release-notes/rl-2505.section.md @@ -75,6 +75,7 @@ - `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` - 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. diff --git a/lib/tests/modules.sh b/lib/tests/modules.sh index 1505782547f53..dbbb92d4400da 100755 --- a/lib/tests/modules.sh +++ b/lib/tests/modules.sh @@ -413,8 +413,14 @@ 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.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.functor.wrapped ./deprecated-wrapped.nix -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 +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 +# 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 # 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 .*' \ diff --git a/lib/tests/modules/deprecated-wrapped.nix b/lib/tests/modules/deprecated-wrapped.nix index 8d363a2ad3443..dc9771ec38c1d 100644 --- a/lib/tests/modules/deprecated-wrapped.nix +++ b/lib/tests/modules/deprecated-wrapped.nix @@ -6,6 +6,7 @@ let # attrsOf uses attrsWith internally attrsOf listOf + unique ; in { @@ -26,6 +27,13 @@ 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); + }; } ) # Module B @@ -38,6 +46,9 @@ in options.mergedListOf = mkOption { type = listOf (listOf types.str); }; + options.mergedUnique = mkOption { + type = unique { message = ""; } (listOf types.str); + }; } ) ]; diff --git a/lib/types.nix b/lib/types.nix index cdba500ae07f3..62aa337c167ad 100644 --- a/lib/types.nix +++ b/lib/types.nix @@ -844,7 +844,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; }; From 4fe25460e13eeb6b78d41dabd5c95da024698d0b Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sun, 19 Jan 2025 16:21:33 +0100 Subject: [PATCH 2/4] lib/types: types.nullOr deprecate functor.wrapped in favor of functor.payload.elemType --- doc/release-notes/rl-2505.section.md | 1 + lib/tests/modules.sh | 10 ++++++++-- lib/tests/modules/deprecated-wrapped.nix | 11 +++++++++++ lib/types.nix | 4 +++- 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/doc/release-notes/rl-2505.section.md b/doc/release-notes/rl-2505.section.md index 2a44045fecb3d..c71ac169d78ba 100644 --- a/doc/release-notes/rl-2505.section.md +++ b/doc/release-notes/rl-2505.section.md @@ -76,6 +76,7 @@ - `lib.types.attrsWith` - `lib.types.listOf` - `lib.types.unique` and `lib.types.uniq` + - `lib.types.nullOr` - 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. diff --git a/lib/tests/modules.sh b/lib/tests/modules.sh index dbbb92d4400da..5bdc6e9835014 100755 --- a/lib/tests/modules.sh +++ b/lib/tests/modules.sh @@ -413,14 +413,20 @@ 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.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.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 +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 # 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 .*' \ diff --git a/lib/tests/modules/deprecated-wrapped.nix b/lib/tests/modules/deprecated-wrapped.nix index dc9771ec38c1d..fcdfef7dea71f 100644 --- a/lib/tests/modules/deprecated-wrapped.nix +++ b/lib/tests/modules/deprecated-wrapped.nix @@ -7,6 +7,7 @@ let attrsOf listOf unique + nullOr ; in { @@ -34,6 +35,13 @@ in 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); + }; } ) # Module B @@ -49,6 +57,9 @@ in options.mergedUnique = mkOption { type = unique { message = ""; } (listOf types.str); }; + options.mergedNullOr = mkOption { + type = nullOr (listOf types.str); + }; } ) ]; diff --git a/lib/types.nix b/lib/types.nix index 62aa337c167ad..f38f96c337867 100644 --- a/lib/types.nix +++ b/lib/types.nix @@ -866,7 +866,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; }; From f6214eb786bffd05a17941bfe68cdecb0c0438af Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sun, 19 Jan 2025 16:22:24 +0100 Subject: [PATCH 3/4] lib/types: types.functionTo deprecate functor.wrapped in favor of functor.payload.elemType --- doc/release-notes/rl-2505.section.md | 1 + lib/tests/modules.sh | 6 ++++++ lib/tests/modules/deprecated-wrapped.nix | 11 +++++++++++ lib/types.nix | 4 +++- 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/doc/release-notes/rl-2505.section.md b/doc/release-notes/rl-2505.section.md index c71ac169d78ba..240cda17b1eb6 100644 --- a/doc/release-notes/rl-2505.section.md +++ b/doc/release-notes/rl-2505.section.md @@ -77,6 +77,7 @@ - `lib.types.listOf` - `lib.types.unique` and `lib.types.uniq` - `lib.types.nullOr` + - `lib.types.functionTo` - 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. diff --git a/lib/tests/modules.sh b/lib/tests/modules.sh index 5bdc6e9835014..ffdc1505f06da 100755 --- a/lib/tests/modules.sh +++ b/lib/tests/modules.sh @@ -427,6 +427,12 @@ 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.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 # 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 .*' \ diff --git a/lib/tests/modules/deprecated-wrapped.nix b/lib/tests/modules/deprecated-wrapped.nix index fcdfef7dea71f..7db64edfcce3a 100644 --- a/lib/tests/modules/deprecated-wrapped.nix +++ b/lib/tests/modules/deprecated-wrapped.nix @@ -8,6 +8,7 @@ let listOf unique nullOr + functionTo ; in { @@ -42,6 +43,13 @@ in options.mergedNullOr = mkOption { type = nullOr (listOf types.str); }; + # nullOr + options.functionTo = mkOption { + type = functionTo (listOf types.str); + }; + options.mergedFunctionTo = mkOption { + type = functionTo (listOf types.str); + }; } ) # Module B @@ -60,6 +68,9 @@ in options.mergedNullOr = mkOption { type = nullOr (listOf types.str); }; + options.mergedFunctionTo = mkOption { + type = functionTo (listOf types.str); + }; } ) ]; diff --git a/lib/types.nix b/lib/types.nix index f38f96c337867..24d5192225a34 100644 --- a/lib/types.nix +++ b/lib/types.nix @@ -887,7 +887,9 @@ rec { getSubOptions = prefix: elemType.getSubOptions (prefix ++ [ "" ]); 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; }; From 4f123107b47e6cdb137e64b1b361a26f6eb5ae6d Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sun, 19 Jan 2025 16:24:43 +0100 Subject: [PATCH 4/4] lib/types: types.coercedTo deprecate functor.wrapped in favor of functor.payload.elemType --- doc/release-notes/rl-2505.section.md | 1 + lib/tests/modules.sh | 6 ++++++ lib/tests/modules/deprecated-wrapped.nix | 8 +++++++- lib/types.nix | 11 +++++++---- 4 files changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/release-notes/rl-2505.section.md b/doc/release-notes/rl-2505.section.md index 240cda17b1eb6..2f9c4a00d6f44 100644 --- a/doc/release-notes/rl-2505.section.md +++ b/doc/release-notes/rl-2505.section.md @@ -78,6 +78,7 @@ - `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. diff --git a/lib/tests/modules.sh b/lib/tests/modules.sh index ffdc1505f06da..2f21e466450d6 100755 --- a/lib/tests/modules.sh +++ b/lib/tests/modules.sh @@ -434,6 +434,12 @@ 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.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 .*' \ config.value ./declare-int-unsigned-value.nix ./define-value-list.nix ./define-value-int-positive.nix diff --git a/lib/tests/modules/deprecated-wrapped.nix b/lib/tests/modules/deprecated-wrapped.nix index 7db64edfcce3a..5559cd3e9332e 100644 --- a/lib/tests/modules/deprecated-wrapped.nix +++ b/lib/tests/modules/deprecated-wrapped.nix @@ -9,6 +9,7 @@ let unique nullOr functionTo + coercedTo ; in { @@ -43,13 +44,18 @@ in options.mergedNullOr = mkOption { type = nullOr (listOf types.str); }; - # nullOr + # 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 diff --git a/lib/types.nix b/lib/types.nix index 24d5192225a34..dee93a62e3981 100644 --- a/lib/types.nix +++ b/lib/types.nix @@ -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 '' - 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; }; + 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 = @@ -1163,7 +1164,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; };