[bug#62684] [PATCH] gnu: Zstandard: Update to 1.5.5.

[bug#62684] [PATCH] gnu: Zstandard: Update to 1.5.5.

[Leo Famulari]

This fixes a corruption bug:

https://github.com/facebook/zstd/releases/tag/v1.5.5

* gnu/packages/compression.scm (zstd)[replacement]: New field.
(zstd-1.5.5): New variable.
---
 gnu/packages/compression.scm | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/gnu/packages/compression.scm b/gnu/packages/compression.scm
index e58fd65e49..8a78fee107 100644
--- a/gnu/packages/compression.scm
+++ b/gnu/packages/compression.scm
@@ -1635,6 +1635,7 @@ (define-public unshield
 (define-public zstd
   (package
     (name "zstd")
+    (replacement zstd-1.5.5)
     (version "1.5.0")
     (source
      (origin
@@ -1721,6 +1722,18 @@ (define-public zstd
                    license:public-domain ; zlibWrapper/examples/fitblk*
                    license:zlib))))      ; zlibWrapper/{gz*.c,gzguts.h}
 
+(define-public zstd-1.5.5
+  (package
+    (inherit zstd)
+    (version "1.5.5")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "https://github.com/facebook/zstd/releases/download/"
+                           "v" version "/zstd-" version ".tar.gz"))
+       (sha256
+        (base32 "1r1ydmj7ib3g5372yj3k40vl3b9ax0154qg2lqcy7ylwhb69chww"))))))
+
 (define-public pzstd
   (package/inherit zstd
     (name "pzstd")
-- 
2.39.1

[bug#62684] [PATCH] gnu: Zstandard: Update to 1.5.5.

[Leo Famulari]

I've updated my packages based on this patch. So far, so good.

[bug#62684] [PATCH] gnu: Zstandard: Update to 1.5.5.

[Simon Tournier]

Hi Leo,

On mer., 05 avril 2023 at 15:26, Leo Famulari <leo@famulari.name> wrote:

> +    (replacement zstd-1.5.5)
>      (version "1.5.0")

[...]

> +(define-public zstd-1.5.5
> +  (package
> +    (inherit zstd)
> +    (version "1.5.5")
> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (string-append "https://github.com/facebook/zstd/releases/download/"
> +                           "v" version "/zstd-" version ".tar.gz"))
> +       (sha256
> +        (base32 "1r1ydmj7ib3g5372yj3k40vl3b9ax0154qg2lqcy7ylwhb69chww"))))))

I am always confused by the implication of such change.

--8<---------------cut here---------------start------------->8---
$ ./pre-inst-env guix show zstd | recsel -p name,version
name: zstd
version: 1.5.5

name: zstd
version: 1.5.0

$ ./pre-inst-env guix build zstd@1.5.0
/gnu/store/g8cl62bmsdsqn14yxghdl882zn0ls8n9-zstd-1.5.5-lib
/gnu/store/b980xf8i6qmx7iaih1bfnqvaihg37p3b-zstd-1.5.5
/gnu/store/6iysnbm6rb9hm61f7jsqgiry5l9v9yca-zstd-1.5.5-static

$ ./pre-inst-env guix build zstd@1.5.0 --no-grafts
/gnu/store/3x3dl71d4xm6y4hjwq110hmfyfx0xc6j-zstd-1.5.0-lib
/gnu/store/bn6pk5zjjdpdfzb6yfr5psi9pji9w51n-zstd-1.5.0
/gnu/store/wa5pngf2lywgi8vd8k9b1k13wp2acvi4-zstd-1.5.0-static
--8<---------------cut here---------------end--------------->8---

Well, maybe something like:

--8<---------------cut here---------------start------------->8---
diff --git a/gnu/packages/compression.scm b/gnu/packages/compression.scm
index 8a78fee107..5841ea0cf0 100644
--- a/gnu/packages/compression.scm
+++ b/gnu/packages/compression.scm
@@ -1637,6 +1637,7 @@ (define-public zstd
     (name "zstd")
     (replacement zstd-1.5.5)
     (version "1.5.0")
+    (properties `((hidden? . #true)))
     (source
      (origin
        (method url-fetch)
@@ -1726,6 +1727,7 @@ (define-public zstd-1.5.5
   (package
     (inherit zstd)
     (version "1.5.5")
+    (properties '())
     (source
      (origin
        (method url-fetch)
--8<---------------cut here---------------end--------------->8---

would be less confusing.

Note this discussion [1] about similar examples.  And this patch [2] as
an attempt to address the UX issue.

1: https://yhetil.org/guix/86czvohn86.fsf@gmail.com/
2: https://yhetil.org/guix/86im5a6ea4.fsf@gmail.com

Cheers,
simon

[bug#62684] [PATCH] gnu: Zstandard: Update to 1.5.5.

[Leo Famulari]

On Fri, Apr 07, 2023 at 12:52:40PM +0200, Simon Tournier wrote:
> Well, maybe something like:
[...]
> +    (properties `((hidden? . #true)))

Yes, thank you. Please see version 2 of the patch.

I tried using the HIDDEN-PACKAGE procedure for zstd@1.5.0. It doesn't
change the derivation, which is good, but I don't know how to un-hide
the replacement. So this is good enough, I think.

[bug#62684] [PATCH v2] gnu: Zstandard: Update to 1.5.5.

[Leo Famulari]

This fixes a corruption bug:

https://github.com/facebook/zstd/releases/tag/v1.5.5

* gnu/packages/compression.scm (zstd)[replacement]: New field.
(zstd-1.5.5): New variable.
---
 gnu/packages/compression.scm | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/gnu/packages/compression.scm b/gnu/packages/compression.scm
index e58fd65e49..1187d12421 100644
--- a/gnu/packages/compression.scm
+++ b/gnu/packages/compression.scm
@@ -1635,6 +1635,13 @@ (define-public unshield
 (define-public zstd
   (package
     (name "zstd")
+    ;; Replace to the data corruption bug fixed in Zstd 1.5.5.
+    ;; https://github.com/facebook/zstd/releases/tag/v1.5.5
+    (replacement zstd-1.5.5)
+    ;; Hide this buggy package in the Guix UI. If you add another
+    ;; property to this package, adjust the properties in the package
+    ;; replacement accordingly.
+    (properties `((hidden? . #true)))
     (version "1.5.0")
     (source
      (origin
@@ -1721,6 +1728,20 @@ (define-public zstd
                    license:public-domain ; zlibWrapper/examples/fitblk*
                    license:zlib))))      ; zlibWrapper/{gz*.c,gzguts.h}
 
+(define-public zstd-1.5.5
+  (package
+    (inherit zstd)
+    ;; Don't hide this package from the UI.
+    (properties '())
+    (version "1.5.5")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "https://github.com/facebook/zstd/releases/download/"
+                           "v" version "/zstd-" version ".tar.gz"))
+       (sha256
+        (base32 "1r1ydmj7ib3g5372yj3k40vl3b9ax0154qg2lqcy7ylwhb69chww"))))))
+
 (define-public pzstd
   (package/inherit zstd
     (name "pzstd")
-- 
2.39.2

bug#62684: [PATCH v2] gnu: Zstandard: Update to 1.5.5.

[Leo Famulari]

On Sat, Apr 08, 2023 at 01:07:12PM -0400, Leo Famulari wrote:
> This fixes a corruption bug:
> 
> https://github.com/facebook/zstd/releases/tag/v1.5.5
> 
> * gnu/packages/compression.scm (zstd)[replacement]: New field.
> (zstd-1.5.5): New variable.

Pushed as 60c97c60a53686ec321eb541b85e01b6decc2014