delta-funnel 0.1.2

Lightweight, fast Delta Lake to SQL Server loads with DataFusion SQL and native TDS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
//! Default target derivation for Delta scan file task partitions.
//!
//! The policy is intentionally conservative and CPU-oriented. Explicit
//! DeltaFunnel configuration wins first, and machine-derived parallelism is
//! reduced by cheap OS resource hints when those hints are available. Unit tests
//! inject machine context instead of reading host state.

use super::super::execution::environment::{
    DeltaExecutionEnvironmentProfile, DeltaExecutionOsFamily, DeltaMemoryHint,
    DeltaUnixFileDescriptorLimit, DeltaUnixResourceLimit,
};
use super::file_task_partition::DeltaScanFileTaskPartitionOptions;
use crate::{DeltaFunnelError, error::DeltaScanFileTaskPartitionPlanningSnafu};

const DEFAULT_MIN_PARTITIONS: usize = 1;
const DEFAULT_PARALLELISM_MULTIPLIER: usize = 1;
// Conservative pre-benchmark guards used to keep fallback partition counts from
// over-consuming per-partition OS resources. Issue #128's benchmark matrix is
// expected to validate or replace these policy variables before they become
// performance-tuned defaults.
const DEFAULT_FILE_DESCRIPTORS_PER_PARTITION: usize = 16;
const DEFAULT_AVAILABLE_MEMORY_BYTES_PER_PARTITION: u64 = 256 * 1024 * 1024;

/// Provider scan context used to report target-derivation failures.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) struct DeltaScanPartitionTargetContext<'a> {
    /// DataFusion table name for this source.
    pub(crate) source_name: &'a str,
    /// Normalized Delta table URI for this source.
    pub(crate) table_uri: &'a str,
    /// Resolved Delta snapshot version.
    pub(crate) snapshot_version: u64,
}

/// Inputs used to derive the scan file task partition target.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) struct DeltaScanPartitionTargetConfig {
    /// User-provided DeltaFunnel override, if configured.
    pub(crate) explicit_target_partitions: Option<usize>,
    /// DataFusion execution target partition count, if available.
    pub(crate) datafusion_target_partitions: Option<usize>,
    /// Local execution environment profile used for fallback target derivation.
    pub(crate) environment_profile: DeltaExecutionEnvironmentProfile,
}

/// Conservative fallback policy for deriving scan partition targets.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) struct DeltaScanPartitionTargetPolicy {
    /// Lower bound for machine-derived fallback targets.
    pub(crate) min_default_partitions: usize,
    /// Multiplier applied to available parallelism before resource caps.
    pub(crate) parallelism_multiplier: usize,
    /// File descriptors reserved per fallback scan partition on Unix platforms.
    ///
    /// This is a conservative policy variable for benchmark validation, not a
    /// measured optimum.
    pub(crate) file_descriptors_per_partition: usize,
    /// Available memory reserved per fallback scan partition when memory is known.
    ///
    /// This is a conservative policy variable for benchmark validation, not a
    /// measured optimum.
    pub(crate) available_memory_bytes_per_partition: u64,
}

/// Source that selected the final scan partition target.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) enum DeltaScanPartitionTargetSource {
    /// User-provided DeltaFunnel override selected the target.
    ExplicitOverride,
    /// Bounded host parallelism fallback selected the target.
    AvailableParallelismFallback,
    /// Static fallback selected the target because host parallelism was unavailable.
    StaticFallback,
}

/// Derived scan partition target plus diagnostic inputs.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) struct DeltaScanPartitionTargetDecision {
    /// Final target partition count passed to file task grouping.
    pub(crate) target_partitions: usize,
    /// Input source that selected the final target.
    pub(crate) source: DeltaScanPartitionTargetSource,
    /// Original user override input.
    pub(crate) explicit_target_partitions: Option<usize>,
    /// Original DataFusion execution target input, retained for diagnostics.
    pub(crate) datafusion_target_partitions: Option<usize>,
    /// Execution environment profile used by this decision.
    pub(crate) environment_profile: DeltaExecutionEnvironmentProfile,
    /// Resource caps that affected fallback target derivation.
    pub(crate) applied_caps: DeltaScanPartitionTargetAppliedCaps,
    /// Policy used for fallback target derivation.
    pub(crate) policy: DeltaScanPartitionTargetPolicy,
}

