course-service 0.2.0

Course Service — a course-administration microservice modelled on schema.org/Course; interoperates with the course-matcher crate
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
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
//! REST handlers.
//!
//! FR-1..FR-9 + FR-14..FR-18 are wired against the repository, search
//! engine, matcher, validation, audit, streaming, and privacy modules.
//! The `not_implemented` shim is parked behind one route only:
//! `GET /api/courses` (list-all-without-search), which spec.md §9
//! intentionally leaves out of scope — clients call
//! `/api/courses/search` with an empty `q` for the same effect.
//!
//! Error mapping:
//! - `Error::NotFound` → 404
//! - `Error::Validation` → 422 (with `details`)
//! - `Error::Conflict` → 409
//! - `Error::Database` / `Error::Search` / `Error::Matching` / etc → 500

use axum::{
    Json,
    extract::{Path, Query, State},
    http::StatusCode,
    response::IntoResponse,
};
use chrono::Utc;
use serde::{Deserialize, Serialize};
use utoipa::{IntoParams, ToSchema};
use uuid::Uuid;

use super::state::AppState;
use crate::api::{ApiError, ApiResponse};
use crate::db::audit::{AuditContext, AuditEntry};
use crate::models::{
    BatchDeduplicationRequest, BatchDeduplicationResponse, Course, CourseInstance, MergeRecord,
    MergeRequest, MergeResponse, MergeStatus, ReviewQueueItem, ReviewStatus,
};
use crate::streaming::{CourseEvent, EventKind};
use crate::validation::{ValidationError, validate_course, validate_instance};

/// Body of the `GET /api/health` liveness probe. All three fields are
/// `'static` since they are baked in at compile time.
#[derive(Debug, Clone, Serialize, ToSchema)]
pub struct HealthResponse {
    /// Always `"healthy"` — presence of the field is the signal.
    pub status: &'static str,
    /// Service identifier, fixed to `"course-service"`.
    pub service: &'static str,
    /// Crate version, sourced from `CARGO_PKG_VERSION` at compile time.
    pub version: &'static str,
}

/// Health check — always returns `200 healthy` so orchestrators can
/// distinguish "process is up" from "process can talk to DB".
#[utoipa::path(
    get, path = "/api/health",
    responses((status = 200, description = "service is up", body = HealthResponse)),
    tag = "health",
)]
pub async fn health(State(_state): State<AppState>) -> impl IntoResponse {
    Json(ApiResponse::success(HealthResponse {
        status: "healthy",
        service: "course-service",
        version: env!("CARGO_PKG_VERSION"),
    }))
}

/// The `501` shim, kept as a deliberate marker for the one endpoint
/// `GET /api/courses` (list-all-without-search) that spec.md §9
/// intentionally parks. Removing the handler would orphan the route
/// declaration in `mod.rs`; keeping it stable lets the router
/// table double as documentation.
pub async fn not_implemented(State(_state): State<AppState>) -> impl IntoResponse {
    let body: ApiResponse<()> = ApiResponse::error(
        "NOT_IMPLEMENTED",
        "Endpoint not yet implemented — see spec.md §13 for status.",
    );
    (StatusCode::NOT_IMPLEMENTED, Json(body))
}

// ────────────────── Query / body types ──────────────────

/// Pagination query string for plain list endpoints. Reserved for the
/// `GET /api/courses` route (currently parked behind `not_implemented`).
#[derive(Debug, Deserialize, ToSchema)]
pub struct ListQuery {
    /// Page size; defaults to 20 via `default_limit`.
    #[serde(default = "default_limit")]
    pub limit: u64,
    /// Rows to skip before the page; defaults to 0.
    #[serde(default)]
    pub offset: u64,
}

/// Query string for `GET /api/courses/search`. An empty / absent `q`
/// falls back to a paged `list` rather than a full-text query.
#[derive(Debug, Deserialize, Default, ToSchema, IntoParams)]
pub struct SearchQuery {
    /// Free-text query; empty/absent → paged list of all courses.
    pub q: Option<String>,
    /// Maximum hits to return; defaults to 20 via `default_limit`.
    #[serde(default = "default_limit")]
    pub limit: u64,
    /// Rows to skip (only meaningful on the empty-query list path).
    #[serde(default)]
    pub offset: u64,
    /// When `true`, route through the Tantivy fuzzy matcher.
    #[serde(default)]
    pub fuzzy: bool,
    /// Accepted for API parity with sibling services; currently a
    /// no-op — phonetic matching is on the T-13 / matcher roadmap.
    #[serde(default)]
    pub phonetic: bool,
    /// Accepted for API parity; the masking module lands in T-10.
    #[serde(default)]
    pub mask_sensitive: bool,
}

/// Default page size (20) used by `#[serde(default = ...)]` on the
/// `limit` fields of [`ListQuery`], [`SearchQuery`], and [`AuditQuery`].
fn default_limit() -> u64 {
    20
}

/// Envelope for search results — the hydrated course rows plus a count.
#[derive(Debug, Serialize, ToSchema)]
pub struct SearchResponse {
    /// Hydrated course records for this page of hits.
    pub items: Vec<Course>,
    /// Number of items in `items` (this page, not the global total).
    pub total: usize,
}

/// Flat match result. Carries the candidate `course_id` plus a slim
/// in-line summary (`name`, `course_code`) so the front-end can render
/// a match list without an N+1 round-trip back to the API.
#[derive(Debug, Serialize, ToSchema)]
pub struct ScoredCandidate {
    /// Id of the matched candidate course.
    pub course_id: Uuid,
    /// Candidate's primary name (inlined to avoid an extra fetch).
    pub name: String,
    /// Candidate's course code, when present.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub course_code: Option<String>,
    /// Overall match score in `[0.0, 1.0]`.
    pub score: f64,
    /// `true` when the score cleared the matcher's threshold.
    pub is_match: bool,
    /// Human label for the confidence band (`"High"` / `"Medium"` / `"Low"`).
    pub confidence: &'static str,
    /// Per-component score breakdown from the matcher.
    pub breakdown: crate::matching::MatchBreakdown,
}

// ────────────────── Handlers (FR-1..FR-5, FR-7) ──────────────────

