Add configurable report module composition

internal/config/config.go

@@ -2,7 +2,13 @@
 // precedence, and validation.
 package config
 
-import "time"
+import (
+	"fmt"
+	"time"
+
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
+	"gopkg.in/yaml.v3"
+)
 
 type MissingSourcePolicy string
 type NotifyFailurePolicy string
@@ -16,15 +22,16 @@ const (
 )
 
 type Config struct {
-	WeatherAPI    WeatherAPIConfig    `yaml:"weather_api"`
-	Location      LocationConfig      `yaml:"location"`
-	Secrets       SecretsConfig       `yaml:"secrets"`
-	Notify        NotifyConfig        `yaml:"notify"`
-	MissingSource MissingSourceConfig `yaml:"missing_source"`
-	Scriptorium   ScriptoriumConfig   `yaml:"scriptorium"`
-	Workspace     WorkspaceConfig     `yaml:"workspace"`
-	Dayparts      []DaypartConfig     `yaml:"dayparts"`
-	RecentChange  RecentChangeConfig  `yaml:"recent_change"`
+	WeatherAPI    WeatherAPIConfig        `yaml:"weather_api"`
+	Location      LocationConfig          `yaml:"location"`
+	Secrets       SecretsConfig           `yaml:"secrets"`
+	Notify        NotifyConfig            `yaml:"notify"`
+	MissingSource MissingSourceConfig     `yaml:"missing_source"`
+	Scriptorium   ScriptoriumConfig       `yaml:"scriptorium"`
+	Workspace     WorkspaceConfig         `yaml:"workspace"`
+	Dayparts      []DaypartConfig         `yaml:"dayparts"`
+	RecentChange  RecentChangeConfig      `yaml:"recent_change"`
+	Reports       map[string]ReportConfig `yaml:"reports"`
 }
 
 type WeatherAPIConfig struct {
@@ -96,3 +103,71 @@ type RecentChangeConfig struct {
 	WindGustMilesPerHour     int     `yaml:"wind_gust_miles_per_hour"`
 	PrecipTimingShiftMinutes int     `yaml:"precip_timing_shift_minutes"`
 }
+
+type ReportConfig struct {
+	DeterministicModules    []ModuleConfigItem `yaml:"deterministic_modules"`
+	deterministicModulesSet bool
+}
+
+type ModuleConfigItem struct {
+	ID      module.ID `yaml:"id"`
+	Options any       `yaml:"options,omitempty"`
+}
+
+func (c *ReportConfig) UnmarshalYAML(value *yaml.Node) error {
+	if value.Kind != yaml.MappingNode {
+		return fmt.Errorf("report entry must be a mapping")
+	}
+	for i := 0; i < len(value.Content); i += 2 {
+		key := value.Content[i].Value
+		node := value.Content[i+1]
+		switch key {
+		case "deterministic_modules":
+			if err := node.Decode(&c.DeterministicModules); err != nil {
+				return err
+			}
+			c.deterministicModulesSet = true
+		default:
+			return fmt.Errorf("unknown report entry field %q", key)
+		}
+	}
+	return nil
+}
+
+func (m *ModuleConfigItem) UnmarshalYAML(value *yaml.Node) error {
+	switch value.Kind {
+	case yaml.ScalarNode:
+		if value.Value == "" {
+			return fmt.Errorf("module id is required")
+		}
+		m.ID = module.ID(value.Value)
+		return nil
+	case yaml.MappingNode:
+		var sawID bool
+		for i := 0; i < len(value.Content); i += 2 {
+			key := value.Content[i].Value
+			node := value.Content[i+1]
+			switch key {
+			case "id":
+				if err := node.Decode(&m.ID); err != nil {
+					return err
+				}
+				sawID = true
+			case "options":
+				var options any
+				if err := node.Decode(&options); err != nil {
+					return err
+				}
+				m.Options = options
+			default:
+				return fmt.Errorf("unknown module entry field %q", key)
+			}
+		}
+		if !sawID || m.ID == "" {
+			return fmt.Errorf("module id is required")
+		}
+		return nil
+	default:
+		return fmt.Errorf("module entry must be a string or mapping")
+	}
+}

internal/config/config_test.go

@@ -6,6 +6,9 @@ import (
 	"strings"
 	"testing"
 	"time"
+
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
 )
 
 func TestDefaults(t *testing.T) {
@@ -116,6 +119,138 @@ func TestLoadMinimalExampleConfig(t *testing.T) {
 	}
 }
 
+func TestLoadReportModuleOverrides(t *testing.T) {
+	path := writeConfig(t, `
+reports:
+  daily:
+    deterministic_modules:
+      - metadata
+      - current_conditions
+      - id: area_forecast_discussion
+        options:
+          sections:
+            - short_term
+`)
+
+	cfg, err := LoadFile(path)
+	if err != nil {
+		t.Fatalf("LoadFile() error = %v", err)
+	}
+	overrides := cfg.ReportModuleOverrides()
+	items := overrides[report.DailyToday]
+	if len(items) != 3 {
+		t.Fatalf("daily override length = %d, want 3", len(items))
+	}
+	if items[0].ID != module.Metadata || items[1].ID != module.CurrentConditions || items[2].ID != module.AreaForecastDiscussion {
+		t.Fatalf("daily override = %#v, want configured module order", items)
+	}
+	options, ok := items[2].Options.(module.AreaForecastDiscussionOptions)
+	if !ok {
+		t.Fatalf("AFD options type = %T, want AreaForecastDiscussionOptions", items[2].Options)
+	}
+	if strings.Join(options.Sections, ",") != "short_term" {
+		t.Fatalf("AFD sections = %#v, want short_term", options.Sections)
+	}
+}
+
+func TestReportModuleOverrideValidation(t *testing.T) {
+	tests := []struct {
+		name    string
+		yaml    string
+		wantErr string
+	}{
+		{
+			name: "UnknownReport",
+			yaml: `
+reports:
+  moon:
+    deterministic_modules:
+      - metadata
+`,
+			wantErr: "reports.moon",
+		},
+		{
+			name: "UnknownModule",
+			yaml: `
+reports:
+  daily:
+    deterministic_modules:
+      - missing_module
+`,
+			wantErr: `unknown module "missing_module"`,
+		},
+		{
+			name: "DuplicateModule",
+			yaml: `
+reports:
+  daily:
+    deterministic_modules:
+      - metadata
+      - metadata
+`,
+			wantErr: `duplicate module "metadata"`,
+		},
+		{
+			name: "IncompatibleModule",
+			yaml: `
+reports:
+  daily:
+    deterministic_modules:
+      - storm_window_summary
+`,
+			wantErr: `not compatible with report "daily_today"`,
+		},
+		{
+			name: "InvalidOptions",
+			yaml: `
+reports:
+  daily:
+    deterministic_modules:
+      - id: metadata
+        options:
+          sections:
+            - short_term
+`,
+			wantErr: "options are invalid",
+		},
+		{
+			name: "DuplicateReportAlias",
+			yaml: `
+reports:
+  daily:
+    deterministic_modules:
+      - metadata
+  daily_today:
+    deterministic_modules:
+      - current_conditions
+`,
+			wantErr: "duplicates report override",
+		},
+		{
+			name: "UnknownReportField",
+			yaml: `
+reports:
+  daily:
+    modules:
+      - metadata
+`,
+			wantErr: `unknown report entry field "modules"`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := LoadFile(writeConfig(t, tt.yaml))
+			if err == nil {
+				t.Fatal("LoadFile() error = nil, want validation error")
+			}
+			if !strings.Contains(err.Error(), tt.wantErr) {
+				t.Fatalf("error = %q, want %q", err.Error(), tt.wantErr)
+			}
+		})
+	}
+}
+
 func TestExplicitMissingConfigReturnsError(t *testing.T) {
 	_, err := LoadFile(filepath.Join(t.TempDir(), "missing.yml"))
 	if err == nil {
@@ -126,6 +261,15 @@ func TestExplicitMissingConfigReturnsError(t *testing.T) {
 	}
 }
 
+func writeConfig(t *testing.T, contents string) string {
+	t.Helper()
+	path := filepath.Join(t.TempDir(), "config.yml")
+	if err := os.WriteFile(path, []byte(contents), 0o600); err != nil {
+		t.Fatalf("write config fixture: %v", err)
+	}
+	return path
+}
+
 func TestInvalidConfigProducesActionableError(t *testing.T) {
 	dir := t.TempDir()
 	path := filepath.Join(dir, "config.yml")

internal/config/defaults.go

@@ -65,5 +65,6 @@ func Defaults() Config {
 			WindGustMilesPerHour:     10,
 			PrecipTimingShiftMinutes: 120,
 		},
+		Reports: map[string]ReportConfig{},
 	}
 }

