[WIP] Mob moss work on packaging flarum #23

albertchae · 2023-07-21T13:30:16Z

Currently this is a draft PR just for communication on #10

default.nix.bak can be ignored for now
composer.lock is the lock file we got after running composer create-project flarum/flarum . as recommended by https://docs.flarum.org/install/#installing. Neither https://github.com/flarum/flarum nor https://github.com/flarum/framework have composer.lock files checked in, which prevents composer2nix from generating php-packages.nix

The rest of the files (composer-env.nix, default.nix, php-packages.nix) are the output of composer2nix

lastFile:README.md

lastFile:pkgs/flarum/default.nix

lastFile:pkgs/flarum/composer-env.nix

lastFile:pkgs/flarum/php-packages.nix

lastFile:pkgs/flarum/default.nix.bak

albertchae · 2023-07-21T13:33:55Z

pkgs/flarum/php-packages.nix

+composerEnv.buildPackage {
+  inherit packages devPackages noDev;
+  name = "flarum-flarum";
+  src = composerEnv.filterSrc ./.;


This line seems to be written assuming that this nix expression will be evaluated in the project repo, but because it's in ngipkgs, we end up copying only composer.lock and the vendor directory into the nix store. As far as we know, we can't just replace this with fetchFromGitHub because the flarum/flarum and flarum/framework repos do not have a composer.lock checked in.

So we were thinking we could get around this by using fetchFromGitHub and then copying our composer.lock on top of it.

We came across https://discourse.nixos.org/t/source-combinators/13331/8 and https://discourse.nixos.org/t/easy-source-filtering-with-file-sets/29117 but neither seem to be usable yet

Yeah, this is what I feared. composer2nix makes a few assumptions here that we can't work around without ripping open the whole thing. @infinisil is still working on file set combinators, but we may get enough of it into Nixpkgs for you to use.

albertchae · 2023-07-21T13:35:51Z

pkgs/flarum/default.nix.bak

@@ -0,0 +1,35 @@
+{ stdenv, fetchFromGitHub, php, phpPackages, ... }:


ignore this file for now, this is a mix of a default.nix we were handwriting plus trying to copy in some of the autogenerated nix code from composer2nix

fricklerhandwerk · 2023-07-21T14:56:44Z

pkgs/flarum/composer-env.nix

+  inherit (phpPackages) composer;
+
+  filterSrc = src:
+    builtins.filterSource (path: type: type != "directory" || (baseNameOf path != ".git" && baseNameOf path != ".git" && baseNameOf path != ".svn")) src;


This code is generic, and while usually I'd say that stuff should be part of composer2nix and just be imported, you can actually trick it into doing what you want with something along these lines:

Suggested change

builtins.filterSource (path: type: type != "directory" || (baseNameOf path != ".git" && baseNameOf path != ".git" && baseNameOf path != ".svn")) src;

let

flarum-src = builtins.fetchTarball ...;

# hardcode flarum source here. not great

filtered-src = builtins.filterSource (path: type: type != "directory" || (baseNameOf path != ".git" && baseNameOf path != ".git" && baseNameOf path != ".svn")) flarum-src;

# combine what with what's actually in this source tree

in pkgs.symlinkJoin [ src filtered-src ];

Obviously this is fugly, but it doesn't make any sense to touch the generated sources file. I'm sure you'll find a more reasonable workaround.

No idea if this will actually work with symlinks.

fricklerhandwerk · 2023-07-21T14:59:07Z

pkgs/flarum/php-packages.nix

+composerEnv.buildPackage {
+  inherit packages devPackages noDev;
+  name = "flarum-flarum";
+  src = composerEnv.filterSrc ./.;


Yeah, this is what I feared. composer2nix makes a few assumptions here that we can't work around without ripping open the whole thing. @infinisil is still working on file set combinators, but we may get enough of it into Nixpkgs for you to use.

commit 670a5c4 Author: Jack Leightcap <jack.leightcap@trailofbits.com> Date: Thu Jul 20 20:13:08 2023 -0400 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/php-packages.nix commit 29f6b9c Author: Albert Chae <albertchae@users.noreply.github.com> Date: Thu Jul 20 16:55:51 2023 -0700 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix.bak commit 743fcc3 Author: Jack Leightcap <jack.leightcap@trailofbits.com> Date: Thu Jul 20 19:35:17 2023 -0400 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/php-packages.nix commit 084ed40 Author: Jack Leightcap <jack.leightcap@trailofbits.com> Date: Thu Jul 20 18:24:17 2023 -0400 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/composer-env.nix commit 3faa9a6 Author: Albert Chae <albertchae@users.noreply.github.com> Date: Thu Jul 20 15:06:24 2023 -0700 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix commit efcd4b2 Author: Jason Odoom <jasonodoom@gmail.com> Date: Thu Jul 20 17:56:57 2023 -0400 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix commit 8645907 Author: Dominic Mills <dominic.millz27@gmail.com> Date: Thu Jul 20 16:38:57 2023 -0500 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix commit 7649658 Author: Anish Lakhwara <anish+git@lakhwara.com> Date: Thu Jul 20 14:27:08 2023 -0700 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix commit 5cca401 Author: Jack Leightcap <jack.leightcap@trailofbits.com> Date: Thu Jul 20 17:16:08 2023 -0400 mob next [ci-skip] [ci skip] [skip ci] lastFile:pkgs/flarum/default.nix commit 2f38aa2 Author: Jack Leightcap <jack.leightcap@trailofbits.com> Date: Thu Jul 20 17:07:20 2023 -0400 mob start [ci-skip] [ci skip] [skip ci] Co-authored-by: Jason Odoom <jasonodoom@gmail.com> Co-authored-by: Anish Lakhwara <anish+git@lakhwara.com> Co-authored-by: Dominic Mills <dominic.millz27@gmail.com> Co-authored-by: Albert Chae <albertchae@users.noreply.github.com> Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

…arum

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

…dfcffbd74fd6f0419370d8240e445252a39f4d10/pkgs/servers/web-apps/pixelfed

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

copy installPhase build script from closed PR NixOS/nixpkgs#96869 fix typo

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

albertchae and others added 16 commits July 18, 2023 15:21

mob start [ci-skip] [ci skip] [skip ci]

13fd40b

mob next [ci-skip] [ci skip] [skip ci]

154c914

lastFile:README.md

mob next [ci-skip] [ci skip] [skip ci]

fc5b003

lastFile:README.md

mob next [ci-skip] [ci skip] [skip ci]

7790c80

lastFile:README.md

mob next [ci-skip] [ci skip] [skip ci]

6a9089f

lastFile:README.md

mob next [ci-skip] [ci skip] [skip ci]

94f8a5e

lastFile:README.md

mob start [ci-skip] [ci skip] [skip ci]

2f38aa2

mob next [ci-skip] [ci skip] [skip ci]

5cca401

lastFile:pkgs/flarum/default.nix

mob next [ci-skip] [ci skip] [skip ci]

7649658

lastFile:pkgs/flarum/default.nix

mob next [ci-skip] [ci skip] [skip ci]

8645907

lastFile:pkgs/flarum/default.nix

mob next [ci-skip] [ci skip] [skip ci]

efcd4b2

lastFile:pkgs/flarum/default.nix

mob next [ci-skip] [ci skip] [skip ci]

3faa9a6

lastFile:pkgs/flarum/default.nix

mob next [ci-skip] [ci skip] [skip ci]

084ed40

lastFile:pkgs/flarum/composer-env.nix

mob next [ci-skip] [ci skip] [skip ci]

743fcc3

lastFile:pkgs/flarum/php-packages.nix

mob next [ci-skip] [ci skip] [skip ci]

29f6b9c

lastFile:pkgs/flarum/default.nix.bak

undo README changes when learning mob.sh

b31dc42

albertchae commented Jul 21, 2023

View reviewed changes

albertchae mentioned this pull request Jul 21, 2023

Flarum #10

Closed

fricklerhandwerk reviewed Jul 21, 2023

View reviewed changes

jleightcap and others added 8 commits July 24, 2023 17:27

Merge branch 'moss-flarum' of github.com:ngi-nix/ngipkgs into moss-fl…

8e9ddc4

…arum

flarum: jack

65fa58e

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

Copied structure from pixelfed https://github.com/NixOS/nixpkgs/tree/…

fb7aac9

…dfcffbd74fd6f0419370d8240e445252a39f4d10/pkgs/servers/web-apps/pixelfed

flarum: lockfile sync

24e6d04

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

Pull from albertchae fork

3e36923

Use albertchae/flarum fork which has composer.lock committed

dc7176e

copy installPhase build script from closed PR NixOS/nixpkgs#96869 fix typo

flarum: init module

f4fdd6a

Signed-off-by: Jack Leightcap <jack.leightcap@trailofbits.com>

jleightcap closed this Aug 3, 2023

jleightcap mentioned this pull request Aug 3, 2023

flarum: package definition #32

Merged

albertchae deleted the moss-flarum branch August 3, 2023 23:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Mob moss work on packaging flarum #23

[WIP] Mob moss work on packaging flarum #23

albertchae commented Jul 21, 2023 •

edited

Loading

albertchae Jul 21, 2023 •

edited

Loading

albertchae Jul 21, 2023

fricklerhandwerk Jul 21, 2023

albertchae Jul 21, 2023

fricklerhandwerk Jul 21, 2023

fricklerhandwerk Jul 21, 2023

		@@ -0,0 +1,35 @@
		{ stdenv, fetchFromGitHub, php, phpPackages, ... }:

-    builtins.filterSource (path: type: type != "directory" || (baseNameOf path != ".git" && baseNameOf path != ".git" && baseNameOf path != ".svn")) src;
+    let
+      flarum-src = builtins.fetchTarball ...;
+      # hardcode flarum source here. not great
+      filtered-src = builtins.filterSource (path: type: type != "directory" || (baseNameOf path != ".git" && baseNameOf path != ".git" && baseNameOf path != ".svn")) flarum-src;
+    # combine what with what's actually in this source tree
+    in pkgs.symlinkJoin [ src filtered-src ];

[WIP] Mob moss work on packaging flarum #23

[WIP] Mob moss work on packaging flarum #23

Conversation

albertchae commented Jul 21, 2023 • edited Loading

albertchae Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

albertchae Jul 21, 2023

Choose a reason for hiding this comment

fricklerhandwerk Jul 21, 2023

Choose a reason for hiding this comment

albertchae Jul 21, 2023

Choose a reason for hiding this comment

fricklerhandwerk Jul 21, 2023

Choose a reason for hiding this comment

fricklerhandwerk Jul 21, 2023

Choose a reason for hiding this comment

albertchae commented Jul 21, 2023 •

edited

Loading

albertchae Jul 21, 2023 •

edited

Loading