/// FR-1 — create with duplicate detection.
#[utoipa::path(
    post, path = "/api/courses",
    request_body = Course,
    responses(
        (status = 201, description = "Created", body = Course),
        (status = 409, description = "Probable duplicate", body = ApiError),
        (status = 422, description = "Validation failure", body = ApiError),
    ),
    tag = "courses",
)]
pub async fn create_course(
    State(state): State<AppState>,
    Json(course): Json<Course>,
) -> impl IntoResponse {
    let errs = validate_course(&course);
    if !errs.is_empty() {
        return validation_response(errs);
    }

    match find_probable_duplicates(&state, &course).await {
        Ok(hits) if !hits.is_empty() => {
            let body: ApiResponse<Vec<ScoredCandidate>> = ApiResponse::error_with_details(
                "DUPLICATE_CANDIDATE",
                "A probable duplicate already exists; see `details` for ranked candidates.",
                &hits,
            );
            return (StatusCode::CONFLICT, Json(body)).into_response();
        }
        Ok(_) => {}
        Err(e) => return error_response(e),
    }

    let created = match state.course_repository.create(&course).await {
        Ok(c) => c,
        Err(e) => return error_response(e),
    };
    if let Err(e) = state.search_engine.index_course(&created) {
        tracing::warn!("indexing course after create failed: {e}");
    }
    record_create(&state, "Course", created.id, &created, EventKind::CourseCreated).await;
    (StatusCode::CREATED, Json(ApiResponse::success(created))).into_response()
}

/// FR-2 — get by id. Embeds the `instances` collection so a single
/// fetch carries the full record (the sub-resource handlers still
/// exist for mutation; this is the read shape the front-end's
/// detail view expects). Syllabus sections remain deferred until
/// the syllabus sub-resource lands.
#[utoipa::path(
    get, path = "/api/courses/{id}",
    params(("id" = uuid::Uuid, Path,)),
    responses(
        (status = 200, body = Course),
        (status = 404, body = ApiError),
    ),
    tag = "courses",
)]
pub async fn get_course(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
) -> impl IntoResponse {
    let mut course = match state.course_repository.get_by_id(&id).await {
        Ok(Some(c)) => c,
        Ok(None) => return not_found_response("Course not found"),
        Err(e) => return error_response(e),
    };
    match state.course_repository.list_instances(&id).await {
        Ok(instances) => course.instances = instances,
        Err(e) => {
            tracing::warn!("hydrating instances on GET course failed: {e}");
        }
    }
    Json(ApiResponse::success(course)).into_response()
}

/// FR-3 — replace.
#[utoipa::path(
    put, path = "/api/courses/{id}",
    params(("id" = uuid::Uuid, Path,)),
    request_body = Course,
    responses(
        (status = 200, body = Course),
        (status = 404, body = ApiError),
        (status = 422, body = ApiError),
    ),
    tag = "courses",
)]
pub async fn update_course(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
    Json(mut course): Json<Course>,
) -> impl IntoResponse {
    course.id = id;
    let errs = validate_course(&course);
    if !errs.is_empty() {
        return validation_response(errs);
    }
    // Snapshot the existing row so the audit entry can carry old/new
    // values. Failure to read the prior state is non-fatal — the
    // update itself is the source of truth.
    let prior = state
        .course_repository
        .get_by_id(&id)
        .await
        .ok()
        .flatten();
    let updated = match state.course_repository.update(&course).await {
        Ok(c) => c,
        Err(crate::Error::NotFound) => return not_found_response("Course not found"),
        Err(e) => return error_response(e),
    };
    if let Err(e) = state.search_engine.delete_course(&id.to_string()) {
        tracing::warn!("removing prior course segment after update failed: {e}");
    }
    if let Err(e) = state.search_engine.index_course(&updated) {
        tracing::warn!("re-indexing course after update failed: {e}");
    }
    record_update(
        &state,
        "Course",
        updated.id,
        prior.as_ref(),
        &updated,
        EventKind::CourseUpdated,
    )
    .await;
    Json(ApiResponse::success(updated)).into_response()
}

/// FR-4 — soft delete.
#[utoipa::path(
    delete, path = "/api/courses/{id}",
    params(("id" = uuid::Uuid, Path,)),
    responses(
        (status = 204, description = "Soft-deleted"),
        (status = 404, body = ApiError),
    ),
    tag = "courses",
)]
pub async fn delete_course(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
) -> impl IntoResponse {
    let prior = state
        .course_repository
        .get_by_id(&id)
        .await
        .ok()
        .flatten();
    match state.course_repository.soft_delete(&id).await {
        Ok(()) => {
            if let Err(e) = state.search_engine.delete_course(&id.to_string()) {
                tracing::warn!("removing course segment after soft-delete failed: {e}");
            }
            record_delete(&state, "Course", id, prior.as_ref(), EventKind::CourseDeleted).await;
            StatusCode::NO_CONTENT.into_response()
        }
        Err(crate::Error::NotFound) => not_found_response("Course not found"),
        Err(e) => error_response(e),
    }
}

/// FR-5 — search.
#[utoipa::path(
    get, path = "/api/courses/search",
    params(SearchQuery),
    responses((status = 200, body = SearchResponse)),
    tag = "search",
)]
pub async fn search_courses(
    State(state): State<AppState>,
    Query(q): Query<SearchQuery>,
) -> impl IntoResponse {
    // Empty query → page through `list`.
    let query = q.q.unwrap_or_default();
    let ids: Vec<String> = if query.trim().is_empty() {
        match state.course_repository.list(q.limit, q.offset).await {
            Ok(rows) => return Json(ApiResponse::success(SearchResponse {
                total: rows.len(),
                items: rows,
            })).into_response(),
            Err(e) => return error_response(e),
        }
    } else if q.fuzzy {
        match state.search_engine.fuzzy_search(&query, q.limit as usize) {
            Ok(v) => v,
            Err(e) => return error_response(e),
        }
    } else {
        match state.search_engine.search(&query, q.limit as usize) {
            Ok(v) => v,
            Err(e) => return error_response(e),
        }
    };

    let mut items = Vec::with_capacity(ids.len());
    for sid in ids {
        let Ok(uuid) = Uuid::parse_str(&sid) else { continue };
        match state.course_repository.get_by_id(&uuid).await {
            Ok(Some(c)) => items.push(c),
            Ok(None) => {} // stale index entry
            Err(e) => return error_response(e),
        }
    }
    let total = items.len();
    Json(ApiResponse::success(SearchResponse { items, total })).into_response()
}

