log cleanup (#969)

- Improvement: New `ZEN_SCOPED_LOG(Expr)` macro routes `ZEN_INFO`/`ZEN_WARN`/`ZEN_DEBUG` in the enclosing block through the given logger expression instead of the default
- Improvement: `BuildContainer`, `SaveOplog`, and `LoadOplogContext` now take a caller-provided `LoggerRef` so diagnostic messages route through the caller's logger

1 files changed, 22 insertions, 38 deletions

diff --git a/src/zenstore/projectstore.cpp b/src/zenstore/projectstore.cpp
index 7cd6b9e37..38c609252 100644
--- a/src/zenstore/projectstore.cpp
+++ b/src/zenstore/projectstore.cpp
@@ -4739,7 +4739,7 @@ ProjectStore::GetProjectsList()
 CbObject
 ProjectStore::GetProjectFiles(LoggerRef InLog, Project& Project, Oplog& Oplog, const std::unordered_set<std::string>& WantedFieldNames)
 {
-	auto Log = [&InLog]() { return InLog; };
+	ZEN_SCOPED_LOG(InLog);
 
 	using namespace std::literals;
 
@@ -4894,7 +4894,7 @@ ProjectStore::GetProjectChunkInfos(LoggerRef InLog, Project& Project, Oplog& Opl
 	ZEN_MEMSCOPE(GetProjectstoreTag());
 	ZEN_TRACE_CPU("ProjectStore::GetProjectChunkInfos");
 
-	auto Log = [&InLog]() { return InLog; };
+	ZEN_SCOPED_LOG(InLog);
 
 	using namespace std::literals;
 
@@ -5051,16 +5051,13 @@ ProjectStore::GetProjectChunkInfos(LoggerRef InLog, Project& Project, Oplog& Opl
 }
 
 CbObject
-ProjectStore::GetChunkInfo(LoggerRef InLog, Project& Project, Oplog& Oplog, const Oid& ChunkId)
+ProjectStore::GetChunkInfo(Project& Project, Oplog& Oplog, const Oid& ChunkId)
 {
 	ZEN_MEMSCOPE(GetProjectstoreTag());
 	ZEN_TRACE_CPU("ProjectStore::GetChunkInfo");
 
 	using namespace std::literals;
 
-	auto Log = [&InLog]() { return InLog; };
-	ZEN_UNUSED(Log);
-
 	IoBuffer Chunk = Oplog.FindChunk(Project.RootDir, ChunkId, nullptr);
 	if (!Chunk)
 	{
@@ -5209,8 +5206,7 @@ ExtractRange(IoBuffer&& Chunk, uint64_t Offset, uint64_t Size, ZenContentType Ac
 }
 
 ProjectStore::GetChunkRangeResult
-ProjectStore::GetChunkRange(LoggerRef	   InLog,
-							Project&	   Project,
+ProjectStore::GetChunkRange(Project&	   Project,
 							Oplog&		   Oplog,
 							const Oid&	   ChunkId,
 							uint64_t	   Offset,
@@ -5222,9 +5218,6 @@ ProjectStore::GetChunkRange(LoggerRef	   InLog,
 
 	ZEN_TRACE_CPU("ProjectStore::GetChunkRange");
 
-	auto Log = [&InLog]() { return InLog; };
-	ZEN_UNUSED(Log);
-
 	uint64_t OldTag = OptionalInOutModificationTag == nullptr ? 0 : *OptionalInOutModificationTag;
 	IoBuffer Chunk	= Oplog.FindChunk(Project.RootDir, ChunkId, OptionalInOutModificationTag);
 	if (!Chunk)
@@ -5731,7 +5724,7 @@ public:
 		ZEN_TRACE_CPU("Store::CompactStore");
 		ZEN_MEMSCOPE(GetProjectstoreTag());
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		Stopwatch  Timer;
 		const auto _ = MakeGuard([&] {
@@ -5867,7 +5860,7 @@ ProjectStore::RemoveExpiredData(GcCtx& Ctx, GcStats& Stats)
 	ZEN_TRACE_CPU("Store::RemoveExpiredData");
 	ZEN_MEMSCOPE(GetProjectstoreTag());
 
-	auto Log = [&Ctx]() { return Ctx.Logger; };
+	ZEN_SCOPED_LOG(Ctx.Logger);
 
 	Stopwatch  Timer;
 	const auto _ = MakeGuard([&] {
@@ -6020,7 +6013,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::UpdateLockedState");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		Stopwatch Timer;
 
@@ -6097,7 +6090,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::GetUnusedReferences");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		size_t InitialCount = IoCids.size();
 		size_t UsedCount	= InitialCount;
@@ -6121,6 +6114,7 @@ public:
 	}
 
 private:
+	LoggerRef			Log() { return m_ProjectStore.Log(); }
 	ProjectStore&		m_ProjectStore;
 	std::vector<IoHash> m_References;
 };
@@ -6165,7 +6159,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::Oplog::PreCache");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		Stopwatch  Timer;
 		const auto _ = MakeGuard([&] {
@@ -6283,7 +6277,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::Oplog::UpdateLockedState");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		Stopwatch  Timer;
 		const auto _ = MakeGuard([&] {
@@ -6391,7 +6385,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::Oplog::GetUnusedReferences");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		const size_t InitialCount = IoCids.size();
 		size_t		 UsedCount	  = InitialCount;
@@ -6417,6 +6411,7 @@ public:
 		return UnusedReferences;
 	}
 
+	LoggerRef				   Log() { return m_Project->Log(); }
 	ProjectStore&			   m_ProjectStore;
 	Ref<ProjectStore::Project> m_Project;
 	std::string				   m_OplogId;
@@ -6432,7 +6427,7 @@ ProjectStore::CreateReferenceCheckers(GcCtx& Ctx)
 {
 	ZEN_TRACE_CPU("Store::CreateReferenceCheckers");
 
-	auto Log = [&Ctx]() { return Ctx.Logger; };
+	ZEN_SCOPED_LOG(Ctx.Logger);
 
 	size_t ProjectCount = 0;
 	size_t OplogCount	= 0;
@@ -6494,11 +6489,9 @@ ProjectStore::CreateReferenceCheckers(GcCtx& Ctx)
 std::vector<RwLock::SharedLockScope>
 ProjectStore::LockState(GcCtx& Ctx)
 {
+	ZEN_UNUSED(Ctx);
 	ZEN_TRACE_CPU("Store::LockState");
 
-	auto Log = [&Ctx]() { return Ctx.Logger; };
-	ZEN_UNUSED(Log);
-
 	std::vector<RwLock::SharedLockScope> Locks;
 	Locks.emplace_back(RwLock::SharedLockScope(m_ProjectsLock));
 	for (auto& ProjectIt : m_Projects)
@@ -6530,7 +6523,7 @@ public:
 	{
 		ZEN_TRACE_CPU("Store::Validate");
 
-		auto Log = [&Ctx]() { return Ctx.Logger; };
+		ZEN_SCOPED_LOG(Ctx.Logger);
 
 		ProjectStore::Oplog::ValidationResult Result;
 
@@ -6629,9 +6622,6 @@ ProjectStore::CreateReferenceValidators(GcCtx& Ctx)
 		return {};
 	}
 
-	auto Log = [&Ctx]() { return Ctx.Logger; };
-	ZEN_UNUSED(Log);
-
 	DiscoverProjects();
 
 	std::vector<std::pair<std::string, std::string>> Oplogs;
@@ -8246,8 +8236,7 @@ TEST_CASE("project.store.partial.read")
 	{
 		uint64_t ModificationTag = 0;
 
-		auto Result = ProjectStore.GetChunkRange(Log(),
-												 *Project1,
+		auto Result = ProjectStore.GetChunkRange(*Project1,
 												 *Oplog1,
 												 Attachments[OpIds[1]][0].first,
 												 0,
@@ -8262,8 +8251,7 @@ TEST_CASE("project.store.partial.read")
 		CompressedBuffer Attachment = CompressedBuffer::FromCompressed(Result.Chunk, RawHash, RawSize);
 		CHECK(RawSize == Attachments[OpIds[1]][0].second.DecodeRawSize());
 
-		auto Result2 = ProjectStore.GetChunkRange(Log(),
-												  *Project1,
+		auto Result2 = ProjectStore.GetChunkRange(*Project1,
 												  *Oplog1,
 												  Attachments[OpIds[1]][0].first,
 												  0,
@@ -8276,8 +8264,7 @@ TEST_CASE("project.store.partial.read")
 	{
 		uint64_t FullChunkModificationTag = 0;
 		{
-			auto Result = ProjectStore.GetChunkRange(Log(),
-													 *Project1,
+			auto Result = ProjectStore.GetChunkRange(*Project1,
 													 *Oplog1,
 													 Attachments[OpIds[2]][1].first,
 													 0,
@@ -8290,8 +8277,7 @@ TEST_CASE("project.store.partial.read")
 				  Attachments[OpIds[2]][1].second.DecodeRawSize());
 		}
 		{
-			auto Result = ProjectStore.GetChunkRange(Log(),
-													 *Project1,
+			auto Result = ProjectStore.GetChunkRange(*Project1,
 													 *Oplog1,
 													 Attachments[OpIds[2]][1].first,
 													 0,
@@ -8304,8 +8290,7 @@ TEST_CASE("project.store.partial.read")
 	{
 		uint64_t PartialChunkModificationTag = 0;
 		{
-			auto Result = ProjectStore.GetChunkRange(Log(),
-													 *Project1,
+			auto Result = ProjectStore.GetChunkRange(*Project1,
 													 *Oplog1,
 													 Attachments[OpIds[2]][1].first,
 													 5,
@@ -8328,8 +8313,7 @@ TEST_CASE("project.store.partial.read")
 		}
 
 		{
-			auto Result = ProjectStore.GetChunkRange(Log(),
-													 *Project1,
+			auto Result = ProjectStore.GetChunkRange(*Project1,
 													 *Oplog1,
 													 Attachments[OpIds[2]][1].first,
 													 0,