/// Resource caps applied to fallback target derivation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) struct DeltaScanPartitionTargetAppliedCaps {
    /// Cap derived from DataFusion execution target partitions.
    pub(crate) datafusion_target_partitions: Option<usize>,
    /// Cap derived from Unix file descriptor limits.
    pub(crate) unix_file_descriptor_limit: Option<usize>,
    /// Cap derived from available memory hints.
    pub(crate) memory_hint: Option<usize>,
}

impl Default for DeltaScanPartitionTargetPolicy {
    fn default() -> Self {
        Self {
            min_default_partitions: DEFAULT_MIN_PARTITIONS,
            parallelism_multiplier: DEFAULT_PARALLELISM_MULTIPLIER,
            file_descriptors_per_partition: DEFAULT_FILE_DESCRIPTORS_PER_PARTITION,
            available_memory_bytes_per_partition: DEFAULT_AVAILABLE_MEMORY_BYTES_PER_PARTITION,
        }
    }
}

impl DeltaScanPartitionTargetConfig {
    /// Builds config from DataFusion execution state and local host signals.
    ///
    /// DataFusion always exposes a non-null target partition value. The scan
    /// target policy records that value for diagnostics, but does not treat the
    /// DataFusion default as an explicit DeltaFunnel override.
    #[allow(dead_code)]
    pub(crate) fn from_datafusion_target(datafusion_target_partitions: usize) -> Self {
        Self::from_scan_targets(datafusion_target_partitions, None)
    }

    /// Builds config from DataFusion execution state plus an optional DeltaFunnel override.
    ///
    /// The explicit DeltaFunnel target is source-local and wins over DataFusion's
    /// broader session target when present.
    #[allow(dead_code)]
    pub(crate) fn from_scan_targets(
        datafusion_target_partitions: usize,
        explicit_target_partitions: Option<usize>,
    ) -> Self {
        Self {
            explicit_target_partitions,
            datafusion_target_partitions: Some(datafusion_target_partitions),
            environment_profile: DeltaExecutionEnvironmentProfile::from_local_environment(),
        }
    }
}

impl DeltaScanPartitionTargetPolicy {
    /// Derives the target partition count for one provider scan.
    #[allow(dead_code)]
    pub(crate) fn derive_target(
        self,
        context: DeltaScanPartitionTargetContext<'_>,
        config: DeltaScanPartitionTargetConfig,
    ) -> Result<DeltaScanPartitionTargetDecision, DeltaFunnelError> {
        self.validate(context)?;

        if let Some(target_partitions) = config.explicit_target_partitions {
            self.validate_target(context, "explicit target_partitions", target_partitions)?;
            return Ok(self.decision(
                DeltaScanPartitionTargetSource::ExplicitOverride,
                target_partitions,
                config,
            ));
        }

        if let Some(target_partitions) = config.datafusion_target_partitions {
            self.validate_target(context, "DataFusion target_partitions", target_partitions)?;
        }

        let (source, target_partitions, applied_caps) =
            match config.environment_profile.available_parallelism {
                Some(available_parallelism) => {
                    self.validate_target(context, "available_parallelism", available_parallelism)?;
                    let multiplied = available_parallelism
                        .saturating_mul(self.parallelism_multiplier)
                        .max(self.min_default_partitions);
                    let (capped, applied_caps) = self.apply_fallback_caps(multiplied, config);

                    (
                        DeltaScanPartitionTargetSource::AvailableParallelismFallback,
                        capped,
                        applied_caps,
                    )
                }
                None => {
                    let (capped, applied_caps) =
                        self.apply_fallback_caps(self.min_default_partitions, config);
                    (
                        DeltaScanPartitionTargetSource::StaticFallback,
                        capped,
                        applied_caps,
                    )
                }
            };

        Ok(self.fallback_decision(source, target_partitions, config, applied_caps))
    }

    fn validate(
        self,
        context: DeltaScanPartitionTargetContext<'_>,
    ) -> Result<(), DeltaFunnelError> {
        if self.min_default_partitions == 0 {
            return target_planning_error(
                context,
                "min_default_partitions must be greater than zero",
            );
        }
        if self.parallelism_multiplier == 0 {
            return target_planning_error(
                context,
                "parallelism_multiplier must be greater than zero",
            );
        }
        if self.file_descriptors_per_partition == 0 {
            return target_planning_error(
                context,
                "file_descriptors_per_partition must be greater than zero",
            );
        }
        if self.available_memory_bytes_per_partition == 0 {
            return target_planning_error(
                context,
                "available_memory_bytes_per_partition must be greater than zero",
            );
        }

        Ok(())
    }