// ────────────────── Instance sub-resource (FR-10..FR-13) ──────────────────

/// FR-10 — list instances ordered `schedule.start_date DESC NULLS LAST`.
#[utoipa::path(
    get, path = "/api/courses/{id}/instances",
    params(("id" = uuid::Uuid, Path,)),
    responses(
        (status = 200, body = Vec<CourseInstance>),
        (status = 404, body = ApiError),
    ),
    tag = "instances",
)]
pub async fn list_instances(
    State(state): State<AppState>,
    Path(course_id): Path<Uuid>,
) -> impl IntoResponse {
    if let Err(e) = require_course_exists(&state, &course_id).await {
        return e;
    }
    match state.course_repository.list_instances(&course_id).await {
        Ok(items) => Json(ApiResponse::success(items)).into_response(),
        Err(e) => error_response(e),
    }
}

/// FR-11 — create instance.
#[utoipa::path(
    post, path = "/api/courses/{id}/instances",
    params(("id" = uuid::Uuid, Path,)),
    request_body = CourseInstance,
    responses(
        (status = 201, body = CourseInstance),
        (status = 404, body = ApiError),
        (status = 422, body = ApiError),
    ),
    tag = "instances",
)]
pub async fn create_instance(
    State(state): State<AppState>,
    Path(course_id): Path<Uuid>,
    Json(mut instance): Json<CourseInstance>,
) -> impl IntoResponse {
    if let Err(e) = require_course_exists(&state, &course_id).await {
        return e;
    }
    instance.course_id = course_id;
    let errs = validate_instance(&instance);
    if !errs.is_empty() {
        return validation_response(errs);
    }
    match state.course_repository.create_instance(&instance).await {
        Ok(created) => {
            record_instance_create(&state, course_id, &created).await;
            (StatusCode::CREATED, Json(ApiResponse::success(created))).into_response()
        }
        Err(e) => error_response(e),
    }
}

/// FR-12 — replace instance.
#[utoipa::path(
    put, path = "/api/courses/{id}/instances/{instance_id}",
    params(
        ("id" = uuid::Uuid, Path,),
        ("instance_id" = uuid::Uuid, Path,),
    ),
    request_body = CourseInstance,
    responses(
        (status = 200, body = CourseInstance),
        (status = 404, body = ApiError),
        (status = 422, body = ApiError),
    ),
    tag = "instances",
)]
pub async fn update_instance_handler(
    State(state): State<AppState>,
    Path((course_id, instance_id)): Path<(Uuid, Uuid)>,
    Json(mut instance): Json<CourseInstance>,
) -> impl IntoResponse {
    instance.course_id = course_id;
    instance.id = instance_id;
    let errs = validate_instance(&instance);
    if !errs.is_empty() {
        return validation_response(errs);
    }
    let prior = state
        .course_repository
        .get_instance(&course_id, &instance_id)
        .await
        .ok()
        .flatten();
    match state.course_repository.update_instance(&instance).await {
        Ok(updated) => {
            record_instance_update(&state, course_id, prior.as_ref(), &updated).await;
            Json(ApiResponse::success(updated)).into_response()
        }
        Err(crate::Error::NotFound) => not_found_response("CourseInstance not found"),
        Err(e) => error_response(e),
    }
}

/// Read one instance. Mirror of FR-10's list shape but for a single
/// row — not numbered in the spec but trivially follows from the
/// existing list+update+delete trio.
#[utoipa::path(
    get, path = "/api/courses/{id}/instances/{instance_id}",
    params(
        ("id" = uuid::Uuid, Path,),
        ("instance_id" = uuid::Uuid, Path,),
    ),
    responses(
        (status = 200, body = CourseInstance),
        (status = 404, body = ApiError),
    ),
    tag = "instances",
)]
pub async fn get_instance(
    State(state): State<AppState>,
    Path((course_id, instance_id)): Path<(Uuid, Uuid)>,
) -> impl IntoResponse {
    match state
        .course_repository
        .get_instance(&course_id, &instance_id)
        .await
    {
        Ok(Some(i)) => Json(ApiResponse::success(i)).into_response(),
        Ok(None) => not_found_response("CourseInstance not found"),
        Err(e) => error_response(e),
    }
}

/// FR-13 — soft-delete instance.
#[utoipa::path(
    delete, path = "/api/courses/{id}/instances/{instance_id}",
    params(
        ("id" = uuid::Uuid, Path,),
        ("instance_id" = uuid::Uuid, Path,),
    ),
    responses(
        (status = 204, description = "Soft-deleted"),
        (status = 404, body = ApiError),
    ),
    tag = "instances",
)]
pub async fn delete_instance(
    State(state): State<AppState>,
    Path((course_id, instance_id)): Path<(Uuid, Uuid)>,
) -> impl IntoResponse {
    let prior = state
        .course_repository
        .get_instance(&course_id, &instance_id)
        .await
        .ok()
        .flatten();
    match state
        .course_repository
        .soft_delete_instance(&course_id, &instance_id)
        .await
    {
        Ok(()) => {
            record_instance_delete(&state, course_id, instance_id, prior.as_ref()).await;
            StatusCode::NO_CONTENT.into_response()
        }
        Err(crate::Error::NotFound) => not_found_response("CourseInstance not found"),
        Err(e) => error_response(e),
    }
}

/// Guard used by the instance sub-resource handlers: confirm the parent
/// course exists before touching its instances. Returns the ready-made
/// `404` (or `500`) response in the `Err` arm so callers can early-return.
async fn require_course_exists(
    state: &AppState,
    course_id: &Uuid,
) -> std::result::Result<(), axum::response::Response> {
    match state.course_repository.get_by_id(course_id).await {
        Ok(Some(_)) => Ok(()),
        Ok(None) => Err(not_found_response("Course not found")),
        Err(e) => Err(error_response(e)),
    }
}

