Enrich metadata with type information (#8615)

* Cargo.lock after merge * Restore scale-info feature * Fully qualify TypeInfo derive * Skip PendingSwap T * Add missing skip_type_params attr * metadata docs features * Reduce pallet event attribute to struct * Cargo.lock * Update frame/balances/src/tests_composite.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Line widths check * Cargo.lock * Add scale-info/std * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Use `skip_type_params` to remove `TypeInfo` requirements on checks * Revert "Remove unused Call metadata stuff" This reverts commit 41311f85 * Skip BalanceSwapAction type parameter * Remove unused event metadata macro * Update frame-metadata * Update primitives/npos-elections/compact/src/codec.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Manual TypeInfo for Header * Remove TypeInfo requirement for consts in BoundedVec etc. * Another TypeInfo bound removed * review: fix indentation * TypeInfo impls for Identity types * Add some todos to add custom TypeInfo impls * Update frame/support/procedural/src/pallet/expand/pallet_struct.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Add some todos to add custom TypeInfo impls * Add a test for manual Data TypeInfo impl * Add custom TypeInfo impl for Vote * Era custom TypeInfo crimes * Revert finality-grandpa version to 0.14.z * review: renamed module to pallet_constants_metadata * New line at end of file * Add missing scale-info/std * Update frame/support/src/storage/types/mod.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Remove StorageEntryType::Map unused flag * Add missing scale-info dependency after merge * SignedExtension::AdditionalSigned metadata * Update frame-metadata, use abbreviated docs and args fields * Update frame/example/Cargo.toml Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Add scale_info/std and remove unused scale-info dependency * Remove scale-info dependency * Remove treasury pallet::metadata * Remove redundant Event test * Add back scale-info as dev dependency * fix error metadata when no error defined in decl_module * Add Module3 to tests * Fix metadata test * Add docs feature to frame-support test * WIP fixing pallet metadata test * Remove redundant FunctionMetadata, FunctionArgumentMetadata as per https://github.com/paritytech/frame-metadata/pull/20 * Use main branch of frame-metadata * Use patch of scale-info for latest changes * Use latest patched scale-info * Manual TypeInfo for DigestItem * Manual TypeInfo for DigestItem * Update scale-info * Skip __Ignore variants for Error, depends on https://github.com/paritytech/scale-info/pull/117 * Named fields for FRAME v2 pallet Call variants * Named fields for FRAME v1 pallet Call variants * Add missing scale-info dependency * WIP expand benchmark call variant * fix benchmark with new function create a new function for each variant of a pallet call. This function is called by benchmarking macro in order not to break call creation with unnamed argument * fix tests * more fix * Fix staking tests * Fix offchain workers calls * Cherry pick rustfmt.toml from master * cargo +nightly-2021-06-22 fmt --all * Update to new call variant structs * More call variant struct updates * Remove unused import * More call variant structs * More call variant structs * Even more call variant structs * Mooar variant structs * Evermore variant structs * Call variant structs ad infinitum * Fmt * More call variants * Last call variant * Call variants all done? * Fix SS58Prefix type * Potential workaround for BitFlags<IdentityFields> TypeInfo * Enable docs capturing for Call, Event, and Error types * Fix IdentityFields TypeInfo * Remove metadata-docs feature * Add capture_docs = true for legacy Call, Event and Error types * Fmt * Fix metadata test type * Update benchmarks with call struct variants * Fmt * More test fixes * Fmt * Fix benches * Use latest capture_docs attr * Latest scale_info * Fmt * review: change &Vec to &[] * Remove pallet metadata attr * review: remove commented out test code * review: skip_type_params trailing comma suggestion * Update to scale-info 0.10.0 * Update construct_runtime ui tests, different because of metadata TypeInfo impls * Add some TypeInfo derives for UI tests * Update storage ensure span ui stderrs * Update call argument bound ui tests Possibly changed because change from tuple to struct variants? * Add scale-info dev dependency * Update to latest finality-grandpa release * review: missing newline * review: missing scale-info/std * review: remove duplicate scale-info/std * review: remove fully qualified TypeInfo * review: add missing scale-info/std * review: remove unnecessary imports. * Fmt * Use crates.io RC version of frame-metadata * Remove scale-info/std because it is a dev dependency * Add missing scale_info dev-dependency for test * Delete empty metadata folder * Fix sp_std import * review: improve manual UncheckedExtrinsic TypeInfo impl * review: use full scale-info for dev-dependency * Remove DefaultByteGetter impl * review: derive TypeInfo for generic header * Fmt * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update bin/node/executor/Cargo.toml Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/identity/src/types.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/support/src/dispatch.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Remove redundant derive * Simplify scale-info dependency * Strip underscore prefix from call variant struct names * Another underscore field * More underscore fields * Another underscore field * Update to frame-metadata 14.0.0-rc.2 with combined StorageEntryType::Map * Fmt * Revert weights formatting * Fix up some tests * Fix up some tests for StorageEntryTypeMetadata * scale-info dev dependency * Fix test error * Add missing TypeInfo derives * Add back missing scale-info dependency * Add back missing scale-info dependency * Fix npos compact impls * Cargo.lock * Fmt * Fix errors * Fmt * Fix renamed raw_solution field * Fix error * Fmt * Fix some benchmarks * Fmt * Stray R * Fix * Add missing TypeInfos * ui test fix * Fix line widths * Revert "ui test fix" This reverts commit 2d15ec058a216e3f92d713f1174603a2bb1eac65. * Upgrade to scale-info 0.11.0 * Revert "Upgrade to scale-info 0.11.0" This reverts commit 047bb179085a0059c36cd20ab405f55cf0867e28. * Add Runtime type * Update to scale-info 0.12 * Update to scale-info 1.0 * Update frame-metadata to version 14.0.0 * Patch finality-grandpa until release available * Fix metadata tests * Fix metadata tests * Fmt * Remove patched finality-grandpa * Fix tests, use scale_info imports * Fix pallet tests * Add BlockNumber TypeInfo bound * ui test fix * Cargo.lock * Remove pallet metadata * Cargo.lock * Add missing scale-info dependency * Remove pallet event metadata * Fix error * Fix collective errors * Semicolol * Fmt * Remove another metadata attribute * Add new variant to custom digest TypeInfo * Fmt * Cargo.lock from master * Remove comma lol * Fix example call error * Fix example call error properly Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
2026-05-01 18:17:56 +00:00 · 2021-09-15 12:40:41 +01:00
parent ebe78a4c1b
commit 49b6dfd2e5
305 changed files with 4015 additions and 3947 deletions
@@ -16,6 +16,7 @@
 // limitations under the License.

 use super::helper;
+use frame_support_procedural_tools::get_doc_literals;
 use quote::ToTokens;
 use syn::spanned::Spanned;

@@ -219,7 +220,7 @@ impl CallDef {
 					args.push((!arg_attrs.is_empty(), arg_ident, arg.ty.clone()));
 				}

-				let docs = helper::get_doc_literals(&method.attrs);
+				let docs = get_doc_literals(&method.attrs);

 				methods.push(CallVariantDef { name: method.sig.ident.clone(), weight, args, docs });
 			} else {
@@ -234,7 +235,7 @@ impl CallDef {
 			instances,
 			methods,
 			where_clause: item.generics.where_clause.clone(),
-			docs: helper::get_doc_literals(&item.attrs),
+			docs: get_doc_literals(&item.attrs),
 		})
 	}
 }
