Merge pull request #13714 from xokdvium/move-ref-scan-sink

libutil: Move references.{hh,cc} to libstore, remove unused scanForReferences

src/libstore-tests/ref-scan-bench.cc

@@ -1,4 +1,4 @@
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 #include "nix/store/path.hh"
 #include "nix/util/base-nix-32.hh"
 

src/libstore-tests/references.cc

@@ -1,9 +1,46 @@
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 
 #include <gtest/gtest.h>
 
 namespace nix {
 
+struct RewriteParams
+{
+    std::string originalString, finalString;
+    StringMap rewrites;
+
+    friend std::ostream & operator<<(std::ostream & os, const RewriteParams & bar)
+    {
+        StringSet strRewrites;
+        for (auto & [from, to] : bar.rewrites)
+            strRewrites.insert(from + "->" + to);
+        return os << "OriginalString: " << bar.originalString << std::endl
+                  << "Rewrites: " << dropEmptyInitThenConcatStringsSep(",", strRewrites) << std::endl
+                  << "Expected result: " << bar.finalString;
+    }
+};
+
+class RewriteTest : public ::testing::TestWithParam<RewriteParams>
+{};
+
+TEST_P(RewriteTest, IdentityRewriteIsIdentity)
+{
+    RewriteParams param = GetParam();
+    StringSink rewritten;
+    auto rewriter = RewritingSink(param.rewrites, rewritten);
+    rewriter(param.originalString);
+    rewriter.flush();
+    ASSERT_EQ(rewritten.s, param.finalString);
+}
+
+INSTANTIATE_TEST_CASE_P(
+    references,
+    RewriteTest,
+    ::testing::Values(
+        RewriteParams{"foooo", "baroo", {{"foo", "bar"}, {"bar", "baz"}}},
+        RewriteParams{"foooo", "bazoo", {{"fou", "bar"}, {"foo", "baz"}}},
+        RewriteParams{"foooo", "foooo", {}}));
+
 TEST(references, scan)
 {
     std::string hash1 = "dc04vv14dak1c1r48qa0m23vr9jy8sm0";

src/libstore/include/nix/store/meson.build

@@ -62,6 +62,7 @@ headers = [ config_pub_h ] + files(
   'posix-fs-canonicalise.hh',
   'profiles.hh',
   'realisation.hh',
+  'references.hh',
   'remote-fs-accessor.hh',
   'remote-store-connection.hh',
   'remote-store.hh',

src/libstore/include/nix/store/path-references.hh

@@ -1,13 +1,11 @@
 #pragma once
 ///@file
 
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 #include "nix/store/path.hh"
 
 namespace nix {
 
-std::pair<StorePathSet, HashResult> scanForReferences(const Path & path, const StorePathSet & refs);
-
 StorePathSet scanForReferences(Sink & toTee, const Path & path, const StorePathSet & refs);
 
 class PathRefScanSink : public RefScanSink

src/libstore/local-store.cc

@@ -7,7 +7,7 @@
 #include "nix/store/derivations.hh"
 #include "nix/store/realisation.hh"
 #include "nix/store/nar-info.hh"
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 #include "nix/util/callback.hh"
 #include "nix/util/topo-sort.hh"
 #include "nix/util/finally.hh"

src/libstore/make-content-addressed.cc

@@ -1,5 +1,5 @@
 #include "nix/store/make-content-addressed.hh"
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 
 namespace nix {
 

src/libstore/meson.build

@@ -316,6 +316,7 @@ sources = files(
   'posix-fs-canonicalise.cc',
   'profiles.cc',
   'realisation.cc',
+  'references.cc',
   'remote-fs-accessor.cc',
   'remote-store.cc',
   'restricted-store.cc',

src/libstore/path-references.cc

@@ -43,14 +43,6 @@ StorePathSet PathRefScanSink::getResultPaths()
     return found;
 }
 
-std::pair<StorePathSet, HashResult> scanForReferences(const std::string & path, const StorePathSet & refs)
-{
-    HashSink hashSink{HashAlgorithm::SHA256};
-    auto found = scanForReferences(hashSink, path, refs);
-    auto hash = hashSink.finish();
-    return std::pair<StorePathSet, HashResult>(found, hash);
-}
-
 StorePathSet scanForReferences(Sink & toTee, const Path & path, const StorePathSet & refs)
 {
     PathRefScanSink refsSink = PathRefScanSink::fromPaths(refs);

src/libstore/references.cc

@@ -1,6 +1,6 @@
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
+#include "nix/store/path.hh"
 #include "nix/util/hash.hh"
-#include "nix/util/archive.hh"
 #include "nix/util/base-nix-32.hh"
 
 #include <map>
@@ -10,7 +10,7 @@
 
 namespace nix {
 
-static size_t refLength = 32; /* characters */
+static constexpr auto refLength = StorePath::HashLen;
 
 static void search(std::string_view s, StringSet & hashes, StringSet & seen)
 {

src/libstore/store-api.cc

@@ -9,7 +9,6 @@
 #include "nix/util/util.hh"
 #include "nix/store/nar-info-disk-cache.hh"
 #include "nix/util/thread-pool.hh"
-#include "nix/util/references.hh"
 #include "nix/util/archive.hh"
 #include "nix/util/callback.hh"
 #include "nix/util/git.hh"
@@ -18,7 +17,6 @@
 // `addMultipleToStore`.
 #include "nix/store/worker-protocol.hh"
 #include "nix/util/signals.hh"
-#include "nix/util/users.hh"
 
 #include <filesystem>
 #include <nlohmann/json.hpp>

src/libutil-tests/meson.build

@@ -66,7 +66,6 @@ sources = files(
   'pool.cc',
   'position.cc',
   'processes.cc',
-  'references.cc',
   'sort.cc',
   'spawn.cc',
   'strings.cc',

src/libutil-tests/references.cc

@@ -1,45 +0,0 @@
-#include "nix/util/references.hh"
-#include <gtest/gtest.h>
-
-namespace nix {
-
-using std::string;
-
-struct RewriteParams
-{
-    string originalString, finalString;
-    StringMap rewrites;
-
-    friend std::ostream & operator<<(std::ostream & os, const RewriteParams & bar)
-    {
-        StringSet strRewrites;
-        for (auto & [from, to] : bar.rewrites)
-            strRewrites.insert(from + "->" + to);
-        return os << "OriginalString: " << bar.originalString << std::endl
-                  << "Rewrites: " << dropEmptyInitThenConcatStringsSep(",", strRewrites) << std::endl
-                  << "Expected result: " << bar.finalString;
-    }
-};
-
-class RewriteTest : public ::testing::TestWithParam<RewriteParams>
-{};
-
-TEST_P(RewriteTest, IdentityRewriteIsIdentity)
-{
-    RewriteParams param = GetParam();
-    StringSink rewritten;
-    auto rewriter = RewritingSink(param.rewrites, rewritten);
-    rewriter(param.originalString);
-    rewriter.flush();
-    ASSERT_EQ(rewritten.s, param.finalString);
-}
-
-INSTANTIATE_TEST_CASE_P(
-    references,
-    RewriteTest,
-    ::testing::Values(
-        RewriteParams{"foooo", "baroo", {{"foo", "bar"}, {"bar", "baz"}}},
-        RewriteParams{"foooo", "bazoo", {{"fou", "bar"}, {"foo", "baz"}}},
-        RewriteParams{"foooo", "foooo", {}}));
-
-} // namespace nix

src/libutil/include/nix/util/meson.build

@@ -55,7 +55,6 @@ headers = files(
   'posix-source-accessor.hh',
   'processes.hh',
   'ref.hh',
-  'references.hh',
   'regex-combinators.hh',
   'repair-flag.hh',
   'serialise.hh',

src/libutil/meson.build

@@ -145,7 +145,6 @@ sources = [ config_priv_h ] + files(
   'pos-table.cc',
   'position.cc',
   'posix-source-accessor.cc',
-  'references.cc',
   'serialise.cc',
   'signature/local-keys.cc',
   'signature/signer.cc',

src/nix/hash.cc

@@ -3,7 +3,7 @@
 #include "nix/store/content-address.hh"
 #include "nix/cmd/legacy.hh"
 #include "nix/main/shared.hh"
-#include "nix/util/references.hh"
+#include "nix/store/references.hh"
 #include "nix/util/archive.hh"
 #include "nix/util/git.hh"
 #include "nix/util/posix-source-accessor.hh"