/// FR-7 — duplicate check (no write).
#[utoipa::path(
    post, path = "/api/courses/check-duplicates",
    request_body = Course,
    responses((status = 200, body = Vec<ScoredCandidate>)),
    tag = "matching",
)]
pub async fn check_duplicates(
    State(state): State<AppState>,
    Json(course): Json<Course>,
) -> impl IntoResponse {
    match find_probable_duplicates(&state, &course).await {
        Ok(hits) => Json(ApiResponse::success(hits)).into_response(),
        Err(e) => error_response(e),
    }
}

// ────────────────── Helpers ──────────────────

/// Upper bound on candidates pulled from the search-engine blocker
/// before the (more expensive) matcher scores each one. Caps the
/// per-request matcher fan-out for create / match / check-duplicates.
const BLOCK_CANDIDATE_LIMIT: usize = 50;

/// Run the search-engine blocker → repository hydrate → matcher score
/// pipeline, returning only candidates above the matcher's threshold.
async fn find_probable_duplicates(
    state: &AppState,
    probe: &Course,
) -> crate::Result<Vec<ScoredCandidate>> {
    if probe.name.trim().is_empty() {
        return Ok(Vec::new());
    }
    let ids = state.search_engine.search_by_name_and_provider(
        &probe.name,
        probe.provider_id,
        BLOCK_CANDIDATE_LIMIT,
    )?;

    let mut candidates: Vec<Course> = Vec::with_capacity(ids.len());
    for sid in ids {
        let Ok(uuid) = Uuid::parse_str(&sid) else { continue };
        if Some(uuid) == Some(probe.id) && probe.id != Uuid::nil() {
            continue;
        }
        if let Some(c) = state.course_repository.get_by_id(&uuid).await? {
            candidates.push(c);
        }
    }

    let mut scored: Vec<ScoredCandidate> = candidates
        .iter()
        .map(|c| {
            let r = state.matcher.match_courses(probe, c);
            ScoredCandidate {
                course_id: c.id,
                name: c.name.clone(),
                course_code: c.course_code.clone(),
                score: r.score,
                is_match: r.is_match,
                confidence: confidence_label(r.confidence),
                breakdown: r.breakdown,
            }
        })
        .filter(|r| r.is_match)
        .collect();
    scored.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap_or(std::cmp::Ordering::Equal));
    Ok(scored)
}

/// Map a [`MatchConfidence`](crate::matching::MatchConfidence) band to
/// its stable wire string for `ScoredCandidate.confidence`.
fn confidence_label(c: crate::matching::MatchConfidence) -> &'static str {
    match c {
        crate::matching::MatchConfidence::High => "High",
        crate::matching::MatchConfidence::Medium => "Medium",
        crate::matching::MatchConfidence::Low => "Low",
    }
}

/// Build a `422 Unprocessable Entity` response carrying the field-scoped
/// validation errors in the envelope's `details`.
fn validation_response(errs: Vec<ValidationError>) -> axum::response::Response {
    let body: ApiResponse<Vec<ValidationError>> = ApiResponse::error_with_details(
        "VALIDATION_FAILED",
        "Request failed validation; see `details` for field-scoped errors.",
        &errs,
    );
    (StatusCode::UNPROCESSABLE_ENTITY, Json(body)).into_response()
}

/// Build a `404 Not Found` response with the given human-readable message.
fn not_found_response(msg: &str) -> axum::response::Response {
    let body: ApiResponse<()> = ApiResponse::error("NOT_FOUND", msg);
    (StatusCode::NOT_FOUND, Json(body)).into_response()
}

// ────────────────── Match + Merge (FR-6, FR-8) ──────────────────

/// FR-6 — score a Course request against blocked candidates. Returns
/// every blocked candidate with its `ScoredCandidate`, sorted by
/// descending score (the front-end can apply its own threshold).
#[utoipa::path(
    post, path = "/api/courses/match",
    request_body = Course,
    responses(
        (status = 200, body = Vec<ScoredCandidate>),
        (status = 422, body = ApiError),
    ),
    tag = "matching",
)]
pub async fn match_course(
    State(state): State<AppState>,
    Json(probe): Json<Course>,
) -> impl IntoResponse {
    if probe.name.trim().is_empty() {
        let body: ApiResponse<()> = ApiResponse::error(
            "VALIDATION_FAILED",
            "match request requires a non-empty `name` for blocking",
        );
        return (StatusCode::UNPROCESSABLE_ENTITY, Json(body)).into_response();
    }
    match score_all_blocked_candidates(&state, &probe).await {
        Ok(hits) => Json(ApiResponse::success(hits)).into_response(),
        Err(e) => error_response(e),
    }
}

/// FR-8 — fold a duplicate into a main course.
#[utoipa::path(
    post, path = "/api/courses/merge",
    request_body = MergeRequest,
    responses(
        (status = 200, body = MergeResponse),
        (status = 404, body = ApiError),
        (status = 422, body = ApiError),
    ),
    tag = "matching",
)]
pub async fn merge_courses(
    State(state): State<AppState>,
    Json(req): Json<MergeRequest>,
) -> impl IntoResponse {
    if req.main_course_id == req.duplicate_course_id {
        return validation_response(vec![ValidationError {
            field: "duplicate_course_id".into(),
            message: "main_course_id and duplicate_course_id must differ".into(),
        }]);
    }

    let main = match state.course_repository.get_by_id(&req.main_course_id).await {
        Ok(Some(c)) => c,
        Ok(None) => return not_found_response("main course not found"),
        Err(e) => return error_response(e),
    };
    let duplicate = match state.course_repository.get_by_id(&req.duplicate_course_id).await {
        Ok(Some(c)) => c,
        Ok(None) => return not_found_response("duplicate course not found"),
        Err(e) => return error_response(e),
    };

    let match_result = state.matcher.match_courses(&main, &duplicate);

    let (merged, transferred) = fold_duplicate_into_main(&main, &duplicate);

    let updated = match state.course_repository.update(&merged).await {
        Ok(c) => c,
        Err(crate::Error::NotFound) => return not_found_response("main course not found"),
        Err(e) => return error_response(e),
    };
    if let Err(e) = state.search_engine.delete_course(&main.id.to_string()) {
        tracing::warn!("removing main course segment during merge failed: {e}");
    }
    if let Err(e) = state.search_engine.index_course(&updated) {
        tracing::warn!("re-indexing main course during merge failed: {e}");
    }

    if let Err(e) = state.course_repository.soft_delete(&duplicate.id).await {
        tracing::warn!("soft-deleting duplicate during merge failed: {e}");
    }
    if let Err(e) = state.search_engine.delete_course(&duplicate.id.to_string()) {
        tracing::warn!("removing duplicate course segment during merge failed: {e}");
    }

    let merge_record = MergeRecord {
        id: Uuid::new_v4(),
        main_course_id: updated.id,
        duplicate_course_id: duplicate.id,
        status: MergeStatus::Completed,
        merged_by: req.merged_by.clone(),
        merge_reason: req.merge_reason.clone(),
        match_score: Some(match_result.score),
        transferred_data: Some(transferred),
        merged_at: Utc::now(),
    };
    let merge_record = match state.course_repository.record_merge(&merge_record).await {
        Ok(r) => r,
        Err(e) => return error_response(e),
    };

    // FR-17 / FR-18 — audit + event for both sides + the merge itself.
    record_update(
        &state,
        "Course",
        updated.id,
        Some(&main),
        &updated,
        EventKind::CourseUpdated,
    )
    .await;
    record_delete(
        &state,
        "Course",
        duplicate.id,
        Some(&duplicate),
        EventKind::CourseDeleted,
    )
    .await;
    record_create(
        &state,
        "CourseMerge",
        merge_record.id,
        &merge_record,
        EventKind::CourseMerged,
    )
    .await;

    Json(ApiResponse::success(MergeResponse {
        merge_record,
        main_course: updated,
    }))
    .into_response()
}