    fn validate_target(
        self,
        context: DeltaScanPartitionTargetContext<'_>,
        target_name: &str,
        target_partitions: usize,
    ) -> Result<(), DeltaFunnelError> {
        if target_partitions == 0 {
            return target_planning_error(
                context,
                format!("{target_name} must be greater than zero"),
            );
        }

        Ok(())
    }

    fn decision(
        self,
        source: DeltaScanPartitionTargetSource,
        target_partitions: usize,
        config: DeltaScanPartitionTargetConfig,
    ) -> DeltaScanPartitionTargetDecision {
        DeltaScanPartitionTargetDecision {
            target_partitions,
            source,
            explicit_target_partitions: config.explicit_target_partitions,
            datafusion_target_partitions: config.datafusion_target_partitions,
            environment_profile: config.environment_profile,
            applied_caps: DeltaScanPartitionTargetAppliedCaps {
                datafusion_target_partitions: None,
                unix_file_descriptor_limit: None,
                memory_hint: None,
            },
            policy: self,
        }
    }

    fn fallback_decision(
        self,
        source: DeltaScanPartitionTargetSource,
        target_partitions: usize,
        config: DeltaScanPartitionTargetConfig,
        applied_caps: DeltaScanPartitionTargetAppliedCaps,
    ) -> DeltaScanPartitionTargetDecision {
        DeltaScanPartitionTargetDecision {
            target_partitions,
            source,
            explicit_target_partitions: config.explicit_target_partitions,
            datafusion_target_partitions: config.datafusion_target_partitions,
            environment_profile: config.environment_profile,
            applied_caps,
            policy: self,
        }
    }

    fn apply_fallback_caps(
        self,
        target_partitions: usize,
        config: DeltaScanPartitionTargetConfig,
    ) -> (usize, DeltaScanPartitionTargetAppliedCaps) {
        let datafusion_target_partitions = config.datafusion_target_partitions;
        let unix_file_descriptor_limit = self.unix_file_descriptor_cap(config);
        let memory_hint = self.memory_cap(config.environment_profile.memory_hint);
        let mut capped_target = target_partitions;

        if let Some(cap) = datafusion_target_partitions {
            capped_target = capped_target.min(cap);
        }
        if let Some(cap) = unix_file_descriptor_limit {
            capped_target = capped_target.min(cap);
        }
        if let Some(cap) = memory_hint {
            capped_target = capped_target.min(cap);
        }

        (
            capped_target.max(1),
            DeltaScanPartitionTargetAppliedCaps {
                datafusion_target_partitions,
                unix_file_descriptor_limit,
                memory_hint,
            },
        )
    }

    fn unix_file_descriptor_cap(self, config: DeltaScanPartitionTargetConfig) -> Option<usize> {
        let limit = config.environment_profile.unix_file_descriptor_limit?;
        let DeltaUnixResourceLimit::Finite(soft_limit) = limit.soft_limit else {
            return None;
        };
        let soft_limit = usize::try_from(soft_limit).ok()?;

        Some((soft_limit / self.file_descriptors_per_partition).max(1))
    }

    fn memory_cap(self, memory_hint: Option<DeltaMemoryHint>) -> Option<usize> {
        let available_bytes = memory_hint?.available_bytes?;
        let cap = available_bytes / self.available_memory_bytes_per_partition;

        usize::try_from(cap).ok().map(|cap| cap.max(1))
    }
}

impl DeltaScanPartitionTargetDecision {
    /// Builds grouping options while preserving diagnostics on this decision.
    #[allow(dead_code)]
    pub(crate) fn file_task_partition_options(&self) -> DeltaScanFileTaskPartitionOptions {
        DeltaScanFileTaskPartitionOptions {
            target_partitions: self.target_partitions,
        }
    }
}

/// Diagnostic input for scan partition target benchmark tools.
#[doc(hidden)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DeltaScanPartitionTargetDiagnosticInput {
    /// Explicit DeltaFunnel target override.
    pub explicit_target_partitions: Option<usize>,
    /// DataFusion execution target, used as an upper cap during fallback.
    pub datafusion_target_partitions: Option<usize>,
    /// Available host parallelism used as the fallback baseline.
    pub available_parallelism: Option<usize>,
    /// Available memory in bytes, used as an upper cap when present.
    pub available_memory_bytes: Option<u64>,
    /// Unix soft file descriptor limit, used as an upper cap when present.
    pub unix_soft_file_descriptor_limit: Option<u64>,
    /// Minimum fallback partition count.
    pub min_default_partitions: usize,
    /// Multiplier applied to available parallelism before caps.
    pub parallelism_multiplier: usize,
    /// File descriptors reserved per fallback scan partition.
    pub file_descriptors_per_partition: usize,
    /// Available memory reserved per fallback scan partition.
    pub available_memory_bytes_per_partition: u64,
}

