operon 0.7.0

A workflow engine for parallel, incremental scheduling of DAG-defined multiplex tasks.
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
use std::num::TryFromIntError;

use bytes::Bytes;
use futures::SinkExt;
use tokio_postgres::Row;

use crate::meta_storage::psql::error::PsqlResult;
use crate::meta_storage::psql::{PsqlClient, PsqlMetaError};
use crate::meta_storage::{MetaStorageError, MetaTicketApi};
use crate::schema::{
    DimensionMetadata, Job, OptionCoordinate, Resolution, TableShape, TaskMetadata, Ticket,
    TicketStatus,
};
use crate::utils::{
    SchemaPrefix, ShapeAction, ShapeTable, SqlParams, box_sql, build_tables, hash_metadata,
    psql_identifier, shape_query,
};

/// The table recording each task's shape ID, keyed by task ID.
pub(crate) const TICKET_SHAPES: ShapeTable<'static> = ShapeTable {
    table: "_ticket_hash",
    column: "hash",
};

/// Postgres wire (de)serialization for [`Ticket`], alongside the query builders that use it.
///
/// [`TicketStatus`] carries its own wire mapping via its `ToSql`/`FromSql` derive.
impl<const N: usize> Ticket<N> {
    /// Serializes a ticket into the ordered parameter list expected by the ticket table.
    fn as_sql_params(&self) -> Result<SqlParams, TryFromIntError> {
        let params = self
            .coordinate
            .iter()
            .map(|c| c.as_sql_param().map(box_sql))
            .chain([
                i64::try_from(self.deps_done()).map(box_sql),
                i64::try_from(self.deps_quota()).map(box_sql),
                Ok(box_sql(self.status)),
            ])
            .collect::<Result<Vec<_>, _>>()?;

        Ok(SqlParams::new(params))
    }

    /// Serializes a ticket into a `COPY ... FROM STDIN` CSV row.
    fn to_copy_string(self) -> Result<String, TryFromIntError> {
        Ok(self.as_sql_params()?.to_copy_string())
    }

    /// Materializes a ticket from a row of the ticket table.
    fn from_row(meta: TaskMetadata<N>, row: &Row) -> Result<Ticket<N>, TryFromIntError> {
        let mut coordinate = [OptionCoordinate::none(); N];
        let mut i = 0;

        while i < N {
            let c = OptionCoordinate::from_sql_value(row.get(meta.dims[i]))?;
            coordinate[i] = c;
            i += 1;
        }

        let deps_done = usize::try_from(row.get::<_, i64>("deps_done"))?;
        let deps_quota = usize::try_from(row.get::<_, i64>("deps_quota"))?;
        let status = row.get::<_, TicketStatus>("status");

        Ok(Ticket::from_parts(
            coordinate, deps_done, deps_quota, status,
        ))
    }
}

/// Helper struct for building SQL queries related to tickets.
#[derive(Debug)]
pub struct PsqlTicketQueryBuilder<'a, const N: usize> {
    client: &'a PsqlClient<'a>,
    task_meta: TaskMetadata<N>,
}

impl<'a> PsqlClient<'a> {
    /// Helper method to create a `PsqlTicketQueryBuilder` for the tickets of a given task.
    pub fn ticket<const N: usize>(
        &'a self,
        task_meta: TaskMetadata<N>,
    ) -> PsqlTicketQueryBuilder<'a, N> {
        PsqlTicketQueryBuilder {
            client: self,
            task_meta,
        }
    }
}

impl<const N: usize> PsqlTicketQueryBuilder<'_, N> {
    /// Streams `tickets` into this task's ticket table over `COPY ... FROM STDIN`.
    async fn copy_in(&self, tickets: &[Ticket<N>]) -> PsqlResult<()> {
        if tickets.is_empty() {
            return Ok(());
        }

        let copy_stmt = CopyInQuery(self.client.schema_prefix(), self.task_meta);
        let sink = self
            .client
            .copy_in::<_, Bytes>(&copy_stmt.to_string())
            .await?;
        let mut sink = Box::pin(sink);
        for ticket in tickets {
            sink.feed(ticket.to_copy_string()?.into())
                .await
                .map_err(PsqlMetaError::from)?;
        }
        sink.close().await.map_err(PsqlMetaError::from)?;
        Ok(())
    }
}