/// Fold `duplicate` into a copy of `main`, returning the merged
/// `Course` and a JSON snapshot of what was transferred (for the
/// `course_merge_records.transferred_data` column + audit trail).
///
/// Strategy: union-by-value-equality for free-text Vec<String>
/// collections; dedupe identifiers by `(scheme, value)`; preserve the
/// duplicate's primary name as a `[former]` alternate on main; do not
/// touch the parent's status / version / lifecycle scalars.
fn fold_duplicate_into_main(
    main: &Course,
    duplicate: &Course,
) -> (Course, serde_json::Value) {
    let mut merged = main.clone();

    // Alternate names — record the duplicate's primary name explicitly
    // ("former") so reverse-lookup queries can still find it.
    let former = format!("[former] {}", duplicate.name);
    merge_unique(&mut merged.alternate_names, std::iter::once(former.clone()));
    merge_unique(&mut merged.alternate_names, duplicate.alternate_names.iter().cloned());

    // Free-text / URL collections — union.
    merge_unique(&mut merged.image, duplicate.image.iter().cloned());
    merge_unique(&mut merged.same_as, duplicate.same_as.iter().cloned());
    merge_unique(&mut merged.keywords, duplicate.keywords.iter().cloned());
    merge_unique(&mut merged.about, duplicate.about.iter().cloned());
    merge_unique(&mut merged.in_language, duplicate.in_language.iter().cloned());
    merge_unique(&mut merged.teaches, duplicate.teaches.iter().cloned());
    merge_unique(&mut merged.assesses, duplicate.assesses.iter().cloned());
    merge_unique(
        &mut merged.competency_required,
        duplicate.competency_required.iter().cloned(),
    );
    merge_unique(
        &mut merged.course_prerequisites,
        duplicate.course_prerequisites.iter().cloned(),
    );
    merge_unique(
        &mut merged.available_language,
        duplicate.available_language.iter().cloned(),
    );
    merge_unique(
        &mut merged.financial_aid_eligible,
        duplicate.financial_aid_eligible.iter().cloned(),
    );

    // Identifiers — dedupe by (scheme, value).
    for ident in &duplicate.identifiers {
        let already = merged.identifiers.iter().any(|i| {
            std::mem::discriminant(&i.property_id) == std::mem::discriminant(&ident.property_id)
                && i.value == ident.value
        });
        if !already {
            merged.identifiers.push(ident.clone());
        }
    }

    // Add a Replaces link from main → duplicate so the audit chain
    // stays navigable. Avoid duplicating an existing link.
    let already_links = merged.links.iter().any(|l| {
        l.other_course_id == duplicate.id
            && matches!(l.link_type, crate::models::LinkType::Replaces)
    });
    if !already_links {
        merged.links.push(crate::models::CourseLink {
            other_course_id: duplicate.id,
            link_type: crate::models::LinkType::Replaces,
        });
    }

    let transferred = serde_json::json!({
        "from_course_id": duplicate.id,
        "from_name": duplicate.name,
        "identifiers_added": duplicate.identifiers.len(),
        "alternate_names_added": 1 + duplicate.alternate_names.len(),
        "keywords_added": duplicate.keywords.len(),
        "teaches_added": duplicate.teaches.len(),
        "same_as_added": duplicate.same_as.len(),
    });

    (merged, transferred)
}

/// Append each `incoming` string to `target` unless an equal value is
/// already present — an order-preserving set union for `Vec<String>`.
fn merge_unique<I: IntoIterator<Item = String>>(target: &mut Vec<String>, incoming: I) {
    for v in incoming {
        if !target.iter().any(|t| t == &v) {
            target.push(v);
        }
    }
}

/// Variant of `find_probable_duplicates` that returns every blocked
/// candidate (not just `is_match=true`), sorted by descending score.
/// Powers FR-6.
async fn score_all_blocked_candidates(
    state: &AppState,
    probe: &Course,
) -> crate::Result<Vec<ScoredCandidate>> {
    let ids = state.search_engine.search_by_name_and_provider(
        &probe.name,
        probe.provider_id,
        BLOCK_CANDIDATE_LIMIT,
    )?;

    let mut candidates: Vec<Course> = Vec::with_capacity(ids.len());
    for sid in ids {
        let Ok(uuid) = Uuid::parse_str(&sid) else { continue };
        if Some(uuid) == Some(probe.id) && probe.id != Uuid::nil() {
            continue;
        }
        if let Some(c) = state.course_repository.get_by_id(&uuid).await? {
            candidates.push(c);
        }
    }

    let mut scored: Vec<ScoredCandidate> = candidates
        .iter()
        .map(|c| {
            let r = state.matcher.match_courses(probe, c);
            ScoredCandidate {
                course_id: c.id,
                name: c.name.clone(),
                course_code: c.course_code.clone(),
                score: r.score,
                is_match: r.is_match,
                confidence: confidence_label(r.confidence),
                breakdown: r.breakdown,
            }
        })
        .collect();
    scored.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap_or(std::cmp::Ordering::Equal));
    Ok(scored)
}

