merge: resolve conflicts with origin/main into rkuris/logging-subsystem-improvements (keep RootStore flag and new logging options)

Author: rkuris

.github/pull_request_template.md

@@ -3,5 +3,3 @@
 ## How this works
 
 ## How this was tested
-
-## Need to be documented in RELEASES.md?

Cargo.lock

@@ -15,7 +15,7 @@ import (
 )
 
 // Open a database with default configuration
-db, err := ffi.New("/path/to/database.db")
+db, err := ffi.New("/path/to/database_dir")
 if err != nil {
     log.Fatal(err)
 }
@@ -29,7 +29,7 @@ defer db.Close(ctx)
 Firewood uses the functional options pattern for configuration. You can customize the database by passing option functions:
 
 ```go
-db, err := ffi.New("/path/to/database.db",
+db, err := ffi.New("/path/to/database_dir",
     ffi.WithTruncate(true),                    // Clear the database if it exists
     ffi.WithNodeCacheEntries(2_000_000),       // Set node cache size
     ffi.WithFreeListCacheEntries(50_000),      // Set freelist cache size

ffi/README.md

@@ -92,6 +92,7 @@ type config struct {
 	revisions uint
 	// readCacheStrategy is the caching strategy used for the node cache.
 	readCacheStrategy CacheStrategy
+<<<<<<< HEAD
 	// rootStoreDir defines a path to store all historical roots on disk.
 	rootStoreDir string
 	// logPath is the file path where logs will be written.
@@ -100,6 +101,10 @@ type config struct {
 	// logFilter is the RUST_LOG format filter string for logging.
 	// If empty and logPath is set, env_logger defaults will be used.
 	logFilter string
+=======
+	// rootStore defines whether to enable storing all historical revisions on disk.
+	rootStore bool
+>>>>>>> origin/main
 }
 
 func defaultConfig() *config {
@@ -161,13 +166,13 @@ func WithReadCacheStrategy(strategy CacheStrategy) Option {
 	}
 }
 
-// WithRootStoreDir sets a path to store all historical roots on disk.
+// WithRootStore defines whether to enable storing all historical revisions on disk.
 // When set, historical revisions will be persisted to disk even after being
 // removed from memory (based on the Revisions limit).
-// Default: empty string (no disk persistence)
-func WithRootStoreDir(dir string) Option {
+// Default: false
+func WithRootStore() Option {
 	return func(c *config) {
-		c.rootStoreDir = dir
+		c.rootStore = true
 	}
 }
 
@@ -217,7 +222,7 @@ const (
 )
 
 // New opens or creates a new Firewood database with the given options.
-// The database file will be created at the provided file path if it does not
+// The database directory will be created at the provided path if it does not
 // already exist.
 //
 // If no [Option] is provided, sensible defaults will be used.
@@ -226,7 +231,7 @@ const (
 // It is the caller's responsibility to call [Database.Close] when the database
 // is no longer needed. No other [Database] in this process should be opened with
 // the same file path until the database is closed.
-func New(filePath string, opts ...Option) (*Database, error) {
+func New(dbDir string, opts ...Option) (*Database, error) {
 	conf := defaultConfig()
 	for _, opt := range opts {
 		opt(conf)
@@ -267,13 +272,13 @@ func New(filePath string, opts ...Option) (*Database, error) {
 	defer pinner.Unpin()
 
 	args := C.struct_DatabaseHandleArgs{
-		path:                 newBorrowedBytes([]byte(filePath), &pinner),
+		dir:                  newBorrowedBytes([]byte(dbDir), &pinner),
 		cache_size:           C.size_t(conf.nodeCacheEntries),
 		free_list_cache_size: C.size_t(conf.freeListCacheEntries),
 		revisions:            C.size_t(conf.revisions),
 		strategy:             C.uint8_t(conf.readCacheStrategy),
 		truncate:             C.bool(conf.truncate),
-		root_store_path:      newBorrowedBytes([]byte(conf.rootStoreDir), &pinner),
+		root_store:           C.bool(conf.rootStore),
 	}
 
 	return getDatabaseFromHandleResult(C.fwd_open_db(args))