nginx service: add nested locations support #40303

sshisk · 2018-05-10T20:38:26Z

Motivation for this change

Copy locations from vhost-options.nix so can be nested.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
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 nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

infinisil

What are nested locations used for?

infinisil · 2018-07-07T16:14:09Z

lib/types.nix

+      getSubOptions = prefix: {};
+      getSubModules = null;
+    };
+


You can just override the description of the type (type // { description = "custom descr"; }) to get rid of the infinite recursion, no function in lib needed.

This doesn't work. Recursion occurs in manual generation when it tries to generate options description for locations._name_.locations._name_ etc.

There's potentially a more thorough solution now, in

lib/types: make either expose submodules #208227

Look for recursive = in types.nix.

cc @ncfavier

sshisk · 2019-05-31T08:11:12Z

@infinisil I use them to restrict access to sublocations with password. They are useful for other settings too.

sshisk · 2019-08-18T18:39:34Z

Any update?

nixos/modules/services/web-servers/nginx/location-options.nix

stale · 2020-06-01T08:22:55Z

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

Search for maintainers and people that previously touched the
related code and @ mention them in a comment.
Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
irc.freenode.net.

stale · 2021-06-04T15:03:52Z

I marked this as stale due to inactivity. → More info

abbradar · 2021-12-22T22:59:40Z

I have used this for sub-locations like those:

          locations = {
            "/private/" = {
              extraConfig = ''
                auth_basic "Secret area";
                auth_basic_user_file /root/private-htpasswd;
              '';
              locations."/private/files/".extraConfig = "autoindex on;";
            };

This function is helpful for infinitely recursive types to stop traversing early. Without this infinitely recursive options crash Nix during documentation build.

sshisk · 2021-12-23T22:44:09Z

I rebased tree atop latest master.

abbradar · 2022-01-08T10:25:11Z

@infinisil kind ping -- I'd like to merge because I use this patch, but not sure you are okay with this. Also I'm not sure hideSubTree is the good way here.

infinisil

I'd like to merge this once these points are addressed :)

infinisil · 2022-03-01T01:18:54Z

nixos/modules/services/web-servers/nginx/location-options.nix

@@ -111,6 +112,21 @@ with lib;
      '';
    };

+    locations = mkOption {
+      type = types.attrsOf (types.hideSubTree (types.submodule self));


The hideSubTree hack is not necessary anymore thanks to @roberth with 64dfd98. Now you can do

Suggested change

type = types.attrsOf (types.hideSubTree (types.submodule self));

type = types.attrsOf (types.submodule self);

visible = "shallow";

infinisil · 2022-03-01T01:28:46Z

nixos/modules/services/web-servers/nginx/location-options.nix

@@ -7,6 +7,7 @@

 with lib;

+let self =


Suggestion: Instead of doing the recursion here, do it in ./vhost-options.nix by doing

diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix index c4e8285dc48..d687cb8ab2d 100644 --- a/nixos/modules/services/web-servers/nginx/vhost-options.nix +++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix @@ -271,9 +271,12 @@ with lib; }; locations = mkOption { - type = types.attrsOf (types.submodule (import ./location-options.nix { - inherit lib; - })); + type = + let + locationsType = types.attrsOf (types.submodule (import ./location-options.nix { + inherit lib locationsType; + })); + in locationsType; default = {}; example = literalExpression '' {

Then you can take the locationsType argument in this module (though it's passed a bit unconventional, but that's another issue), and use that directly as the type for the locations option.

kirillrdy · 2024-01-23T13:23:06Z

This branch has conflicts that must be resolved ( damn English )

infinisil · 2024-01-25T20:18:17Z

It looks like the PR author isn't active anymore. I encourage others to pick this up.

GrahamcOfBorg added 6.topic: nixos 8.has: module (update) labels May 10, 2018

sshisk force-pushed the nginx branch from 9474ccb to 5c352a8 Compare May 13, 2018 12:43

sshisk requested review from edolstra and nbp as code owners May 13, 2018 12:43

sshisk force-pushed the nginx branch from 5c352a8 to a466f8a Compare May 13, 2018 12:44

GrahamcOfBorg added 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels May 13, 2018

infinisil requested changes Jul 7, 2018

View reviewed changes

sshisk force-pushed the nginx branch from a466f8a to 0f370b1 Compare May 31, 2019 08:20

infinisil reviewed Sep 20, 2019

View reviewed changes

nixos/modules/services/web-servers/nginx/location-options.nix Show resolved Hide resolved

sshisk force-pushed the nginx branch from 0f370b1 to b2aab23 Compare October 3, 2019 10:18

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 1, 2020

ryantm added the 2.status: merge conflict label Oct 3, 2020

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 3, 2020

ryantm added 2.status: merge conflict and removed 2.status: merge conflict labels Oct 3, 2020

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 4, 2021

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Dec 22, 2021

hideSubTree: add to break recursion

16cffe7

This function is helpful for infinitely recursive types to stop traversing early. Without this infinitely recursive options crash Nix during documentation build.

abbradar force-pushed the nginx branch from b2aab23 to cee35c5 Compare December 23, 2021 22:39

nginx service: add nested locations support

36ee268

sshisk force-pushed the nginx branch from cee35c5 to 36ee268 Compare December 23, 2021 22:41

sshisk requested a review from infinisil December 23, 2021 22:42

ofborg bot added 10.rebuild-linux: 1-10 and removed 2.status: merge conflict 10.rebuild-linux: 0 labels Dec 23, 2021

infinisil reviewed Mar 1, 2022

View reviewed changes

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Sep 21, 2022

GabrielDougherty approved these changes Mar 5, 2023

View reviewed changes

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 5, 2023

wegank added the 12.approvals: 1 label Sep 7, 2023

wegank added 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 2.status: merge conflict labels Mar 19, 2024

wegank marked this pull request as draft March 20, 2024 16:12

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nginx service: add nested locations support #40303

nginx service: add nested locations support #40303

sshisk commented May 10, 2018

infinisil left a comment

infinisil Jul 7, 2018

sshisk May 31, 2019

roberth Mar 5, 2023

sshisk commented May 31, 2019

sshisk commented Aug 18, 2019

stale bot commented Jun 1, 2020

stale bot commented Jun 4, 2021

abbradar commented Dec 22, 2021

sshisk commented Dec 23, 2021

abbradar commented Jan 8, 2022

infinisil left a comment

infinisil Mar 1, 2022

infinisil Mar 1, 2022

kirillrdy commented Jan 23, 2024 •

edited

infinisil commented Jan 25, 2024

	type = types.attrsOf (types.hideSubTree (types.submodule self));
	type = types.attrsOf (types.submodule self);
	visible = "shallow";

nginx service: add nested locations support #40303

Are you sure you want to change the base?

nginx service: add nested locations support #40303

Conversation

sshisk commented May 10, 2018

Motivation for this change

Things done

infinisil left a comment

Choose a reason for hiding this comment

infinisil Jul 7, 2018

Choose a reason for hiding this comment

sshisk May 31, 2019

Choose a reason for hiding this comment

roberth Mar 5, 2023

Choose a reason for hiding this comment

sshisk commented May 31, 2019

sshisk commented Aug 18, 2019

stale bot commented Jun 1, 2020

stale bot commented Jun 4, 2021

abbradar commented Dec 22, 2021

sshisk commented Dec 23, 2021

abbradar commented Jan 8, 2022

infinisil left a comment

Choose a reason for hiding this comment

infinisil Mar 1, 2022

Choose a reason for hiding this comment

infinisil Mar 1, 2022

Choose a reason for hiding this comment

kirillrdy commented Jan 23, 2024 • edited

infinisil commented Jan 25, 2024

kirillrdy commented Jan 23, 2024 •

edited