mealie: init at 1.2.0 #278454

litchipi · 2024-01-03T09:33:08Z

Description of changes

Package request: #254260

Adds a new package mealie, with its NixOS module.

Work mostly inspired from the work previously made by @fleaz, and tested on a Qemu VM setup before being ported here.

Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend
application built with NuxtJS for a pleasant user experience for the whole family.
Easily add recipes into your database by providing the URL and Mealie will automatically import the relevant data or add a family recipe with the UI editor.

(See more in homepage)

Things done

litchipi · 2024-01-03T09:49:07Z

@ambroisie Can't add you as a reviewer, but here's the PR for mealie.
Also @fleaz worked on it and may want to take a look (as 90% of this is his code 😛 )

Tried to fit Contributing, let me know if you see anything.

Also: the package wasn't tested outside a systemd service, I don't really know yet if that would work directly from the ./result/bin

ambroisie

Took a first look at the module and package.

maintainers/maintainer-list.nix

nixos/doc/manual/release-notes/rl-2405.section.md

nixos/modules/services/web-apps/mealie.nix

pkgs/servers/web-apps/mealie/default.nix

pkgs/top-level/all-packages.nix

litchipi · 2024-01-04T08:56:57Z

@ambroisie Thank you for the detailed review, tried to address it the best I could.
I'll rebase / squash everything in clean commits once nobody has any more comment, and the whole thing is ready to merge

litchipi · 2024-01-04T12:55:34Z

I keep getting the error

pkgs.mealie: This attribute is manually defined (most likely in pkgs/top-level/all-packages.nix), which is only allowed if the definition is of the form `pkgs.callPackage pkgs/by-name/me/mealie/package.nix { ... }` with a non-empty second argument.

when putting the package inside the by-name directory, so I moved it back to pkgs/servers/web-apps/mealie and it works now.
Is it really annoying if it stays here ? Am I missing something ?

ambroisie · 2024-01-04T16:25:38Z

@litchipi if you move it from pkgs/servers/web-apps/mealie/default.nix to pkgs/by-name/me/mealie/package.nix and remove it from top-level/all-packages.nix then you shouldn't get an error.

The point of pkgs/by-name is that they are automatically callPackaged, so no need to do it explicitly.

litchipi · 2024-01-05T09:32:55Z

@ambroisie Made all the changes, CI is green, ready for a new round of review ! 🙂

ambroisie

It's starting to look very good, please bear with me for some additional changes :-)

nixos/modules/services/web-apps/mealie.nix

pkgs/by-name/me/mealie/mealie-frontend.nix

ambroisie · 2024-01-05T10:32:40Z

nixos/modules/services/web-apps/mealie.nix

+        ExecStart = "${pkg.pythonPkg.gunicorn}/bin/gunicorn -b ${cfg.host}:${builtins.toString cfg.port} -k uvicorn.workers.UvicornWorker mealie.app:app";
+        StateDirectory = "mealie";
+        LogsDirectory = "mealie";
+      };


One thing which is missing is a credentialsFile option, I will refer you to my pyload PR as an example, but there should be plenty more in various modules.

This seems unresolved. Is this needed?

