-
Notifications
You must be signed in to change notification settings - Fork 739
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
[FRAME] Warn on unchecked weight witness #1818
Merged
Merged
Changes from 19 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
56f0cbc
Warn on unchecked weight witness
ggwpez 03f8669
Remove stupid folder
ggwpez ca3e754
Use key limit in kill_prefix
ggwpez f3562fb
Put into own file
ggwpez 52ef342
Use new help link
ggwpez 7ae121c
Typo
ggwpez d7ae3e1
Ignore in dev-mode
ggwpez 2a6f572
Ignore in root calls
ggwpez 9c96883
Fix HRMP pallet
ggwpez f6415d9
Put pallet-root-testing into dev-mode
ggwpez 19f7a12
Fix other tests
ggwpez bc8c5ce
Add prdoc
ggwpez 8a075d3
Add minor bump to prdoc
ggwpez dee51fd
Update substrate/frame/sudo/src/lib.rs
ggwpez c4059c5
Dont use VisitMut
ggwpez e0b5aa5
Add pallet-ui test
ggwpez d2f893a
Prevent font-run in clean_defunct_voters
ggwpez 8ff36d3
Compile
ggwpez 359b199
Merge branch 'master' into oty-unchecked-weight-witness
kianenigma 7ce1019
Fix bench
ggwpez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
title: FRAME pallets warning for unchecked weight witness | ||
|
||
doc: | ||
- audience: Core Dev | ||
description: | | ||
FRAME pallets now emit a warning when a call uses a function argument that starts with an underscore in its weight declaration. | ||
|
||
migrations: | ||
db: [ ] | ||
runtime: [ ] | ||
|
||
host_functions: [] | ||
|
||
crates: | ||
- name: "frame-support-procedural" | ||
semver: minor | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
substrate/frame/support/procedural/src/pallet/expand/warnings.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
// This file is part of Substrate. | ||
|
||
// Copyright (C) Parity Technologies (UK) Ltd. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
//! Generates warnings for undesirable pallet code. | ||
|
||
use crate::pallet::parse::call::{CallVariantDef, CallWeightDef}; | ||
use proc_macro_warning::Warning; | ||
use syn::{ | ||
spanned::Spanned, | ||
visit::{self, Visit}, | ||
}; | ||
|
||
/// Warn if any of the call arguments starts with a underscore and is used in a weight formula. | ||
pub(crate) fn weight_witness_warning( | ||
method: &CallVariantDef, | ||
dev_mode: bool, | ||
warnings: &mut Vec<Warning>, | ||
) { | ||
if dev_mode { | ||
return | ||
} | ||
let CallWeightDef::Immediate(w) = &method.weight else { | ||
return; | ||
}; | ||
|
||
let partial_warning = Warning::new_deprecated("UncheckedWeightWitness") | ||
.old("not check weight witness data") | ||
ggwpez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
.new("ensure that all witness data for weight calculation is checked before usage") | ||
.help_link("https://github.com/paritytech/polkadot-sdk/pull/1818"); | ||
|
||
for (_, arg_ident, _) in method.args.iter() { | ||
if !arg_ident.to_string().starts_with('_') || !contains_ident(w.clone(), &arg_ident) { | ||
continue | ||
} | ||
|
||
let warning = partial_warning | ||
.clone() | ||
.index(warnings.len()) | ||
.span(arg_ident.span()) | ||
.build_or_panic(); | ||
|
||
warnings.push(warning); | ||
} | ||
} | ||
|
||
/// Warn if the weight is a constant and the pallet not in `dev_mode`. | ||
pub(crate) fn weight_constant_warning( | ||
weight: &syn::Expr, | ||
dev_mode: bool, | ||
warnings: &mut Vec<Warning>, | ||
) { | ||
if dev_mode { | ||
return | ||
} | ||
let syn::Expr::Lit(lit) = weight else { | ||
return; | ||
}; | ||
|
||
let warning = Warning::new_deprecated("ConstantWeight") | ||
.index(warnings.len()) | ||
.old("use hard-coded constant as call weight") | ||
.new("benchmark all calls or put the pallet into `dev` mode") | ||
.help_link("https://github.com/paritytech/substrate/pull/13798") | ||
.span(lit.span()) | ||
.build_or_panic(); | ||
|
||
warnings.push(warning); | ||
} | ||
|
||
/// Returns whether `expr` contains `ident`. | ||
fn contains_ident(mut expr: syn::Expr, ident: &syn::Ident) -> bool { | ||
struct ContainsIdent { | ||
ident: syn::Ident, | ||
found: bool, | ||
} | ||
|
||
impl<'a> Visit<'a> for ContainsIdent { | ||
fn visit_ident(&mut self, i: &syn::Ident) { | ||
if *i == self.ident { | ||
self.found = true; | ||
} | ||
} | ||
} | ||
|
||
let mut visitor = ContainsIdent { ident: ident.clone(), found: false }; | ||
visit::visit_expr(&mut visitor, &mut expr); | ||
visitor.found | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is still the default schema?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, i used the
prdoc schema
andprdoc check
.