// ────────────────── Batch dedup (FR-9) ──────────────────

/// FR-9 — scan every active Course, score against blocked candidates,
/// auto-merge above `auto_merge_threshold`, queue everything else
/// above `threshold` for review.
#[utoipa::path(
    post, path = "/api/courses/deduplicate",
    request_body = BatchDeduplicationRequest,
    responses(
        (status = 200, body = BatchDeduplicationResponse),
        (status = 422, body = ApiError),
    ),
    tag = "matching",
)]
pub async fn deduplicate(
    State(state): State<AppState>,
    Json(req): Json<BatchDeduplicationRequest>,
) -> impl IntoResponse {
    if !(0.0..=1.0).contains(&req.threshold)
        || !(0.0..=1.0).contains(&req.auto_merge_threshold)
        || req.auto_merge_threshold < req.threshold
    {
        return validation_response(vec![ValidationError {
            field: "thresholds".into(),
            message: "thresholds must be in [0, 1] with auto_merge_threshold >= threshold".into(),
        }]);
    }

    match run_batch_dedup(&state, &req).await {
        Ok(resp) => Json(ApiResponse::success(resp)).into_response(),
        Err(e) => error_response(e),
    }
}

/// Page size for the batch-dedup scan's repository pagination — bounds
/// memory per loop iteration while keeping round-trips low.
const DEDUP_PAGE: u64 = 100;

/// Drive the FR-9 batch scan: page through every active course, block +
/// score candidates, auto-merge above the threshold, and queue the rest
/// for review. A `seen_pairs` set keeps each unordered pair scored once,
/// and `soft_deleted` skips rows already folded away this run.
async fn run_batch_dedup(
    state: &AppState,
    req: &BatchDeduplicationRequest,
) -> crate::Result<BatchDeduplicationResponse> {
    use std::collections::HashSet;

    let mut response = BatchDeduplicationResponse {
        courses_scanned: 0,
        duplicates_found: 0,
        auto_merged: 0,
        queued_for_review: 0,
        review_items: Vec::new(),
    };
    let mut seen_pairs: HashSet<(Uuid, Uuid)> = HashSet::new();
    let mut soft_deleted: HashSet<Uuid> = HashSet::new();
    let mut offset: u64 = 0;

    loop {
        let page = state.course_repository.list(DEDUP_PAGE, offset).await?;
        if page.is_empty() {
            break;
        }
        let page_len = page.len() as u64;
        response.courses_scanned += page_len;

        for probe in &page {
            if soft_deleted.contains(&probe.id) {
                continue;
            }
            let candidate_ids = state.search_engine.search_by_name_and_provider(
                &probe.name,
                probe.provider_id,
                req.max_candidates as usize,
            )?;

            for sid in candidate_ids {
                let Ok(cid) = Uuid::parse_str(&sid) else { continue };
                if cid == probe.id || soft_deleted.contains(&cid) {
                    continue;
                }
                let pair = canonical_pair(probe.id, cid);
                if !seen_pairs.insert(pair) {
                    continue;
                }
                let Some(candidate) = state.course_repository.get_by_id(&cid).await? else {
                    continue;
                };

                let r = state.matcher.match_courses(probe, &candidate);
                if r.score < req.threshold {
                    continue;
                }
                response.duplicates_found += 1;

                if r.score >= req.auto_merge_threshold {
                    auto_merge(state, probe, &candidate, r.score).await?;
                    soft_deleted.insert(candidate.id);
                    response.auto_merged += 1;
                } else {
                    response.review_items.push(ReviewQueueItem {
                        id: Uuid::new_v4(),
                        course_id_a: probe.id,
                        course_id_b: candidate.id,
                        match_score: r.score,
                        match_quality: confidence_label(r.confidence).to_string(),
                        detection_method: "BatchScan".to_string(),
                        score_breakdown: serde_json::to_value(&r.breakdown).ok(),
                        status: ReviewStatus::Pending,
                        reviewed_by: None,
                        created_at: Utc::now(),
                        reviewed_at: None,
                    });
                    response.queued_for_review += 1;
                }
            }
        }

        offset += DEDUP_PAGE;
        if page_len < DEDUP_PAGE {
            break;
        }
    }
    Ok(response)
}

/// Auto-merge `duplicate` into `main` inside the batch scan. Mirrors
/// the side effects of `merge_courses` but is awaited inline so the
/// dedup loop can keep accurate counters.
async fn auto_merge(
    state: &AppState,
    main: &Course,
    duplicate: &Course,
    score: f64,
) -> crate::Result<()> {
    let (merged, transferred) = fold_duplicate_into_main(main, duplicate);
    let updated = state.course_repository.update(&merged).await?;
    if let Err(e) = state.search_engine.delete_course(&main.id.to_string()) {
        tracing::warn!("auto_merge: removing main segment failed: {e}");
    }
    if let Err(e) = state.search_engine.index_course(&updated) {
        tracing::warn!("auto_merge: reindex main failed: {e}");
    }
    state.course_repository.soft_delete(&duplicate.id).await?;
    if let Err(e) = state.search_engine.delete_course(&duplicate.id.to_string()) {
        tracing::warn!("auto_merge: removing duplicate segment failed: {e}");
    }

    let merge_record = MergeRecord {
        id: Uuid::new_v4(),
        main_course_id: updated.id,
        duplicate_course_id: duplicate.id,
        status: MergeStatus::Completed,
        merged_by: Some("system:batch-dedup".into()),
        merge_reason: Some("auto-merge above auto_merge_threshold".into()),
        match_score: Some(score),
        transferred_data: Some(transferred),
        merged_at: Utc::now(),
    };
    let merge_record = state.course_repository.record_merge(&merge_record).await?;

    record_update(
        state,
        "Course",
        updated.id,
        Some(main),
        &updated,
        EventKind::CourseUpdated,
    )
    .await;
    record_delete(
        state,
        "Course",
        duplicate.id,
        Some(duplicate),
        EventKind::CourseDeleted,
    )
    .await;
    record_create(
        state,
        "CourseMerge",
        merge_record.id,
        &merge_record,
        EventKind::CourseMerged,
    )
    .await;
    Ok(())
}