/// Diagnostic output for scan partition target benchmark tools.
#[doc(hidden)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DeltaScanPartitionTargetDiagnosticOutput {
    /// Final target partition count.
    pub target_partitions: usize,
    /// Source that selected the uncapped target.
    pub source: DeltaScanPartitionTargetDiagnosticSource,
    /// Explicit DeltaFunnel target override from the input.
    pub explicit_target_partitions: Option<usize>,
    /// DataFusion execution target from the input.
    pub datafusion_target_partitions: Option<usize>,
    /// Available host parallelism from the input.
    pub available_parallelism: Option<usize>,
    /// DataFusion cap applied during fallback.
    pub datafusion_target_cap: Option<usize>,
    /// Unix file descriptor cap applied during fallback.
    pub unix_file_descriptor_cap: Option<usize>,
    /// Memory cap applied during fallback.
    pub memory_cap: Option<usize>,
}

/// Local environment diagnostic used by scan partition benchmark tools.
#[doc(hidden)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DeltaScanPartitionTargetLocalEnvironmentDiagnostic {
    /// Production diagnostic policy input derived from cheap local host signals.
    pub policy_input: DeltaScanPartitionTargetDiagnosticInput,
    /// Total physical memory in bytes, when available.
    pub memory_total_bytes: Option<u64>,
    /// Available memory in bytes, when available.
    pub memory_available_bytes: Option<u64>,
    /// Unix soft file descriptor limit, when finite and available.
    pub unix_soft_file_descriptor_limit: Option<u64>,
    /// Status of the Unix soft file descriptor limit probe.
    pub unix_soft_file_descriptor_limit_status:
        DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus,
}

/// Diagnostic status for the local Unix fd soft limit probe.
#[doc(hidden)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus {
    /// The current platform does not expose a Unix fd limit.
    Unsupported,
    /// The probe failed or returned no usable value.
    Unknown,
    /// The Unix soft fd limit is finite and stored in the companion value.
    Finite,
    /// The Unix soft fd limit is unlimited.
    Unlimited,
}

/// Diagnostic source that selected the uncapped scan target.
#[doc(hidden)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DeltaScanPartitionTargetDiagnosticSource {
    /// Explicit DeltaFunnel override selected the target.
    ExplicitOverride,
    /// Available host parallelism selected the fallback target.
    AvailableParallelismFallback,
    /// Static fallback selected the target.
    StaticFallback,
}

impl Default for DeltaScanPartitionTargetDiagnosticInput {
    fn default() -> Self {
        Self {
            explicit_target_partitions: None,
            datafusion_target_partitions: None,
            available_parallelism: None,
            available_memory_bytes: None,
            unix_soft_file_descriptor_limit: None,
            min_default_partitions: DEFAULT_MIN_PARTITIONS,
            parallelism_multiplier: DEFAULT_PARALLELISM_MULTIPLIER,
            file_descriptors_per_partition: DEFAULT_FILE_DESCRIPTORS_PER_PARTITION,
            available_memory_bytes_per_partition: DEFAULT_AVAILABLE_MEMORY_BYTES_PER_PARTITION,
        }
    }
}

/// Derives a scan partition target using the production policy for diagnostics.
#[doc(hidden)]
pub fn derive_delta_scan_partition_target_diagnostic(
    input: DeltaScanPartitionTargetDiagnosticInput,
) -> Result<DeltaScanPartitionTargetDiagnosticOutput, DeltaFunnelError> {
    let policy = DeltaScanPartitionTargetPolicy {
        min_default_partitions: input.min_default_partitions,
        parallelism_multiplier: input.parallelism_multiplier,
        file_descriptors_per_partition: input.file_descriptors_per_partition,
        available_memory_bytes_per_partition: input.available_memory_bytes_per_partition,
    };
    let decision = policy.derive_target(
        DeltaScanPartitionTargetContext {
            source_name: "scan-target-diagnostic",
            table_uri: "diagnostic://scan-target",
            snapshot_version: 0,
        },
        DeltaScanPartitionTargetConfig {
            explicit_target_partitions: input.explicit_target_partitions,
            datafusion_target_partitions: input.datafusion_target_partitions,
            environment_profile: DeltaExecutionEnvironmentProfile {
                available_parallelism: input.available_parallelism,
                os_family: DeltaExecutionOsFamily::Other,
                memory_hint: input
                    .available_memory_bytes
                    .map(|available_bytes| DeltaMemoryHint {
                        total_bytes: None,
                        available_bytes: Some(available_bytes),
                    }),
                unix_file_descriptor_limit: input.unix_soft_file_descriptor_limit.map(
                    |soft_limit| DeltaUnixFileDescriptorLimit {
                        soft_limit: DeltaUnixResourceLimit::Finite(soft_limit),
                        hard_limit: DeltaUnixResourceLimit::Finite(soft_limit),
                    },
                ),
                io_latency_hint: None,
                runtime_probe: None,
            },
        },
    )?;

    Ok(DeltaScanPartitionTargetDiagnosticOutput {
        target_partitions: decision.target_partitions,
        source: decision.source.into(),
        explicit_target_partitions: decision.explicit_target_partitions,
        datafusion_target_partitions: decision.datafusion_target_partitions,
        available_parallelism: decision.environment_profile.available_parallelism,
        datafusion_target_cap: decision.applied_caps.datafusion_target_partitions,
        unix_file_descriptor_cap: decision.applied_caps.unix_file_descriptor_limit,
        memory_cap: decision.applied_caps.memory_hint,
    })
}