impl<const N: usize> MetaTicketApi<N> for PsqlTicketQueryBuilder<'_, N> {
    type Error = PsqlMetaError;

    async fn init(&self) -> PsqlResult<TableShape> {
        let schema_prefix = self.client.schema_prefix();
        let id = self.task_meta.id;
        let shape_record = TICKET_SHAPES.record(id);
        let shape_id = hash_metadata(&self.task_meta);
        let ticket_table = psql_identifier("ticket", id);
        let tables = [ticket_table.as_str()];

        let shape_stmt = shape_query(shape_record, &tables, schema_prefix);
        let row = self.client.query_opt(&shape_stmt, &[]).await?;
        let action = ShapeAction::from_row(row.as_ref(), &shape_id);

        let init_stmt = InitTicketQuery(schema_prefix, self.task_meta);
        let trigger_stmts = TicketSummaryTriggerQuery(schema_prefix, self.task_meta);
        let delete_stmt = TicketSummaryDeleteQuery(schema_prefix, self.task_meta);
        if let Some(stmt) = build_tables(
            shape_record,
            &tables,
            &shape_id,
            schema_prefix,
            action,
            format!("{init_stmt}\n{trigger_stmts}\n{delete_stmt}"),
        ) {
            self.client.batch_execute(&stmt).await?;
        }

        let summary_stmt = TicketSummaryInsertQuery(schema_prefix);
        let inserted_summary_rows = self
            .client
            .execute_stmt(&summary_stmt, &[&self.task_meta.id])
            .await?;

        // Ticket table was kept with live tickets, but the summary table was rebuilt.
        if inserted_summary_rows > 0 && action == ShapeAction::Keep {
            // This summary row was just zeroed out, so recount the tickets into it.
            let resync_stmt = TicketSummaryResyncQuery(schema_prefix, self.task_meta);
            let _num_rows = self.client.execute_stmt(&resync_stmt, &[]).await?;
        }
        Ok(action.into())
    }

    async fn clear(&self) -> PsqlResult<()> {
        let schema_prefix = self.client.schema_prefix();
        let stmt = ClearTicketQuery(schema_prefix, self.task_meta);
        let _num_rows = self.client.execute_stmt(&stmt, &[]).await?;
        Ok(())
    }

    async fn get_all(&self, status: TicketStatus) -> PsqlResult<Vec<Ticket<N>>> {
        let schema_prefix = self.client.schema_prefix();
        let stmt = GetAllTicketQuery(schema_prefix, self.task_meta);
        let rows = self.client.query_stmt(&stmt, &[&status]).await?;
        let tickets = rows
            .iter()
            .map(|row| Ticket::from_row(self.task_meta, row))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(tickets)
    }

    async fn put(&self, ticket: Ticket<N>) -> PsqlResult<()> {
        let schema_prefix = self.client.schema_prefix();
        let stmt = PutTicketQuery(schema_prefix, self.task_meta);
        let params = ticket.as_sql_params()?;
        let _num_rows = self.client.execute_stmt(&stmt, &params.borrow()).await?;
        Ok(())
    }

    async fn dump(&self) -> PsqlResult<Vec<Ticket<N>>> {
        let schema_prefix = self.client.schema_prefix();
        let stmt = DumpTicketQuery(schema_prefix, self.task_meta);
        let rows = self.client.query_stmt(&stmt, &[]).await?;
        let tickets = rows
            .iter()
            .map(|row| Ticket::from_row(self.task_meta, row))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(tickets)
    }

    async fn hydrate(&self, tickets: Vec<Ticket<N>>) -> PsqlResult<()> {
        self.clear().await?;
        self.copy_in(&tickets).await
    }

    async fn raise_deps_done<const M: usize>(
        &self,
        upstream_meta: TaskMetadata<M>,
        upstream_job: Job<M>,
        aggregate_dims: &[&'static str],
    ) -> PsqlResult<Vec<Ticket<N>>> {
        let schema = self.client.schema_prefix();
        let stmt = RaiseDepsDoneQuery(schema, self.task_meta, upstream_meta, aggregate_dims);

        let params = upstream_meta
            .dims
            .iter()
            .zip(upstream_job.coordinate)
            .filter(|(d, _)| self.task_meta.dims.contains(d) && !aggregate_dims.contains(d))
            .map(|(_, c)| c);
        let params = SqlParams::from_usize(params)?;

        let rows = self.client.query_stmt(&stmt, &params.borrow()).await?;
        let tickets = rows
            .iter()
            .map(|row| Ticket::from_row(self.task_meta, row))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(tickets)
    }

    async fn raise_deps_quota<const M: usize>(
        &self,
        upstream_meta: TaskMetadata<M>,
        upstream_ticket: Ticket<M>,
        aggregate_dims: &[&'static str],
        ub: usize,
    ) -> PsqlResult<Vec<Ticket<N>>> {
        let schema = self.client.schema_prefix();

        let (cols, values): (Vec<_>, Vec<_>) = upstream_meta
            .dims
            .iter()
            .zip(upstream_ticket.coordinate)
            .filter_map(|(&dim, coord)| {
                if aggregate_dims.contains(&dim) {
                    return None;
                }
                Some((dim, coord.0?))
            })
            .unzip();
        let stmt = RaiseDepsQuotaQuery(schema, self.task_meta, &cols);

        let params = SqlParams::from_usize([ub].into_iter().chain(values))?;

        let rows = self.client.query_stmt(&stmt, &params.borrow()).await?;
        let tickets = rows
            .iter()
            .map(|row| Ticket::from_row(self.task_meta, row))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(tickets)
    }

    async fn explode<const M: usize, const IDX: usize>(
        &self,
        res_meta: DimensionMetadata<M>,
        res: Resolution<M>,
    ) -> PsqlResult<Vec<Ticket<N>>> {
        const { assert!(IDX < N) }
        if self.task_meta.dims[IDX] != res_meta.id {
            tracing::warn!("Invalid resolution received for explosion.");
            return Ok(vec![]);
        }

        let schema_prefix = self.client.schema_prefix();
        let pop_stmt = ExplodePopQuery(schema_prefix, self.task_meta, res_meta);

        let params = res_meta
            .deps
            .iter()
            .zip(res.coordinate)
            .filter_map(|(d, c)| self.task_meta.dims.contains(d).then_some(c));
        let params = SqlParams::from_usize(params)?;

        let rows = self.client.query_stmt(&pop_stmt, &params.borrow()).await?;
        let tickets = rows
            .iter()
            .map(|row| Ticket::from_row(self.task_meta, row))
            .collect::<Result<Vec<_>, _>>()?;

        if tickets
            .iter()
            .any(|ticket| ticket.coordinate[IDX].is_some())
        {
            return Err(MetaStorageError::invalid_explosion(
                self.task_meta.id,
                res_meta.id,
            ));
        }

        let new_tickets = tickets
            .iter()
            .flat_map(|ticket| (0..res.ub).map(|x| ticket.with_coordinate::<IDX>(x)))
            .map(|ticket| ticket.update_status())
            .collect::<Vec<_>>();

        self.copy_in(&new_tickets).await?;

        Ok(tickets)
    }

    async fn mark_done(&self, job: Job<N>) -> PsqlResult<()> {
        let schema = self.client.schema_prefix();
        let stmt = MarkDoneQuery(schema, self.task_meta);
        let params = SqlParams::from_usize(job.coordinate)?;
        let _num_rows = self.client.execute_stmt(&stmt, &params.borrow()).await?;
        Ok(())
    }

    async fn get_status(&self) -> PsqlResult<(i64, i64, i64)> {
        let schema_prefix = self.client.schema_prefix();
        let stmt = GetStatusQuery(schema_prefix);

        let task_id = self.task_meta.id;
        let Some(row) = self.client.query_opt_stmt(&stmt, &[&task_id]).await? else {
            return Err(MetaStorageError::missing_ticket_summary(task_id));
        };

        let done: i64 = row.get("done");
        let queued: i64 = row.get("queued");
        let waiting: i64 = row.get("waiting");
        Ok((done, queued, waiting))
    }
}

/// Helper struct to generate the SQL query for initializing a ticket table.
struct InitTicketQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for InitTicketQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let dims = self.1.dims;
        let table = psql_identifier("ticket", id);

        writeln!(f, "CREATE TABLE IF NOT EXISTS {schema}{table} (",)?;
        for dim in dims {
            writeln!(f, "    {dim} BIGINT,")?;
        }
        writeln!(f, "    deps_done BIGINT NOT NULL,")?;
        writeln!(f, "    deps_quota BIGINT NOT NULL,")?;
        write!(f, "    status {schema}ticket_status NOT NULL")?;

        if dims.is_empty() {
            writeln!(f)?;
            return write!(f, ");");
        }

        writeln!(f, ",")?;
        write!(f, "    PRIMARY KEY (")?;
        for (idx, dim) in dims.iter().enumerate() {
            if idx > 0 {
                write!(f, ", ")?;
            }
            write!(f, "{dim}")?;
        }
        writeln!(f, ")")?;
        write!(f, ");")
    }
}

