Cut configuration and CLI over to output cache and debug surfaces

internal/core/config/file_config.go

@@ -8,7 +8,6 @@ import (
 	"sort"
 	"strings"
 
-	"gitea.maximumdirect.net/eric/notarius/internal/core/diagnostics"
 	"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
 	"gopkg.in/yaml.v3"
 )
@@ -18,8 +17,9 @@ type FileConfig struct {
 	Scriptorium *FileScriptoriumConfig         `yaml:"scriptorium,omitempty"`
 	Pipelines   map[string]FilePipelineProfile `yaml:"pipelines,omitempty"`
 	Concurrency *FileConcurrencyConfig         `yaml:"concurrency,omitempty"`
-	Diagnostics *FileDiagnosticsConfig         `yaml:"diagnostics,omitempty"`
-	Workspace   *FileWorkspaceConfig           `yaml:"workspace,omitempty"`
+	Output      *FileOutputConfig              `yaml:"output,omitempty"`
+	Cache       *FileCacheConfig               `yaml:"cache,omitempty"`
+	Debug       *FileDebugConfig               `yaml:"debug,omitempty"`
 }
 
 type FileScriptoriumConfig struct {
@@ -48,31 +48,22 @@ type FileConcurrencyConfig struct {
 	StageWorkers map[string]int `yaml:"stage_workers,omitempty"`
 }
 
-type FileDiagnosticsConfig struct {
-	WorkDir   *string `yaml:"work_dir,omitempty"`
-	Retention *string `yaml:"retention,omitempty"`
-}
-
-type FileWorkspaceConfig struct {
-	Directory   *string                         `yaml:"directory,omitempty"`
-	ChunkCache  *FileWorkspaceChunkCacheConfig  `yaml:"chunk_cache,omitempty"`
-	Diagnostics *FileWorkspaceDiagnosticsConfig `yaml:"diagnostics,omitempty"`
-	Resume      *FileWorkspaceEnabledConfig     `yaml:"resume,omitempty"`
-	Debug       *FileWorkspaceEnabledConfig     `yaml:"debug,omitempty"`
-}
-
-type FileWorkspaceChunkCacheConfig struct {
-	Mode      *string `yaml:"mode,omitempty"`
+type FileOutputConfig struct {
 	Directory *string `yaml:"directory,omitempty"`
 }
-
-type FileWorkspaceDiagnosticsConfig struct {
-	Enabled   *bool   `yaml:"enabled,omitempty"`
-	Retention *string `yaml:"retention,omitempty"`
+type FileCacheConfig struct {
+	ChunkPlans  *FileChunkPlanCacheConfig  `yaml:"chunk_plans,omitempty"`
+	Checkpoints *FileCheckpointCacheConfig `yaml:"checkpoints,omitempty"`
 }
-
-type FileWorkspaceEnabledConfig struct {
-	Enabled *bool `yaml:"enabled,omitempty"`
+type FileChunkPlanCacheConfig struct {
+	Directory *string `yaml:"directory,omitempty"`
+	Mode      *string `yaml:"mode,omitempty"`
+}
+type FileCheckpointCacheConfig struct {
+	Directory *string `yaml:"directory,omitempty"`
+}
+type FileDebugConfig struct {
+	Directory *string `yaml:"directory,omitempty"`
 }
 
 type fileModuleBinding struct {
@@ -172,18 +163,27 @@ func LoadFileConfig(path string) (FileConfig, error) {
 }
 
 func ParseFileConfigYAML(data []byte) (FileConfig, error) {
+	var header struct {
+		Version int `yaml:"version"`
+	}
+	if err := yaml.Unmarshal(data, &header); err != nil {
+		return FileConfig{}, fmt.Errorf("decode yaml version header: %w", err)
+	}
+	if header.Version == 0 {
+		return FileConfig{}, fmt.Errorf("config version is required")
+	}
+	if header.Version == 2 {
+		return FileConfig{}, fmt.Errorf("config version 2 is no longer supported; migrate the file using the version 2-to-3 migration in docs/config.md")
+	}
+	if header.Version != SupportedFileConfigVersion {
+		return FileConfig{}, fmt.Errorf("unsupported config version %d (supported version is %d)", header.Version, SupportedFileConfigVersion)
+	}
 	var fileCfg FileConfig
 	decoder := yaml.NewDecoder(bytes.NewReader(data))
 	decoder.KnownFields(true)
 	if err := decoder.Decode(&fileCfg); err != nil {
 		return FileConfig{}, fmt.Errorf("decode yaml: %w", err)
 	}
-	if fileCfg.Version == 0 {
-		return FileConfig{}, fmt.Errorf("config version is required")
-	}
-	if fileCfg.Version != SupportedFileConfigVersion {
-		return FileConfig{}, fmt.Errorf("unsupported config version %d", fileCfg.Version)
-	}
 	return fileCfg, nil
 }
 
@@ -333,48 +333,47 @@ func (c *Config) applyFileConfigWithLookup(fileCfg FileConfig, lookup func(strin
 		c.Concurrency.extractWorkersConfigured = configured
 	}
 	c.Concurrency.recomputeStageWorkerDefaults()
-	if fileCfg.Diagnostics != nil {
-		if fileCfg.Diagnostics.WorkDir != nil {
-			c.Diagnostics.WorkDir = strings.TrimSpace(*fileCfg.Diagnostics.WorkDir)
+	if fileCfg.Output != nil && fileCfg.Output.Directory != nil {
+		c.Output.Directory = strings.TrimSpace(*fileCfg.Output.Directory)
+		if c.Output.Directory == "" {
+			return fmt.Errorf("output.directory must not be empty")
 		}
-		if fileCfg.Diagnostics.Retention != nil {
-			c.Diagnostics.Retention = diagnostics.RetentionMode(strings.TrimSpace(*fileCfg.Diagnostics.Retention))
+		if strings.ContainsRune(c.Output.Directory, '\x00') {
+			return fmt.Errorf("output.directory must not contain NUL")
 		}
 	}
-	if fileCfg.Workspace != nil {
-		if fileCfg.Workspace.Directory != nil {
-			c.Workspace.Directory = strings.TrimSpace(*fileCfg.Workspace.Directory)
-		}
-		if fileCfg.Workspace.ChunkCache != nil {
-			if fileCfg.Workspace.ChunkCache.Mode != nil {
-				mode, err := pipeline.ParseChunkCacheMode(*fileCfg.Workspace.ChunkCache.Mode)
+	if fileCfg.Cache != nil {
+		if fileCfg.Cache.ChunkPlans != nil {
+			if fileCfg.Cache.ChunkPlans.Mode != nil {
+				mode, err := pipeline.ParseChunkCacheMode(*fileCfg.Cache.ChunkPlans.Mode)
 				if err != nil {
-					return fmt.Errorf("workspace.chunk_cache.mode: %w", err)
+					return fmt.Errorf("cache.chunk_plans.mode: %w", err)
 				}
-				c.Workspace.ChunkCache.Mode = mode
+				c.Cache.ChunkPlans.Mode = mode
 			}
-			if fileCfg.Workspace.ChunkCache.Directory != nil {
-				c.Workspace.ChunkCache.Directory = cleanOptionalPath(*fileCfg.Workspace.ChunkCache.Directory)
+			if fileCfg.Cache.ChunkPlans.Directory != nil {
+				c.Cache.ChunkPlans.Directory = cleanOptionalPath(*fileCfg.Cache.ChunkPlans.Directory)
+				if strings.ContainsRune(c.Cache.ChunkPlans.Directory, '\x00') {
+					return fmt.Errorf("cache.chunk_plans.directory must not contain NUL")
+				}
 			}
 		}
-		if fileCfg.Workspace.Diagnostics != nil {
-			if fileCfg.Workspace.Diagnostics.Enabled != nil {
-				c.Workspace.Diagnostics.Enabled = *fileCfg.Workspace.Diagnostics.Enabled
-				c.Workspace.Diagnostics.enabledSet = true
+		if fileCfg.Cache.Checkpoints != nil && fileCfg.Cache.Checkpoints.Directory != nil {
+			c.Cache.Checkpoints.Directory = cleanOptionalPath(*fileCfg.Cache.Checkpoints.Directory)
+			if strings.ContainsRune(c.Cache.Checkpoints.Directory, '\x00') {
+				return fmt.Errorf("cache.checkpoints.directory must not contain NUL")
 			}
-			if fileCfg.Workspace.Diagnostics.Retention != nil {
-				c.Workspace.Diagnostics.Retention = diagnostics.RetentionMode(strings.TrimSpace(*fileCfg.Workspace.Diagnostics.Retention))
-				c.Workspace.Diagnostics.retentionSet = true
-			}
-		}
-		if fileCfg.Workspace.Resume != nil && fileCfg.Workspace.Resume.Enabled != nil {
-			c.Workspace.Resume.Enabled = *fileCfg.Workspace.Resume.Enabled
-		}
-		if fileCfg.Workspace.Debug != nil && fileCfg.Workspace.Debug.Enabled != nil {
-			c.Workspace.Debug.Enabled = *fileCfg.Workspace.Debug.Enabled
 		}
 	}
-	c.RecomputeEffectiveDiagnostics()
+	if fileCfg.Debug != nil && fileCfg.Debug.Directory != nil {
+		c.Debug.Directory = strings.TrimSpace(*fileCfg.Debug.Directory)
+		if c.Debug.Directory == "" {
+			return fmt.Errorf("debug.directory must not be empty")
+		}
+		if strings.ContainsRune(c.Debug.Directory, '\x00') {
+			return fmt.Errorf("debug.directory must not contain NUL")
+		}
+	}
 
 	return nil
 }