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

factorio: fail fetch early if no credentials provided #104732

Merged
merged 1 commit into from Nov 24, 2020

Conversation

lukegb
Copy link
Contributor

@lukegb lukegb commented Nov 24, 2020

Motivation for this change

The download URL will redirect to the login page if credentials are not
present, but will return an error if the credentials are wrong.

Since we know we always expect credentials, we can fail the fetch in
the preHook if they're not provided.

We can't use e.g. builtins.throw because we want the fetchurl derivation
to be evaluated in all cases - because that's the mechanism which allows
you to just manually add the tarball to the Nix store.

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.

Manually tested with:

  • nix-build . -A factorio - fails, as expected
  • nix-build -E '((import ./. {}).factorio.override { username = ...; token = ...; }' - works, as expected
  • nix-build -E '((import ./. {}).factorio.override { username = ...; token = "wrong"; }' - fails, as expected
  • nix-build -E '((import ./. {}).factorio.override { username = ...; }' - fails, as expected
  • nix-build -E '((import ./. {}).factorio.override { token = ...; }' - fails, as expected

The download URL will redirect to the login page if credentials are not
present, but will return an error if the credentials are wrong.

Since we know we always expect credentials, we can fail the fetch in
the preHook if they're not provided.

We can't use e.g. builtins.throw because we want the fetchurl derivation
to be evaluated in all cases - because that's the mechanism which allows
you to just manually add the tarball to the Nix store.
@lukegb
Copy link
Contributor Author

lukegb commented Nov 24, 2020

@erictapen @elitak @Baughn (because there's no actual diff I guess ofborg didn't add reviewers)

Copy link
Contributor

@elitak elitak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for finally solving this niggling issue.

@prusnak prusnak merged commit 2b884eb into NixOS:master Nov 24, 2020
@lukegb lukegb deleted the factorio-fail-if-no-creds branch December 5, 2022 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants