uf-valence-codegen 0.1.2

Valence schema codegen (caller-supplied roots)
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
#![allow(clippy::unwrap_used, clippy::expect_used)]
use std::collections::HashMap;

use crate::codegen::generate_from_schema_file;
use crate::codegen::parser::ParsedTraitDef;

use super::support::write_temp_schema_file;

#[test]
fn generates_code_from_dsl_schema() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    TestEntity {
        table: "test_entity",
        version: "0.1.0",
        description: "Test entity for DSL parsing",

        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            name: { r#type: FieldType::String, required: true },
            deleted_at: { r#type: FieldType::Datetime, required: false },
        ]
    }
}
"#;

    let path = write_temp_schema_file(schema, "dsl_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("DSL codegen failed");
    insta::assert_snapshot!(generated);
}

#[test]
fn generates_clear_method_for_optional_fields() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    TestNotification {
        table: "test_notification",
        version: "0.1.0",
        description: "Test entity with optional field for clear method",

        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            message: { r#type: FieldType::String, required: true },
            read_at: { r#type: FieldType::Datetime, required: false },
        ]
    }
}
"#;

    let path = write_temp_schema_file(schema, "optional_field_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("codegen failed");

    // Verify clear_read_at method is generated
    assert!(
        generated.contains("clear_read_at"),
        "Expected clear_read_at method to be generated"
    );
    assert!(
        generated.contains("pub fn clear_read_at"),
        "Expected clear_read_at to be a public method"
    );

    // Verify the mutable field uses Option<Option<T>> for optional fields
    assert!(
        generated.contains("Option<Option<chrono::DateTime<chrono::Utc>>>"),
        "Expected Option<Option<T>> for optional datetime field"
    );

    // Verify set method uses Some(Some(value))
    assert!(
        generated.contains("Some(Some(value))"),
        "Expected setter to use Some(Some(value)) for optional fields"
    );

    insta::assert_snapshot!(generated);
}

#[test]
fn generates_field_changes_and_dispatch_for_side_effects() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    ScoreTracker {
        table: "score_tracker",
        version: "0.1.0",
        description: "Test entity with side effects",

        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            user: { r#type: FieldType::Record("user"), required: true },
            value: { r#type: FieldType::Integer, required: true },
        ],

        side_effects: [ScoreNotifier, AuditLogger],
    }
}
"#;

    let path = write_temp_schema_file(schema, "side_effects_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("codegen failed");

    // FieldChanges struct is generated
    assert!(
        generated.contains("pub struct ScoreTrackerFieldChanges"),
        "Expected ScoreTrackerFieldChanges struct to be generated"
    );

    // FieldChanges has typed fields for non-PK fields
    assert!(
        generated.contains("pub value: valence::FieldChange<i64>"),
        "Expected typed FieldChange<i64> for value field"
    );
    assert!(
        generated.contains("pub user: valence::FieldChange<valence::RecordId>"),
        "Expected typed FieldChange<RecordId> for user field"
    );

    // FieldChanges associated type is set on Model
    assert!(
        generated.contains("type FieldChanges = ScoreTrackerFieldChanges"),
        "Expected FieldChanges associated type on Model impl"
    );

    // Side effect dispatch references both registered types
    assert!(
        generated.contains("Box::new(ScoreNotifier)"),
        "Expected ScoreNotifier instantiation in dispatch"
    );
    assert!(
        generated.contains("Box::new(AuditLogger)"),
        "Expected AuditLogger instantiation in dispatch"
    );
    assert!(
        generated.contains("dyn valence::SideEffect<Self>"),
        "Expected SideEffect trait object in dispatch"
    );

    // Mutation construction in create
    assert!(
        generated.contains("valence::MutationKind::Create"),
        "Expected MutationKind::Create in generated code"
    );

    // Mutation construction in update
    assert!(
        generated.contains("valence::MutationKind::Update"),
        "Expected MutationKind::Update in generated code"
    );

    // Queued delete path (physical delete runs in host deletion worker)
    assert!(
        generated.contains("valence::deletion::DeletionService::create_run"),
        "Expected queued deletion run creation in generated delete()"
    );

    // Side effect errors are logged, not propagated
    assert!(
        generated.contains("record_side_effect_error"),
        "Expected side-effect error instrumentation in dispatch"
    );

    insta::assert_snapshot!(generated);
}