/// Collects cheap local host signals for scan partition target diagnostics.
#[doc(hidden)]
pub fn delta_scan_partition_target_local_environment_diagnostic()
-> DeltaScanPartitionTargetLocalEnvironmentDiagnostic {
    let profile = DeltaExecutionEnvironmentProfile::from_local_environment();
    let available_parallelism = profile.available_parallelism;
    let memory_total_bytes = profile
        .memory_hint
        .and_then(|memory_hint| memory_hint.total_bytes);
    let memory_available_bytes = profile
        .memory_hint
        .and_then(|memory_hint| memory_hint.available_bytes);
    let (unix_soft_file_descriptor_limit, unix_soft_file_descriptor_limit_status) =
        unix_soft_file_descriptor_diagnostic(profile.unix_file_descriptor_limit);

    DeltaScanPartitionTargetLocalEnvironmentDiagnostic {
        policy_input: DeltaScanPartitionTargetDiagnosticInput {
            available_parallelism,
            datafusion_target_partitions: available_parallelism,
            available_memory_bytes: memory_available_bytes,
            unix_soft_file_descriptor_limit,
            ..DeltaScanPartitionTargetDiagnosticInput::default()
        },
        memory_total_bytes,
        memory_available_bytes,
        unix_soft_file_descriptor_limit,
        unix_soft_file_descriptor_limit_status,
    }
}

impl From<DeltaScanPartitionTargetSource> for DeltaScanPartitionTargetDiagnosticSource {
    fn from(source: DeltaScanPartitionTargetSource) -> Self {
        match source {
            DeltaScanPartitionTargetSource::ExplicitOverride => Self::ExplicitOverride,
            DeltaScanPartitionTargetSource::AvailableParallelismFallback => {
                Self::AvailableParallelismFallback
            }
            DeltaScanPartitionTargetSource::StaticFallback => Self::StaticFallback,
        }
    }
}

fn unix_soft_file_descriptor_diagnostic(
    limit: Option<DeltaUnixFileDescriptorLimit>,
) -> (
    Option<u64>,
    DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus,
) {
    let Some(limit) = limit else {
        let status = if cfg!(unix) {
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unknown
        } else {
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unsupported
        };
        return (None, status);
    };

    match limit.soft_limit {
        DeltaUnixResourceLimit::Finite(soft_limit) => (
            Some(soft_limit),
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Finite,
        ),
        DeltaUnixResourceLimit::Unlimited => (
            None,
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unlimited,
        ),
    }
}

fn target_planning_error<T>(
    context: DeltaScanPartitionTargetContext<'_>,
    reason: impl Into<String>,
) -> Result<T, DeltaFunnelError> {
    DeltaScanFileTaskPartitionPlanningSnafu {
        source_name: context.source_name.to_owned(),
        table_uri: context.table_uri.to_owned(),
        snapshot_version: context.snapshot_version,
        reason: reason.into(),
    }
    .fail()
}

#[cfg(test)]
mod tests {
    use super::super::super::execution::environment::{
        DeltaExecutionOsFamily, DeltaMemoryHint, DeltaUnixFileDescriptorLimit,
    };
    use super::*;

