Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chatterino2: fix install on macOS #79067

Merged
merged 2 commits into from Feb 25, 2020
Merged

chatterino2: fix install on macOS #79067

merged 2 commits into from Feb 25, 2020

Conversation

@strager
Copy link
Contributor

@strager strager commented Feb 2, 2020

On Darwin/macOS, chatterino2's install phase copies no files into the output. make install does not copy chatterino2.app. Copy the .app manually, fixing the installation.

Additionally, apply a workaround for issue #42893. Otherwise, the installed .app crashes unless qtbase is separately installed in the user's environment.

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
On Darwin/macOS, chatterino2's install phase copies no files into the
output. `make install` does not copy chatterino2.app. Copy the .app
manually, fixing the installation.

With this patch, chatterino2 almost works on macOS. Issue #42893
applies, so to make chatterino2 work, you must install qtbase in your
environment. For example:

    $ nix-env -iA nixpkgs.qt5.qtbase
    $ open ~/.nix-profile/Applications/chatterino.app
@ofborg ofborg bot added the 6.topic: darwin label Feb 2, 2020
@Infinisil
Copy link
Member

@Infinisil Infinisil commented Feb 2, 2020

You should be able to use wrapQtAppsHook to not require the nix-env step, see https://nixos.org/nixpkgs/manual/#sec-language-qt and #54525

@strager
Copy link
Contributor Author

@strager strager commented Feb 2, 2020

You should be able to use wrapQtAppsHook to not require the nix-env step, see https://nixos.org/nixpkgs/manual/#sec-language-qt and #54525

Thanks for pointing this out to me! It looks like that feature has no effect on macOS binaries installed in Applications. I'll look into fixing that.

EDIT: Actually, it looks like wrapQtAppsHook's automatic wrapping is ELF-specific [1]. I'll explicitly call wrapQtApp here as a workaround.

[1]

patchelf --print-interpreter "$file" >/dev/null 2>&1 || continue

wrapQtAppsHook ignores Mach-O binaries [1]. Additionally, wrapQtAppsHook
doesn't look inside $out/Applications [2], which is where chatterino2 is
installed. This means chatterino2 for Darwin/macOS is not wrapped
properly, causing the following error when launched:

> qt.qpa.plugin: Could not find the Qt platform plugin "cocoa" in ""
>
> This application failed to start because no Qt platform plugin could
> be initialized. Reinstalling the application may fix this problem.

On macOS, explicitly wrap chatterino2's executable.

[1] pkgs/development/libraries/qt-5/hooks/wrap-qt-apps-hook.sh line 85
[2] pkgs/development/libraries/qt-5/hooks/wrap-qt-apps-hook.sh line 76
@Infinisil
Copy link
Member

@Infinisil Infinisil commented Feb 2, 2020

Ohh nice find, would be good if this was fixed in wrapQtAppsHook directly

@@ -10,8 +10,15 @@ mkDerivation rec {
sha256 = "0i2385hamhd9i7jdy906cfrd81cybw524j92l87c8pzrkxphignk";
fetchSubmodules = true;
};
nativeBuildInputs = [ qmake pkgconfig ];
nativeBuildInputs = [ qmake pkgconfig wrapQtAppsHook ];

This comment has been minimized.

@worldofpeace

worldofpeace Feb 2, 2020
Member

this already uses the custom deriver that add wrapQtAppsHook, so you don't need to add it here explicitly.

This comment has been minimized.

@strager

strager Feb 2, 2020
Author Contributor

I understand that the dependency is implied. I think it's clearer if the dependency is explicit, though.

This comment has been minimized.

@worldofpeace

worldofpeace Feb 3, 2020
Member

It's not implied, the deriver adds the dependency by design, and in 19.09 we had fix several 100+ expressions to use mkDerivation instead of stdenv.mkDerivation because people didn't read the docs.
It was even requested in the PR that initially was meant fix this #78296 https://github.com/NixOS/nixpkgs/compare/c2ce79000873d1936c07ec0261c200927c2bb40c..717c2207c2a0fe702ff678af230e583e05deb177

This comment has been minimized.

@strager

strager Feb 3, 2020
Author Contributor

It's not implied, the deriver adds the dependency by design

That's what I meant when I said "the dependency is implied". The dependency is implied when using mkDerivation from pkgs/development/libraries/qt-5/mkDerivation.nix (instead of stdenv.mkDerivation).

On line 20, we call wrapQtApp in postFixup (on Darwin). wrapQtApp requires a dependency on wrapQtAppsHook. That's why I added the dependency here on line 13. If expressing the dependency here is a bug, let me know so I can remove it. My current understanding is that expressing the dependency here is merely optional.

@strager strager mentioned this pull request Feb 23, 2020
4 of 10 tasks complete
@strager
Copy link
Contributor Author

@strager strager commented Feb 23, 2020

ping

cc @rexim, @doronbehar

@doronbehar
Copy link
Contributor

@doronbehar doronbehar commented Feb 25, 2020

Can't test on darwin @strager Sorry :/.

@LnL7
LnL7 approved these changes Feb 25, 2020
@LnL7 LnL7 merged commit 1b5e9c4 into NixOS:master Feb 25, 2020
15 checks passed
15 checks passed
Evaluation Performance Report Evaluator Performance Report
Details
chatterino2 on aarch64-linux Success
Details
chatterino2 on x86_64-linux Success
Details
grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-darwin nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A darwin-tested
Details
grahamcofborg-eval-nixos nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release-combined.nix -A tested
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A manual
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A options
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A manual
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A tarball
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A unstable
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.