/// Helper struct to generate the SQL queries for ticket summary insert.
struct TicketSummaryInsertQuery<'a>(SchemaPrefix<'a>);

impl std::fmt::Display for TicketSummaryInsertQuery<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;

        writeln!(
            f,
            "INSERT INTO {schema}ticket_summary (task_id, waiting, queued, done)"
        )?;
        writeln!(f, "VALUES ($1, 0, 0, 0)")?;
        write!(f, "ON CONFLICT (task_id) DO NOTHING;")
    }
}

/// Helper struct to generate the SQL query for recounting a task's ticket summary.
struct TicketSummaryResyncQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for TicketSummaryResyncQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let table = psql_identifier("ticket", id);

        writeln!(f, "UPDATE {schema}ticket_summary SET")?;
        writeln!(f, "    waiting = counts.waiting,")?;
        writeln!(f, "    queued = counts.queued,")?;
        writeln!(f, "    done = counts.done")?;
        writeln!(f, "FROM (")?;
        writeln!(f, "    SELECT")?;
        writeln!(
            f,
            "        COUNT(*) FILTER (WHERE status = 'waiting') AS waiting,"
        )?;
        writeln!(
            f,
            "        COUNT(*) FILTER (WHERE status = 'queued') AS queued,"
        )?;
        writeln!(f, "        COUNT(*) FILTER (WHERE status = 'done') AS done")?;
        writeln!(f, "    FROM {schema}{table}")?;
        writeln!(f, ") AS counts")?;
        write!(f, "WHERE task_id = '{id}';")
    }
}

