[bug#77041,04/16] services: package-database: Turn into a Shepherd timer.

Message ID 1344bace2389f90a2aa26834ab4b0528e55e2c30.1742073920.git.ludo@gnu.org
State New
Headers
Series Replacing mcron jobs by Shepherd timers |

Commit Message

Ludovic Courtès March 15, 2025, 9:37 p.m. UTC
  * gnu/services/admin.scm (package-database-mcron-jobs): Rename to…
(package-database-shepherd-services): … this.  Return a shepherd
service.
(package-database-service-type): Update accordingly.
* doc/guix.texi (File Search Services): Update documentation of the
‘schedule’ field.

Change-Id: Id7b4c5cff95a7117dca7d95af37db7389bb5ca92
---
 doc/guix.texi          |  7 ++++---
 gnu/services/admin.scm | 34 ++++++++++++++++++++++++----------
 2 files changed, 28 insertions(+), 13 deletions(-)
  

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index ae7b08ad23..e45e8a9979 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -27194,9 +27194,10 @@  File Search Services
 The Guix package to use.
 
 @item @code{schedule} (default: @code{%default-package-database-update-schedule})
-String or G-exp denoting an mcron schedule for the periodic
-@command{guix locate --update} job (@pxref{Guile Syntax,,, mcron,
-GNU@tie{}mcron}).
+This is the schedule of the periodic @command{guix locate --update} job,
+expressed as a string in traditional cron syntax or as a gexp evaluating
+to a Shepherd calendar event (@pxref{Timers,,, shepherd, The GNU
+Shepherd Manual}).
 
 @item @code{method} (default: @code{'store})
 Indexing method for @command{guix locate}.  The default value,
diff --git a/gnu/services/admin.scm b/gnu/services/admin.scm
index b73accc4af..e473794043 100644
--- a/gnu/services/admin.scm
+++ b/gnu/services/admin.scm
@@ -529,23 +529,37 @@  (define-configuration/no-serialization package-database-configuration
             "G-exp denoting the channels to use when updating the database
 (@pxref{Channels})."))
 
-(define (package-database-mcron-jobs configuration)
+(define (package-database-shepherd-services configuration)
   (match-record configuration <package-database-configuration>
     (package schedule method channels)
     (let ((channels (scheme-file "channels.scm" channels)))
-      (list #~(job #$schedule
-                   ;; XXX: The whole thing's running as "root" just because it
-                   ;; needs write access to /var/cache/guix/locate.
-                   (string-append #$(file-append package "/bin/guix")
-                                  " time-machine -C " #$channels
-                                  " -- locate --update --method="
-                                  #$(symbol->string method)))))))
+      (list (shepherd-service
+             (provision '(package-database-update))
+             (requirement '(user-processes guix-daemon))
+             (modules '((shepherd service timer)))
+             ;; XXX: The whole thing's running as "root" just because it needs
+             ;; write access to /var/cache/guix/locate.
+             (start #~(make-timer-constructor
+                       #$(if (string? schedule)
+                             #~(cron-string->calendar-event #$schedule)
+                             schedule)
+                       (command '(#$(file-append package "/bin/guix")
+                                  "time-machine" "-C" #$channels
+                                  "--" "locate" "--update"
+                                  #$(string-append
+                                     "--method=" (symbol->string method))))
+                       #:wait-for-termination? #t))
+             (stop #~(make-timer-destructor))
+             (documentation
+              "Periodically update the system-wide package database that can
+be queried by the 'guix locate' command.")
+             (actions (list shepherd-trigger-action)))))))
 
 (define package-database-service-type
   (service-type
    (name 'package-database)
-   (extensions (list (service-extension mcron-service-type
-                                        package-database-mcron-jobs)))
+   (extensions (list (service-extension shepherd-root-service-type
+                                        package-database-shepherd-services)))
    (description
     "Periodically update the package database used by the @code{guix locate} command,
 which lets you search for packages that provide a given file.")