/// Order a pair of ids deterministically (smaller first) so an
/// unordered `(a, b)` pair has a single key in the dedup `seen_pairs`
/// set regardless of scan order.
fn canonical_pair(a: Uuid, b: Uuid) -> (Uuid, Uuid) {
    if a < b { (a, b) } else { (b, a) }
}

// ────────────────── Privacy (FR-15, FR-16) ──────────────────

/// FR-16 — masked view of a Course.
#[utoipa::path(
    get, path = "/api/courses/{id}/masked",
    params(("id" = uuid::Uuid, Path,)),
    responses(
        (status = 200, body = Course),
        (status = 404, body = ApiError),
    ),
    tag = "privacy",
)]
pub async fn masked_course(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
) -> impl IntoResponse {
    match state.course_repository.get_by_id(&id).await {
        Ok(Some(c)) => Json(ApiResponse::success(crate::privacy::mask_course(&c))).into_response(),
        Ok(None) => not_found_response("Course not found"),
        Err(e) => error_response(e),
    }
}

/// FR-15 — GDPR Article-15 portability export.
#[utoipa::path(
    get, path = "/api/courses/{id}/export",
    params(("id" = uuid::Uuid, Path,)),
    responses(
        (status = 200, description = "GDPR Article-15 portability envelope"),
        (status = 404, body = ApiError),
    ),
    tag = "privacy",
)]
pub async fn export_course_data(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
) -> impl IntoResponse {
    match state.course_repository.get_by_id(&id).await {
        Ok(Some(c)) => Json(ApiResponse::success(crate::privacy::export_course(&c))).into_response(),
        Ok(None) => not_found_response("Course not found"),
        Err(e) => error_response(e),
    }
}

// ────────────────── Audit / streaming hooks (FR-17, FR-18) ──────────────────

/// Query string for the two audit endpoints — caps how many newest-first
/// rows are returned.
#[derive(Debug, Deserialize, ToSchema, IntoParams)]
pub struct AuditQuery {
    /// Maximum audit rows to return; defaults to 20 via `default_limit`.
    #[serde(default = "default_limit")]
    pub limit: u64,
}

/// FR-14 — entries for a Course (and any child whose audit row carries
/// the same `entity_id` once the merge / instance handlers tag them
/// against the parent). Newest first.
#[utoipa::path(
    get, path = "/api/courses/{id}/audit",
    params(
        ("id" = uuid::Uuid, Path,),
        AuditQuery,
    ),
    responses((status = 200, body = Vec<AuditEntry>)),
    tag = "audit",
)]
pub async fn audit_for_course(
    State(state): State<AppState>,
    Path(id): Path<Uuid>,
    Query(q): Query<AuditQuery>,
) -> impl IntoResponse {
    match state.audit_log.list_for_entity(id, q.limit).await {
        Ok(rows) => Json(ApiResponse::success(rows)).into_response(),
        Err(e) => error_response(e),
    }
}

/// System-wide recent-activity tail, newest first.
#[utoipa::path(
    get, path = "/api/audit/recent",
    params(AuditQuery),
    responses((status = 200, body = Vec<AuditEntry>)),
    tag = "audit",
)]
pub async fn audit_recent(
    State(state): State<AppState>,
    Query(q): Query<AuditQuery>,
) -> impl IntoResponse {
    match state.audit_log.list_recent(q.limit).await {
        Ok(rows) => Json(ApiResponse::success(rows)).into_response(),
        Err(e) => error_response(e),
    }
}

/// FR-17/FR-18 side effects for a create: write a `CREATE` audit row
/// (new values only) and publish the corresponding event. Both failures
/// are logged and swallowed so the primary write still succeeds.
async fn record_create(
    state: &AppState,
    entity_type: &str,
    entity_id: Uuid,
    new_value: &impl Serialize,
    event_kind: EventKind,
) {
    let new_json = serde_json::to_value(new_value).unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_create(entity_type, entity_id, new_json.clone(), &AuditContext::default())
        .await
    {
        tracing::warn!("audit_log.log_create failed: {e}");
    }
    let evt = CourseEvent::course(event_kind, entity_id, new_json);
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish failed: {e}");
    }
}

/// FR-17/FR-18 side effects for an update: write an `UPDATE` audit row
/// (old + new values) and publish the event. Failures are logged and
/// swallowed. A `None` prior serialises to JSON null.
async fn record_update(
    state: &AppState,
    entity_type: &str,
    entity_id: Uuid,
    old: Option<&impl Serialize>,
    new_value: &impl Serialize,
    event_kind: EventKind,
) {
    let old_json = old
        .map(|v| serde_json::to_value(v).unwrap_or(serde_json::Value::Null))
        .unwrap_or(serde_json::Value::Null);
    let new_json = serde_json::to_value(new_value).unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_update(
            entity_type,
            entity_id,
            old_json,
            new_json.clone(),
            &AuditContext::default(),
        )
        .await
    {
        tracing::warn!("audit_log.log_update failed: {e}");
    }
    let evt = CourseEvent::course(event_kind, entity_id, new_json);
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish failed: {e}");
    }
}

/// FR-17/FR-18 side effects for a (soft) delete: write a `DELETE` audit
/// row (old values only) and publish the event. Failures are logged and
/// swallowed.
async fn record_delete(
    state: &AppState,
    entity_type: &str,
    entity_id: Uuid,
    old: Option<&impl Serialize>,
    event_kind: EventKind,
) {
    let old_json = old
        .map(|v| serde_json::to_value(v).unwrap_or(serde_json::Value::Null))
        .unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_delete(entity_type, entity_id, old_json.clone(), &AuditContext::default())
        .await
    {
        tracing::warn!("audit_log.log_delete failed: {e}");
    }
    let evt = CourseEvent::course(event_kind, entity_id, old_json);
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish failed: {e}");
    }
}

