n8n: init 0.96.0 #98234

freezeboy · 2020-09-18T20:00:13Z

Motivation for this change

New package for n8n.io app

Service heavily inspired from services/misc/bazaar.nix
Never wrote a test, and don't know which one would be great for such a service

Things done

freezeboy · 2020-09-19T08:14:37Z

Added a test again based on bazaar service test, just checking that the port is available and working

nixos-discourse · 2020-11-15T00:22:55Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/368

doronbehar · 2020-11-28T15:51:28Z

Diff LGTM, only there should be 2 commits.

freezeboy · 2020-11-28T16:30:14Z

1 for the package and 1 for the module and test ?

doronbehar · 2020-11-28T16:31:02Z

Yes.

doronbehar · 2020-11-28T16:37:49Z

cc me when you force push.

freezeboy · 2020-11-28T17:00:46Z

cc @doronbehar

aanderse

@freezeboy I find it difficult to review this module with the whitespace here. Can you please have consistent indentation throughout the module, following the standards for nixpkgs?

freezeboy · 2020-11-28T17:11:49Z

@aanderse Sorry, I force pushed this PR and I am not sure which indent problem you have :/

aanderse · 2020-11-28T17:19:06Z

@aanderse Sorry, I force pushed this PR and I am not sure which indent problem you have :/

You are using a mixture of tabs and spaces. If you view your changes in the github ui don't you see very inconsistent spacing like this?

freezeboy · 2020-11-28T17:21:56Z

Oh my bad ... It's ugly, didn't notice the tabs here

aanderse

I have reviewed the module portion of this PR. I hope you find the review helpful. Please don't hesitate to ask if you have any questions.

nixos/modules/services/misc/n8n.nix

aanderse · 2020-11-28T17:35:22Z

nixos/modules/services/misc/n8n.nix

+        Group = cfg.group;
+        StateDirectory = "n8n";
+        SyslogIdentifier = "n8n";
+        Environment = "N8N_CONFIG_FILES=${configFile}";


Personally I prefer systemd.services.n8n.environment.N8N_CONFIG_FILES because it allows the user more control, but this is fine as well if you don't like my suggestion.

This isn't needed anymore.

aanderse · 2020-11-28T17:36:48Z

nixos/modules/services/misc/n8n.nix

