nix-shell icon indicating copy to clipboard operation
nix-shell copied to clipboard

defaultExtensions are way too fat, resulting in long installation times

Open ostrolucky opened this issue 1 year ago • 19 comments

Running eg. nix develop github:loophp/nix-shell#php74 in folder with composer.json that has no ext- sections takes still quite long time. I can see it compiling things like gd, mysql, iconv and so on which are not needed at all. Is it possible to either improve the speed of installing these (binaries instead of having to compile it? Installing multiple extensions at the same time, or at least each with -J flag?), or skip them? Otherwise amazing feature of this shell, which is auto-installation of extensions from composer.json is quite under-utilized.

ostrolucky avatar Feb 08 '23 22:02 ostrolucky

Hey hi!

Have you added nix-shell in Cachix ? This will actually download binaries instead of compiling stuff.

Let me know if you need help to enable it!

Cheers

drupol avatar Feb 08 '23 22:02 drupol

Unfortunately Cachix doesn't seem to do anything on my machine, because I have m1 arm64 and there are no build artifacts for this machine published. What's worse, Github doesn't seem to have such runners at the moment https://github.com/actions/runner-images/issues/5631 (although it's possible to use self-hosted ones, or buildjet ones but that's not free)

This could be important:

➜  ~ uname -a
Darwin PL00562-3.local 22.3.0 Darwin Kernel Version 22.3.0: Thu Jan  5 20:48:54 PST 2023; root:xnu-8792.81.2~2/RELEASE_ARM64_T6000 arm64

ostrolucky avatar Feb 09 '23 14:02 ostrolucky

Dear @ostrolucky ,

I aksed on the Nix PHP Matrix channel.

The issue comes from the fact that we merged the latest update of PHP without making sure that it was successfully built on that architecture.

If cannot be built (due to test or otherwise) it cannot be cached

@LeSuisse partially fixed the issue in https://github.com/NixOS/nixpkgs/pull/215004 but it seems that there is another issue here https://github.com/NixOS/nixpkgs/pull/215220.

I believe we need to wait the next release of PHP to make sure it builds correctly, unless there is an alternative, maybe @LeSuisse might know more than me on this?

drupol avatar Feb 09 '23 16:02 drupol

Yes there is one remaining flaky test on darwin, I opened https://github.com/NixOS/nixpkgs/pull/215539 so we can work around it and have everything in cache.nixos.org again.

Note that is note the last PHP upgrade that caused the issue, it seems it is the case for quite a while (I did not bother further than that in time).

LeSuisse avatar Feb 09 '23 17:02 LeSuisse

Thanks @LeSuisse, let's bury that issue in your new PR :)

drupol avatar Feb 09 '23 17:02 drupol

Thanks patch has been merged :tada: !

We just need to wait for the next hydra iteration (https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents) and you'll be able to use the binaries from the cache!

Thanks @LeSuisse and @etu !

drupol avatar Feb 10 '23 10:02 drupol

@ostrolucky I think it should be fixed by now. Can you try ?

drupol avatar Feb 13 '23 10:02 drupol

@drupol Another thing to consider is that PHP 7.4 isn't cached by hydra since it's not a supported version in nixpkgs. Do you have a separate cache somewhere?

etu avatar Feb 13 '23 10:02 etu

Yes, we do have fossar :) but it's not building for M1 architecture since it's not available on Github actions.

image

drupol avatar Feb 13 '23 10:02 drupol

I had to do nix channel --update first, right?

Following extensions are still being built php-amqp, php-dom php-mysqlnd php-xdebug php-mysqli php-pdo_mysql php-xmlreader

but rest seems not, so I would say that's a big improvement :)

ostrolucky avatar Feb 13 '23 11:02 ostrolucky

No, we don't use channels, we just use the flake feature, I never liked the idea of using channels.

To try correctly, do:

  1. rm -rf ~/.cache/nix
  2. nix run nixpkgs#php82 -- -v
  3. That said, it is possible that extensions that are not enabled by default in PHP are being built locally on your machine.

And that should be quite fast now :)

drupol avatar Feb 13 '23 14:02 drupol

Still same thing with above listed 7 extensions, but yeah it's good enough now I would say. But I think we can still remove these php-dom php-mysqlnd php-mysqli php-pdo_mysql php-xmlreader from here https://github.com/loophp/nix-shell/blob/24b06707a15ebb08b8ff837137398d886e512096/src/phps.nix#L5-L43 right? Or how can we convince upstream php pkg to include these packages by default?

ostrolucky avatar Feb 13 '23 15:02 ostrolucky

I will think about it but if we want to convince upstream to have those enabled by default, then we have to motivate the request in an issue on NixOS/nixpkgs.

This is also something that we should discuss with the PHP Maintainers team (@jtojnar, @etu, @aanderse, etc etc... )

What you could also do to avoid compilation time is to not use loophp/nix-shell and use php from nixpkgs only in the meantime.

drupol avatar Feb 13 '23 15:02 drupol

It's not a very hard change to implement, however, it's a breaking change.

Here's the steps of what we need to do to do that breaking change:

  1. Decide which the new defaults should be (and a good motivation for this, the current defaults haven't been decided recently, they where decided many years ago before PHP in Nix was modular so to enable a module you needed to compile the whole thing.
  2. Then we need to alter the three files (one for each supported version) 8.0 8.1 8.2 with the new defaults, however, this shouldn't just remove a bunch of things. Instead we should look at the stateVersion and make sure to not change the defaults if one is on an older version.
  3. Document it in the release notes.

etu avatar Feb 13 '23 15:02 etu

@etu are you sure this would be a breaking change? Here, we are suggesting adding extensions, not removing any. Why would this be considered a BC ?

drupol avatar Feb 13 '23 15:02 drupol

Oh, yeah, I misread that then... I'm however questioning if we have sensible defaults to begin with :smiley:

etu avatar Feb 13 '23 15:02 etu

I don't think we have indeed... We should really discuss that thing :)

drupol avatar Feb 13 '23 15:02 drupol

Oh crap,... the page I used to take inspiration from is no more existing.

drupol avatar Feb 13 '23 15:02 drupol

At https://symfony.com/doc/current/setup.html#technical-requirements only these extensions are listed:

  • ctype
  • iconv
  • PCRE
  • session
  • simplexml
  • tokenizer

ostrolucky avatar Mar 12 '23 22:03 ostrolucky