@@ -17,6 +17,7 @@

 use super::helper;
 use core::convert::TryFrom;
+use frame_support_procedural_tools::get_doc_literals;
 use quote::ToTokens;
 use syn::spanned::Spanned;

@@ -69,7 +70,7 @@ impl TryFrom<&syn::TraitItemType> for ConstMetadataDef {
 		let err = |span, msg| {
 			syn::Error::new(span, format!("Invalid usage of `#[pallet::constant]`: {}", msg))
 		};
-		let doc = helper::get_doc_literals(&trait_ty.attrs);
+		let doc = get_doc_literals(&trait_ty.attrs);
 		let ident = trait_ty.ident.clone();
 		let bound = trait_ty
 			.bounds
@@ -16,6 +16,7 @@
 // limitations under the License.

 use super::helper;
+use frame_support_procedural_tools::get_doc_literals;
 use quote::ToTokens;
 use syn::spanned::Spanned;

@@ -80,7 +81,7 @@ impl ErrorDef {
 					return Err(syn::Error::new(span, msg))
 				}

-				Ok((variant.ident.clone(), helper::get_doc_literals(&variant.attrs)))
+				Ok((variant.ident.clone(), get_doc_literals(&variant.attrs)))
 			})
 			.collect::<Result<_, _>>()?;

@@ -16,13 +16,11 @@
 // limitations under the License.

 use super::helper;