/// Helper struct to generate the SQL query dropping a task's ticket summary row.
///
/// Leaves the row absent, exactly as it is for a task whose ticket table has never been
/// initialized, so that the trailing `TicketSummaryInsertQuery` in `init` recreates it.
struct TicketSummaryDeleteQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for TicketSummaryDeleteQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;

        write!(
            f,
            "DELETE FROM {schema}ticket_summary WHERE task_id = '{id}';"
        )
    }
}

/// Helper struct to generate the SQL queries for ticket summary triggers.
struct TicketSummaryTriggerQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for TicketSummaryTriggerQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let table = psql_identifier("ticket", id);
        let trigger_prefix = psql_identifier("trg_ticket", id);

        writeln!(f, "CREATE OR REPLACE TRIGGER {trigger_prefix}_ins")?;
        writeln!(f, "    AFTER INSERT ON {schema}{table}")?;
        writeln!(f, "    REFERENCING NEW TABLE AS NEW_TABLE")?;
        writeln!(f, "    FOR EACH STATEMENT")?;
        writeln!(
            f,
            "    EXECUTE FUNCTION {schema}trg_ticket_summary('{id}');"
        )?;
        writeln!(f)?;

        writeln!(f, "CREATE OR REPLACE TRIGGER {trigger_prefix}_upd")?;
        writeln!(f, "    AFTER UPDATE ON {schema}{table}")?;
        writeln!(f, "    REFERENCING")?;
        writeln!(f, "        NEW TABLE AS NEW_TABLE")?;
        writeln!(f, "        OLD TABLE AS OLD_TABLE")?;
        writeln!(f, "    FOR EACH STATEMENT")?;
        writeln!(
            f,
            "    EXECUTE FUNCTION {schema}trg_ticket_summary('{id}');"
        )?;

        writeln!(f)?;
        writeln!(f, "CREATE OR REPLACE TRIGGER {trigger_prefix}_del")?;
        writeln!(f, "    AFTER DELETE ON {schema}{table}")?;
        writeln!(f, "    REFERENCING OLD TABLE AS OLD_TABLE")?;
        writeln!(f, "    FOR EACH STATEMENT")?;
        writeln!(
            f,
            "    EXECUTE FUNCTION {schema}trg_ticket_summary('{id}');"
        )?;
        writeln!(f)?;

        writeln!(f, "CREATE OR REPLACE TRIGGER {trigger_prefix}_trunc")?;
        writeln!(f, "    AFTER TRUNCATE ON {schema}{table}")?;
        writeln!(f, "    FOR EACH STATEMENT")?;
        write!(
            f,
            "    EXECUTE FUNCTION {schema}trg_ticket_summary('{id}');"
        )
    }
}

