Prosody 0.10.0 #32960

florianjacob · 2017-12-22T00:50:39Z

Motivation for this change

Prosody 0.10 most notably introduces long-awaited support for the XEPs Message Carbons and Message Archive Management.
See the release notes for more detail.

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.

Note: Some module names now gained an underscore in their name, and therefore, with the current system, need a snake case option name instead of a camel case one – ideas for improvements welcome. 😉 I searched for a nix function to convert camelCase attribute names to snake_case for the config, but could not find something like this.

orivej

I have not tested this, but the change looks good.

orivej · 2017-12-22T01:01:31Z

nixos/modules/services/networking/prosody.nix

+      type = types.bool;
+      default = true;
+      description = "Allow users to register on this server using a client and change passwords";
+    };


Was this previously built in, or were the users unable to register over XMPP?

Ah, actually, this has not much to do with the 0.10 update in itself, I just stumbled over it during cleaning and creating the new module section. 😅

Previously, enabling this module was not exposed, but tied to the state of services.prosody.allowRegistration. The author probably thought that the module has no benefit when registration is disabled (it has, users can change their passwords themselves) or that enabling it would allow users to register even if services.prosody.allowRegistration = false; (it doesn't, this module is actually what gets configured through services.prosody.allowRegistration).

services.prosody.allowRegistration = false; and services.prosody.modules.register = true; is also upstream's default.

For server admins upgrading, the only effect should be that users can change their passwords via their XMPP clients now, even when public registration via XMPP is disabled, i.e. users are managed manually with the prosodyctl command line tool.

Mic92 · 2017-12-29T00:57:50Z

pkgs/servers/xmpp/prosody/default.nix

  };

  communityModules = fetchhg {
    url = "https://hg.prosody.im/prosody-modules";
-    rev = "9a3e51f348fe";
+    rev = "a844d1535c4d";
    sha256 = "09g4vi52rv0r3jzcm0bsgp4ngqq6iapfbxfh0l7qj36qnajp4vm6";


No checksum update?

Strangely not, at the time I updated, nix-prefetch-hg https://hg.prosody.im/prosody-modules returned the checksum that was already there. No idea how that could happen, but the build worked. 🤔

Just updated the communityModules again when resolving the merge conflicts, now the checksum changed. Maybe the prosody module hosting was broken or something…

florianjacob · 2018-01-01T17:16:28Z

notes from 34C3 NixOS meetup:

@fpletz mentioned he's using prosody, and will test the update when he finds the time. 👍
Someone else was preparing the update as well and might have something to add, but I did not notice when they left and forgot to ask for their name in advance. 😕

updating config options, removing luazlib as mod_compression was removed for security reasons.

florianjacob · 2018-03-12T19:29:58Z

@fpletz is it still be possible to get this into 18.03?
Would be quite nice to be able to run my server on stable after the next release. 🙂

fpletz · 2018-03-12T20:27:16Z

@florianjacob 18.03 still on the table. Unfortunately I wasn't able to upgrade my jabber instance to master or 18.03 yet due to #34253. We should probably add a prosody test.

globin · 2018-03-20T23:24:22Z

I'll finish this tomorrow, I've just deployed this on our infrastructure, with some minor changes that I'll clean up then. Thanks for your work!

globin · 2018-03-21T13:34:17Z

nixos/tests/prosody.nix

+    services.prosody.enable = true;
+    environment.systemPackages = let
+      sendMessage = pkgs.writeScriptBin "send-message" ''
+        #!{pkgs.python3.interpreter}


#!{pkgs.python3.interpreter} -> #!${pkgs.python3.interpreter}?

Damn, you caught me! I'm working on adding that simple test at this very moment and pushed that commit to test it on another machine / trying it with the borg build bot. I hoped to be finished before you'd take a look. 😉

Test is now finished! This was harder than expected, sorry for the inconvenience.

florianjacob · 2018-03-21T14:46:41Z

I added a basic test after @fpletz' proposal which starts a server, plays around with the user database via prosodyctl and connects locally to send a message using a python xmpp library.

This is the first NixOS test I wrote, I did not find a place where I need to register that test so it gets executed along the other ones, is that right? EDIT: I stumbled over a list of many tests inside of nixpkgs/nixos/release.nix, but I'm not sure whether I should / need to add it there…

The test could be expanded in some places to cover more which I noted as TODOs, but I'd say the basics sanity checks are covered and this is now good to go, if @globin is fine with how it was written.

globin · 2018-03-22T02:47:36Z

@GrahamcOfBorg test prosody

GrahamcOfBorg · 2018-03-22T03:14:53Z

Success on aarch64-linux (full log)

Attempted: tests.prosody

Partial log (click to expand)

machine: exit status 1
syncing
machine: running command: sync
machine: exit status 0
test script finished in 96.40s
cleaning up
killing machine (pid 627)
vde_switch: EOF on stdin, cleaning up and exiting
vde_switch: Could not remove ctl dir '/build/vde1.ctl': Directory not empty
/nix/store/mawk11zaj2bvcyf53kpq5cbqchy0vw2l-vm-test-run-prosody

GrahamcOfBorg · 2018-03-22T03:48:27Z

Failure on x86_64-linux (full log)

Attempted: tests.prosody

Partial log (click to expand)

cannot build derivation '/nix/store/vi474bxlvn3gbx31qk3gr00mz9v59pr8-etc.drv': 1 dependencies couldn't be built
cannot build derivation '/nix/store/ppgznrpbc3i4xn5awrkwlccwkhpph4c7-stage-1-init.sh.drv': 1 dependencies couldn't be built
cannot build derivation '/nix/store/8f0isrfpn8czy3s1235imfv0vskp7nrk-initrd.drv': 1 dependencies couldn't be built
cannot build derivation '/nix/store/xc3wfiqx6bzy3kbs9k6mfg28f2x09szp-nixos-system-machine-18.09.git.7c6a649.drv': 5 dependencies couldn't be built
cannot build derivation '/nix/store/fyb1d19dzwr5bbch54g7xl0hk1m53xsn-closure-info.drv': 1 dependencies couldn't be built
cannot build derivation '/nix/store/b60sijvfh9im3w1qni4vx2jgnqghmg92-run-nixos-vm.drv': 2 dependencies couldn't be built
cannot build derivation '/nix/store/rzclp0kfdiw0v3bgn8b9rjk0yrvj3wvm-nixos-vm.drv': 2 dependencies couldn't be built
cannot build derivation '/nix/store/m4vp0cwqp7sx33ikrk2xpngskfn24799-nixos-test-driver-prosody.drv': 1 dependencies couldn't be built
cannot build derivation '/nix/store/nmpry9wcb8c5l3y0ij0g9zsc3p7bkaa8-vm-test-run-prosody.drv': 1 dependencies couldn't be built
error: build of '/nix/store/nmpry9wcb8c5l3y0ij0g9zsc3p7bkaa8-vm-test-run-prosody.drv' failed

dotlambda · 2018-03-22T09:41:53Z

nixos/modules/services/networking/prosody.nix

@@ -255,37 +417,47 @@ in

  config = mkIf cfg.enable {

-    environment.systemPackages = [ pkgs.prosody ];
+    environment.systemPackages = [ cfg.package ];

    environment.etc."prosody/prosody.cfg.lua".text = ''


I suggest using the --config option instead of polluting /etc.

We would have to create a specially wrapped prosodyctl then, so 👎

True. Didn't think about that because I don't use prosodyctl for managing users.

globin · 2018-03-22T13:12:51Z

Test only timed out, built it locally.

florianjacob · 2018-03-22T13:22:57Z

@globin thank you!

fpletz · 2018-03-22T14:11:14Z

Also big 👍 from me. Thanks!

florianjacob · 2018-03-23T00:34:15Z

nixos/doc/manual/release-notes/rl-1803.xml

@@ -347,6 +347,11 @@ following incompatible changes:</para>
    <para>
      The better-performing <literal>libevent</literal> backend is now enabled by default.
    </para>
+
+    <para>
+      <literal>withCommunityModules</literal> now passes through the modules to <option>services.prosody.extraModules</option>.


Just simplified my config with this. ❤️

ghost · 2018-03-29T06:00:50Z

nixos/modules/services/networking/prosody.nix

    };

+    vcard = mkOption {


There is a lot of new options, but they are not referenced anywhere in module, so they will not work. What's the purpose of that change then?

Every option in moduleOpts is automatically converted to lua and added to the config file at https://github.com/NixOS/nixpkgs/pull/32960/files#diff-d51fea555a73d3c752f162a7a433c498R442 so they don't need to be explicitly mentioned anywhere else in the module, avoiding loads of boilerplate code. Note that this mechanism was already in place before this PR, in case that caused the confusion. 😉

@florianjacob Very interesting, thank you!

@gnidorah you're welcome, thanks for reviewing. 🙂

florianjacob force-pushed the prosody-0.10 branch from e829d0c to 232287f Compare December 22, 2017 00:51

orivej approved these changes Dec 22, 2017

View reviewed changes

GrahamcOfBorg added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Dec 22, 2017

Mic92 reviewed Dec 29, 2017

View reviewed changes

florianjacob force-pushed the prosody-0.10 branch 2 times, most recently from f8d4652 to a102d18 Compare January 1, 2018 16:53

orivej added the 2.status: merge conflict label Jan 6, 2018

florianjacob force-pushed the prosody-0.10 branch from a102d18 to 16a9e0e Compare February 20, 2018 11:21

GrahamcOfBorg added 6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) 8.has: package (new) labels Feb 20, 2018

fpletz removed the 2.status: merge conflict label Feb 20, 2018

fpletz self-requested a review February 20, 2018 23:29

florianjacob force-pushed the prosody-0.10 branch 2 times, most recently from 729916d to ec691ad Compare February 28, 2018 20:55

florianjacob mentioned this pull request Feb 28, 2018

prosody: 0.9.12 -> 0.10.0 #35976

Closed

florianjacob added 3 commits March 12, 2018 20:18

luaevent: 0.4.3 -> 0.4.4

0c74665

prosody: 0.9.12 -> 0.10.0

226965d

updating config options, removing luazlib as mod_compression was removed for security reasons.

prosody: update community modules

2c0b230

florianjacob force-pushed the prosody-0.10 branch from ec691ad to 2c0b230 Compare March 12, 2018 19:19

dotlambda mentioned this pull request Mar 15, 2018

prosody: 0.9.12 -> 0.10.0 #37085

Closed

globin self-assigned this Mar 20, 2018

globin reviewed Mar 21, 2018

View reviewed changes

nixos/prosody: add a basic test

88f06c5

florianjacob force-pushed the prosody-0.10 branch from a83162d to 88f06c5 Compare March 21, 2018 14:34

globin added 2 commits March 22, 2018 03:40

prosody: improve module handling

0a80f2c

prosody: add test to release.nix

faaf32a

dotlambda reviewed Mar 22, 2018

View reviewed changes

globin merged commit 76ea0e1 into NixOS:master Mar 22, 2018

florianjacob deleted the prosody-0.10 branch March 22, 2018 13:19

florianjacob commented Mar 23, 2018

View reviewed changes

ghost reviewed Mar 29, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prosody 0.10.0 #32960

Prosody 0.10.0 #32960

florianjacob commented Dec 22, 2017

orivej left a comment

orivej Dec 22, 2017

florianjacob Dec 22, 2017

Mic92 Dec 29, 2017

florianjacob Jan 1, 2018

florianjacob commented Jan 1, 2018

florianjacob commented Mar 12, 2018

fpletz commented Mar 12, 2018

globin commented Mar 20, 2018 •

edited

globin Mar 21, 2018

florianjacob Mar 21, 2018

florianjacob Mar 21, 2018

florianjacob commented Mar 21, 2018 •

edited

globin commented Mar 22, 2018

GrahamcOfBorg commented Mar 22, 2018

GrahamcOfBorg commented Mar 22, 2018

dotlambda Mar 22, 2018

globin Mar 22, 2018

dotlambda Mar 22, 2018

globin commented Mar 22, 2018

florianjacob commented Mar 22, 2018

fpletz commented Mar 22, 2018

florianjacob Mar 23, 2018

ghost Mar 29, 2018

florianjacob Mar 29, 2018 •

edited

ghost Mar 29, 2018

florianjacob Mar 29, 2018

Prosody 0.10.0 #32960

Prosody 0.10.0 #32960

Conversation

florianjacob commented Dec 22, 2017

Motivation for this change

Things done

orivej 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

florianjacob commented Jan 1, 2018

florianjacob commented Mar 12, 2018

fpletz commented Mar 12, 2018

globin commented Mar 20, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

florianjacob commented Mar 21, 2018 • edited

globin commented Mar 22, 2018

GrahamcOfBorg commented Mar 22, 2018

GrahamcOfBorg commented Mar 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

globin commented Mar 22, 2018

florianjacob commented Mar 22, 2018

fpletz commented Mar 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

florianjacob Mar 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

globin commented Mar 20, 2018 •

edited

florianjacob commented Mar 21, 2018 •

edited

florianjacob Mar 29, 2018 •

edited