#[test]
fn generates_no_op_dispatch_without_side_effects() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    PlainModel {
        table: "plain_model",
        version: "0.1.0",
        description: "Model with no side effects",

        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            name: { r#type: FieldType::String, required: true },
        ]
    }
}
"#;

    let path = write_temp_schema_file(schema, "no_side_effects_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("codegen failed");

    // FieldChanges struct is still generated
    assert!(
        generated.contains("pub struct PlainModelFieldChanges"),
        "Expected PlainModelFieldChanges struct"
    );

    // No-op dispatch: has unused_variables allow and empty body
    assert!(
        generated.contains("#[allow(unused_variables)]"),
        "Expected #[allow(unused_variables)] on no-op dispatch"
    );

    // Should NOT contain side-effect error instrumentation (no-op path)
    assert!(
        !generated.contains("record_side_effect_error"),
        "No-op dispatch should not contain side-effect error instrumentation"
    );

    // Should NOT contain Box::new (no side effects to instantiate)
    assert!(
        !generated.contains("Box::new"),
        "No-op dispatch should not contain side effect instantiations"
    );

    insta::assert_snapshot!(generated);
}

#[test]
fn rejects_toml_schema() {
    let schema = r##"
use valence::prelude::*;

valence_schema! {
    r#"
[table_properties]
name = "toml_entity"
version = "1.0.0"
description = "TOML based schema"

[privacy]
gdpr_compliant = false
deletion_tracking = true
roles = ["public"]

[mutation]
create_roles = ["system", "user"]
update_roles = ["system", "user"]
delete_roles = ["system", "admin"]

[[fields]]
name = "id"
type = "string"
primary_key = true
required = true

[[fields]]
name = "count"
type = "integer"
required = true
default = "0"
validations = ["non_negative"]
"#
}
"##;

    let path = write_temp_schema_file(schema, "toml_schema.rs");
    let result = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new());
    assert!(result.is_err());
}

#[test]
fn test_union_join_methods_generated() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    TestEntity {
        table: "test_entity",
        version: "0.1.0",
        description: "Simple entity for union/join test",

        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            name: { r#type: FieldType::String, required: true },
        ]
    }
}
"#;

    let path = write_temp_schema_file(schema, "union_join_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("union/join codegen failed");

    assert!(
        generated.contains("fn union"),
        "Expected union method to be generated on query builder"
    );
    assert!(
        generated.contains("fn join"),
        "Expected join method to be generated on query builder"
    );
    assert!(
        generated.contains("union_with"),
        "Expected union_with call in generated union method"
    );
    assert!(
        generated.contains("join_with"),
        "Expected join_with call in generated join method"
    );
}

#[test]
fn generates_json_as_and_currency_and_record_target() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    TypedFields {
        table: "typed_fields",
        version: "0.1.0",
        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            payload: { r#type: FieldType::JsonAs("crate::Payload"), required: true },
            panic_payload: {
                r#type: FieldType::JsonAs("crate::Payload").serde_error(JsonAsSerdeError::Panic),
                required: true
            },
            price: { r#type: FieldType::Currency, required: true },
            author: {
                r#type: FieldType::Record("user").target("other_crate::generated::User"),
                required: true
            },
            blob: { r#type: FieldType::Json, required: true },
            at: { r#type: FieldType::DateTime, required: true },
        ]
    }
}
"#;

    let path = write_temp_schema_file(schema, "typed_fields_schema.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("typed fields codegen failed");

    assert!(
        generated.contains("payload: crate :: Payload")
            || generated.contains("payload: crate::Payload"),
        "Expected JsonAs Rust type on payload"
    );
    assert!(
        generated.contains("serde_json::Value"),
        "Expected plain Json to remain serde_json::Value"
    );
    assert!(
        generated.contains("valence::Currency"),
        "Expected Currency field type"
    );
    assert!(
        generated.contains("where_price_code") && generated.contains("where_price_minor"),
        "Expected currency subfield query methods"
    );
    assert!(
        generated.contains("other_crate::generated::User")
            || generated.contains("other_crate :: generated :: User"),
        "Expected Record.target model path in connection helpers"
    );
    assert!(
        generated.contains("valence::datetime_unix"),
        "Expected datetime unix serde module"
    );
    assert!(
        generated.contains("JsonAsSerdeError::Panic")
            || generated.contains("valence::JsonAsSerdeError::Panic"),
        "Expected Panic serde policy helper"
    );
}

#[test]
fn connection_target_alias_sets_model_path() {
    let schema = r#"
use valence::prelude::*;

valence_schema! {
    Note {
        table: "note",
        version: "0.1.0",
        fields: [
            id: { r#type: FieldType::String, primary_key: true, required: true },
            author: { r#type: FieldType::Record("user"), required: true },
        ],
        connections: [
            author: {
                table: "user",
                cardinality: HasOne,
                required: true,
                on_delete: Cascade,
                target: "other_crate::generated::User",
            },
        ],
    }
}
"#;

    let path = write_temp_schema_file(schema, "note_target_alias.rs");
    let generated = generate_from_schema_file(&path, &HashMap::<String, ParsedTraitDef>::new())
        .expect("target alias codegen failed");

    assert!(
        generated.contains("other_crate::generated::User")
            || generated.contains("other_crate :: generated :: User"),
        "Expected target: alias to populate model_path"
    );
    assert!(
        generated.contains("query_author"),
        "Expected typed hop for cross-crate target"
    );
}