+  };
+
+  config = mkIf cfg.enable {
+    systemd.services.n8n = {


I noticed the upstream repo doesn't have a systemd unit file. They might benefit from you submitting a PR to add one.

nixos/modules/services/misc/n8n.nix

nixos/tests/n8n.nix

nixos/modules/services/misc/n8n.nix

aanderse · 2020-11-28T17:44:38Z

nixos/modules/services/misc/n8n.nix

+      description = "Open ports in the firewall for the n8n web interface.";
+    };
+
+    package = mkOption {


It looks like the n8n package has no build options and only a single version in nixpkgs: what is the value this option provides?

just to make it easy to use a custom version ?

This is what overrides are for.

freezeboy · 2020-11-28T18:41:35Z

@aanderse Thank you for the the review, I tried to fix the things you mention

Atm, no idea to fix the test and the hardening parts

aanderse

Apparently I lost a comment from my review.

aanderse · 2020-11-28T18:49:49Z

nixos/modules/services/misc/n8n.nix

+      description = "Group under which n8n runs.";
+    };
+
+    config = {


Have you looked at RFC42 yet?

No, added to the list

So basically, I rename my "config" key to a single empty option, link to the documentation, and use a lib to build the json file?

Is there a general policy for the default?

So basically, I rename my "config" key to a single empty option, link to the documentation, and use a lib to build the json file?

Yes. If you don't think this provides enough value to the sysadmin you could utilize a freeform module option to provide type checking and validation to your settings option.

Please don't hesitate to ask for any help on this PR 😄

Ok I see in the config part, instead of the options

aanderse · 2020-11-28T18:52:14Z

nixos/modules/services/misc/n8n.nix

+        Group = cfg.group;
+        StateDirectory = "n8n";
+        SyslogIdentifier = "n8n";
+        Environment = "N8N_CONFIG_FILES=${configFile}";


This isn't needed anymore.

freezeboy · 2020-11-28T20:10:20Z

I guess the hardening blocks the tests, I can't write the config to /var/lib/n8n anymore

freezeboy · 2020-11-28T22:07:43Z

Test passes, thank you for all your reviews, the module is way simpler and safer now.

freezeboy · 2020-11-29T10:16:51Z

@aanderse I did some cleanup, I think this time it is ok

aanderse

Fantastic job on the module @freezeboy! I approve of the module portion of this PR. ~~Unfortunately I don't usually review packages, and am not overly qualified to review nodePackage changes so we will have to get someone else to review that.~~ Right, @doronbehar has already reviewed the package changes... so I think we're good to merge. Right? 😄

nixos/modules/services/misc/n8n.nix

doronbehar · 2020-12-05T10:20:53Z

@freezeboy I'm a bit reluctant into adding yet another package with complete node dependencies Nix expressions. There is a call for node packages maintainers and in general most people (I think) would like to get less of such expressions, mostly because they take a lot of disk space (even after removed of course, due to version control), see e.g: #96961 (review) .

There was one PR in the past that aggregated a few init prs with node packages that people wanted to add them to https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/node-packages/node-packages.json - #100606 . Hence, if you are motivated, it'd be much appreciated if you could do something similar. I hope I'd be able to help you with such a PR quick enough so that it won't be blocked due to merge conflicts.

freezeboy · 2020-12-05T10:25:35Z

@doronbehar In fact I tried yesterday to put it it node-packages.json file, but I encountered two problems:

btc-rpc-explorer was having a problem with a timeout with github.com, and the generate script was taking ages ... so I gave up

doronbehar · 2020-12-05T11:39:52Z

Sigh... Maybe in the future this will work better, with flakes or some mach-nix kind of implementation for Node packages. In the meantime it's not worth waiting IMO. The test passes and the diff LGTM.

doronbehar · 2020-12-05T11:40:16Z

Result of nixpkgs-review pr 98234 1

1 package blacklisted:

tests.nixos-functions.nixos-test

1 package built:

n8n

freezeboy force-pushed the add-n8n branch from f938c55 to 1399ad9 Compare September 19, 2020 08:13

freezeboy force-pushed the add-n8n branch 2 times, most recently from da06607 to 82f4a52 Compare September 19, 2020 18:27

freezeboy force-pushed the add-n8n branch from 82f4a52 to 0f5a9fa Compare October 15, 2020 10:18

freezeboy changed the title ~~n8n: init 0.83.0~~ n8n: init 0.87.1 Oct 15, 2020

freezeboy force-pushed the add-n8n branch from 0f5a9fa to 5b60cda Compare November 1, 2020 22:37

freezeboy force-pushed the add-n8n branch from 5b60cda to 6f694b0 Compare November 28, 2020 17:00

aanderse requested changes Nov 28, 2020

View reviewed changes

freezeboy force-pushed the add-n8n branch from 6f694b0 to 3f497b0 Compare November 28, 2020 17:11

freezeboy force-pushed the add-n8n branch from 3f497b0 to a313965 Compare November 28, 2020 17:21

freezeboy force-pushed the add-n8n branch 2 times, most recently from 7516158 to 0591ee0 Compare November 28, 2020 17:24

aanderse requested changes Nov 28, 2020

View reviewed changes

freezeboy force-pushed the add-n8n branch from 0591ee0 to 7556027 Compare November 28, 2020 18:40

freezeboy force-pushed the add-n8n branch from 7556027 to 4d8ca57 Compare November 28, 2020 18:51

aanderse reviewed Nov 28, 2020

View reviewed changes

freezeboy changed the title ~~n8n: init 0.87.1~~ n8n: init 0.95.1 Nov 28, 2020

freezeboy force-pushed the add-n8n branch 2 times, most recently from 9dabaaf to d056c73 Compare November 28, 2020 22:02

freezeboy force-pushed the add-n8n branch from d056c73 to 1acc951 Compare November 29, 2020 10:04

aanderse approved these changes Nov 29, 2020

View reviewed changes

nixos/modules/services/misc/n8n.nix Outdated Show resolved Hide resolved

nixos/modules/services/misc/n8n.nix Show resolved Hide resolved

freezeboy force-pushed the add-n8n branch from 1acc951 to 48f2c00 Compare December 4, 2020 22:16

n8n: init at 0.96.0

b5ee81b

freezeboy force-pushed the add-n8n branch from 48f2c00 to 8c40e1f Compare December 4, 2020 22:47

freezeboy changed the title ~~n8n: init 0.95.1~~ n8n: init 0.96.0 Dec 4, 2020

nixos/n8n: init module and test

903b2aa

freezeboy force-pushed the add-n8n branch from 8c40e1f to 903b2aa Compare December 5, 2020 10:02

doronbehar merged commit 956e642 into NixOS:master Dec 5, 2020

freezeboy deleted the add-n8n branch December 5, 2020 12:07

n8n: init 0.96.0 #98234

n8n: init 0.96.0 #98234

Conversation

freezeboy commented Sep 18, 2020 • edited Loading

Motivation for this change

Things done

freezeboy commented Sep 19, 2020

nixos-discourse commented Nov 15, 2020

doronbehar commented Nov 28, 2020

freezeboy commented Nov 28, 2020

doronbehar commented Nov 28, 2020

doronbehar commented Nov 28, 2020

freezeboy commented Nov 28, 2020

aanderse left a comment

Choose a reason for hiding this comment

freezeboy commented Nov 28, 2020

aanderse commented Nov 28, 2020

freezeboy commented Nov 28, 2020

aanderse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freezeboy commented Nov 28, 2020

aanderse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aanderse Nov 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freezeboy commented Nov 28, 2020

freezeboy commented Nov 28, 2020

freezeboy commented Nov 29, 2020

aanderse left a comment • edited Loading

Choose a reason for hiding this comment

doronbehar commented Dec 5, 2020

freezeboy commented Dec 5, 2020

doronbehar commented Dec 5, 2020

doronbehar commented Dec 5, 2020

freezeboy commented Sep 18, 2020 •

edited

Loading

aanderse Nov 28, 2020 •

edited

Loading

aanderse left a comment •

edited

Loading