Skip to content

fix(rust): add serde flatten for subclass field preservation #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vyuan2037 wants to merge 1 commit into from
Closed

fix(rust): add serde flatten for subclass field preservation #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion lib/codegen/fromcto/rust/rustvisitor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,16 @@ class RustVisitor {
.getAllDeclarations()
.find((declaration) => declaration.isMapDeclaration?.());

if (hasMapDeclaration) {
// Check if any class has subclasses (needs HashMap + serde_json for flatten)
const hasBaseTypes = modelFile
.getAllDeclarations()
.filter((declaration) => declaration.isClassDeclaration?.())
.some((declaration) => {
const subs = declaration.getDirectSubclasses?.() || [];
return subs.length > 0;
});

if (hasMapDeclaration || hasBaseTypes) {
parameters.fileWriter.writeLine(
0,
'use std::collections::HashMap;'
Expand Down Expand Up @@ -326,6 +335,22 @@ class RustVisitor {
property.accept(this, parameters);
});

// Add #[serde(flatten)] catch-all field for base types with subtypes.
// When a Concerto class has subclasses, the JSON AST for those subtypes
// contains fields from both the parent and child. Without flatten, the
// parent struct silently drops the child-specific fields during deserialization.
const subclasses = classDeclaration.getDirectSubclasses?.() || [];
if (subclasses.length > 0) {
parameters.fileWriter.writeLine(1, '');
parameters.fileWriter.writeLine(1, '#[serde(');
parameters.fileWriter.writeLine(2, 'flatten,');
parameters.fileWriter.writeLine(1, ')]');
parameters.fileWriter.writeLine(
1,
'pub extra: std::collections::HashMap<String, serde_json::Value>,'
);
}

parameters.fileWriter.writeLine(0, '}');
parameters.fileWriter.writeLine(0, '');

Expand Down
114 changes: 114 additions & 0 deletions test/codegen/__snapshots__/codegen.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5646,6 +5646,7 @@ exports[`codegen #formats check we can convert all formats from namespace unvers
use chrono::{ DateTime, Utc };

use crate::concerto_1_0_0::*;
use std::collections::HashMap;
use crate::utils::*;

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5654,6 +5655,11 @@ pub struct Decorator {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5680,6 +5686,7 @@ exports[`codegen #formats check we can convert all formats from namespace unvers
use chrono::{ DateTime, Utc };

use crate::concerto_decorator_1_0_0::*;
use std::collections::HashMap;
use crate::utils::*;

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5688,6 +5695,11 @@ pub struct Concept {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5701,6 +5713,11 @@ pub struct Asset {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5714,6 +5731,11 @@ pub struct Participant {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5729,6 +5751,11 @@ pub struct Transaction {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -5744,6 +5771,11 @@ pub struct Event {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

",
Expand Down Expand Up @@ -5829,6 +5861,11 @@ pub struct Category {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -6052,6 +6089,11 @@ pub struct Equipment {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -6144,6 +6186,11 @@ pub struct Person {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -6246,6 +6293,11 @@ pub struct Employee {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -6441,6 +6493,11 @@ pub struct CompanyEvent {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -13509,6 +13566,7 @@ exports[`codegen #formats check we can convert all formats from namespace versio
use chrono::{ DateTime, Utc };

use crate::concerto_1_0_0::*;
use std::collections::HashMap;
use crate::utils::*;

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13517,6 +13575,11 @@ pub struct Decorator {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13543,6 +13606,7 @@ exports[`codegen #formats check we can convert all formats from namespace versio
use chrono::{ DateTime, Utc };

use crate::concerto_decorator_1_0_0::*;
use std::collections::HashMap;
use crate::utils::*;

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13551,6 +13615,11 @@ pub struct Concept {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13564,6 +13633,11 @@ pub struct Asset {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13577,6 +13651,11 @@ pub struct Participant {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13592,6 +13671,11 @@ pub struct Transaction {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand All @@ -13607,6 +13691,11 @@ pub struct Event {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

",
Expand Down Expand Up @@ -13692,6 +13781,11 @@ pub struct Category {
rename = "$class",
)]
pub _class: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -13915,6 +14009,11 @@ pub struct Equipment {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -14007,6 +14106,11 @@ pub struct Person {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -14109,6 +14213,11 @@ pub struct Employee {
rename = "$identifier",
)]
pub _identifier: String,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -14304,6 +14413,11 @@ pub struct CompanyEvent {
deserialize_with = "deserialize_datetime",
)]
pub _timestamp: DateTime<Utc>,

#[serde(
flatten,
)]
pub extra: std::collections::HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down