    fn context() -> DeltaScanPartitionTargetContext<'static> {
        DeltaScanPartitionTargetContext {
            source_name: "orders",
            table_uri: "file:///tmp/table",
            snapshot_version: 42,
        }
    }

    fn config(
        explicit_target_partitions: Option<usize>,
        datafusion_target_partitions: Option<usize>,
        available_parallelism: Option<usize>,
    ) -> DeltaScanPartitionTargetConfig {
        DeltaScanPartitionTargetConfig {
            explicit_target_partitions,
            datafusion_target_partitions,
            environment_profile: profile(available_parallelism, None, None),
        }
    }

    fn profile(
        available_parallelism: Option<usize>,
        memory_hint: Option<DeltaMemoryHint>,
        unix_file_descriptor_limit: Option<DeltaUnixFileDescriptorLimit>,
    ) -> DeltaExecutionEnvironmentProfile {
        DeltaExecutionEnvironmentProfile {
            available_parallelism,
            os_family: DeltaExecutionOsFamily::Other,
            memory_hint,
            unix_file_descriptor_limit,
            io_latency_hint: None,
            runtime_probe: None,
        }
    }

    fn test_policy() -> DeltaScanPartitionTargetPolicy {
        DeltaScanPartitionTargetPolicy {
            min_default_partitions: 1,
            parallelism_multiplier: 1,
            file_descriptors_per_partition: 16,
            available_memory_bytes_per_partition: 256 * 1024 * 1024,
        }
    }

    #[test]
    fn explicit_target_wins_over_datafusion_and_available_parallelism()
    -> Result<(), Box<dyn std::error::Error>> {
        let decision =
            test_policy().derive_target(context(), config(Some(12), Some(8), Some(4)))?;

        assert_eq!(decision.target_partitions, 12);
        assert_eq!(
            decision.source,
            DeltaScanPartitionTargetSource::ExplicitOverride
        );
        assert_eq!(decision.explicit_target_partitions, Some(12));
        assert_eq!(decision.datafusion_target_partitions, Some(8));
        assert_eq!(decision.environment_profile.available_parallelism, Some(4));
        assert_eq!(
            decision.applied_caps,
            DeltaScanPartitionTargetAppliedCaps {
                datafusion_target_partitions: None,
                unix_file_descriptor_limit: None,
                memory_hint: None,
            }
        );
        assert_eq!(decision.file_task_partition_options().target_partitions, 12);

        Ok(())
    }

    #[test]
    fn explicit_zero_target_is_rejected() -> Result<(), Box<dyn std::error::Error>> {
        let error = test_policy()
            .derive_target(context(), config(Some(0), Some(8), Some(4)))
            .err()
            .ok_or("expected explicit zero target to fail")?;

        assert!(matches!(
            error,
            DeltaFunnelError::DeltaScanFileTaskPartitionPlanning { .. }
        ));
        assert!(error.to_string().contains("explicit target_partitions"));
        assert!(error.to_string().contains("greater than zero"));

        Ok(())
    }

    #[test]
    fn datafusion_target_caps_fallback_when_no_explicit_override()
    -> Result<(), Box<dyn std::error::Error>> {
        let decision = test_policy().derive_target(context(), config(None, Some(8), Some(16)))?;

        assert_eq!(decision.target_partitions, 8);
        assert_eq!(
            decision.source,
            DeltaScanPartitionTargetSource::AvailableParallelismFallback
        );
        assert_eq!(decision.datafusion_target_partitions, Some(8));
        assert_eq!(decision.applied_caps.datafusion_target_partitions, Some(8));

        Ok(())
    }

    #[test]
    fn datafusion_zero_target_is_rejected() -> Result<(), Box<dyn std::error::Error>> {
        let error = test_policy()
            .derive_target(context(), config(None, Some(0), Some(4)))
            .err()
            .ok_or("expected DataFusion zero target to fail")?;

        assert!(matches!(
            error,
            DeltaFunnelError::DeltaScanFileTaskPartitionPlanning { .. }
        ));
        assert!(error.to_string().contains("DataFusion target_partitions"));
        assert!(error.to_string().contains("greater than zero"));

        Ok(())
    }

    #[test]
    fn datafusion_target_cap_does_not_raise_lower_fallback()
    -> Result<(), Box<dyn std::error::Error>> {
        let decision = test_policy().derive_target(context(), config(None, Some(8), Some(4)))?;

        assert_eq!(decision.target_partitions, 4);
        assert_eq!(decision.applied_caps.datafusion_target_partitions, Some(8));

        Ok(())
    }

    #[test]
    fn diagnostic_facade_uses_production_policy_caps() -> Result<(), Box<dyn std::error::Error>> {
        let output = derive_delta_scan_partition_target_diagnostic(
            DeltaScanPartitionTargetDiagnosticInput {
                datafusion_target_partitions: Some(32),
                available_parallelism: Some(64),
                available_memory_bytes: Some(512 * 1024 * 1024),
                unix_soft_file_descriptor_limit: Some(128),
                ..DeltaScanPartitionTargetDiagnosticInput::default()
            },
        )?;

        assert_eq!(output.target_partitions, 2);
        assert_eq!(
            output.source,
            DeltaScanPartitionTargetDiagnosticSource::AvailableParallelismFallback
        );
        assert_eq!(output.datafusion_target_cap, Some(32));
        assert_eq!(output.unix_file_descriptor_cap, Some(8));
        assert_eq!(output.memory_cap, Some(2));

        Ok(())
    }

    #[test]
    fn local_environment_diagnostic_feeds_policy_input() -> Result<(), Box<dyn std::error::Error>> {
        let diagnostic = delta_scan_partition_target_local_environment_diagnostic();
        let decision = derive_delta_scan_partition_target_diagnostic(diagnostic.policy_input)?;

        assert_eq!(
            diagnostic.policy_input.datafusion_target_partitions,
            diagnostic.policy_input.available_parallelism
        );
        assert_eq!(
            diagnostic.policy_input.available_memory_bytes,
            diagnostic.memory_available_bytes
        );
        assert_eq!(
            diagnostic.policy_input.unix_soft_file_descriptor_limit,
            diagnostic.unix_soft_file_descriptor_limit
        );
        assert!(decision.target_partitions > 0);
        if diagnostic.unix_soft_file_descriptor_limit.is_some() {
            assert_eq!(
                diagnostic.unix_soft_file_descriptor_limit_status,
                DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Finite
            );
        }

        Ok(())
    }

    #[test]
    fn unix_fd_diagnostic_distinguishes_unknown_finite_and_unlimited() {
        let (value, status) = unix_soft_file_descriptor_diagnostic(None);
        assert_eq!(value, None);
        assert!(matches!(
            status,
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unknown
                | DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unsupported
        ));

        let (value, status) =
            unix_soft_file_descriptor_diagnostic(Some(DeltaUnixFileDescriptorLimit {
                soft_limit: DeltaUnixResourceLimit::Finite(128),
                hard_limit: DeltaUnixResourceLimit::Finite(256),
            }));
        assert_eq!(value, Some(128));
        assert_eq!(
            status,
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Finite
        );

        let (value, status) =
            unix_soft_file_descriptor_diagnostic(Some(DeltaUnixFileDescriptorLimit {
                soft_limit: DeltaUnixResourceLimit::Unlimited,
                hard_limit: DeltaUnixResourceLimit::Unlimited,
            }));
        assert_eq!(value, None);
        assert_eq!(
            status,
            DeltaScanPartitionTargetLocalUnixFileDescriptorLimitStatus::Unlimited
        );
    }

    #[test]
    fn diagnostic_facade_reuses_policy_validation() -> Result<(), Box<dyn std::error::Error>> {
        let error = derive_delta_scan_partition_target_diagnostic(
            DeltaScanPartitionTargetDiagnosticInput {
                datafusion_target_partitions: Some(0),
                available_parallelism: Some(4),
                ..DeltaScanPartitionTargetDiagnosticInput::default()
            },
        )
        .err()
        .ok_or("expected diagnostic input validation to fail")?;

        assert!(matches!(
            error,
            DeltaFunnelError::DeltaScanFileTaskPartitionPlanning { .. }
        ));
        assert!(error.to_string().contains("DataFusion target_partitions"));

        Ok(())
    }

    #[test]
    fn available_parallelism_fallback_uses_parallelism_without_fixed_upper_bound()
    -> Result<(), Box<dyn std::error::Error>> {
        let low = test_policy().derive_target(context(), config(None, None, Some(1)))?;
        let high = test_policy().derive_target(context(), config(None, None, Some(512)))?;

        assert_eq!(low.target_partitions, 1);
        assert_eq!(
            low.source,
            DeltaScanPartitionTargetSource::AvailableParallelismFallback
        );
        assert_eq!(high.target_partitions, 512);
        assert_eq!(
            high.source,
            DeltaScanPartitionTargetSource::AvailableParallelismFallback
        );

        Ok(())
    }

    #[test]
    fn available_parallelism_fallback_applies_policy_multiplier()
    -> Result<(), Box<dyn std::error::Error>> {
        let policy = DeltaScanPartitionTargetPolicy {
            min_default_partitions: 1,
            parallelism_multiplier: 2,
            file_descriptors_per_partition: 16,
            available_memory_bytes_per_partition: 256 * 1024 * 1024,
        };

        let decision = policy.derive_target(context(), config(None, None, Some(8)))?;

        assert_eq!(decision.target_partitions, 16);
        assert_eq!(
            decision.source,
            DeltaScanPartitionTargetSource::AvailableParallelismFallback
        );

        Ok(())
    }

    #[test]
    fn unix_file_descriptor_limit_caps_fallback_target() -> Result<(), Box<dyn std::error::Error>> {
        let config = DeltaScanPartitionTargetConfig {
            explicit_target_partitions: None,
            datafusion_target_partitions: None,
            environment_profile: profile(
                Some(64),
                None,
                Some(DeltaUnixFileDescriptorLimit {
                    soft_limit: DeltaUnixResourceLimit::Finite(64),
                    hard_limit: DeltaUnixResourceLimit::Finite(256),
                }),
            ),
        };

        let decision = test_policy().derive_target(context(), config)?;

        assert_eq!(decision.target_partitions, 4);
        assert_eq!(decision.applied_caps.datafusion_target_partitions, None);
        assert_eq!(decision.applied_caps.unix_file_descriptor_limit, Some(4));
        assert_eq!(decision.applied_caps.memory_hint, None);

        Ok(())
    }

    #[test]
    fn memory_hint_caps_fallback_target() -> Result<(), Box<dyn std::error::Error>> {
        let config = DeltaScanPartitionTargetConfig {
            explicit_target_partitions: None,
            datafusion_target_partitions: None,
            environment_profile: profile(
                Some(64),
                Some(DeltaMemoryHint {
                    total_bytes: Some(4 * 1024 * 1024 * 1024),
                    available_bytes: Some(512 * 1024 * 1024),
                }),
                None,
            ),
        };

        let decision = test_policy().derive_target(context(), config)?;

        assert_eq!(decision.target_partitions, 2);
        assert_eq!(decision.applied_caps.datafusion_target_partitions, None);
        assert_eq!(decision.applied_caps.unix_file_descriptor_limit, None);
        assert_eq!(decision.applied_caps.memory_hint, Some(2));

        Ok(())
    }

    #[test]
    fn resource_caps_do_not_override_explicit_target() -> Result<(), Box<dyn std::error::Error>> {
        let config = DeltaScanPartitionTargetConfig {
            explicit_target_partitions: Some(32),
            datafusion_target_partitions: None,
            environment_profile: profile(
                Some(64),
                Some(DeltaMemoryHint {
                    total_bytes: Some(4 * 1024 * 1024 * 1024),
                    available_bytes: Some(512 * 1024 * 1024),
                }),
                Some(DeltaUnixFileDescriptorLimit {
                    soft_limit: DeltaUnixResourceLimit::Finite(64),
                    hard_limit: DeltaUnixResourceLimit::Finite(256),
                }),
            ),
        };

        let decision = test_policy().derive_target(context(), config)?;

        assert_eq!(decision.target_partitions, 32);
        assert_eq!(
            decision.source,
            DeltaScanPartitionTargetSource::ExplicitOverride
        );
        assert_eq!(decision.applied_caps.unix_file_descriptor_limit, None);
        assert_eq!(decision.applied_caps.datafusion_target_partitions, None);
        assert_eq!(decision.applied_caps.memory_hint, None);

        Ok(())
    }

    #[test]
    fn missing_available_parallelism_uses_static_nonzero_fallback()
    -> Result<(), Box<dyn std::error::Error>> {
        let decision = test_policy().derive_target(context(), config(None, None, None))?;

        assert_eq!(decision.target_partitions, 1);
        assert_eq!(
            decision.source,
            DeltaScanPartitionTargetSource::StaticFallback
        );

        Ok(())
    }

    #[test]
    fn invalid_policy_is_rejected_before_target_derivation()
    -> Result<(), Box<dyn std::error::Error>> {
        let policy = DeltaScanPartitionTargetPolicy {
            min_default_partitions: 0,
            parallelism_multiplier: 1,
            file_descriptors_per_partition: 16,
            available_memory_bytes_per_partition: 256 * 1024 * 1024,
        };

        let error = policy
            .derive_target(context(), config(None, None, Some(8)))
            .err()
            .ok_or("expected invalid policy to fail")?;

        assert!(matches!(
            error,
            DeltaFunnelError::DeltaScanFileTaskPartitionPlanning { .. }
        ));
        assert!(error.to_string().contains("min_default_partitions"));

        Ok(())
    }
}