provide properties attr to services

properties are similar to outputs, but are different in that they are
fixed values (do not change) and are present even when the service is
down

if the attribute is present and an attrset, this will write the
equivalent recursive directory structure to $out/.properties/

NEWS

@@ -156,4 +156,16 @@ https://www.liminix.org/doc/admin.html#updating-an-installed-system
 2024-12-22
 
 outputs.zimage is now outputs.kernel.zImage. This is unlikely to
-affect many people at all but I mention it anyway.
+affect many people at all but I mention it anyway.
+
+2024-03-11
+
+The fennel function (svc.open ...) now expects to be given the store
+directory of a service derivation, not a direct path to the .outputs
+directory. Thus
+
+(svc.open "/nix/store/eeeeeeeeeeeeee-hellod")
+not
+(svc.open "/nix/store/eeeeeeeeeeeeee-hellod/.outputs")
+
+This simplifies most extant uses of it

ci.nix

@@ -56,7 +56,12 @@ let
             fennel
             luaPackages.lyaml
           ];
-          src = ./.;
+
+          src = pkgs.lib.sources.sourceFilesBySuffices
+            (pkgs.lib.cleanSource ./. ) [
+              ".nix" ".rst" "Makefile" ".svg" ".fnl" ".py"
+            ];
+
           buildPhase = ''
             cat ${json} | fennel --correlate doc/parse-options.fnl > doc/modules-generated.inc.rst
             cat ${json} | fennel --correlate doc/parse-options-outputs.fnl     > doc/outputs-generated.inc.rst

modules/firewall/service.nix

@@ -49,7 +49,7 @@ let
          (mapAttrs' (n: _: mkSet "ip6" n) zones);
   allRules = lib.recursiveUpdate extraRules (lib.recursiveUpdate sets rules);
   script = firewallgen "firewall1.nft" allRules;
-  watchArg = z: intfs: map (i: "${z}:${i}/.outputs") intfs;
+  watchArg = z: intfs: map (i: "${z}:${i}") intfs;
   name = "firewall";
   service = longrun {
     inherit name;

pkgs/anoia/Makefile

@@ -1,4 +1,5 @@
 servicedir:=$(shell mktemp -d)
+outputdir:=$(servicedir)/.outputs
 
 default: fs.lua init.lua nl.lua svc.lua process.lua net/constants.lua
 
@@ -9,12 +10,13 @@ check:
 	fennel ./run-tests.fnl $(CHECK)
 	fennel test.fnl
 	fennel test-svc.fnl $(servicedir)
-	test -f $(servicedir)/fish
+	find $(outputdir) -ls
-	test "`cat $(servicedir)/fish`" = "food"
+	test -f $(outputdir)/fish
-	test -d $(servicedir)/nested/path
+	test "`cat $(outputdir)/fish`" = "food"
-	test "`cat $(servicedir)/nested/path/name`" = "value"
+	test -d $(outputdir)/nested/path
-	test "`cat $(servicedir)/nested/path/complex/attribute`" = "val"
+	test "`cat $(outputdir)/nested/path/name`" = "value"
-	test "`cat $(servicedir)/nested/path/complex/other`" = "42"
+	test "`cat $(outputdir)/nested/path/complex/attribute`" = "val"
+	test "`cat $(outputdir)/nested/path/complex/other`" = "42"
 
 
 net/constants.lua: net/constants.c

pkgs/anoia/example-output/.outputs/array/1

@@ -0,0 +1 @@
+cat

pkgs/anoia/example-output/.outputs/array/2

@@ -0,0 +1 @@
+dog

pkgs/anoia/example-output/.outputs/array/3

@@ -0,0 +1 @@
+cow

pkgs/anoia/example-output/.outputs/array/4

@@ -0,0 +1 @@
+sheep

pkgs/anoia/svc.fnl

@@ -1,5 +1,5 @@
 (local inotify (require :inotify))
-(local { : file-exists? : dirname } (require :anoia))
+(local { : file-exists? : dirname : append-path } (require :anoia))
 (local { : file-type : dir : mktree &as fs } (require :anoia.fs))
 
 (fn read-line [name]
@@ -25,7 +25,7 @@
     (with-open [f (assert (io.open pathname :w) (.. "can't open " pathname))]
       (f:write value))
     "table" (each [k v (pairs value)]
-              (write-value (.. pathname "/" k) v))))
+              (write-value (append-path pathname k) v))))
 
 (fn read-value [pathname]
   (case (file-type pathname)
@@ -33,7 +33,7 @@
     :directory
     (collect [f (fs.dir pathname)]
       (when (not (or (= f ".") (= f "..")))
-        (values f (read-value ( .. pathname "/" f)))))
+        (values f (read-value (append-path pathname f)))))
     :file
     (read-line pathname)
     :link