/// Helper struct to generate the SQL query for clearing a ticket table.
struct ClearTicketQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for ClearTicketQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let table = psql_identifier("ticket", id);

        write!(f, "TRUNCATE TABLE {schema}{table};")
    }
}

/// Helper struct to generate the SQL query for getting all tickets of a given task.
struct GetAllTicketQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for GetAllTicketQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let table = psql_identifier("ticket", id);

        write!(f, "SELECT * FROM {schema}{table} WHERE status = $1;")
    }
}

/// Helper struct to generate the SQL query for inserting tickets for a task.
struct PutTicketQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for PutTicketQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let dims = self.1.dims;
        let table = psql_identifier("ticket", id);

        write!(f, "INSERT INTO {schema}{table} (")?;
        for dim in dims {
            write!(f, "{dim}, ")?;
        }
        writeln!(f, "deps_done, deps_quota, status)")?;

        write!(f, "VALUES (")?;
        for i in 1..=(dims.len() + 3) {
            if i != 1 {
                write!(f, ", ")?;
            }
            write!(f, "${i}")?;
        }
        writeln!(f, ")")?;

        write!(f, "ON CONFLICT DO NOTHING;")?;

        Ok(())
    }
}

/// Helper struct to generate the SQL query for getting every ticket of a given task.
struct DumpTicketQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for DumpTicketQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;

        write!(f, "SELECT * FROM {schema}ticket_{id};")
    }
}

/// Helper struct to generate the SQL query for raising `deps_done` count of tickets.
struct RaiseDepsDoneQuery<'a, const N: usize, const M: usize>(
    SchemaPrefix<'a>,
    TaskMetadata<N>,
    TaskMetadata<M>,
    &'a [&'static str],
);