-use frame_support_procedural_tools::clean_type_string;
 use quote::ToTokens;
 use syn::spanned::Spanned;

 /// List of additional token to be used for parsing.
 mod keyword {
-	syn::custom_keyword!(metadata);
 	syn::custom_keyword!(Event);
 	syn::custom_keyword!(pallet);
 	syn::custom_keyword!(generate_deposit);
@@ -35,60 +33,31 @@ pub struct EventDef {
 	pub index: usize,
 	/// The keyword Event used (contains span).
 	pub event: keyword::Event,
-	/// Event metadatas: `(name, args, docs)`.
-	pub metadata: Vec<(syn::Ident, Vec<String>, Vec<syn::Lit>)>,
 	/// A set of usage of instance, must be check for consistency with trait.
 	pub instances: Vec<helper::InstanceUsage>,
 	/// The kind of generic the type `Event` has.
 	pub gen_kind: super::GenericKind,
 	/// Whether the function `deposit_event` must be generated.
-	pub deposit_event: Option<(syn::Visibility, proc_macro2::Span)>,
+	pub deposit_event: Option<PalletEventDepositAttr>,
 	/// Where clause used in event definition.
 	pub where_clause: Option<syn::WhereClause>,
 	/// The span of the pallet::event attribute.
 	pub attr_span: proc_macro2::Span,
 }

-/// Attribute for Event: defines metadata name to use.
+/// Attribute for a pallet's Event.
 ///
 /// Syntax is:
-/// * `#[pallet::metadata(SomeType = MetadataName, ...)]`
 /// * `#[pallet::generate_deposit($vis fn deposit_event)]`
-enum PalletEventAttr {
-	Metadata {
-		metadata: Vec<(syn::Type, String)>,
-		// Span of the attribute
-		span: proc_macro2::Span,
-	},
-	DepositEvent {
-		fn_vis: syn::Visibility,
-		// Span for the keyword deposit_event
-		fn_span: proc_macro2::Span,
-		// Span of the attribute
-		span: proc_macro2::Span,
-	},
+pub struct PalletEventDepositAttr {
+	pub fn_vis: syn::Visibility,
+	// Span for the keyword deposit_event
+	pub fn_span: proc_macro2::Span,
+	// Span of the attribute
+	pub span: proc_macro2::Span,
 }

-impl PalletEventAttr {
-	fn span(&self) -> proc_macro2::Span {
-		match self {
-			Self::Metadata { span, .. } => *span,
-			Self::DepositEvent { span, .. } => *span,
-		}
-	}
-}
-
-/// Parse for syntax `$Type = "$SomeString"`.
-fn parse_event_metadata_element(
-	input: syn::parse::ParseStream,
-) -> syn::Result<(syn::Type, String)> {
-	let typ = input.parse::<syn::Type>()?;
-	input.parse::<syn::Token![=]>()?;
-	let ident = input.parse::<syn::LitStr>()?;
-	Ok((typ, ident.value()))
-}
-
-impl syn::parse::Parse for PalletEventAttr {
+impl syn::parse::Parse for PalletEventDepositAttr {
 	fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
 		input.parse::<syn::Token![#]>()?;
 		let content;
@@ -96,56 +65,33 @@ impl syn::parse::Parse for PalletEventAttr {
 		content.parse::<keyword::pallet>()?;
 		content.parse::<syn::Token![::]>()?;

-		let lookahead = content.lookahead1();
-		if lookahead.peek(keyword::metadata) {
-			let span = content.parse::<keyword::metadata>()?.span();
-			let metadata_content;
-			syn::parenthesized!(metadata_content in content);
+		let span = content.parse::<keyword::generate_deposit>()?.span();
+		let generate_content;
+		syn::parenthesized!(generate_content in content);
+		let fn_vis = generate_content.parse::<syn::Visibility>()?;
+		generate_content.parse::<syn::Token![fn]>()?;
+		let fn_span = generate_content.parse::<keyword::deposit_event>()?.span();

-			let metadata = metadata_content
-				.parse_terminated::<_, syn::Token![,]>(parse_event_metadata_element)?
-				.into_pairs()
-				.map(syn::punctuated::Pair::into_value)
-				.collect();
-
-			Ok(PalletEventAttr::Metadata { metadata, span })
-		} else if lookahead.peek(keyword::generate_deposit) {
-			let span = content.parse::<keyword::generate_deposit>()?.span();
-
-			let generate_content;
-			syn::parenthesized!(generate_content in content);
-			let fn_vis = generate_content.parse::<syn::Visibility>()?;
-			generate_content.parse::<syn::Token![fn]>()?;
-			let fn_span = generate_content.parse::<keyword::deposit_event>()?.span();
-
-			Ok(PalletEventAttr::DepositEvent { fn_vis, span, fn_span })
-		} else {
-			Err(lookahead.error())
-		}
+		Ok(PalletEventDepositAttr { fn_vis, span, fn_span })
 	}
 }

 struct PalletEventAttrInfo {
-	metadata: Option<Vec<(syn::Type, String)>>,
-	deposit_event: Option<(syn::Visibility, proc_macro2::Span)>,
+	deposit_event: Option<PalletEventDepositAttr>,
 }

 impl PalletEventAttrInfo {
-	fn from_attrs(attrs: Vec<PalletEventAttr>) -> syn::Result<Self> {
-		let mut metadata = None;
+	fn from_attrs(attrs: Vec<PalletEventDepositAttr>) -> syn::Result<Self> {
 		let mut deposit_event = None;
 		for attr in attrs {
-			match attr {
-				PalletEventAttr::Metadata { metadata: m, .. } if metadata.is_none() =>
-					metadata = Some(m),
-				PalletEventAttr::DepositEvent { fn_vis, fn_span, .. }
-					if deposit_event.is_none() =>
-					deposit_event = Some((fn_vis, fn_span)),
-				attr => return Err(syn::Error::new(attr.span(), "Duplicate attribute")),
+			if deposit_event.is_none() {
+				deposit_event = Some(attr)
+			} else {
+				return Err(syn::Error::new(attr.span, "Duplicate attribute"))
 			}
 		}

-		Ok(PalletEventAttrInfo { metadata, deposit_event })
+		Ok(PalletEventAttrInfo { deposit_event })
 	}
 }

@@ -161,9 +107,9 @@ impl EventDef {
 			return Err(syn::Error::new(item.span(), "Invalid pallet::event, expected item enum"))
 		};

-		let event_attrs: Vec<PalletEventAttr> = helper::take_item_pallet_attrs(&mut item.attrs)?;
+		let event_attrs: Vec<PalletEventDepositAttr> =
+			helper::take_item_pallet_attrs(&mut item.attrs)?;
 		let attr_info = PalletEventAttrInfo::from_attrs(event_attrs)?;
-		let metadata = attr_info.metadata.unwrap_or_else(Vec::new);
 		let deposit_event = attr_info.deposit_event;

 		if !matches!(item.vis, syn::Visibility::Public(_)) {
@@ -190,39 +136,6 @@ impl EventDef {

 		let event = syn::parse2::<keyword::Event>(item.ident.to_token_stream())?;

-		let metadata = item
-			.variants
-			.iter()
-			.map(|variant| {
-				let name = variant.ident.clone();
-				let docs = helper::get_doc_literals(&variant.attrs);
-				let args = variant
-					.fields
-					.iter()
-					.map(|field| {
-						metadata
-							.iter()
-							.find(|m| m.0 == field.ty)
-							.map(|m| m.1.clone())
-							.unwrap_or_else(|| {
-								clean_type_string(&field.ty.to_token_stream().to_string())
-							})
-					})
-					.collect();
-
-				(name, args, docs)
-			})
-			.collect();
-
-		Ok(EventDef {
-			attr_span,
-			index,
-			metadata,
-			instances,
-			deposit_event,
-			event,
-			gen_kind,
-			where_clause,
-		})
+		Ok(EventDef { attr_span, index, instances, deposit_event, event, gen_kind, where_clause })
 	}
 }
@@ -16,6 +16,7 @@
 // limitations under the License.

 use super::helper;
+use frame_support_procedural_tools::get_doc_literals;
 use syn::spanned::Spanned;

 /// List of additional token to be used for parsing.
@@ -104,7 +105,7 @@ impl ExtraConstantsDef {
 			extra_constants.push(ExtraConstantDef {
 				ident: method.sig.ident.clone(),
 				type_,
-				doc: helper::get_doc_literals(&method.attrs),
+				doc: get_doc_literals(&method.attrs),
 			});
 		}

@@ -139,24 +139,6 @@ impl MutItemAttrs for syn::ItemMod {
 	}
 }

-/// Return all doc attributes literals found.
-pub fn get_doc_literals(attrs: &Vec<syn::Attribute>) -> Vec<syn::Lit> {
-	attrs
-		.iter()
-		.filter_map(|attr| {
-			if let Ok(syn::Meta::NameValue(meta)) = attr.parse_meta() {
-				if meta.path.get_ident().map_or(false, |ident| ident == "doc") {
-					Some(meta.lit)
-				} else {
-					None
-				}
-			} else {
-				None
-			}
-		})
-		.collect()
-}
-
 /// Parse for `()`
 struct Unit;
 impl syn::parse::Parse for Unit {
@@ -16,6 +16,7 @@
 // limitations under the License.

 use super::helper;
+use frame_support_procedural_tools::get_doc_literals;
 use quote::ToTokens;
 use std::collections::HashMap;
 use syn::spanned::Spanned;
@@ -609,7 +610,7 @@ impl StorageDef {
 		instances.push(helper::check_type_def_gen(&item.generics, item.ident.span())?);

 		let where_clause = item.generics.where_clause.clone();
-		let docs = helper::get_doc_literals(&item.attrs);
+		let docs = get_doc_literals(&item.attrs);

 		let typ = if let syn::Type::Path(typ) = &*item.ty {
 			typ