[move] Small lint cleanups #18878
Merged
[move] Small lint cleanups #18878
Conversation
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
|
@tnowacki is attempting to deploy a commit to the Mysten Labs Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
cgswords
reviewed
Aug 1, 2024
| } | ||
| fn is_freeze_function(fun: &T::ModuleCall) -> bool { | ||
| FREEZE_FUNCTIONS.iter().any(|(addr, module, fname)| { | ||
| fun.module.value.is(*addr, *module) && &fun.name.value().as_str() == fname |
There was a problem hiding this comment.
Would it be cheaper to convert the names into symbols to avoid the as_str() check?
There was a problem hiding this comment.
Maybe, but a lot of these aren't static symbols already, so not sure it would be worth it 🤷
cgswords
reviewed
Aug 1, 2024
external-crates/move/crates/move-compiler/src/sui_mode/linters/freezing_capability.rs
Outdated
Show resolved
Hide resolved
cgswords
reviewed
Aug 1, 2024
| } | ||
|
|
||
| static REGEX: Lazy<Regex> = | ||
| Lazy::new(|| Regex::new(r".*((Cap[A-Z0-9_]+)|Capability|(Cap$)).*").unwrap()); |
There was a problem hiding this comment.
Suggested change
| Lazy::new(|| Regex::new(r".*((Cap[A-Z0-9_]+)|Capability|(Cap$)).*").unwrap()); | |
| Lazy::new(|| Regex::new(r".*Cap(?:[A-Z0-9_]+|ability|$).*").unwrap()); |
Shorter but less clear Regex.
There was a problem hiding this comment.
Would it make sense to revise the regex as:
.*Cap(?:(?:v)[A-Z0-9_]+|ability|$).*
This would catch Capv0, etc, as well.
There was a problem hiding this comment.
I don't think I want to catch Capv0, since someone should write it as CapV0. In short, I'm trying to find word boundaries
cgswords
reviewed
Aug 1, 2024
Comment on lines
105
to
110
| let msg = format!( | ||
| "The type {} is potentially a capability based on its name. Freezing a capability might lock out critical operations or otherwise open access to operations that otherwise should be restricted.", | ||
| core::error_format_(type_arg, &core::Subst::empty()), | ||
| ); | ||
| let diag = diag!(FREEZE_CAPABILITY_DIAG, (loc, msg)); | ||
| context.env.add_diag(diag); |
There was a problem hiding this comment.
More recently I have been trying to follow Rust and split up longer message like this into a location message and a note, e.g., :
Suggested change
| let msg = format!( | |
| "The type {} is potentially a capability based on its name. Freezing a capability might lock out critical operations or otherwise open access to operations that otherwise should be restricted.", | |
| core::error_format_(type_arg, &core::Subst::empty()), | |
| ); | |
| let diag = diag!(FREEZE_CAPABILITY_DIAG, (loc, msg)); | |
| context.env.add_diag(diag); | |
| let msg = format!( | |
| "The type {} is potentially a capability based on its name", | |
| core::error_format_(type_arg, &core::Subst::empty()), | |
| ); | |
| let mut diag = diag!(FREEZE_CAPABILITY_DIAG, (loc, msg)); | |
| diag.add_note("Freezing a capability might lock out critical operations or otherwise open access to operations that otherwise should be restricted"); | |
| context.env.add_diag(diag); |
There was a problem hiding this comment.
Maybe. Keep in mind though the note might not be rendered in the IDE easily
cgswords
approved these changes
Aug 1, 2024
tx-tomcat
pushed a commit
to tx-tomcat/sui-network
that referenced
this pull request
Aug 27, 2024
## Description - Small changes/rewording to lints - Improved capability freezing lint - Fixed VISIT_TYPES ## Test plan - Updated tests --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
suiwombat
pushed a commit
that referenced
this pull request
Sep 16, 2024
## Description - Small changes/rewording to lints - Improved capability freezing lint - Fixed VISIT_TYPES ## Test plan - Updated tests --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Test plan
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.