impl<const N: usize, const M: usize> std::fmt::Display for RaiseDepsDoneQuery<'_, N, M> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let self_dims = self.1.dims;
        let received_dims = self.2.dims;
        let aggregate_dims = self.3;
        let table = psql_identifier("ticket", id);

        writeln!(f, "WITH updated AS (")?;
        writeln!(f, "    UPDATE {schema}{table}")?;
        writeln!(f, "    SET")?;
        writeln!(f, "        deps_done = deps_done + 1,")?;
        writeln!(f, "        status = CASE")?;
        writeln!(f, "            WHEN deps_done + 1 >= deps_quota")?;
        writeln!(f, "                THEN 'queued'::{schema}ticket_status")?;
        writeln!(f, "            ELSE 'waiting'::{schema}ticket_status")?;
        writeln!(f, "        END")?;
        writeln!(f, "    WHERE status = 'waiting'::{schema}ticket_status")?;
        for (idx, dim) in received_dims
            .iter()
            .filter(|d| self_dims.contains(d) && !aggregate_dims.contains(d))
            .enumerate()
        {
            writeln!(f, "        AND {} = ${}", dim, idx + 1)?;
        }
        writeln!(f, "    RETURNING *")?;
        writeln!(f, ")")?;
        writeln!(f, "SELECT *")?;
        writeln!(f, "FROM updated")?;
        write!(f, "WHERE status = 'queued'::{schema}ticket_status;")
    }
}

/// Helper struct to generate the SQL query for raising `deps_done` count of tickets.
struct RaiseDepsQuotaQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>, &'a [&'a str]);

impl<const N: usize> std::fmt::Display for RaiseDepsQuotaQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let cols = self.2;
        let table = psql_identifier("ticket", id);

        writeln!(f, "WITH updated AS (")?;
        writeln!(f, "    UPDATE {schema}{table}")?;
        writeln!(f, "    SET")?;
        writeln!(f, "        deps_quota = deps_quota + $1 - 1,")?;
        writeln!(f, "        status = CASE")?;
        writeln!(f, "            WHEN deps_done >= deps_quota + $1 - 1")?;
        writeln!(f, "                THEN 'queued'::{schema}ticket_status")?;
        writeln!(f, "            ELSE 'waiting'::{schema}ticket_status")?;
        writeln!(f, "        END")?;
        writeln!(f, "    WHERE status = 'waiting'::{schema}ticket_status")?;
        for (idx, dim) in cols.iter().enumerate() {
            writeln!(f, "        AND {} = ${}", dim, idx + 2)?;
        }
        writeln!(f, "    RETURNING *")?;
        writeln!(f, ")")?;
        writeln!(f, "SELECT *")?;
        writeln!(f, "FROM updated")?;
        write!(f, "WHERE status = 'queued'::{schema}ticket_status;")
    }
}

/// A helper struct to generate the SQL query for popping tickets to be exploded.
struct ExplodePopQuery<'a, const N: usize, const M: usize>(
    SchemaPrefix<'a>,
    TaskMetadata<N>,
    DimensionMetadata<M>,
);

impl<const N: usize, const M: usize> std::fmt::Display for ExplodePopQuery<'_, N, M> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let task_id = self.1.id;
        let table = psql_identifier("ticket", task_id);

        writeln!(f, "DELETE FROM {schema}{table}")?;
        for (idx, dep) in self
            .2
            .deps
            .iter()
            .filter(|dim| self.1.dims.contains(dim))
            .enumerate()
        {
            if idx == 0 {
                write!(f, "WHERE")?;
            } else {
                write!(f, "    AND")?;
            }
            writeln!(f, " {} = ${}", dep, idx + 1)?;
        }
        write!(f, "RETURNING *;")
    }
}

/// A helper struct to generate the SQL query for copying tickets into the database.
struct CopyInQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for CopyInQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let dims = self.1.dims;
        let table = psql_identifier("ticket", id);

        writeln!(f, "COPY {schema}{table} (")?;
        write!(f, "    ")?;
        for dim in dims {
            write!(f, "{dim}, ")?;
        }
        writeln!(f, "deps_done, deps_quota, status")?;
        writeln!(f, ")")?;
        write!(f, "FROM STDIN WITH (FORMAT csv);")
    }
}

/// A helper struct to generate the SQL query for marking the ticket of a given job as done.
struct MarkDoneQuery<'a, const N: usize>(SchemaPrefix<'a>, TaskMetadata<N>);

impl<const N: usize> std::fmt::Display for MarkDoneQuery<'_, N> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;
        let id = self.1.id;
        let dims = self.1.dims;
        let table = psql_identifier("ticket", id);

        write!(f, "UPDATE {schema}{table} SET status = 'done'")?;
        for (idx, dim) in dims.iter().enumerate() {
            if idx == 0 {
                write!(f, " WHERE")?;
            } else {
                write!(f, " AND")?;
            }
            write!(f, " {dim} = ${}", idx + 1)?;
        }
        write!(f, ";")
    }
}

/// A helper struct to generate the SQL query for fetching a task's ticket counts.
struct GetStatusQuery<'a>(SchemaPrefix<'a>);

impl std::fmt::Display for GetStatusQuery<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let schema = self.0;

        write!(
            f,
            "SELECT * FROM {schema}ticket_summary WHERE task_id = $1;"
        )
    }
}

#[cfg(test)]
mod tests {
    use indoc::indoc;
    use pretty_assertions::assert_eq;
    use rstest::{fixture, rstest};

    use super::*;
    use crate::schema::TaskMetadata;

    fn task_alpha() -> TaskMetadata<0> {
        TaskMetadata {
            id: "alpha",
            spawn_dim: Some("i"),
            dims: [],
            priority: &[],
        }
    }

    fn task_beta() -> TaskMetadata<1> {
        TaskMetadata {
            id: "beta",
            spawn_dim: Some("j"),
            dims: ["i"],
            priority: &[],
        }
    }

