Subject: [bug#74900]

From: Daniel Khodabakhsh <[email-masked]>
Date: Sat, 28 Dec 2024 19:00:38 +0000

Tested the patch and ran into an issue that was introduced when I
shortened some lines to within 80 characters, fixed this now and also
included the additional rationale in the patch descriptions.
From e4ea7b88ce39b1f5b24818174f2e5c17424f3adc Mon Sep 17 00:00:00 2001
Message-ID: <e4ea7[email-masked]>
From: Daniel Khodabakhsh <[email-masked]>
Date: Thu, 26 Dec 2024 04:35:39 -0800
Subject: [PATCH] Replace (guix build json) with (json) in node build system

This change replaces the use of (guix build json) with (json) for the node ecosystem.
Since guile-json is a dependency of Guix, and it's used elsewhere in the project, it makes sense to use this instead of rolling our own JSON implementation with (guix build json).
(guix build json) also has a few issues:
 - write-json escapes forward slashes in strings for some reason ("/" become "\/")
 - read-json produces a structure similar to an association list but with '@' to indicate an object, making it not possible to use association list procedures directly.
This is one step to move away from (guix build json), there will be other changes to remove the other uses of it.

Signed-off-by: Daniel Khodabakhsh <[email-masked]>
Change-Id: I9fd5152a98b6a241d414e9a94ab179c9cabcfb85
---
 gnu/packages/node-xyz.scm        | 148 ++++++++++++-------------
 guix/build-system/node.scm       |   6 +-
 guix/build/node-build-system.scm | 180 ++++++++++++-------------------
 3 files changed, 139 insertions(+), 195 deletions(-)

diff --git a/gnu/packages/node-xyz.scm b/gnu/packages/node-xyz.scm
index e98eda2a01..ec3f9fbfb1 100644
--- a/gnu/packages/node-xyz.scm
+++ b/gnu/packages/node-xyz.scm
@@ -7,6 +7,7 @@
 ;;; Copyright © 2021 Dhruvin Gandhi <[email-masked]>
 ;;; Copyright © 2022 Nicolas Graves <[email-masked]>
 ;;; Copyright © 2023 Jelle Licht <[email-masked]>
+;;; Copyright © 2024 Daniel Khodabakhsh <[email-masked]>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -24,14 +25,14 @@
 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
 
 (define-module (gnu packages node-xyz)
-  #:use-module ((guix licenses) #:prefix license:)
   #:use-module (gnu packages sqlite)
   #:use-module (gnu packages python)
   #:use-module (gnu packages web)
+  #:use-module (guix build-system node)
   #:use-module (guix gexp)
-  #:use-module (guix packages)
   #:use-module (guix git-download)
-  #:use-module (guix build-system node))
+  #:use-module ((guix licenses) #:prefix license:)
+  #:use-module (guix packages))
 
 ;;;
 ;;; Please: Try to add new module packages in alphabetic order.
@@ -69,19 +70,17 @@ (define-public node-acorn
              ;; it would try to use the build environment and would block the
              ;; automatic building by other packages making use of node-acorn.
              ;; TODO: Add utility function
-             (with-atomic-json-file-replacement "package.json"
-               (match-lambda
-                 (('@ . pkg-meta-alist)
-                  (cons '@ (map (match-lambda
-                                  (("scripts" @ . scripts-alist)
-                                   `("scripts" @ ,@(filter (match-lambda
-                                                             (("prepare" . _)
-                                                              #f)
-                                                             (_
-                                                              #t))
-                                                           scripts-alist)))
-                                  (other other))
-                                pkg-meta-alist)))))))
+             (with-atomic-json-file-replacement (lambda (pkg-meta-alist)
+               (map
+                 (match-lambda
+                   (("scripts" . scripts-alist)
+                     (cons "scripts" (filter
+                       (match-lambda
+                         (("prepare" . _) #f)
+                         (_ #t))
+                       scripts-alist)))
+                   (other other))
+                 pkg-meta-alist)))))
          (replace 'build
            (lambda* (#:key inputs native-inputs #:allow-other-keys)
              (let ((esbuild (search-input-file (or native-inputs inputs)
@@ -158,23 +157,17 @@ (define-public node-addon-api
            (lambda args
              (define new-test-script
                "echo stopping after pretest on Guix")
-             (with-atomic-json-file-replacement "package.json"
-               (match-lambda
-                 (('@ . pkg-meta-alist)
-                  (cons
-                   '@
-                   (map (match-lambda
-                          (("scripts" '@ . scripts-alist)
-                           `("scripts" @ ,@(map (match-lambda
-                                                  (("test" . _)
-                                                   (cons "test"
-                                                         new-test-script))
-                                                  (other
-                                                   other))
-                                                scripts-alist)))
-                          (other
-                           other))
-                        pkg-meta-alist))))))))))
+             (with-atomic-json-file-replacement (lambda (pkg-meta-alist)
+               (map
+                 (match-lambda
+                   (("scripts" . scripts-alist)
+                     (cons "scripts" (map
+                       (match-lambda
+                         (("test" . _) (cons "test" new-test-script))
+                         (other other))
+                       scripts-alist)))
+                   (other other))
+                 pkg-meta-alist))))))))
     (home-page "https://github.com/nodejs/node-addon-api")
     (synopsis "Node.js API (Node-API) header-only C++ wrappers")
     (description "This module contains header-only C++ wrapper classes which
@@ -1223,22 +1216,19 @@ (define-public node-serialport-bindings
                                     "node-abi"))))
          (add-after 'chdir 'avoid-prebuild-install
            (lambda args
-             (with-atomic-json-file-replacement "package.json"
-               (match-lambda
-                 (('@ . pkg-meta-alist)
-                  (cons '@ (map (match-lambda
-                                  (("scripts" @ . scripts-alist)
-                                   `("scripts" @ ,@(filter (match-lambda
-                                                             (("install" . _)
-                                                              #f)
-                                                             (_
-                                                              #t))
-                                                           scripts-alist)))
-                                  (("gypfile" . _)
-                                   '("gypfile" . #f))
-                                  (other
-                                   other))
-                                pkg-meta-alist))))))))
+             (with-atomic-json-file-replacement (lambda (pkg-meta-alist)
+               (map
+                 (match-lambda
+                   (("scripts" . scripts-alist)
+                     (cons "scripts" (filter
+                       (match-lambda
+                         (("install" . _) #f)
+                         (_ #t))
+                       scripts-alist)))
+                   (("gypfile" . _)
+                     (cons "gypfile" #f))
+                   (other other))
+                 pkg-meta-alist))))))
        #:tests? #f))
     (synopsis "Abstract base class for Node SerialPort bindings")
     (description "Node SerialPort is a modular suite of Node.js packages for
@@ -1524,39 +1514,33 @@ (define-public node-sqlite3
              (substitute* ".npmignore"
                (("lib/binding")
                 "#lib/binding # <- patched for Guix"))
-             (with-atomic-json-file-replacement "package.json"
-               (match-lambda
-                 (('@ . pkg-meta-alist)
-                  (match (assoc-ref pkg-meta-alist "binary")
-                    (('@ . binary-alist)
-                     ;; When it builds from source, node-pre-gyp supplies
-                     ;; module_name and module_path based on the entries under
-                     ;; "binary" from "package.json", so this package's
-                     ;; "binding.gyp" doesn't define them. Thus, we also need
-                     ;; to supply them. The GYP_DEFINES environment variable
-                     ;; turns out to be the easiest way to make sure they are
-                     ;; propagated from npm to node-gyp to gyp.
-                     (setenv "GYP_DEFINES"
-                             (string-append
-                              "module_name="
-                              (assoc-ref binary-alist "module_name")
-                              " "
-                              "module_path="
-                              (assoc-ref binary-alist "module_path")))))
-                  ;; We need to remove the install script from "package.json",
-                  ;; as it would try to use node-pre-gyp and would block the
-                  ;; automatic building performed by `npm install`.
-                  (cons '@ (map (match-lambda
-                                  (("scripts" @ . scripts-alist)
-                                   `("scripts" @ ,@(filter (match-lambda
-                                                             (("install" . _)
-                                                              #f)
-                                                             (_
-                                                              #t))
-                                                           scripts-alist)))
-                                  (other
-                                   other))
-                                pkg-meta-alist))))))))))
+             (with-atomic-json-file-replacement (lambda (pkg-meta-alist)
+               (let ((binary-alist (assoc-ref pkg-meta-alist "binary")))
+                 ;; When it builds from source, node-pre-gyp supplies
+                 ;; module_name and module_path based on the entries under
+                 ;; "binary" from "package.json", so this package's
+                 ;; "binding.gyp" doesn't define them. Thus, we also need
+                 ;; to supply them. The GYP_DEFINES environment variable
+                 ;; turns out to be the easiest way to make sure they are
+                 ;; propagated from npm to node-gyp to gyp.
+                 (setenv "GYP_DEFINES" (string-append
+                   "module_name="
+                   (assoc-ref binary-alist "module_name")
+                   " module_path="
+                   (assoc-ref binary-alist "module_path"))))
+               ;; We need to remove the install script from "package.json",
+               ;; as it would try to use node-pre-gyp and would block the
+               ;; automatic building performed by `npm install`.
+               (map
+                 (match-lambda
+                   (("scripts" . scripts-alist)
+                     (cons "scripts" (filter
+                       (match-lambda
+                         (("install" . _) #f)
+                         (_ #t))
+                       scripts-alist)))
+                   (other other))
+                 pkg-meta-alist))))))))
     (home-page "https://github.com/mapbox/node-sqlite3")
     (synopsis "Node.js bindings for SQLite3")
     (description
diff --git a/guix/build-system/node.scm b/guix/build-system/node.scm
index 57fe5f6030..425b8cd9b3 100644
--- a/guix/build-system/node.scm
+++ b/guix/build-system/node.scm
@@ -4,6 +4,7 @@
 ;;; Copyright © 2021 Ludovic Courtès <[email-masked]>
 ;;; Copyright © 2021 Pierre Langlois <[email-masked]>
 ;;; Copyright © 2021 Philip McGrath <[email-masked]>
+;;; Copyright © 2024 Daniel Khodabakhsh <[email-masked]>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -36,7 +37,10 @@ (define-module (guix build-system node)
 (define %node-build-system-modules
   ;; Build-side modules imported by default.
   `((guix build node-build-system)
-    (guix build json)
+    (json)
+    (json builder)
+    (json parser)
+    (json record)
     ,@%default-gnu-imported-modules))
 
 (define (default-node)
diff --git a/guix/build/node-build-system.scm b/guix/build/node-build-system.scm
index fb23894bc1..df7ea7774c 100644
--- a/guix/build/node-build-system.scm
+++ b/guix/build/node-build-system.scm
@@ -4,6 +4,7 @@
 ;;; Copyright © 2019, 2021 Timothy Sample <[email-masked]>
 ;;; Copyright © 2021, 2022 Philip McGrath <[email-masked]>
 ;;; Copyright © 2022 Liliana Marie Prikler <[email-masked]>
+;;; Copyright © 2024 Daniel Khodabakhsh <[email-masked]>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -23,10 +24,10 @@
 (define-module (guix build node-build-system)
   #:use-module ((guix build gnu-build-system) #:prefix gnu:)
   #:use-module (guix build utils)
-  #:use-module (guix build json)
   #:use-module (ice-9 ftw)
   #:use-module (ice-9 regex)
   #:use-module (ice-9 match)
+  #:use-module (json)
   #:use-module (srfi srfi-1)
   #:use-module (srfi srfi-71)
   #:export (%standard-phases
@@ -34,13 +35,14 @@ (define-module (guix build node-build-system)
             delete-dependencies
             node-build))
 
-(define (with-atomic-json-file-replacement file proc)
+(define* (with-atomic-json-file-replacement proc
+  #:optional (file "package.json"))
   "Like 'with-atomic-file-replacement', but PROC is called with a single
 argument---the result of parsing FILE's contents as json---and should a value
 to be written as json to the replacement FILE."
   (with-atomic-file-replacement file
     (lambda (in out)
-      (write-json (proc (read-json in)) out))))
+      (scm->json (proc (json->scm in)) out))))
 
 (define* (assoc-ref* alist key #:optional default)
   "Like assoc-ref, but return DEFAULT instead of #f if no value exists."
@@ -48,10 +50,6 @@ (define* (assoc-ref* alist key #:optional default)
     (#f default)
     ((_ . value) value)))
 
-(define* (jsobject-ref obj key #:optional default)
-  (match obj
-    (('@ . alist) (assoc-ref* alist key default))))
-
 (define* (alist-pop alist key #:optional (= equal?))
   "Return two values, the first pair in ALIST with key KEY, and the other
 elements.  Equality calls are made as (= KEY ALISTCAR)."
@@ -63,67 +61,17 @@ (define* (alist-pop alist key #:optional (= equal?))
         (values (car after) (append before (cdr after)))
         (values #f before))))
 
-(define* (alist-update alist key proc #:optional default (= equal?))
+(define* (alist-update alist key proc #:optional (= equal?))
   "Return an association list like ALIST, but with KEY mapped to the result of
 PROC applied to the first value found under the comparison (= KEY ALISTCAR).
-If no such value exists, use DEFAULT instead.
+If no such value exists, return the list unchanged.
 Unlike acons, this removes the previous association of KEY (assuming it is
 unique), but the result may still share storage with ALIST."
   (let ((pair rest (alist-pop alist key =)))
-    (acons key
-           (proc (if (pair? pair)
-                     (cdr pair)
-                     default))
-           rest)))
-
-(define (jsobject-update* js . updates)
-  "Return a json object like JS, but with all UPDATES applied.  Each update is
-a list (KEY PROC [DEFAULT]), so that KEY is mapped to the result of PROC
-applied to the value to which KEY is mapped in JS.  If no such mapping exists,
-PROC is instead applied to DEFAULT, or to '#f' is no DEFAULT is specified.
-The update takes place from left to right, so later UPDATERs will receive the
-values returned by earlier UPDATERs for the same KEY."
-  (match js
-    (('@ . alist)
-     (let loop ((alist alist)
-                (updates updates))
-       (match updates
-         (() (cons '@ alist))
-         (((key proc) . updates)
-          (loop (alist-update alist key proc #f equal?) updates))
-         (((key proc default) . updates)
-          (loop (alist-update alist key proc default equal?) updates)))))))
-
-(define (jsobject-union combine seed . objects)
-  "Merge OBJECTS into SEED by applying (COMBINE KEY VAL0 VAL), where VAL0
-is the value found in the (possibly updated) SEED and VAL is the new value
-found in one of the OBJECTS."
-  (match seed
-    (('@ . aseed)
-     (match objects
-       (() seed)
-       ((('@ . alists) ...)
-        (cons
-         '@
-         (fold (lambda (alist aseed)
-                 (if (null? aseed) alist
-                     (fold
-                      (match-lambda*
-                        (((k . v) aseed)
-                         (let ((pair tail (alist-pop alist k)))
-                           (match pair
-                             (#f (acons k v aseed))
-                             ((_ . v0) (acons k (combine k v0 v) aseed))))))
-                      aseed
-                      alist)))
-               aseed
-               alists)))))))
+    (if (pair? pair)
+      (acons key (proc (cdr pair)) rest)
+      alist)))
 
-;; Possibly useful helper functions:
-;; (define (newest key val0 val) val)
-;; (define (unkeyed->keyed proc) (lambda (_key val0 val) (proc val0 val)))
-
-
 ;;;
 ;;; Phases.
 ;;;
@@ -142,8 +90,8 @@ (define (set-home . _)
 
 (define (module-name module)
   (let* ((package.json (string-append module "/package.json"))
-         (package-meta (call-with-input-file package.json read-json)))
-    (jsobject-ref package-meta "name")))
+         (package-meta (call-with-input-file package.json json->scm)))
+    (assoc-ref package-meta "name")))
 
 (define (index-modules input-paths)
   (define (list-modules directory)
@@ -167,49 +115,59 @@ (define* (patch-dependencies #:key inputs #:allow-other-keys)
 
   (define index (index-modules (map cdr inputs)))
 
-  (define resolve-dependencies
-    (match-lambda
-      (('@ . alist)
-       (cons '@ (map (match-lambda
-                       ((key . value)
-                        (cons key (hash-ref index key value))))
-                     alist)))))
+  (define (resolve-dependencies dependencies)
+    (map
+      (match-lambda
+        ((dependency . version)
+          (cons dependency (hash-ref index dependency version))))
+      dependencies))
 
-  (with-atomic-json-file-replacement "package.json"
+  (with-atomic-json-file-replacement
     (lambda (pkg-meta)
-      (jsobject-update*
-       pkg-meta
-       `("devDependencies" ,resolve-dependencies (@))
-       `("dependencies" ,(lambda (deps)
-                           (resolve-dependencies
-                            (jsobject-union
-                             (lambda (k a b) b)
-                             (jsobject-ref pkg-meta "peerDependencies" '(@))
-                             deps)))
-         (@)))))
+      (fold
+        (lambda (proc pkg-meta) (proc pkg-meta))
+        pkg-meta
+        (list
+          (lambda (pkg-meta)
+            (alist-update pkg-meta "devDependencies" resolve-dependencies))
+          (lambda (pkg-meta)
+            (assoc-set!
+              pkg-meta
+              "dependencies"
+              (resolve-dependencies
+                ; Combined "peerDependencies" and "dependencies" dependencies
+                ; with "dependencies" taking precedent.
+                (fold
+                  (lambda (dependency dependencies)
+                    (assoc-set! dependencies (car dependency) (cdr dependency)))
+                  (assoc-ref* pkg-meta "peerDependencies" '())
+                  (assoc-ref* pkg-meta "dependencies" '())))))))))
   #t)
 
-(define (delete-dependencies absent)
+(define (delete-dependencies dependencies-to-remove)
   "Rewrite 'package.json' to allow the build to proceed without packages
-listed in ABSENT, a list of strings naming npm packages.
+listed in 'dependencies-to-remove', a list of strings naming npm packages.
 
 To prevent the deleted dependencies from being reintroduced, use this function
 only after the 'patch-dependencies' phase."
-  (define delete-from-jsobject
-    (match-lambda
-      (('@ . alist)
-       (cons '@ (filter (match-lambda
-                          ((k . _)
-                           (not (member k absent))))
-                        alist)))))
-
-  (with-atomic-json-file-replacement "package.json"
+  (with-atomic-json-file-replacement
     (lambda (pkg-meta)
-      (jsobject-update*
-       pkg-meta
-       `("devDependencies" ,delete-from-jsobject (@))
-       `("dependencies" ,delete-from-jsobject (@))
-       `("peerDependencies" ,delete-from-jsobject (@))))))
+      (fold
+        (lambda (dependency-key pkg-meta)
+          (alist-update
+            pkg-meta
+            dependency-key
+            (lambda (dependencies)
+              (remove
+                (lambda (dependency)
+                  (member (car dependency) dependencies-to-remove))
+                dependencies))))
+        pkg-meta
+        (list
+          "devDependencies"
+          "dependencies"
+          "peerDependencies"
+          "optionalDependencies")))))
 
 (define* (delete-lockfiles #:key inputs #:allow-other-keys)
   "Delete 'package-lock.json', 'yarn.lock', and 'npm-shrinkwrap.json', if they
@@ -228,8 +186,8 @@ (define* (configure #:key outputs inputs #:allow-other-keys)
     #t))
 
 (define* (build #:key inputs #:allow-other-keys)
-  (let ((package-meta (call-with-input-file "package.json" read-json)))
-    (if (jsobject-ref (jsobject-ref package-meta "scripts" '(@)) "build" #f)
+  (let ((package-meta (call-with-input-file "package.json" json->scm)))
+    (if (assoc-ref* (assoc-ref* package-meta "scripts" '()) "build" #f)
         (let ((npm (string-append (assoc-ref inputs "node") "/bin/npm")))
           (invoke npm "run" "build"))
         (format #t "there is no build script to run~%"))
@@ -301,22 +259,20 @@ (define* (avoid-node-gyp-rebuild #:key outputs #:allow-other-keys)
   ;; even need to overwrite this file.  Therefore, let's use some helpers
   ;; that we'd otherwise not need.
   (define pkg-meta
-    (call-with-input-file installed-package.json read-json))
+    (call-with-input-file installed-package.json json->scm))
   (define scripts
-    (jsobject-ref pkg-meta "scripts" '(@)))
-  (define (jsobject-set js key val)
-    (jsobject-update* js (list key (const val))))
+    (assoc-ref* pkg-meta "scripts" '()))
 
-  (when (equal? "node-gyp rebuild" (jsobject-ref scripts "install" #f))
+  (when (equal? "node-gyp rebuild" (assoc-ref* scripts "install" #f))
     (call-with-output-file installed-package.json
       (lambda (out)
-        (write-json
-         (jsobject-set pkg-meta
-                       "scripts"
-                       (jsobject-set scripts
-                                     "install"
-                                     "echo Guix: avoiding node-gyp rebuild"))
-         out)))))
+        (scm->json
+          (assoc-set! pkg-meta
+                      "scripts"
+                      (assoc-set! scripts
+                                  "install"
+                                  "echo Guix: avoiding node-gyp rebuild"))
+          out)))))
 
 (define %standard-phases
   (modify-phases gnu:%standard-phases

base-commit: e16cdcf37d8223b3634ec5e658356c3b7f154859
-- 
2.46.0