Change JSON derivation format to use ContentAddress JSON

Keeps it more consistent.

doc/manual/source/protocols/json/derivation.md

@@ -1,7 +1,7 @@
-{{#include derivation-v3-fixed.md}}
+{{#include derivation-v4-fixed.md}}
 
 <!--
 ## Raw Schema
 
-[JSON Schema for Derivation v3](schema/derivation-v3.json)
+[JSON Schema for Derivation v3](schema/derivation-v4.json)
 -->

doc/manual/source/protocols/json/meson.build

@@ -12,7 +12,7 @@ schemas = [
   'file-system-object-v1',
   'hash-v1',
   'content-address-v1',
-  'derivation-v3',
+  'derivation-v4',
 ]
 
 schema_files = files()

doc/manual/source/protocols/json/schema/derivation-v4.yaml

@@ -1,5 +1,5 @@
 "$schema": http://json-schema.org/draft-04/schema#
-"$id": https://nix.dev/manual/nix/latest/protocols/json/schema/derivation-v3.json
+"$id": https://nix.dev/manual/nix/latest/protocols/json/schema/derivation-v4.json
 title: Derivation
 description: |
   Experimental JSON representation of a Nix derivation (version 3).
@@ -32,10 +32,10 @@ properties:
       Used when calculating store paths for the derivation’s outputs.
 
   version:
-    const: 3
+    const: 4
     title: Format version (must be 3)
     description: |
-      Must be `3`.
+      Must be `4`.
       This is a guard that allows us to continue evolving this format.
       The choice of `3` is fairly arbitrary, but corresponds to this informal version:
 
@@ -47,6 +47,8 @@ properties:
 
       - Version 3: Drop store dir from store paths, just include base name.
 
+      - Version 4: Use canonical content address JSON format for floating content addressed derivation outputs.
+
       Note that while this format is experimental, the maintenance of versions is best-effort, and not promised to identify every change.
 
   outputs:
@@ -161,9 +163,11 @@ properties:
       hashAlgo:
         title: Hash algorithm
         "$ref": "./hash-v1.yaml#/$defs/algorithm"
+        description: |
+          For an output which will be [content addressed], but the content address is not specified up front, the name of the hash algorithm used. When the content address is fixed, use `hash.hashAlgo` instead.
 
       hash:
-        type: string
         title: Expected hash value
         description: |
-          For fixed-output derivations, the expected content hash in base-16.
+          For fixed-output derivations, the expected content hash.
+        "$ref": "./hash-v1.yaml"

src/json-schema-checks/meson.build

@@ -48,7 +48,7 @@ schemas = [
   },
   {
     'stem' : 'derivation',
-    'schema' : schema_dir / 'derivation-v3.yaml',
+    'schema' : schema_dir / 'derivation-v4.yaml',
     'files' : [
       'dyn-dep-derivation.json',
       'simple-derivation.json',
@@ -57,7 +57,7 @@ schemas = [
   # # Not sure how to make subschema work
   # {
   #   'stem': 'derivation',
-  #   'schema': schema_dir / 'derivation-v3.yaml#output',
+  #   'schema': schema_dir / 'derivation-v4.yaml#output',
   #   'files' : [
   #     'output-caFixedFlat.json',
   #     'output-caFixedNAR.json',

src/libstore-tests/data/derivation/ca/advanced-attributes-defaults.json

@@ -22,5 +22,5 @@
     }
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ca/advanced-attributes-structured-attrs-defaults.json

@@ -33,5 +33,5 @@
     "system": "my-system"
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ca/advanced-attributes-structured-attrs.json

@@ -101,5 +101,5 @@
     "system": "my-system"
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ca/advanced-attributes.json

@@ -52,5 +52,5 @@
     }
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ca/self-contained.json

@@ -20,5 +20,5 @@
     }
   },
   "system": "x86_64-linux",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/dyn-dep-derivation.json

@@ -35,5 +35,5 @@
   "name": "dyn-dep-derivation",
   "outputs": {},
   "system": "wasm-sel4",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ia/advanced-attributes-defaults.json

@@ -19,5 +19,5 @@
     }
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ia/advanced-attributes-structured-attrs-defaults.json

@@ -29,5 +29,5 @@
     "system": "my-system"
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ia/advanced-attributes-structured-attrs.json

@@ -96,5 +96,5 @@
     "system": "my-system"
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/ia/advanced-attributes.json

@@ -49,5 +49,5 @@
     }
   },
   "system": "my-system",
-  "version": 3
+  "version": 4
 }

src/libstore-tests/data/derivation/output-caFixedFlat.json