    #[fixture]
    fn schema_prefix() -> SchemaPrefix<'static> {
        SchemaPrefix(Some("test_meta"))
    }

    #[rstest]
    #[case::empty(
        task_alpha(),
        indoc! {"
            CREATE TABLE IF NOT EXISTS test_meta.ticket_alpha (
                deps_done BIGINT NOT NULL,
                deps_quota BIGINT NOT NULL,
                status test_meta.ticket_status NOT NULL
            );"
        }
    )]
    #[case::simple(
        task_beta(),
        indoc! {"
            CREATE TABLE IF NOT EXISTS test_meta.ticket_beta (
                i BIGINT,
                deps_done BIGINT NOT NULL,
                deps_quota BIGINT NOT NULL,
                status test_meta.ticket_status NOT NULL,
                PRIMARY KEY (i)
            );"
        },
    )]
    fn test_init_ticket_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = InitTicketQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(
        indoc! {"
            INSERT INTO test_meta.ticket_summary (task_id, waiting, queued, done)
            VALUES ($1, 0, 0, 0)
            ON CONFLICT (task_id) DO NOTHING;"
        },
    )]
    fn test_ticket_summary_insert_query(
        schema_prefix: SchemaPrefix<'static>,
        #[case] expected: &str,
    ) {
        let stmt = TicketSummaryInsertQuery(schema_prefix).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(
        task_beta(),
        indoc! {"
            UPDATE test_meta.ticket_summary SET
                waiting = counts.waiting,
                queued = counts.queued,
                done = counts.done
            FROM (
                SELECT
                    COUNT(*) FILTER (WHERE status = 'waiting') AS waiting,
                    COUNT(*) FILTER (WHERE status = 'queued') AS queued,
                    COUNT(*) FILTER (WHERE status = 'done') AS done
                FROM test_meta.ticket_beta
            ) AS counts
            WHERE task_id = 'beta';"
        },
    )]
    fn test_ticket_summary_resync_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = TicketSummaryResyncQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(
        task_beta(),
        "DELETE FROM test_meta.ticket_summary WHERE task_id = 'beta';"
    )]
    fn test_ticket_summary_delete_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = TicketSummaryDeleteQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(
        task_beta(),
        indoc! {"
            CREATE OR REPLACE TRIGGER trg_ticket_beta_ins
                AFTER INSERT ON test_meta.ticket_beta
                REFERENCING NEW TABLE AS NEW_TABLE
                FOR EACH STATEMENT
                EXECUTE FUNCTION test_meta.trg_ticket_summary('beta');

            CREATE OR REPLACE TRIGGER trg_ticket_beta_upd
                AFTER UPDATE ON test_meta.ticket_beta
                REFERENCING
                    NEW TABLE AS NEW_TABLE
                    OLD TABLE AS OLD_TABLE
                FOR EACH STATEMENT
                EXECUTE FUNCTION test_meta.trg_ticket_summary('beta');

            CREATE OR REPLACE TRIGGER trg_ticket_beta_del
                AFTER DELETE ON test_meta.ticket_beta
                REFERENCING OLD TABLE AS OLD_TABLE
                FOR EACH STATEMENT
                EXECUTE FUNCTION test_meta.trg_ticket_summary('beta');

            CREATE OR REPLACE TRIGGER trg_ticket_beta_trunc
                AFTER TRUNCATE ON test_meta.ticket_beta
                FOR EACH STATEMENT
                EXECUTE FUNCTION test_meta.trg_ticket_summary('beta');"
        }
    )]
    fn test_ticket_summary_trigger_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = TicketSummaryTriggerQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(task_beta(), "TRUNCATE TABLE test_meta.ticket_beta;")]
    fn test_clear_ticket_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = ClearTicketQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(task_beta(), "SELECT * FROM test_meta.ticket_beta WHERE status = $1;")]
    fn test_get_all_ticket_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = GetAllTicketQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::empty(
        task_alpha(),
        indoc! {"
            INSERT INTO test_meta.ticket_alpha (deps_done, deps_quota, status)
            VALUES ($1, $2, $3)
            ON CONFLICT DO NOTHING;"
        }
    )]
    #[case::simple(
        task_beta(),
        indoc! {"
            INSERT INTO test_meta.ticket_beta (i, deps_done, deps_quota, status)
            VALUES ($1, $2, $3, $4)
            ON CONFLICT DO NOTHING;"
        }
    )]
    fn test_put_ticket_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = PutTicketQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(task_alpha(), "SELECT * FROM test_meta.ticket_alpha;")]
    #[case::with_dimension(task_beta(), "SELECT * FROM test_meta.ticket_beta;")]
    fn test_dump_ticket_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = DumpTicketQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple(task_beta(), task_alpha(), &[], indoc! { "
        WITH updated AS (
            UPDATE test_meta.ticket_beta
            SET
                deps_done = deps_done + 1,
                status = CASE
                    WHEN deps_done + 1 >= deps_quota
                        THEN 'queued'::test_meta.ticket_status
                    ELSE 'waiting'::test_meta.ticket_status
                END
            WHERE status = 'waiting'::test_meta.ticket_status
            RETURNING *
        )
        SELECT *
        FROM updated
        WHERE status = 'queued'::test_meta.ticket_status;"
    })]
    fn test_raise_deps_done_query<const N: usize, const M: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] upstream_meta: TaskMetadata<M>,
        #[case] aggregate_dims: &[&'static str],
        #[case] expected: &str,
    ) {
        let stmt =
            RaiseDepsDoneQuery(schema_prefix, task_meta, upstream_meta, aggregate_dims).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::empty(task_alpha(), "UPDATE test_meta.ticket_alpha SET status = 'done';")]
    #[case::simple(
        task_beta(),
        "UPDATE test_meta.ticket_beta SET status = 'done' WHERE i = $1;"
    )]
    fn test_mark_done_query<const N: usize>(
        schema_prefix: SchemaPrefix<'static>,
        #[case] task_meta: TaskMetadata<N>,
        #[case] expected: &str,
    ) {
        let stmt = MarkDoneQuery(schema_prefix, task_meta).to_string();
        assert_eq!(stmt, expected);
    }

    #[rstest]
    #[case::simple("SELECT * FROM test_meta.ticket_summary WHERE task_id = $1;")]
    fn test_get_status_query(schema_prefix: SchemaPrefix<'static>, #[case] expected: &str) {
        let stmt = GetStatusQuery(schema_prefix).to_string();
        assert_eq!(stmt, expected);
    }
}