commit ac78ae80a43c9ab27a434c3d1c62176cf93b5296 · pyrox.dev/nixpkgs

+1 -1

doc/builders/fetchers.chapter.md

···

       6
        
       

     

       7
        
       Because fixed output derivations are _identified_ by their hash, a common mistake is to update a fetcher's URL or a version parameter, without updating the hash. **This will cause the old contents to be used.** So remember to always invalidate the hash argument.

     

       8
        
       

     

       9
       -
       For those who develop and maintain fetcheres, a similar problem arises with changes to the implementation of a fetcher. These may cause a fixed output derivation to fail, but won't normally be caught by tests because the supposed output is already in the store or cache. For the purpose of testing, you can use a trick that is embodied by the `invalidateFetcherByDrvHash` function. It uses the derivation `name` to create a unique output path per fetcher implementation, defeating the caching precisely where it would be harmful.

     

       10
        
       

     

       11
        
       ## `fetchurl` and `fetchzip` {#fetchurl}

     

       12

···

       6
        
       

     

       7
        
       Because fixed output derivations are _identified_ by their hash, a common mistake is to update a fetcher's URL or a version parameter, without updating the hash. **This will cause the old contents to be used.** So remember to always invalidate the hash argument.

     

       8
        
       

     

       9
       +
       For those who develop and maintain fetcheres, a similar problem arises with changes to the implementation of a fetcher. These may cause a fixed output derivation to fail, but won't normally be caught by tests because the supposed output is already in the store or cache. For the purpose of testing, you can use a trick that is embodied by the [`invalidateFetcherByDrvHash`](#sec-pkgs-invalidateFetcherByDrvHash) function. It uses the derivation `name` to create a unique output path per fetcher implementation, defeating the caching precisely where it would be harmful.

     

       10
        
       

     

       11
        
       ## `fetchurl` and `fetchzip` {#fetchurl}

     

       12

+1

doc/builders/special.xml

···

       7
        
        </para>

     

       8
        
        <xi:include href="special/fhs-environments.section.xml" />

     

       9
        
        <xi:include href="special/mkshell.section.xml" />

     

       0
        
       
     

       10
        
       </chapter>

···

       7
        
        </para>

     

       8
        
        <xi:include href="special/fhs-environments.section.xml" />

     

       9
        
        <xi:include href="special/mkshell.section.xml" />

     

       10
       +
        <xi:include href="special/invalidateFetcherByDrvHash.section.xml" />

     

       11
        
       </chapter>

+31

doc/builders/special/invalidateFetcherByDrvHash.section.md

···

       1
       +
       

     

       2
       +
       ## `invalidateFetcherByDrvHash` {#sec-pkgs-invalidateFetcherByDrvHash}

     

       3
       +
       

     

       4
       +
       Use the derivation hash to invalidate the output via name, for testing.

     

       5
       +
       

     

       6
       +
       Type: `(a@{ name, ... } -> Derivation) -> a -> Derivation`

     

       7
       +
       

     

       8
       +
       Normally, fixed output derivations can and should be cached by their output

     

       9
       +
       hash only, but for testing we want to re-fetch everytime the fetcher changes.

     

       10
       +
       

     

       11
       +
       Changes to the fetcher become apparent in the drvPath, which is a hash of

     

       12
       +
       how to fetch, rather than a fixed store path.

     

       13
       +
       By inserting this hash into the name, we can make sure to re-run the fetcher

     

       14
       +
       every time the fetcher changes.

     

       15
       +
       

     

       16
       +
       This relies on the assumption that Nix isn't clever enough to reuse its

     

       17
       +
       database of local store contents to optimize fetching.

     

       18
       +
       

     

       19
       +
       You might notice that the "salted" name derives from the normal invocation,

     

       20
       +
       not the final derivation. `invalidateFetcherByDrvHash` has to invoke the fetcher

     

       21
       +
       function twice: once to get a derivation hash, and again to produce the final

     

       22
       +
       fixed output derivation.

     

       23
       +
       

     

       24
       +
       Example:

     

       25
       +
       

     

       26
       +
           tests.fetchgit = invalidateFetcherByDrvHash fetchgit {

     

       27
       +
             name = "nix-source";

     

       28
       +
             url = "https://github.com/NixOS/nix";

     

       29
       +
             rev = "9d9dbe6ed05854e03811c361a3380e09183f4f4a";

     

       30
       +
             sha256 = "sha256-7DszvbCNTjpzGRmpIVAWXk20P0/XTrWZ79KSOGLrUWY=";

     

       31
       +
           };

+2 -29

pkgs/top-level/all-packages.nix

···

       614
        
       

     

       615
        
         installShellFiles = callPackage ../build-support/install-shell-files {};

     

       616
        
       

     

       617
       -
         /*

     

       618
       -
           Use the derivation hash to invalidate the output via name, for testing

     

       619
       -
           purposes.

     

       620
       -
       

     

       621
       -
           Type: (a@{ name, ... } -> Derivation) -> a -> Derivation

     

       622
       -
       

     

       623
       -
           Normally, fixed output derivations can and should be cached by their output

     

       624
       -
           hash only, but for testing we want to re-fetch everytime the fetcher changes.

     

       625
       -
       

     

       626
       -
           Changes to the fetcher become apparent in the drvPath, which is a hash of

     

       627
       -
           how to fetch, rather than a fixed store path.

     

       628
       -
           By inserting this hash into the name, we can make sure to re-run the fetcher

     

       629
       -
           every time the fetcher changes.

     

       630
       -
       

     

       631
       -
           This relies on the assumption that Nix isn't clever enough to reuse its

     

       632
       -
           database of local store contents to optimize fetching.

     

       633
       -
       

     

       634
       -
           Note that the "salt" derives from a different drv than the final fetcher

     

       635
       -
           drv. This is necessary, because it can not be defined recursively.

     

       636
       -
       

     

       637
       -
           Example:

     

       638
       -
       

     

       639
       -
             tests.fetchgit = invalidateFetcherByDrvHash fetchgit {

     

       640
       -
               name = "nix-source";

     

       641
       -
               url = "https://github.com/NixOS/nix";

     

       642
       -
               rev = "9d9dbe6ed05854e03811c361a3380e09183f4f4a";

     

       643
       -
               sha256 = "sha256-7DszvbCNTjpzGRmpIVAWXk20P0/XTrWZ79KSOGLrUWY=";

     

       644
       -
             };

     

       645
       -
         */

     

       646
        
         invalidateFetcherByDrvHash = f: args:

     

       647
        
           let

     

       648
        
             drvPath = (f args).drvPath;

···

       614
        
       

     

       615
        
         installShellFiles = callPackage ../build-support/install-shell-files {};

     

       616
        
       

     

       617
       +
         # See doc/builders/special/invalidateFetcherByDrvHash.section.md or

     

       618
       +
         # https://nixos.org/manual/nixpkgs/unstable/#sec-pkgs-invalidateFetcherByDrvHash

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       619
        
         invalidateFetcherByDrvHash = f: args:

     

       620
        
           let

     

       621
        
             drvPath = (f args).drvPath;