@@ -1,5 +1,8 @@
 {
-  "hash": "894517c9163c896ec31a2adbd33c0681fd5f45b2c0ef08a64c92a03fb97f390f",
+  "hash": {
-  "hashAlgo": "sha256",
+    "algorithm": "sha256",
+    "format": "base64",
+    "hash": "iUUXyRY8iW7DGirb0zwGgf1fRbLA7wimTJKgP7l/OQ8="
+  },
   "method": "flat"
 }

src/libstore-tests/data/derivation/output-caFixedNAR.json

@@ -1,5 +1,8 @@
 {
-  "hash": "894517c9163c896ec31a2adbd33c0681fd5f45b2c0ef08a64c92a03fb97f390f",
+  "hash": {
-  "hashAlgo": "sha256",
+    "algorithm": "sha256",
+    "format": "base64",
+    "hash": "iUUXyRY8iW7DGirb0zwGgf1fRbLA7wimTJKgP7l/OQ8="
+  },
   "method": "nar"
 }

src/libstore-tests/data/derivation/output-caFixedText.json

@@ -1,5 +1,8 @@
 {
-  "hash": "894517c9163c896ec31a2adbd33c0681fd5f45b2c0ef08a64c92a03fb97f390f",
+  "hash": {
-  "hashAlgo": "sha256",
+    "algorithm": "sha256",
+    "format": "base64",
+    "hash": "iUUXyRY8iW7DGirb0zwGgf1fRbLA7wimTJKgP7l/OQ8="
+  },
   "method": "text"
 }

src/libstore-tests/data/derivation/simple-derivation.json

@@ -22,5 +22,5 @@
   "name": "simple-derivation",
   "outputs": {},
   "system": "wasm-sel4",
-  "version": 3
+  "version": 4
 }

src/libstore/derivations.cc

@@ -1293,15 +1293,13 @@ void adl_serializer<DerivationOutput>::to_json(json & res, const DerivationOutpu
         overloaded{
             [&](const DerivationOutput::InputAddressed & doi) { res["path"] = doi.path; },
             [&](const DerivationOutput::CAFixed & dof) {
+                res = dof.ca;
+        // FIXME print refs?
         /* it would be nice to output the path for user convenience, but
            this would require us to know the store dir. */
 #if 0
                 res["path"] = dof.path(store, drvName, outputName);
 #endif
-                res["method"] = std::string{dof.ca.method.render()};
-                res["hashAlgo"] = printHashAlgo(dof.ca.hash.algo);
-                res["hash"] = dof.ca.hash.to_string(HashFormat::Base16, false);
-                // FIXME print refs?
             },
             [&](const DerivationOutput::CAFloating & dof) {
                 res["method"] = std::string{dof.method.render()};
@@ -1341,15 +1339,12 @@ adl_serializer<DerivationOutput>::from_json(const json & _json, const Experiment
         };
     }
 
-    else if (keys == (std::set<std::string_view>{"method", "hashAlgo", "hash"})) {
+    else if (keys == (std::set<std::string_view>{"method", "hash"})) {
-        auto [method, hashAlgo] = methodAlgo();
         auto dof = DerivationOutput::CAFixed{
-            .ca =
+            .ca = static_cast<ContentAddress>(_json),
-                ContentAddress{
-                    .method = std::move(method),
-                    .hash = Hash::parseNonSRIUnprefixed(getString(valueAt(json, "hash")), hashAlgo),
-                },
         };
+        if (dof.ca.method == ContentAddressMethod::Raw::Text)
+            xpSettings.require(Xp::DynamicDerivations, "text-hashed derivation output in JSON");
         /* We no longer produce this (denormalized) field (for the
            reasons described above), so we don't need to check it. */
 #if 0
@@ -1392,7 +1387,7 @@ void adl_serializer<Derivation>::to_json(json & res, const Derivation & d)
 
     res["name"] = d.name;
 
-    res["version"] = 3;
+    res["version"] = 4;
 
     {
         nlohmann::json & outputsObj = res["outputs"];
@@ -1450,8 +1445,8 @@ Derivation adl_serializer<Derivation>::from_json(const json & _json, const Exper
 
     res.name = getString(valueAt(json, "name"));
 
-    if (valueAt(json, "version") != 3)
+    if (valueAt(json, "version") != 4)
-        throw Error("Only derivation format version 3 is currently supported.");
+        throw Error("Only derivation format version 4 is currently supported.");
 
     try {
         auto outputs = getObject(valueAt(json, "outputs"));

tests/functional/dyn-drv/non-trivial.nix

@@ -63,7 +63,7 @@ builtins.outputOf
             }
           },
           "system": "${system}",
-          "version": 3
+          "version": 4
         }
       EOF
         drvPath=$(echo "$json" | nix derivation add)