Skip to main content

rivet/config/
export.rs

1//! Per-export configuration: query/table/mode, chunking, format, destination link.
2//!
3//! `SchemaDriftPolicy` lives here because it is only ever read via
4//! [`ExportConfig::on_schema_drift`].
5
6use std::path::Path;
7
8use schemars::JsonSchema;
9use serde::{Deserialize, Serialize};
10
11use super::IncrementalCursorMode;
12use super::destination::DestinationConfig;
13use super::format::{CompressionProfile, CompressionType, FormatType, ParquetConfig};
14use super::resolve::{parse_file_size, resolve_vars};
15use crate::tuning::TuningConfig;
16
17/// What to do when structural schema drift is detected (column added, removed, or retyped).
18///
19/// ```yaml
20/// exports:
21///   - name: orders
22///     on_schema_drift: fail   # warn (default), continue, fail
23/// ```
24/// How deep `--validate` must verify each part's integrity.
25#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Copy, PartialEq, Eq, Default)]
26#[serde(rename_all = "snake_case")]
27pub enum VerifyMode {
28    /// Accept size-only verification when no content checksum is available.
29    #[default]
30    Size,
31    /// Require every part's content to be MD5-verified against the store's
32    /// listing; fail validation for any part that is only size-verified.
33    Content,
34}
35
36impl VerifyMode {
37    /// Whether content (not just size) verification is required.
38    pub fn requires_content(self) -> bool {
39        matches!(self, VerifyMode::Content)
40    }
41}
42
43#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Copy, PartialEq, Eq, Default)]
44#[serde(rename_all = "snake_case")]
45pub enum SchemaDriftPolicy {
46    /// Log a warning and continue. The new schema fingerprint is stored. (Default.)
47    #[default]
48    Warn,
49    /// Silently accept schema changes — store the new schema, no log output.
50    Continue,
51    /// Abort the run with a non-zero exit. The schema store is NOT updated so the
52    /// next run will detect the same change again.
53    Fail,
54}
55#[derive(Debug, Deserialize, JsonSchema, Clone)]
56#[serde(deny_unknown_fields)]
57pub struct ExportConfig {
58    pub name: String,
59    #[serde(default)]
60    pub query: Option<String>,
61    pub query_file: Option<String>,
62    /// Shortcut for `query: "SELECT * FROM <schema>.<table>"`.
63    ///
64    /// Accepts `table` or `schema.table` with ASCII-only identifiers
65    /// (`[A-Za-z_][A-Za-z0-9_]*`). Generates an unquoted single-table
66    /// query so the Postgres NUMERIC catalog-hint resolver recognises it
67    /// and auto-types `numeric(p,s)` columns without manual overrides.
68    ///
69    /// Mutually exclusive with `query` and `query_file`.
70    #[serde(default)]
71    pub table: Option<String>,
72    /// CDC only: capture **several** tables through ONE change stream (one
73    /// PostgreSQL slot / one MySQL binlog connection) instead of one export —
74    /// and one slot — per table. Each table's parts land under
75    /// `<destination>/<table>/` with their own `manifest.json` + `_SUCCESS`;
76    /// the checkpoint (stream position) is shared. Mutually exclusive with
77    /// `table:`. Not yet supported for SQL Server (capture instances are
78    /// per-table).
79    #[serde(default)]
80    pub tables: Option<Vec<String>>,
81    #[serde(default = "default_mode")]
82    pub mode: ExportMode,
83    /// Change-data-capture settings, required when `mode: cdc`. Reuses the
84    /// export's `table`, `destination`, and `format`; carries only the
85    /// CDC-specific knobs (resume checkpoint, per-engine stream params).
86    #[serde(default)]
87    pub cdc: Option<CdcExportConfig>,
88    pub cursor_column: Option<String>,
89    /// Secondary column for [`IncrementalCursorMode::Coalesce`] only (see ADR-0007).
90    #[serde(default)]
91    pub cursor_fallback_column: Option<String>,
92    /// How primary (and optional fallback) columns drive incremental progression.
93    #[serde(default)]
94    pub incremental_cursor_mode: IncrementalCursorMode,
95    pub chunk_column: Option<String>,
96    #[serde(default)]
97    pub chunk_dense: bool,
98    #[serde(default = "default_chunk_size")]
99    pub chunk_size: usize,
100    /// Target memory budget per chunk in MB. When set, `chunk_size` is derived
101    /// from this budget at plan-build time using a `pg_class` row-size estimate
102    /// (`pg_relation_size / reltuples`), clamped to `[10_000, 5_000_000]` rows.
103    ///
104    /// Mutually exclusive with an explicit non-default `chunk_size:`. Only
105    /// applies to `mode: chunked` on a Postgres source using the `table:`
106    /// shortcut (the row-size probe needs a known relation).
107    ///
108    /// ```yaml
109    /// exports:
110    ///   - name: page_views
111    ///     table: public.page_views
112    ///     mode: chunked
113    ///     chunk_size_memory_mb: 256
114    /// ```
115    #[serde(default)]
116    pub chunk_size_memory_mb: Option<u64>,
117    /// Divide the column range into exactly this many equal chunks.
118    /// Mutually exclusive with `chunk_dense` and `chunk_by_days`.
119    /// When set, `chunk_size` is computed dynamically from min/max.
120    pub chunk_count: Option<usize>,
121    pub chunk_by_days: Option<u32>,
122    /// Keyset (seek) pagination on this single index-backed unique key — the
123    /// source-safe shape for tables without a single-integer PK (OPT-4). The
124    /// column MUST be backed by a usable index (PK or unique); the planner
125    /// refuses a non-indexed key rather than emit a full-scan + filesort query.
126    pub chunk_by_key: Option<String>,
127    #[serde(default = "default_parallel")]
128    pub parallel: usize,
129
130    /// Advisory execution wave (1 = highest priority, run first). Written by
131    /// `rivet plan` from the source-aware prioritization score (see ADR-0006)
132    /// and consumed by `rivet apply`, which runs exports wave-by-wave in
133    /// ascending order. `None` = unscheduled (apply treats it as the last wave).
134    /// Operators may hand-edit it; a later `rivet plan` refreshes it in place.
135    #[serde(default, skip_serializing_if = "Option::is_none")]
136    pub wave: Option<u32>,
137
138    /// Whether this export is cheap enough to run concurrently with its
139    /// wave-mates under `rivet apply --parallel-export-processes`. Written by
140    /// `rivet plan` (true when the source-aware cost class is `Low`, i.e.
141    /// < ~100K rows); a heavier table already chunk-parallelizes internally, so
142    /// two of them at once would overload the source. `None`/`false` → the
143    /// export runs alone within its wave. Operators may hand-edit it; a later
144    /// `rivet plan` refreshes it in place.
145    #[serde(default, skip_serializing_if = "Option::is_none")]
146    pub parallel_safe: Option<bool>,
147    pub time_column: Option<String>,
148    #[serde(default = "default_time_column_type")]
149    pub time_column_type: TimeColumnType,
150    pub days_window: Option<u32>,
151
152    /// Date/time output partitioning: split this export's rows into one
153    /// destination sub-prefix per calendar bucket of this **DATE or TIMESTAMP**
154    /// column, bucketed by [`partition_granularity`](Self::partition_granularity)
155    /// (`day` / `month` / `year`), in a Hive-style `col=value/` layout
156    /// (`created_at=2023-01-01/`, `created_at=2023-01/`, `created_at=2023/`).
157    /// Requires a `{partition}` token in `destination.path` /
158    /// `destination.prefix`.
159    ///
160    /// This is **not** arbitrary value partitioning: the column's min/max is
161    /// read and parsed as a date to generate contiguous calendar buckets, so a
162    /// non-temporal column (e.g. `partition_by: status`) fails at run time with
163    /// "could not parse partition min '<value>' from column '<col>' as a date".
164    /// To split by a categorical column, write one export per value with a
165    /// `WHERE` filter instead.
166    ///
167    /// Orthogonal to `mode`: each partition runs the export's own mode, so
168    /// `mode: chunked` chunks *within* a day. Rows whose partition column is
169    /// NULL land in `col=__HIVE_DEFAULT_PARTITION__/` (Hive default partition)
170    /// so no row is silently dropped. Not compatible with `mode: time_window`.
171    ///
172    /// ```yaml
173    /// exports:
174    ///   - name: events
175    ///     table: events
176    ///     partition_by: created_at        # must be a DATE or TIMESTAMP column
177    ///     partition_granularity: day
178    ///     destination:
179    ///       type: s3
180    ///       bucket: my-bucket
181    ///       prefix: "events/{partition}/"   # → events/created_at=2023-01-01/
182    /// ```
183    #[serde(default)]
184    pub partition_by: Option<String>,
185
186    /// Calendar bucket width for [`partition_by`](Self::partition_by):
187    /// `day` (default), `month`, or `year`. Determines how the partition
188    /// column's date/timestamp range is split into contiguous Hive buckets
189    /// (`col=2023-01-01/` / `col=2023-01/` / `col=2023/`). Has no effect
190    /// unless `partition_by` is set.
191    #[serde(default)]
192    pub partition_granularity: PartitionGranularity,
193    pub format: FormatType,
194    #[serde(default)]
195    pub compression: CompressionType,
196    pub compression_level: Option<u32>,
197    pub compression_profile: Option<CompressionProfile>,
198    #[serde(default)]
199    pub skip_empty: bool,
200    pub destination: DestinationConfig,
201    /// Integrity depth required of `--validate` for this export's parts.
202    /// `size` (default) accepts size-only verification; `content` requires every
203    /// part's content MD5 to be checked against the store's listing (no
204    /// download) and **fails** validation for any part that could only be
205    /// size-verified — e.g. a part too large to upload as a single PUT (raise
206    /// `max_file_size` down so it fits), or a backend that exposes no checksum.
207    #[serde(default)]
208    pub verify: VerifyMode,
209    #[serde(default)]
210    pub meta_columns: MetaColumns,
211    #[serde(default)]
212    pub quality: Option<QualityConfig>,
213    /// Rotate to a new part when the current file reaches this size.
214    /// Accepts `B`/`KB`/`MB`/`GB` (case-insensitive) or a bare byte count;
215    /// a fractional value is allowed (`1.5GB`). Units are binary (IEC-style):
216    /// `KB` = 1024 bytes, `MB` = 1024 KB, `GB` = 1024 MB. Example: `256MB`.
217    pub max_file_size: Option<String>,
218    #[serde(default)]
219    pub chunk_checkpoint: bool,
220    pub chunk_max_attempts: Option<u32>,
221    #[serde(default)]
222    pub tuning: Option<TuningConfig>,
223    /// Optional logical group for shared source capacity (replica, host). Advisory prioritization only.
224    #[serde(default)]
225    pub source_group: Option<String>,
226    /// Hint (Epic C / ADR-0006) that this export should always be treated as reconcile-heavy
227    /// by planning, independent of the `--reconcile` CLI flag. Advisory only.
228    #[serde(default)]
229    pub reconcile_required: bool,
230
231    /// Per-column type overrides (roadmap §8). Keys are column names; values
232    /// are short type strings such as `decimal(18,2)`, `timestamp_tz`, `json`.
233    ///
234    /// ```yaml
235    /// exports:
236    ///   - name: payments
237    ///     columns:
238    ///       amount: decimal(18,2)
239    ///       fee: decimal(18,6)
240    ///       created_at: timestamp_tz
241    /// ```
242    ///
243    /// Overrides take priority over autodetection and are validated at
244    /// plan time — an invalid type string fails before the export runs.
245    #[serde(default)]
246    pub columns: std::collections::HashMap<String, String>,
247
248    /// Downstream warehouse this export targets (`bigquery` / `bq`,
249    /// `duckdb`). When set, `rivet check --type-report` resolves each column
250    /// against it (native type, honest autoload type, recovery hint) without
251    /// needing `--target` on the CLI — the CLI flag still wins when both are
252    /// present. The Parquet interchange stays target-neutral (ADR-0014 T2);
253    /// `target:` only drives guidance and the future load-schema artifact.
254    ///
255    /// ```yaml
256    /// exports:
257    ///   - name: payments
258    ///     target: bigquery
259    /// ```
260    #[serde(default)]
261    pub target: Option<String>,
262
263    /// Policy applied when structural schema drift is detected (column added, removed, or retyped).
264    /// Defaults to `warn`: log a warning and continue.
265    #[serde(default)]
266    pub on_schema_drift: SchemaDriftPolicy,
267
268    /// Growth-factor threshold for data shape drift warnings (Epic 8).
269    /// When a string/binary column's max observed byte length in the current run
270    /// exceeds `stored_max * shape_drift_warn_factor`, Rivet logs a warning.
271    /// `None` uses the default of 2.0. Set to `0.0` to disable shape tracking.
272    #[serde(default)]
273    pub shape_drift_warn_factor: Option<f64>,
274
275    /// Parquet row group tuning. Only meaningful when `format: parquet`.
276    /// When absent, the parquet library default (1,048,576 rows/group) is used.
277    #[serde(default)]
278    pub parquet: Option<ParquetConfig>,
279}
280
281impl ExportConfig {
282    /// Resolve the effective `(CompressionType, level)` for this export.
283    /// `compression_profile` takes precedence over `compression` + `compression_level`.
284    ///
285    /// L24: when a profile is set *and* a conflicting explicit codec/level was
286    /// written, warn once that the profile wins rather than silently dropping the
287    /// explicit choice. An explicit codec is only detectable when it differs from
288    /// the `#[serde(default)]` (Zstd) — a literal `compression: zstd` alongside a
289    /// profile is indistinguishable from an omitted field and stays silent.
290    pub fn effective_compression(&self) -> (CompressionType, Option<u32>) {
291        if let Some(profile) = self.compression_profile {
292            let explicit_codec =
293                (self.compression != CompressionType::default()).then_some(self.compression);
294            if let Some(msg) = super::format::compression_profile_override_warning(
295                profile,
296                explicit_codec,
297                self.compression_level,
298            ) {
299                log::warn!("export '{}': {}", self.name, msg);
300            }
301            profile.to_codec()
302        } else {
303            (self.compression, self.compression_level)
304        }
305    }
306
307    pub fn max_file_size_bytes(&self) -> Option<u64> {
308        self.max_file_size
309            .as_ref()
310            .and_then(|s| parse_file_size(s).ok())
311    }
312
313    pub fn resolve_query(
314        &self,
315        config_dir: &Path,
316        params: Option<&std::collections::HashMap<String, String>>,
317    ) -> crate::error::Result<String> {
318        // table: shortcut takes precedence — already validated by
319        // `validate_business_rules` to be mutually exclusive with query/query_file.
320        if let Some(tbl) = &self.table {
321            validate_table_shortcut_ident(&self.name, tbl)?;
322            return Ok(format!("SELECT * FROM {tbl}"));
323        }
324        match (&self.query, &self.query_file) {
325            (Some(q), None) => {
326                if params.is_some() {
327                    resolve_vars(q, params)
328                } else {
329                    Ok(q.clone())
330                }
331            }
332            (None, Some(file)) => {
333                let file_path = std::path::Path::new(file);
334                // SecOps: block absolute paths and `..` traversal components.
335                if file_path.is_absolute() {
336                    anyhow::bail!(
337                        "export '{}': query_file must be a relative path: '{}'",
338                        self.name,
339                        file
340                    );
341                }
342                if file_path
343                    .components()
344                    .any(|c| c == std::path::Component::ParentDir)
345                {
346                    anyhow::bail!(
347                        "export '{}': query_file path must not contain '..': '{}'",
348                        self.name,
349                        file
350                    );
351                }
352                let joined = config_dir.join(file);
353                // Canonicalize-based check catches symlink-based evasion for files
354                // that already exist on disk.
355                if let Ok(canonical) = joined.canonicalize() {
356                    let base = config_dir
357                        .canonicalize()
358                        .unwrap_or_else(|_| config_dir.to_path_buf());
359                    if !canonical.starts_with(&base) {
360                        anyhow::bail!(
361                            "export '{}': query_file '{}' resolves outside the config directory",
362                            self.name,
363                            file
364                        );
365                    }
366                }
367                let raw = std::fs::read_to_string(&joined)?;
368                resolve_vars(&raw, params)
369            }
370            (Some(_), Some(_)) => {
371                anyhow::bail!(
372                    "export '{}': specify either 'query' or 'query_file', not both",
373                    self.name
374                )
375            }
376            (None, None) => {
377                anyhow::bail!(
378                    "export '{}': must specify exactly one of 'query', 'query_file', or 'table'",
379                    self.name
380                )
381            }
382        }
383    }
384}
385
386/// Validate the value of the `table:` YAML shortcut.
387///
388/// Accepts ASCII identifiers in the form `<table>` or `<schema>.<table>`. Each
389/// segment must match `[A-Za-z_][A-Za-z0-9_]*`. Anything else (quoted
390/// identifiers, exotic chars, three-part names, SQL injection attempts) is
391/// rejected — the user should fall back to `query:` for those cases.
392///
393/// The bound on identifier shape keeps generated SQL safe to interpolate
394/// without quoting and ensures the generated `SELECT * FROM <ident>` form is
395/// recognised by the PG catalog-hint parser ([src/source/postgres.rs]).
396fn validate_table_shortcut_ident(export_name: &str, raw: &str) -> crate::error::Result<()> {
397    let trimmed = raw.trim();
398    if trimmed.is_empty() {
399        anyhow::bail!("export '{export_name}': 'table' is empty");
400    }
401    let parts: Vec<&str> = trimmed.split('.').collect();
402    if parts.len() > 2 {
403        anyhow::bail!(
404            "export '{export_name}': 'table' must be `<name>` or `<schema>.<name>` (got '{raw}')"
405        );
406    }
407    for part in &parts {
408        if part.is_empty() {
409            anyhow::bail!("export '{export_name}': 'table' has an empty segment in '{raw}'");
410        }
411        let mut chars = part.chars();
412        let first = chars.next().unwrap();
413        if !(first.is_ascii_alphabetic() || first == '_') {
414            anyhow::bail!(
415                "export '{export_name}': 'table' segment '{part}' must start with a letter or underscore (use 'query:' for quoted identifiers)"
416            );
417        }
418        if !chars.all(|c| c.is_ascii_alphanumeric() || c == '_') {
419            anyhow::bail!(
420                "export '{export_name}': 'table' segment '{part}' contains non-identifier characters (use 'query:' for quoted identifiers)"
421            );
422        }
423    }
424    Ok(())
425}
426
427#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)]
428#[serde(deny_unknown_fields)]
429pub struct QualityConfig {
430    pub row_count_min: Option<usize>,
431    pub row_count_max: Option<usize>,
432    #[serde(default)]
433    pub null_ratio_max: std::collections::HashMap<String, f64>,
434    #[serde(default)]
435    pub unique_columns: Vec<String>,
436    /// Cap on the number of distinct values tracked per column during uniqueness checks.
437    /// When the limit is hit, a Warn issue is emitted and tracking stops for that column.
438    /// Prevents unbounded HashSet growth on high-cardinality columns.
439    pub unique_max_entries: Option<usize>,
440}
441
442#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Default)]
443#[serde(deny_unknown_fields)]
444pub struct MetaColumns {
445    #[serde(default)]
446    pub exported_at: bool,
447    #[serde(default)]
448    pub row_hash: bool,
449}
450
451fn default_mode() -> ExportMode {
452    ExportMode::Full
453}
454
455fn default_chunk_size() -> usize {
456    100_000
457}
458
459fn default_parallel() -> usize {
460    1
461}
462
463fn default_time_column_type() -> TimeColumnType {
464    TimeColumnType::Timestamp
465}
466
467#[derive(Debug, Deserialize, JsonSchema, Clone, Copy, PartialEq, Eq)]
468#[serde(rename_all = "snake_case")]
469pub enum ExportMode {
470    Full,
471    Incremental,
472    Chunked,
473    TimeWindow,
474    /// Log-based change data capture (see [`CdcExportConfig`]): stream
475    /// INSERT/UPDATE/DELETE from the source's transaction log instead of querying
476    /// the table. Reuses the export's `table` / `destination` / `format`.
477    Cdc,
478}
479
480/// Default PostgreSQL logical slot when `cdc.slot` is omitted — shared by the
481/// runner ([`crate::pipeline`]'s cdc job) and config validation, so the
482/// same-slot conflict check sees the value that will actually be used.
483pub const DEFAULT_PG_SLOT: &str = "rivet_slot";
484/// Default MySQL replica `server_id` when `cdc.server_id` is omitted (see
485/// [`DEFAULT_PG_SLOT`] for why this is a shared const).
486pub const DEFAULT_MYSQL_SERVER_ID: u32 = 4271;
487
488/// What the FIRST CDC run does before draining changes.
489#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Copy, PartialEq, Eq)]
490#[serde(rename_all = "lowercase")]
491pub enum CdcInitialMode {
492    /// Anchor-then-snapshot: create the resume anchor (PostgreSQL slot /
493    /// MySQL binlog checkpoint / SQL Server LSN checkpoint) FIRST, then run a
494    /// full batch snapshot of each table into `<destination>[/<table>]/snapshot/`,
495    /// then drain CDC. Because the anchor predates the snapshot read, anything
496    /// changed during the snapshot also appears in the change stream — an
497    /// overlap (dedupe by PK + `__op`), never a gap. The safe switch ordering,
498    /// enforced by construction instead of operator discipline.
499    Snapshot,
500}
501
502/// Per-export CDC settings, required when `mode: cdc`. The output `table`,
503/// `destination`, and `format` come from the export itself; this carries only the
504/// CDC-specific knobs (resume + per-engine stream params).
505#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Default)]
506pub struct CdcExportConfig {
507    /// First-run behaviour: `snapshot` = anchor → full snapshot → drain (see
508    /// [`CdcInitialMode`]). Omitted ⇒ capture changes only (the default; the
509    /// operator owns the initial load).
510    #[serde(default)]
511    pub initial: Option<CdcInitialMode>,
512    /// Persist/resume the source log position to this file. Omit to tail from the
513    /// current position without checkpointing.
514    pub checkpoint: Option<String>,
515    /// Catch up to the source's current end and exit (a bounded run), instead of
516    /// streaming indefinitely — ideal for a scheduler. For MySQL this is a
517    /// non-blocking binlog dump; PostgreSQL / SQL Server already drain-and-exit.
518    #[serde(default)]
519    pub until_current: bool,
520    /// Stop after N change events (default: until end of stream / interrupted).
521    pub max_events: Option<usize>,
522    /// Rows per output part file (default 100000). A part also rolls at a
523    /// transaction boundary, so it never splits a transaction. Larger ⇒ fewer,
524    /// bigger files but more drain memory — the PostgreSQL peek reads a part's
525    /// worth per batch, so drain RSS is O(rollover). Tune per workload: raise it
526    /// to cut file count, lower it to cap memory on a small extractor.
527    pub rollover: Option<usize>,
528    /// Roll a part once its buffered changes reach this many MB, whichever comes
529    /// first with `rollover`. Caps the in-memory buffer and the part file size by
530    /// bytes instead of a fixed row count — predictable for tables with wide
531    /// (large JSON / blob) rows, mirroring the batch path's `batch_size_memory_mb`.
532    pub rollover_memory_mb: Option<usize>,
533    /// MySQL replica server-id for the binlog connection (default 4271; must be
534    /// distinct from the source's and any other replica).
535    pub server_id: Option<u32>,
536    /// PostgreSQL logical replication slot name (default `rivet_slot`).
537    pub slot: Option<String>,
538    /// SQL Server CDC capture instance, e.g. `dbo_orders` — required for
539    /// `sqlserver://` sources.
540    pub capture_instance: Option<String>,
541}
542
543#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Copy, PartialEq, Eq)]
544#[serde(rename_all = "lowercase")]
545pub enum TimeColumnType {
546    Timestamp,
547    Unix,
548}
549
550/// Calendar bucket width for date/timestamp output partitioning
551/// ([`ExportConfig::partition_by`]). The partition column must be a DATE or
552/// TIMESTAMP column; this picks how its range is split into contiguous Hive
553/// buckets. It is not a knob for partitioning by arbitrary column values.
554#[derive(Debug, Deserialize, Serialize, JsonSchema, Clone, Copy, PartialEq, Eq, Default)]
555#[serde(rename_all = "lowercase")]
556pub enum PartitionGranularity {
557    /// One bucket per calendar day (`col=2023-01-01/`). Default.
558    #[default]
559    Day,
560    /// One bucket per calendar month (`col=2023-01/`).
561    Month,
562    /// One bucket per calendar year (`col=2023/`).
563    Year,
564}
565
566/// Canonical fully-populated [`ExportConfig`] for tests across the crate.
567///
568/// One place lists every field, so adding a field is a single-site edit (the
569/// compiler still flags this literal if a field is missing). Test call sites
570/// take this baseline and override only the fields they exercise, rather than
571/// hand-writing the full struct — see `plan::build` and `preflight` tests.
572#[cfg(test)]
573pub(crate) fn sample_export(name: &str) -> ExportConfig {
574    ExportConfig {
575        name: name.into(),
576        target: None,
577        verify: VerifyMode::Size,
578        query: Some("SELECT 1".into()),
579        query_file: None,
580        table: None,
581        tables: None,
582        mode: ExportMode::Full,
583        cdc: None,
584        cursor_column: None,
585        cursor_fallback_column: None,
586        incremental_cursor_mode: Default::default(),
587        chunk_column: None,
588        chunk_dense: false,
589        chunk_size: 100_000,
590        chunk_size_memory_mb: None,
591        chunk_count: None,
592        chunk_by_days: None,
593        chunk_by_key: None,
594        parallel: 1,
595        wave: None,
596        parallel_safe: None,
597        time_column: None,
598        time_column_type: TimeColumnType::Timestamp,
599        days_window: None,
600        partition_by: None,
601        partition_granularity: PartitionGranularity::Day,
602        format: FormatType::Parquet,
603        compression: CompressionType::None,
604        compression_level: None,
605        compression_profile: None,
606        skip_empty: false,
607        destination: crate::config::DestinationConfig {
608            destination_type: crate::config::DestinationType::Local,
609            path: Some("/tmp".into()),
610            ..Default::default()
611        },
612        meta_columns: MetaColumns::default(),
613        quality: None,
614        max_file_size: None,
615        chunk_checkpoint: false,
616        chunk_max_attempts: None,
617        tuning: None,
618        source_group: None,
619        reconcile_required: false,
620        columns: Default::default(),
621        on_schema_drift: Default::default(),
622        shape_drift_warn_factor: None,
623        parquet: None,
624    }
625}
626
627#[cfg(test)]
628mod tests {
629    use super::*;
630
631    // ── ExportConfig::max_file_size_bytes ───────────────────────────────────
632
633    fn make_export_yaml(name: &str, extra: &str) -> ExportConfig {
634        let yaml = format!(
635            "name: {name}\nquery: \"SELECT 1\"\nformat: parquet\ndestination:\n  type: local\n  path: /tmp\n{extra}"
636        );
637        serde_yaml_ng::from_str(&yaml).expect("parse ExportConfig")
638    }
639
640    #[test]
641    fn max_file_size_bytes_none_when_unset() {
642        let exp = make_export_yaml("no_limit", "");
643        assert!(exp.max_file_size_bytes().is_none());
644    }
645
646    #[test]
647    fn max_file_size_bytes_parses_mb() {
648        let exp = make_export_yaml("sized", "max_file_size: \"128MB\"\n");
649        assert_eq!(exp.max_file_size_bytes(), Some(128 * 1024 * 1024));
650    }
651
652    #[test]
653    fn max_file_size_bytes_parses_gb() {
654        let exp = make_export_yaml("sized_gb", "max_file_size: \"2GB\"\n");
655        assert_eq!(exp.max_file_size_bytes(), Some(2 * 1024 * 1024 * 1024));
656    }
657
658    #[test]
659    fn max_file_size_bytes_returns_none_on_invalid() {
660        let exp = make_export_yaml("bad_size", "max_file_size: \"notanumber\"\n");
661        assert!(exp.max_file_size_bytes().is_none());
662    }
663
664    // ── ExportConfig::resolve_query ─────────────────────────────────────────
665
666    // Build a minimal ExportConfig directly, bypassing Config::from_yaml validation.
667    // This lets us test the four branches inside resolve_query itself, including
668    // the (both-set / neither-set) error paths that are normally prevented by the
669    // top-level validator.
670    fn make_export_direct(query: Option<&str>, query_file: Option<&str>) -> ExportConfig {
671        ExportConfig {
672            query: query.map(|s| s.to_string()),
673            query_file: query_file.map(|s| s.to_string()),
674            ..sample_export("test")
675        }
676    }
677
678    fn params(pairs: &[(&str, &str)]) -> std::collections::HashMap<String, String> {
679        pairs
680            .iter()
681            .map(|(k, v)| (k.to_string(), v.to_string()))
682            .collect()
683    }
684
685    #[test]
686    fn resolve_query_inline_no_params_returns_query_as_is() {
687        let exp = make_export_direct(Some("SELECT id FROM orders"), None);
688        let q = exp.resolve_query(Path::new("/tmp"), None).unwrap();
689        assert_eq!(q, "SELECT id FROM orders");
690    }
691
692    #[test]
693    fn resolve_query_inline_with_params_substitutes_vars() {
694        let exp = make_export_direct(Some("SELECT ${col} FROM ${table}"), None);
695        let p = params(&[("col", "id"), ("table", "orders")]);
696        let q = exp.resolve_query(Path::new("/tmp"), Some(&p)).unwrap();
697        assert_eq!(q, "SELECT id FROM orders");
698    }
699
700    #[test]
701    fn resolve_query_inline_params_empty_map_is_noop() {
702        let exp = make_export_direct(Some("SELECT 1"), None);
703        let p = params(&[]);
704        let q = exp.resolve_query(Path::new("/tmp"), Some(&p)).unwrap();
705        assert_eq!(q, "SELECT 1");
706    }
707
708    #[test]
709    fn resolve_query_inline_missing_var_returns_error() {
710        // SAFETY: test-only; this binary is single-threaded in the test runner context.
711        unsafe { std::env::remove_var("UNSET_RIVET_TEST_VAR") };
712        let exp = make_export_direct(Some("SELECT ${UNSET_RIVET_TEST_VAR}"), None);
713        let p = params(&[]);
714        let result = exp.resolve_query(Path::new("/tmp"), Some(&p));
715        assert!(result.is_err());
716        let msg = format!("{:#}", result.unwrap_err());
717        assert!(
718            msg.contains("UNSET_RIVET_TEST_VAR") || msg.contains("not set"),
719            "got: {msg}"
720        );
721    }
722
723    #[test]
724    fn resolve_query_file_reads_content() {
725        let dir = tempfile::TempDir::new().unwrap();
726        let sql_path = dir.path().join("query.sql");
727        std::fs::write(&sql_path, "SELECT * FROM customers").unwrap();
728        let exp = make_export_direct(None, Some("query.sql"));
729        let q = exp.resolve_query(dir.path(), None).unwrap();
730        assert_eq!(q, "SELECT * FROM customers");
731    }
732
733    #[test]
734    fn resolve_query_file_with_params_substitutes() {
735        let dir = tempfile::TempDir::new().unwrap();
736        let sql_path = dir.path().join("q.sql");
737        std::fs::write(&sql_path, "SELECT ${col} FROM ${tbl}").unwrap();
738        let exp = make_export_direct(None, Some("q.sql"));
739        let p = params(&[("col", "name"), ("tbl", "users")]);
740        let q = exp.resolve_query(dir.path(), Some(&p)).unwrap();
741        assert_eq!(q, "SELECT name FROM users");
742    }
743
744    // ── `table:` shortcut ───────────────────────────────────────────────────
745
746    #[test]
747    fn resolve_query_table_shortcut_qualified() {
748        let mut exp = make_export_direct(None, None);
749        exp.table = Some("public.users".into());
750        let q = exp.resolve_query(Path::new("/tmp"), None).unwrap();
751        assert_eq!(q, "SELECT * FROM public.users");
752    }
753
754    #[test]
755    fn resolve_query_table_shortcut_unqualified() {
756        let mut exp = make_export_direct(None, None);
757        exp.table = Some("orders".into());
758        let q = exp.resolve_query(Path::new("/tmp"), None).unwrap();
759        assert_eq!(q, "SELECT * FROM orders");
760    }
761
762    #[test]
763    fn resolve_query_table_shortcut_rejects_three_part_name() {
764        let mut exp = make_export_direct(None, None);
765        exp.table = Some("db.public.users".into());
766        let err = exp.resolve_query(Path::new("/tmp"), None).unwrap_err();
767        let msg = format!("{err:#}");
768        assert!(msg.contains("<schema>.<name>"), "got: {msg}");
769    }
770
771    #[test]
772    fn resolve_query_table_shortcut_rejects_sql_injection() {
773        for bad in [
774            "users; DROP TABLE x",
775            "users--",
776            "users'",
777            "users\"",
778            "public.\"My Table\"",
779            "0starts_with_digit",
780            "",
781            ".trailing",
782            "leading.",
783            "two..dots",
784        ] {
785            let mut exp = make_export_direct(None, None);
786            exp.table = Some(bad.into());
787            assert!(
788                exp.resolve_query(Path::new("/tmp"), None).is_err(),
789                "should reject `table:` value '{bad}'",
790            );
791        }
792    }
793
794    #[test]
795    fn resolve_query_table_shortcut_takes_precedence_over_query() {
796        let mut exp = make_export_direct(Some("SELECT id FROM x"), None);
797        exp.table = Some("public.y".into());
798        let q = exp.resolve_query(Path::new("/tmp"), None).unwrap();
799        assert_eq!(q, "SELECT * FROM public.y");
800    }
801
802    #[test]
803    fn resolve_query_file_missing_returns_error() {
804        let dir = tempfile::TempDir::new().unwrap();
805        let exp = make_export_direct(None, Some("nonexistent.sql"));
806        let result = exp.resolve_query(dir.path(), None);
807        assert!(result.is_err());
808        let msg = format!("{:#}", result.unwrap_err());
809        assert!(
810            msg.contains("nonexistent.sql") || msg.contains("No such file"),
811            "got: {msg}"
812        );
813    }
814
815    #[test]
816    fn resolve_query_both_set_returns_error() {
817        let mut exp = make_export_direct(Some("SELECT 1"), None);
818        exp.query_file = Some("file.sql".into());
819        let result = exp.resolve_query(Path::new("/tmp"), None);
820        assert!(result.is_err());
821        let msg = format!("{:#}", result.unwrap_err());
822        assert!(
823            msg.contains("not both") || msg.contains("query_file"),
824            "got: {msg}"
825        );
826    }
827
828    #[test]
829    fn resolve_query_neither_set_returns_error() {
830        let exp = make_export_direct(None, None);
831        let result = exp.resolve_query(Path::new("/tmp"), None);
832        assert!(result.is_err());
833        let msg = format!("{:#}", result.unwrap_err());
834        assert!(
835            msg.contains("query") || msg.contains("query_file"),
836            "got: {msg}"
837        );
838    }
839
840    // ── SecOps: query_file path traversal prevention ──────────────────────────
841
842    #[test]
843    fn resolve_query_file_dotdot_is_rejected() {
844        let dir = tempfile::TempDir::new().unwrap();
845        let exp = make_export_direct(None, Some("../secret.sql"));
846        let result = exp.resolve_query(dir.path(), None);
847        assert!(result.is_err());
848        let msg = format!("{:#}", result.unwrap_err());
849        assert!(
850            msg.contains("..") || msg.contains("traversal"),
851            "got: {msg}"
852        );
853    }
854
855    #[test]
856    fn resolve_query_file_nested_dotdot_is_rejected() {
857        let dir = tempfile::TempDir::new().unwrap();
858        let exp = make_export_direct(None, Some("subdir/../../etc/passwd"));
859        let result = exp.resolve_query(dir.path(), None);
860        assert!(result.is_err());
861        let msg = format!("{:#}", result.unwrap_err());
862        assert!(
863            msg.contains("..") || msg.contains("traversal"),
864            "got: {msg}"
865        );
866    }
867
868    #[test]
869    fn resolve_query_file_absolute_path_is_rejected() {
870        let dir = tempfile::TempDir::new().unwrap();
871        let exp = make_export_direct(None, Some("/etc/passwd"));
872        let result = exp.resolve_query(dir.path(), None);
873        assert!(result.is_err());
874        let msg = format!("{:#}", result.unwrap_err());
875        assert!(
876            msg.contains("relative") || msg.contains("absolute"),
877            "got: {msg}"
878        );
879    }
880
881    #[test]
882    fn resolve_query_file_in_subdir_is_allowed() {
883        let dir = tempfile::TempDir::new().unwrap();
884        let subdir = dir.path().join("queries");
885        std::fs::create_dir(&subdir).unwrap();
886        std::fs::write(subdir.join("orders.sql"), "SELECT * FROM orders").unwrap();
887        let exp = make_export_direct(None, Some("queries/orders.sql"));
888        let q = exp.resolve_query(dir.path(), None).unwrap();
889        assert_eq!(q, "SELECT * FROM orders");
890    }
891}