@@ -50,15 +50,17 @@
 
 (fn open [directory]
   (let [watcher (watch-fsevents directory)
-        has-file? (fn [filename] (file-exists? (.. directory "/" filename)))]
+        has-file? #(file-exists? (append-path directory $1))
+        outputs-dir (append-path directory ".outputs")]
     {
      :wait #(watcher:read)
      :ready? (fn [self]
-               (and (has-file? "state") (not (has-file? ".lock"))))
+               (and (has-file? ".outputs/state")
+                    (not (has-file? ".outputs/.lock"))))
      :output (fn [_ filename new-value]
                (if new-value
-                   (write-value (.. directory "/" filename) new-value)
+                   (write-value (append-path outputs-dir filename) new-value)
-                   (read-value (.. directory "/" filename))))
+                   (read-value (append-path outputs-dir filename))))
      :close #(watcher:close)
      :fileno #(watcher:fileno)
      : events

pkgs/liminix-tools/services/builder.sh

@@ -1,5 +1,15 @@
 source $stdenv/setup
 mkdir -p $out/${name}
+
+writepath(){
+    mkdir -p $(dirname $1)
+    echo $2 > $1
+}
+if test -n "$propertiesText"; then
+    mkdir $out/.properties
+    ( cd $out/.properties; eval "$propertiesText" )
+fi
+
 echo $serviceType > $out/${name}/type
 mkdir -p $out/${name}/dependencies.d
 echo $buildInputs > $out/buildInputs

pkgs/liminix-tools/services/default.nix

@@ -8,6 +8,8 @@
 let
   prefix = "/run/services/outputs";
   output = service: name: "${prefix}/${service.name}/${name}";
+  inherit (lib.attrsets) mapAttrsRecursive collect;
+  inherit (lib.strings) concatStringsSep;
   serviceScript = commands: ''
     #!/bin/sh
     exec 2>&1
@@ -38,6 +40,7 @@ let
       buildInputs ? [ ],
       restart-on-upgrade ? false,
       controller ? null,
+      properties ? {}
     }:
     stdenvNoCC.mkDerivation {
       # we use stdenvNoCC to avoid generating derivations with names
@@ -56,7 +59,13 @@ let
         timeout-up
         timeout-down
         restart-on-upgrade
-        ;
+      ;
+      propertiesText =
+        let a = mapAttrsRecursive
+          (path: value: "writepath ${concatStringsSep "/" path} ${builtins.toString value}\n")
+          properties;
+        in collect builtins.isString a;
+
       buildInputs =
         buildInputs ++ dependencies ++ contents ++ lib.optional (controller != null) controller;
       inherit controller dependencies contents;

pkgs/output-template/output-template.fnl

@@ -28,7 +28,7 @@
                : ipairs
                :output
                (fn [service-path path default]
-                 (let [s (assert (svc.open (.. service-path "/.outputs")))]
+                 (let [s (assert (svc.open service-path))]
                    (or (s:output path) default)))
                :lua_quote #(string.format "%q" $1)
                :json_quote (fn [x] (.. "\"" (json-escape x) "\""))

pkgs/watch-outputs/watch-outputs.fnl

@@ -71,7 +71,7 @@
 
 (fn open-services [output-references]
   (collect [s p (pairs output-references)]
-    (values (svc.open (.. s "/.outputs")) p)))
+    (values (svc.open s) p)))
 
 (fn run []
   (let [trees {}

pkgs/watch-ssh-keys/watch-ssh-keys.fnl

@@ -50,8 +50,7 @@
 
 (fn run []
   (let [{: out-path : watched-service : path } (parse-args arg)
-        dir (.. watched-service "/.outputs")
+        service (assert (svc.open watched-service))]
-        service (assert (svc.open dir))]
     (accumulate [tree {}
                  v (service:events)]
       (write-changes out-path tree (or (service:output path) {})))))