/// Audit + event side effects for creating a `CourseInstance`. The audit
/// row is keyed on the parent `course_id` so the parent's audit history
/// surfaces instance changes too.
async fn record_instance_create(state: &AppState, course_id: Uuid, instance: &CourseInstance) {
    let payload = serde_json::to_value(instance).unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_create("CourseInstance", course_id, payload.clone(), &AuditContext::default())
        .await
    {
        tracing::warn!("audit_log.log_create (instance) failed: {e}");
    }
    let evt = CourseEvent::instance(
        EventKind::CourseInstanceCreated,
        course_id,
        instance.id,
        payload,
    );
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish (instance) failed: {e}");
    }
}

/// Audit + event side effects for updating a `CourseInstance`, keyed on
/// the parent `course_id`. A `None` prior serialises to JSON null.
async fn record_instance_update(
    state: &AppState,
    course_id: Uuid,
    prior: Option<&CourseInstance>,
    updated: &CourseInstance,
) {
    let old_json = prior
        .map(|p| serde_json::to_value(p).unwrap_or(serde_json::Value::Null))
        .unwrap_or(serde_json::Value::Null);
    let new_json = serde_json::to_value(updated).unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_update(
            "CourseInstance",
            course_id,
            old_json,
            new_json.clone(),
            &AuditContext::default(),
        )
        .await
    {
        tracing::warn!("audit_log.log_update (instance) failed: {e}");
    }
    let evt = CourseEvent::instance(
        EventKind::CourseInstanceUpdated,
        course_id,
        updated.id,
        new_json,
    );
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish (instance) failed: {e}");
    }
}

/// Audit + event side effects for soft-deleting a `CourseInstance`,
/// keyed on the parent `course_id`.
async fn record_instance_delete(
    state: &AppState,
    course_id: Uuid,
    instance_id: Uuid,
    prior: Option<&CourseInstance>,
) {
    let payload = prior
        .map(|p| serde_json::to_value(p).unwrap_or(serde_json::Value::Null))
        .unwrap_or(serde_json::Value::Null);
    if let Err(e) = state
        .audit_log
        .log_delete("CourseInstance", course_id, payload.clone(), &AuditContext::default())
        .await
    {
        tracing::warn!("audit_log.log_delete (instance) failed: {e}");
    }
    let evt = CourseEvent::instance(
        EventKind::CourseInstanceDeleted,
        course_id,
        instance_id,
        payload,
    );
    if let Err(e) = state.event_publisher.publish(evt).await {
        tracing::warn!("event_publisher.publish (instance) failed: {e}");
    }
}

/// Central error → HTTP mapping shared by every handler. Maps the
/// domain [`Error`](enum@crate::Error) variants to status + stable code
/// (404 / 422 / 409, everything else 500) and wraps the message in the
/// standard failure envelope.
fn error_response(e: crate::Error) -> axum::response::Response {
    let (status, code) = match &e {
        crate::Error::NotFound => (StatusCode::NOT_FOUND, "NOT_FOUND"),
        crate::Error::Validation(_) => (StatusCode::UNPROCESSABLE_ENTITY, "VALIDATION_FAILED"),
        crate::Error::Conflict(_) => (StatusCode::CONFLICT, "CONFLICT"),
        _ => (StatusCode::INTERNAL_SERVER_ERROR, "INTERNAL_ERROR"),
    };
    let body: ApiResponse<()> = ApiResponse::error(code, e.to_string());
    (status, Json(body)).into_response()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::models::{CourseIdentifier, IdentifierType, LinkType};

    /// Compact constructor for a bare identifier (scheme + value, no
    /// name/url) used to build merge fixtures.
    fn ident(scheme: IdentifierType, value: &str) -> CourseIdentifier {
        CourseIdentifier {
            property_id: scheme,
            value: value.into(),
            name: None,
            url: None,
        }
    }

    /// `fold_duplicate_into_main` unions free-text collections without
    /// introducing duplicates, dedupes identifiers by (scheme, value),
    /// records the former primary name, and adds a `Replaces` link.
    #[test]
    fn fold_unions_collections_and_dedupes_identifiers() {
        let mut main = Course::new("Intro to CS");
        main.keywords = vec!["programming".into()];
        main.same_as = vec!["https://wikidata.org/wiki/Q1".into()];
        main.identifiers = vec![ident(IdentifierType::Doi, "10.1234/abc")];

        let mut dup = Course::new("Introduction to Computer Science");
        dup.keywords = vec!["programming".into(), "algorithms".into()];
        dup.same_as = vec!["https://wikidata.org/wiki/Q1".into()];
        dup.identifiers = vec![
            ident(IdentifierType::Doi, "10.1234/abc"),         // already on main
            ident(IdentifierType::Wikidata, "Q12345"),         // new
        ];

        let (merged, transferred) = fold_duplicate_into_main(&main, &dup);

        // alternate_names captures the former primary name.
        assert!(merged
            .alternate_names
            .iter()
            .any(|n| n.starts_with("[former]")));
        // free-text union — no duplicates.
        assert_eq!(merged.keywords.len(), 2);
        assert_eq!(merged.same_as.len(), 1);
        // identifier dedupe by (scheme, value).
        assert_eq!(merged.identifiers.len(), 2);
        // a Replaces link was added pointing at the duplicate.
        assert!(
            merged
                .links
                .iter()
                .any(|l| l.other_course_id == dup.id && matches!(l.link_type, LinkType::Replaces))
        );
        // transferred snapshot carries the duplicate id.
        assert_eq!(transferred["from_course_id"], serde_json::json!(dup.id));
    }

    /// `fold_duplicate_into_main` is pure with respect to its inputs:
    /// neither the `main` nor the `duplicate` argument is mutated.
    #[test]
    fn fold_does_not_mutate_inputs() {
        let main = Course::new("A");
        let dup = Course::new("B");
        let snapshot_main = serde_json::to_value(&main).unwrap();
        let snapshot_dup = serde_json::to_value(&dup).unwrap();
        let _ = fold_duplicate_into_main(&main, &dup);
        assert_eq!(serde_json::to_value(&main).unwrap(), snapshot_main);
        assert_eq!(serde_json::to_value(&dup).unwrap(), snapshot_dup);
    }
}