internal/config/load.go

@@ -35,6 +35,10 @@ func Load(opts LoadOptions) (Config, error) {
 		cfg.WeatherAPI.Timezone = opts.Timezone
 	}
 
+	if err := normalizeReportModules(&cfg); err != nil {
+		return Config{}, err
+	}
+
 	if err := loadSecrets(cfg.Secrets); err != nil {
 		return Config{}, err
 	}
@@ -61,5 +65,8 @@ func mergeFile(cfg *Config, path string) error {
 	if cfg.MissingSource.Sources == nil {
 		cfg.MissingSource.Sources = map[string]MissingSourcePolicy{}
 	}
+	if cfg.Reports == nil {
+		cfg.Reports = map[string]ReportConfig{}
+	}
 	return nil
 }

internal/config/reports.go

@@ -0,0 +1,125 @@
+package config
+
+import (
+	"bytes"
+	"fmt"
+	"reflect"
+	"strings"
+
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/briefing"
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/module"
+	"gitea.maximumdirect.net/eric/weatherreporter/internal/report"
+	"gopkg.in/yaml.v3"
+)
+
+func (cfg Config) ReportModuleOverrides() map[report.ID][]module.ConfigItem {
+	overrides := map[report.ID][]module.ConfigItem{}
+	for key, reportCfg := range cfg.Reports {
+		if !reportCfg.deterministicModulesSet {
+			continue
+		}
+		id, err := reportIDForConfigKey(key)
+		if err != nil {
+			continue
+		}
+		items := make([]module.ConfigItem, 0, len(reportCfg.DeterministicModules))
+		for _, item := range reportCfg.DeterministicModules {
+			items = append(items, module.ConfigItem{ID: item.ID, Options: item.Options})
+		}
+		overrides[id] = items
+	}
+	return overrides
+}
+
+func normalizeReportModules(cfg *Config) error {
+	if cfg.Reports == nil {
+		cfg.Reports = map[string]ReportConfig{}
+	}
+	moduleRegistry, err := briefing.DefaultModuleRegistry()
+	if err != nil {
+		return fmt.Errorf("initialize module registry: %w", err)
+	}
+	reportRegistry := report.DefaultRegistry()
+	seenReports := map[report.ID]string{}
+	for key, reportCfg := range cfg.Reports {
+		reportID, err := reportIDForConfigKey(key)
+		if err != nil {
+			return err
+		}
+		if previous, ok := seenReports[reportID]; ok {
+			return fmt.Errorf("reports.%s duplicates report override %q", key, previous)
+		}
+		seenReports[reportID] = key
+		if _, err := reportRegistry.Lookup(reportID); err != nil {
+			return fmt.Errorf("reports.%s: %w", key, err)
+		}
+		if !reportCfg.deterministicModulesSet {
+			continue
+		}
+		items := make([]module.ConfigItem, 0, len(reportCfg.DeterministicModules))
+		for i, rawItem := range reportCfg.DeterministicModules {
+			options, err := normalizeModuleOptions(moduleRegistry, rawItem.ID, rawItem.Options)
+			if err != nil {
+				return fmt.Errorf("reports.%s.deterministic_modules[%d]: %w", key, i, err)
+			}
+			reportCfg.DeterministicModules[i].Options = options
+			items = append(items, module.ConfigItem{ID: rawItem.ID, Options: options})
+		}
+		if err := moduleRegistry.ValidateComposition(reportID, items); err != nil {
+			return fmt.Errorf("reports.%s.deterministic_modules: %w", key, err)
+		}
+		cfg.Reports[key] = reportCfg
+	}
+	return nil
+}
+
+func normalizeModuleOptions(registry briefing.ModuleRegistry, id module.ID, raw any) (any, error) {
+	if raw == nil {
+		return nil, nil
+	}
+	definition, err := registry.Lookup(id)
+	if err != nil {
+		return nil, err
+	}
+	if definition.DefaultOptions == nil {
+		return nil, fmt.Errorf("module %q does not accept options", id)
+	}
+	optionType := reflect.TypeOf(definition.DefaultOptions)
+	normalized, err := decodeKnownOptions(raw, optionType)
+	if err != nil {
+		return nil, fmt.Errorf("module %q options are invalid: %w", id, err)
+	}
+	return normalized, nil
+}
+
+func decodeKnownOptions(raw any, optionType reflect.Type) (any, error) {
+	data, err := yaml.Marshal(raw)
+	if err != nil {
+		return nil, err
+	}
+	target := reflect.New(optionType)
+	decoder := yaml.NewDecoder(bytes.NewReader(data))
+	decoder.KnownFields(true)
+	if err := decoder.Decode(target.Interface()); err != nil {
+		return nil, err
+	}
+	return target.Elem().Interface(), nil
+}
+
+func reportIDForConfigKey(key string) (report.ID, error) {
+	normalized := strings.ReplaceAll(strings.TrimSpace(strings.ToLower(key)), "-", "_")
+	switch normalized {
+	case "daily", "daily_today":
+		return report.DailyToday, nil
+	case "tomorrow", "daily_tomorrow":
+		return report.DailyTomorrow, nil
+	case "three_day", "three_day_outlook":
+		return report.ThreeDay, nil
+	case "weekend", "weekend_outlook":
+		return report.Weekend, nil
+	case "storm", "storm_report":
+		return report.Storm, nil
+	default:
+		return "", fmt.Errorf("reports.%s is not a known report", key)
+	}
+}

internal/config/validate.go

@@ -9,6 +9,9 @@ import (
 )
 
 func Validate(cfg Config) error {
+	if err := normalizeReportModules(&cfg); err != nil {
+		return err
+	}
 	if cfg.WeatherAPI.BaseURL != "" {
 		parsed, err := url.Parse(cfg.WeatherAPI.BaseURL)
 		if err != nil || parsed.Scheme == "" || parsed.Host == "" {