Skip to content
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.

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

fix(dojo-lang): raise an error on value before key in model #2891

Merged
merged 9 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
175 changes: 29 additions & 146 deletions Cargo.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ rpassword = "7.2.0"
rstest = "0.18.2"
rstest_reuse = "0.6.0"
salsa = "0.16.1"
scarb = { git = "https://github.com/dojoengine/scarb", rev = "7eac49b3e61236ce466e712225d9c989f9db1ef3" }
scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "7eac49b3e61236ce466e712225d9c989f9db1ef3" }
scarb = { git = "https://github.com/dojoengine/scarb", rev = "c811c5bcb073afa21cb9b1307adafe733c203eb9" }
scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "c811c5bcb073afa21cb9b1307adafe733c203eb9" }
semver = "1.0.5"
serde = { version = "1.0", features = [ "derive" ] }
serde_json = { version = "1.0", features = [ "arbitrary_precision" ] }
Expand Down
46 changes: 40 additions & 6 deletions crates/dojo/lang/src/attribute_macros/element.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
use cairo_lang_defs::patcher::RewriteNode;
use cairo_lang_defs::plugin::PluginDiagnostic;
use cairo_lang_diagnostics::Severity;
use cairo_lang_syntax::node::ast::Member as MemberAst;
use cairo_lang_syntax::node::db::SyntaxGroup;
use cairo_lang_syntax::node::helpers::QueryAttrs;
use cairo_lang_syntax::node::{Terminal, TypedSyntaxNode};
use cairo_lang_syntax::node::{Terminal, TypedStablePtr, TypedSyntaxNode};
use dojo_types::naming::compute_bytearray_hash;
use starknet_crypto::{poseidon_hash_many, Felt};

Expand Down Expand Up @@ -34,13 +36,45 @@
poseidon_hash_many(&hashes)
}

pub fn parse_members(db: &dyn SyntaxGroup, members: &[MemberAst]) -> Vec<Member> {
pub fn parse_members(
db: &dyn SyntaxGroup,
members: &[MemberAst],
diagnostics: &mut Vec<PluginDiagnostic>,
) -> Vec<Member> {
let mut parsing_keys = true;

Check warning on line 45 in crates/dojo/lang/src/attribute_macros/element.rs

View check run for this annotation

Codecov / codecov/patch

crates/dojo/lang/src/attribute_macros/element.rs#L39-L45

Added lines #L39 - L45 were not covered by tests
members
.iter()
.map(|member_ast| Member {
name: member_ast.name(db).text(db).to_string(),
ty: member_ast.type_clause(db).ty(db).as_syntax_node().get_text(db).trim().to_string(),
key: member_ast.has_attr(db, "key"),
.map(|member_ast| {
let is_key = member_ast.has_attr(db, "key");

let member = Member {
name: member_ast.name(db).text(db).to_string(),
ty: member_ast
.type_clause(db)
.ty(db)
.as_syntax_node()
.get_text(db)
.trim()
.to_string(),
key: is_key,
};

// Make sure all keys are before values in the model.
if is_key && !parsing_keys {
diagnostics.push(PluginDiagnostic {
message: "Key members must be defined before non-key members.".into(),
stable_ptr: member_ast.name(db).stable_ptr().untyped(),
severity: Severity::Error,
});
// Don't return here, since we don't want to stop processing the members after the
// first error to avoid diagnostics just because the field is
// missing.
}

Check warning on line 73 in crates/dojo/lang/src/attribute_macros/element.rs

View check run for this annotation

Codecov / codecov/patch

crates/dojo/lang/src/attribute_macros/element.rs#L48-L73

Added lines #L48 - L73 were not covered by tests

parsing_keys &= is_key;

member

Check warning on line 77 in crates/dojo/lang/src/attribute_macros/element.rs

View check run for this annotation

Codecov / codecov/patch

crates/dojo/lang/src/attribute_macros/element.rs#L75-L77

Added lines #L75 - L77 were not covered by tests
})
.collect::<Vec<_>>()
}
Expand Down
2 changes: 1 addition & 1 deletion crates/dojo/lang/src/attribute_macros/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
}
}

let members = parse_members(db, &struct_ast.members(db).elements(db));
let members = parse_members(db, &struct_ast.members(db).elements(db), &mut diagnostics);

Check warning on line 61 in crates/dojo/lang/src/attribute_macros/event.rs

View check run for this annotation

Codecov / codecov/patch

crates/dojo/lang/src/attribute_macros/event.rs#L61

Added line #L61 was not covered by tests

let mut serialized_keys: Vec<RewriteNode> = vec![];
let mut serialized_values: Vec<RewriteNode> = vec![];
Expand Down
2 changes: 1 addition & 1 deletion crates/dojo/lang/src/attribute_macros/model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
let mut model_member_store_impls_processed: HashSet<String> = HashSet::new();
let mut model_member_store_impls: Vec<String> = vec![];

let members = parse_members(db, &struct_ast.members(db).elements(db));
let members = parse_members(db, &struct_ast.members(db).elements(db), &mut diagnostics);

Check warning on line 75 in crates/dojo/lang/src/attribute_macros/model.rs

View check run for this annotation

Codecov / codecov/patch

crates/dojo/lang/src/attribute_macros/model.rs#L75

Added line #L75 was not covered by tests

members.iter().for_each(|member| {
if member.key {
Expand Down
4 changes: 2 additions & 2 deletions examples/spawn-and-move/src/models.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ pub struct Message {
pub identity: ContractAddress,
#[key]
pub channel: felt252,
pub message: ByteArray,
#[key]
pub salt: felt252
pub salt: felt252,
pub message: ByteArray,
}

#[derive(Copy, Drop, Serde, Debug)]
Expand Down
Binary file modified spawn-and-move-db.tar.gz
Binary file not shown.
Binary file modified types-test-db.tar.gz
Binary file not shown.
Loading