A credentialsFile option was added in 4ebf2b5 (#278454).

fleaz · 2024-01-05T21:55:55Z

Thank you @litchipi for putting so much more work into this than I had! 🚀

And also a big thanks to @ambroisie for the detailed review! 🙏🏻

I will take the code and deploy it on one of my servers on the weekend, and try to spot any problems with it.

Janik-Haag · 2024-01-06T02:45:28Z

maintainers entry lgtm; @ambroisie feel free to ping me for a merger once this is ready.

litchipi · 2024-01-06T07:59:55Z

@ambroisie Thanks for the review, the coded looks so much cleaner now !
I managed to get it worked with most of the work done in the package building as you asked, and it's really cleaner on the nixos module side.
The whole thing looks neat now, and tests are passing on my side, so I squashed the whole thing into 2 clean commits, ready to merge if you're OK with it 😃

fleaz · 2024-01-07T15:36:47Z

Just deployed this on my server and can confirm it's working as expected 👍🏻

I imported a dump from my previous Mealie installation into it
Tested the webscraper with some new recipes
Created/Edited some Users

litchipi · 2024-02-10T12:02:32Z

Change was trivial, updated to latest 1.2.0 version, and rebased over latest master 🙂

ambroisie

Small nits.

pkgs/by-name/me/mealie/mealie-frontend.nix

pkgs/by-name/me/mealie/package.nix

pkgs/by-name/me/mealie/mealie-logs-to-stdout.patch

pkgs/by-name/me/mealie/mealie-frontend.nix

Atemu · 2024-02-12T13:22:26Z

pkgs/by-name/me/mealie/package.nix

@@ -28,7 +28,7 @@ let

  crfpp = stdenv.mkDerivation {
    pname = "mealie-crfpp";
-    version = "master";
+    version = "unstable-2024-02-12";


The date should be the commit date.

Suggested change

version = "unstable-2024-02-12";

version = "unstable-2021-10-10";

Ah yes sorry, good catch

You accidentally reverted this.

litchipi · 2024-02-14T07:57:06Z

The changes proposed upstream has been merged.
If this PR is OK for you, let's merge this with the patches for now, and when a new release is made, at the same time as bumping the version I'll remove the patches ?

Squashed fixups into clean commits, ready to merge if you think it's good

Atemu · 2024-02-14T09:47:33Z

If this PR is OK for you, let's merge this with the patches for now, and when a new release is made, at the same time as bumping the version I'll remove the patches ?

Yup, that's the way to go.

litchipi · 2024-02-22T07:25:41Z

@mweinelt Does this PR looks good for you ? 😃

mweinelt

Only small stuff, thanks for asking.

mweinelt · 2024-02-22T12:30:51Z

pkgs/by-name/me/mealie/mealie-frontend.nix

@@ -0,0 +1,51 @@
+src: version:
+{ lib, fetchYarnDeps, nodejs_18, prefetch-yarn-deps, stdenv }: stdenv.mkDerivation {


Is pinning the nodejs version necessary?

Yes, on the unpinned version I got Expected version "^14.18.0 || ^16.10.0 || ^17.0.0 || ^18.0.0 || ^19.0.0". Got "20.11.0"

mweinelt · 2024-02-22T12:32:12Z

pkgs/by-name/me/mealie/package.nix

+, fetchFromGitHub
+, fetchpatch
+, makeWrapper
+, python3


Use python3Packages instead. Apparently it works better for cross compilation. It maps to python3.pkgs.

I do not only need python3.pkgs, I also require python3.sitePackages, to do an override of packageOverrides for pydantic, and call python3.interpreter

Then use python3Packages.python.sitePackages and python3Packages.python.interpreter.

Thanks, fixed it

mweinelt · 2024-02-22T12:37:57Z

pkgs/by-name/me/mealie/package.nix

+      owner = "mealie-recipes";
+      repo = "crfpp";
+      rev = "c56dd9f29469c8a9f34456b8c0d6ae0476110516";
+      sha256 = "sha256-XNps3ZApU8m07bfPEnvip1w+3hLajdn9+L5+IpEaP0c=";


Generally, prefer hash over sha256, especially with SRI hashes.

mweinelt · 2024-02-22T12:44:43Z

nixos/modules/services/web-apps/mealie.nix

+        ExecStart = "${pkg.pythonPkg.gunicorn}/bin/gunicorn -b ${cfg.host}:${builtins.toString cfg.port} -k uvicorn.workers.UvicornWorker mealie.app:app";
+        StateDirectory = "mealie";
+        LogsDirectory = "mealie";
+      };


This seems unresolved. Is this needed?

mweinelt · 2024-02-22T12:45:49Z

nixos/doc/manual/release-notes/rl-2405.section.md

@@ -81,6 +81,8 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m

 - [systemd-lock-handler](https://git.sr.ht/~whynothugo/systemd-lock-handler/), a bridge between logind D-Bus events and systemd targets. Available as [services.systemd-lock-handler.enable](#opt-services.systemd-lock-handler.enable).

+- [Mealie](https://nightly.mealie.io/), a self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in NuxtJS for a pleasant user experience for the whole family. Available as [services.mealie](#opt-services.mealie.enable)


REST is a fixed term. So you can say "REST API" instead of "RestAPI backend".

Copy-pasted from the website, so I should maybe tell this to the creator as well 😅

litchipi · 2024-02-22T14:15:39Z

@mweinelt Regarding #278454 (comment)

The StateDirectory is used for DATA_DIR env var, the logs isn't used anymore, so I removed it

litchipi · 2024-02-22T14:21:17Z

Made the changes and created clean commits

Signed-off-by: Litchi Pi <litchi.pi@proton.me>

Atemu · 2024-02-26T21:01:40Z

I think we're now at the point where all major issues have been ironed out. Any further improvements can come in follow-up PRs.

Thank you so much for sticking with us and pulling through @litchipi. Not everyone contributes such a high quality PR as their first contribution.

github-actions · 2024-02-28T12:38:45Z

Backport failed for release-23.11, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin release-23.11
git worktree add -d .worktree/backport-278454-to-release-23.11 origin/release-23.11
cd .worktree/backport-278454-to-release-23.11
git switch --create backport-278454-to-release-23.11
git cherry-pick -x be1320f4285720b694ebb176b3d1c7d408de3b60 c1373dd3abaa278382a45b35b9bd42d38e963707 4ebf2b54b09589e35eccb1a565bfb124cb7d09ba ba9431edf8c436efebe139ebb7aa5182952078da aeb79caaf67e8aa73ac7b4b0a477f38b4d0cab09

litchipi requested review from piegamesde and Janik-Haag as code owners January 3, 2024 09:33

github-actions bot added 6.topic: nixos 8.has: module (update) labels Jan 3, 2024

NixOSInfra added the 12. first-time contribution label Jan 3, 2024

github-actions bot added 8.has: documentation 8.has: changelog labels Jan 3, 2024

ambroisie self-requested a review January 3, 2024 12:59

ambroisie requested changes Jan 3, 2024

View reviewed changes

h7x4 added 8.has: module (new) 8.has: tests labels Jan 3, 2024

litchipi force-pushed the mealie branch from 2c8b36b to 3e4e334 Compare January 4, 2024 07:52

piegamesde removed request for piegamesde and Janik-Haag January 4, 2024 10:47

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 10.rebuild-linux: 1-10 labels Jan 4, 2024

ambroisie requested changes Jan 5, 2024

View reviewed changes

litchipi force-pushed the mealie branch from e282f95 to f6f41bd Compare January 6, 2024 07:58

litchipi changed the title ~~mealie: init at 1.1.0~~ mealie: init at 1.2.0 Feb 10, 2024

ambroisie requested changes Feb 10, 2024

View reviewed changes

pkgs/by-name/me/mealie/mealie-frontend.nix Outdated Show resolved Hide resolved

pkgs/by-name/me/mealie/mealie-frontend.nix Outdated Show resolved Hide resolved

pkgs/by-name/me/mealie/package.nix Outdated Show resolved Hide resolved

ambroisie approved these changes Feb 10, 2024

View reviewed changes

SuperSandro2000 reviewed Feb 11, 2024

View reviewed changes

pkgs/by-name/me/mealie/package.nix Outdated Show resolved Hide resolved

pkgs/by-name/me/mealie/mealie-logs-to-stdout.patch Show resolved Hide resolved

pkgs/by-name/me/mealie/mealie-frontend.nix Show resolved Hide resolved

Atemu reviewed Feb 12, 2024

View reviewed changes

litchipi force-pushed the mealie branch from 2cb4f4c to c933371 Compare February 14, 2024 07:56

mweinelt reviewed Feb 22, 2024

View reviewed changes

litchipi force-pushed the mealie branch from c933371 to 8bb3cf5 Compare February 22, 2024 14:21

mweinelt approved these changes Feb 22, 2024

View reviewed changes

Atemu approved these changes Feb 22, 2024

View reviewed changes

litchipi added 4 commits February 23, 2024 07:15

mealie: init at v1.2.0

c1373dd

Signed-off-by: Litchi Pi <litchi.pi@proton.me>

nixos/mealie: init module

4ebf2b5

Signed-off-by: Litchi Pi <litchi.pi@proton.me>

nixos/mealie: add to release notes 24.05

ba9431e

Signed-off-by: Litchi Pi <litchi.pi@proton.me>

nixos/mealie: init tests

aeb79ca

Signed-off-by: Litchi Pi <litchi.pi@proton.me>

litchipi force-pushed the mealie branch from 8bb3cf5 to aeb79ca Compare February 23, 2024 06:16

Atemu merged commit f53c775 into NixOS:master Feb 26, 2024
25 checks passed

Atemu added the backport release-23.11 label Feb 28, 2024

Atemu added 9.needs: port to stable A PR needs a backport to the stable release. and removed backport release-23.11 labels Feb 28, 2024

Atemu mentioned this pull request Feb 28, 2024

[23.11] mealie: init at 1.2.0 #292081

Merged

13 tasks

Atemu added 8.has: port to stable A PR already has a backport to the stable release. and removed 9.needs: port to stable A PR needs a backport to the stable release. labels Feb 28, 2024

	version = "unstable-2024-02-12";
	version = "unstable-2021-10-10";

		@@ -0,0 +1,51 @@
		src: version:
		{ lib, fetchYarnDeps, nodejs_18, prefetch-yarn-deps, stdenv }: stdenv.mkDerivation {

		@@ -81,6 +81,8 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m

		- [systemd-lock-handler](https://git.sr.ht/~whynothugo/systemd-lock-handler/), a bridge between logind D-Bus events and systemd targets. Available as [services.systemd-lock-handler.enable](#opt-services.systemd-lock-handler.enable).

		- [Mealie](https://nightly.mealie.io/), a self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in NuxtJS for a pleasant user experience for the whole family. Available as [services.mealie](#opt-services.mealie.enable)

mealie: init at 1.2.0 #278454

mealie: init at 1.2.0 #278454

Conversation

litchipi commented Jan 3, 2024 • edited Loading

Description of changes

Things done

litchipi commented Jan 3, 2024

ambroisie left a comment

Choose a reason for hiding this comment

litchipi commented Jan 4, 2024

litchipi commented Jan 4, 2024

ambroisie commented Jan 4, 2024

litchipi commented Jan 5, 2024

ambroisie 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

fleaz commented Jan 5, 2024

Janik-Haag commented Jan 6, 2024

litchipi commented Jan 6, 2024

fleaz commented Jan 7, 2024

litchipi commented Feb 10, 2024

ambroisie 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

litchipi commented Feb 14, 2024

Atemu commented Feb 14, 2024

litchipi commented Feb 22, 2024

mweinelt 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

mweinelt Feb 22, 2024 • edited Loading

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

litchipi commented Feb 22, 2024

litchipi commented Feb 22, 2024

Atemu commented Feb 26, 2024

github-actions bot commented Feb 28, 2024

litchipi commented Jan 3, 2024 •

edited

Loading

mweinelt Feb 22, 2024 •

edited

Loading