Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
picodata
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
core
picodata
Commits
87bd5d2a
Commit
87bd5d2a
authored
6 months ago
by
Georgy Moshkin
Committed by
Kurdakov Alexander
5 months ago
Browse files
Options
Downloads
Patches
Plain Diff
feat: Introspection::get_sbroad_type_of_field and #[introspection(sbroad_type = ...)]
parent
912f9e9d
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!1249
feat: support the rest of parameters in alter system + big refactor
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
pico_proc_macro/src/lib.rs
+132
-2
132 additions, 2 deletions
pico_proc_macro/src/lib.rs
src/config.rs
+3
-0
3 additions, 0 deletions
src/config.rs
src/introspection.rs
+97
-0
97 additions, 0 deletions
src/introspection.rs
with
232 additions
and
2 deletions
pico_proc_macro/src/lib.rs
+
132
−
2
View file @
87bd5d2a
...
...
@@ -99,6 +99,8 @@ pub fn derive_introspection(input: proc_macro::TokenStream) -> proc_macro::Token
let
body_for_get_field_default_value_as_rmpv
=
generate_body_for_get_field_default_value_as_rmpv
(
&
context
);
let
body_for_get_sbroad_type_of_field
=
generate_body_for_get_sbroad_type_of_field
(
&
context
);
let
crate_
=
&
context
.args.crate_
;
quote!
{
#[automatically_derived]
...
...
@@ -126,11 +128,17 @@ pub fn derive_introspection(input: proc_macro::TokenStream) -> proc_macro::Token
use
#
crate_
::
introspection
::
IntrospectionError
;
#
body_for_get_field_default_value_as_rmpv
}
fn
get_sbroad_type_of_field
(
path
:
&
str
)
->
Result
<
Option
<
#
crate_
::
config
::
SbroadType
>
,
#
crate_
::
introspection
::
IntrospectionError
>
{
use
#
crate_
::
introspection
::
IntrospectionError
;
#
body_for_get_sbroad_type_of_field
}
}
}
.into
()
}
/// Generates body of `Introspection::FIELD_INFOS` constants array.
fn
generate_body_for_field_infos
(
context
:
&
Context
)
->
proc_macro2
::
TokenStream
{
let
crate_
=
&
context
.args.crate_
;
...
...
@@ -161,6 +169,8 @@ fn generate_body_for_field_infos(context: &Context) -> proc_macro2::TokenStream
code
}
/// Generates body of `Introspection::set_field_from_yaml` or `Introspection::set_field_from_rmpv` method.
/// Or may be used for other methods also if we add those.
fn
generate_body_for_set_field_from_something
(
context
:
&
Context
,
fn_ident
:
&
syn
::
Ident
,
...
...
@@ -274,6 +284,7 @@ fn generate_body_for_set_field_from_something(
}
}
/// Generates body of `Introspection::get_field_as_rmpv` method.
fn
generate_body_for_get_field_as_rmpv
(
context
:
&
Context
)
->
proc_macro2
::
TokenStream
{
let
crate_
=
&
context
.args.crate_
;
...
...
@@ -385,6 +396,7 @@ fn generate_body_for_get_field_as_rmpv(context: &Context) -> proc_macro2::TokenS
}
}
/// Generates body of `Introspection::get_field_default_value_as_rmpv` method.
fn
generate_body_for_get_field_default_value_as_rmpv
(
context
:
&
Context
,
)
->
proc_macro2
::
TokenStream
{
...
...
@@ -512,6 +524,110 @@ fn generate_body_for_get_field_default_value_as_rmpv(
}
}
/// Generates body of `Introspection::get_sbroad_type_of_field` method.
fn
generate_body_for_get_sbroad_type_of_field
(
context
:
&
Context
)
->
proc_macro2
::
TokenStream
{
let
mut
sbroad_type_for_non_nestable
=
quote!
{};
let
mut
sbroad_type_for_whole_nestable
=
quote!
{};
let
mut
sbroad_type_for_nested_subfield
=
quote!
{};
let
mut
non_nestable_names
=
vec!
[];
for
field
in
&
context
.fields
{
let
name
=
&
field
.name
;
#[allow(non_snake_case)]
let
Type
=
&
field
.field.ty
;
if
!
field
.attrs.nested
{
non_nestable_names
.push
(
name
);
// Handle getting sbroad type for a non-nestable field
if
let
Some
(
sbroad_type
)
=
&
field
.attrs.sbroad_type
{
sbroad_type_for_non_nestable
.extend
(
quote!
{
#
name
=>
{
return
Ok
(
Some
(
#
sbroad_type
));
}
});
}
else
{
sbroad_type_for_non_nestable
.extend
(
quote!
{
#
name
=>
{
return
Ok
(
None
);
}
});
}
}
else
{
// Handle getting sbroad type for a field marked with `#[introspection(nested)]`.
// Note that this code is exactly the same as in the non-nestable case.
if
let
Some
(
sbroad_type
)
=
&
field
.attrs.sbroad_type
{
sbroad_type_for_whole_nestable
.extend
(
quote!
{
#
name
=>
{
return
Ok
(
Some
(
#
sbroad_type
));
}
});
}
else
{
sbroad_type_for_whole_nestable
.extend
(
quote!
{
#
name
=>
{
return
Ok
(
None
);
}
});
}
// Handle getting sbroad type for a nested field
sbroad_type_for_nested_subfield
.extend
(
quote!
{
#
name
=>
{
return
#
Type
::
get_sbroad_type_of_field
(
tail
)
.map_err
(|
e
|
e
.with_prepended_prefix
(
head
));
}
});
}
}
// Handle if a nested path is specified for non-nestable field
let
mut
error_if_non_nestable
=
quote!
{};
if
!
non_nestable_names
.is_empty
()
{
error_if_non_nestable
=
quote!
{
#
(
#
non_nestable_names
)|
*
=>
{
return
Err
(
IntrospectionError
::
NotNestable
{
field
:
head
.into
()
})
}
};
}
// Actual generated body:
quote!
{
match
path
.split_once
(
'.'
)
{
Some
((
head
,
tail
))
=>
{
let
head
=
head
.trim
();
if
head
.is_empty
()
{
return
Err
(
IntrospectionError
::
InvalidPath
{
expected
:
"expected a field name before"
,
path
:
format!
(
".{tail}"
),
})
}
let
tail
=
tail
.trim
();
if
!
tail
.chars
()
.next
()
.map_or
(
false
,
char
::
is_alphabetic
)
{
return
Err
(
IntrospectionError
::
InvalidPath
{
expected
:
"expected a field name after"
,
path
:
format!
(
"{head}."
),
})
}
match
head
{
#
error_if_non_nestable
#
sbroad_type_for_nested_subfield
_
=>
{
return
Err
(
IntrospectionError
::
NoSuchField
{
parent
:
""
.into
(),
field
:
head
.into
(),
expected
:
Self
::
FIELD_INFOS
,
});
}
}
}
None
=>
{
match
path
{
#
sbroad_type_for_non_nestable
#
sbroad_type_for_whole_nestable
_
=>
{
return
Err
(
IntrospectionError
::
NoSuchField
{
parent
:
""
.into
(),
field
:
path
.into
(),
expected
:
Self
::
FIELD_INFOS
,
});
}
}
}
}
}
}
struct
Context
{
fields
:
Vec
<
FieldInfo
>
,
args
:
Args
,
...
...
@@ -575,13 +691,19 @@ struct FieldAttrs {
/// as a default configuration parameter value. See also doc comments of
/// `Introspection::get_field_default_value_as_rmpv` for more details.
config_default
:
Option
<
syn
::
Expr
>
,
/// Looks like this in the source code: `#[introspection(sbroad_type = <expr>)]`.
///
/// The provided expression must have type `picodata::config::SbroadType`.
/// The user must make sure that `config_default` is not conflicting with `sbroad_type`.
sbroad_type
:
Option
<
syn
::
Expr
>
,
}
impl
FieldAttrs
{
fn
from_attributes
(
attrs
:
Vec
<
syn
::
Attribute
>
)
->
Result
<
Self
,
syn
::
Error
>
{
let
mut
result
=
Self
::
default
();
for
attr
in
attrs
{
for
attr
in
&
attrs
{
if
!
attr
.path
.is_ident
(
"introspection"
)
{
continue
;
}
...
...
@@ -604,10 +726,18 @@ impl FieldAttrs {
input
.parse
::
<
syn
::
Token!
[
=
]
>
()
?
;
result
.config_default
=
Some
(
input
.parse
::
<
syn
::
Expr
>
()
?
);
}
else
if
ident
==
"sbroad_type"
{
if
result
.sbroad_type
.is_some
()
{
return
Err
(
syn
::
Error
::
new
(
ident
.span
(),
"duplicate `sbroad_type` specified"
));
}
input
.parse
::
<
syn
::
Token!
[
=
]
>
()
?
;
result
.sbroad_type
=
Some
(
input
.parse
::
<
syn
::
Expr
>
()
?
);
}
else
{
return
Err
(
syn
::
Error
::
new
(
ident
.span
(),
format!
(
"unknown attribute argument `{ident}`, expected one of `ignore`, `nested`, `config_default`"
),
format!
(
"unknown attribute argument `{ident}`, expected one of `ignore`, `nested`, `config_default`
, `sbroad_type`
"
),
));
}
...
...
This diff is collapsed.
Click to expand it.
src/config.rs
+
3
−
0
View file @
87bd5d2a
...
...
@@ -29,6 +29,9 @@ use std::str::FromStr;
use
tarantool
::
log
::
SayLevel
;
use
tarantool
::
tlua
;
/// This reexport is used in the derive macro for Introspection.
pub
use
sbroad
::
ir
::
relation
::
Type
as
SbroadType
;
pub
use
crate
::
address
::{
DEFAULT_IPROTO_PORT
,
DEFAULT_LISTEN_HOST
,
DEFAULT_USERNAME
};
pub
const
DEFAULT_CONFIG_FILE_NAME
:
&
str
=
"config.yaml"
;
...
...
This diff is collapsed.
Click to expand it.
src/introspection.rs
+
97
−
0
View file @
87bd5d2a
...
...
@@ -8,6 +8,7 @@
//! supports some basic struct field information.
//!
//! [`PicodataConfig`]: crate::config::PicodataConfig
use
crate
::
config
::
SbroadType
;
use
crate
::
traft
::
error
::
Error
;
pub
use
pico_proc_macro
::
Introspection
;
...
...
@@ -191,6 +192,41 @@ pub trait Introspection {
&
self
,
path
:
&
str
,
)
->
Result
<
Option
<
rmpv
::
Value
>
,
IntrospectionError
>
;
/// Get `SbroadType` which was specified via the `#[introspection(sbroad_type = expr)]` attribute.
///
/// Returns `Ok(None)` if `sbroad_type` attribute wasn't provided for
/// given field.
///
/// Note that the value is not checked neither against the field's type nor
/// against value specified in `config_default` attribute.
/// So it's the user's responsibility to make sure the types are consistent.
///
/// The `expr` in `#[introspection(sbroad_type = expr)]` must be of type
/// [`SbroadType`] otherwise your code will not compile.
///
/// # Examples:
/// ```
/// use picodata::introspection::Introspection;
/// use picodata::config::SbroadType;
///
/// #[derive(Introspection, Default)]
/// #[introspection(crate = picodata)]
/// struct MyStruct {
/// #[introspection(sbroad_type = SbroadType::Integer)]
/// number: i32,
/// #[introspection(sbroad_type = SbroadType::String)]
/// text: String,
/// type_wasnt_specified: bool,
/// }
///
/// assert_eq!(MyStruct::get_sbroad_type_of_field("number").unwrap(), Some(SbroadType::Integer));
///
/// assert_eq!(MyStruct::get_sbroad_type_of_field("text").unwrap(), Some(SbroadType::String));
///
/// assert_eq!(MyStruct::get_sbroad_type_of_field("type_wasnt_specified").unwrap(), None);
/// ```
fn
get_sbroad_type_of_field
(
path
:
&
str
)
->
Result
<
Option
<
SbroadType
>
,
IntrospectionError
>
;
}
/// Information about a single struct field. This is the type which is stored
...
...
@@ -384,12 +420,16 @@ mod test {
struct
S
{
x
:
i32
,
#[introspection(config_default
=
self
.
x
as
f32
*
0.5
)]
#[introspection(sbroad_type
=
SbroadType::Double)]
y
:
f32
,
#[introspection(config_default
=
"this is a &str but it still works"
)]
#[introspection(sbroad_type
=
SbroadType::String)]
s
:
String
,
#[introspection(config_default
=
&[
"this"
,
"also"
,
"works"
]
)]
#[introspection(sbroad_type
=
SbroadType::Array)]
v
:
Vec
<
String
>
,
#[introspection(nested)]
#[introspection(sbroad_type
=
SbroadType::Map)]
r
#
struct
:
Nested
,
#[introspection(ignore)]
...
...
@@ -399,6 +439,7 @@ mod test {
#[derive(Default,
Debug,
Introspection,
PartialEq)]
struct
Nested
{
#[introspection(config_default
=
"nested of course works"
)]
#[introspection(sbroad_type
=
SbroadType::String)]
a
:
String
,
#[introspection(config_default
=
format
!
(
"{}, but type safety is missing unfortunately"
,
self
.
a))]
b
:
i64
,
...
...
@@ -811,4 +852,60 @@ mod test {
])),
);
}
#[test]
fn
get_sbroad_type_of_field
()
{
//
// Error cases are mostly covered in tests above
//
let
e
=
S
::
get_sbroad_type_of_field
(
"struct.no_such_field"
)
.unwrap_err
();
assert_eq!
(
e
.to_string
(),
"struct: unknown field `no_such_field`, expected one of `a`, `b`, `empty`"
);
let
e
=
S
::
get_sbroad_type_of_field
(
"ignored"
)
.unwrap_err
();
assert_eq!
(
e
.to_string
(),
"unknown field `ignored`, expected one of `x`, `y`, `s`, `v`, `struct`"
);
//
// Success cases
//
// We didn't specify type for `x` so it's `None`.
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"x"
)
.unwrap
(),
None
);
// Remember, it's `self.x * 0.5`
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"y"
)
.unwrap
(),
Some
(
SbroadType
::
Double
)
);
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"s"
)
.unwrap
(),
Some
(
SbroadType
::
String
)
);
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"v"
)
.unwrap
(),
Some
(
SbroadType
::
Array
)
);
// Type of whole subsection also works, if specified.
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"struct"
)
.unwrap
(),
Some
(
SbroadType
::
Map
),
);
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"struct.a"
)
.unwrap
(),
Some
(
SbroadType
::
String
)
);
// Didn't specify
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"struct.b"
)
.unwrap
(),
None
);
// Type of nested subsection wasn't specified in this case.
assert_eq!
(
S
::
get_sbroad_type_of_field
(
"struct.empty"
)
.unwrap
(),
None
);
}
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment