ink_analyzer/analysis/migrate.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
//! ink! 5.0 migration.
mod common;
mod e2e_test;
mod host_fn;
mod traversal;
use ink_analyzer_ir::ast::HasName;
use ink_analyzer_ir::syntax::{AstNode, AstToken, SyntaxKind, SyntaxToken, TextRange, TextSize};
use ink_analyzer_ir::{ast, ChainExtension, InkArg, InkArgKind, InkEntity, InkFile, IsInkStruct};
use itertools::Itertools;
use std::collections::HashMap;
use super::{utils, TextEdit};
use crate::analysis::text_edit::format_edits;
use crate::resolution;
/// Computes text edits for migrating an ink! file to ink! 5.0.
pub fn migrate(file: &InkFile) -> Vec<TextEdit> {
let mut results = Vec::new();
// Migrate events.
events(&mut results, file);
// Migrate chain extensions.
chain_extensions(&mut results, file);
// Migrate built-in `derive`s of SCALE codec traits.
scale_derive(&mut results, file);
// Migrate cross-contract host function related APIs.
host_fn::migrate(&mut results, file);
// Migrate e2e tests.
e2e_test::migrate(&mut results, file);
// Format and return edits.
format_edits(results.into_iter().unique(), file).collect()
}
/// Computes text edits for migrating ink! events to ink! 5.0 standalone events (a.k.a events 2.0).
fn events(results: &mut Vec<TextEdit>, file: &InkFile) {
for contract in file.contracts() {
let contract_indent = utils::item_indenting(contract.syntax());
let use_insert_offset = contract
.module()
.and_then(ast::Module::item_list)
.map(|item_list| utils::item_insert_offset_start(&item_list));
// Replace legacy events with 2.0 events.
for event in contract.events() {
if let Some(ink_attr) = event.ink_attr() {
// Replace legacy event with event 2.0.
let mut code = event.syntax().to_string();
code = code.replace(
&ink_attr.syntax().to_string(),
&format!(
"#[ink::event{}]",
if event.anonymous_arg().is_some() {
"(anonymous)"
} else {
""
}
),
);
// Remove standalone `anonymous` attribute (if any).
if let Some(arg) = event.anonymous_arg() {
if !ink_attr
.syntax()
.text_range()
.contains_range(arg.text_range())
{
if let Some(anonymous_attr) = arg.parent_attr() {
code = code.replace(&anonymous_attr.syntax().to_string(), "");
}
}
}
// Update indenting.
if let Some(indent) = utils::item_indenting(event.syntax()) {
code = utils::reduce_indenting(&code, &indent);
}
if let Some(indent) = contract_indent.as_ref() {
code = utils::apply_indenting(&code, indent);
}
// Insert event 2.0 before contract.
results.push(TextEdit::insert(
code,
contract.syntax().text_range().start(),
));
// Add event 2.0 import.
let event_name = event.struct_item().and_then(ast::Struct::name);
if let Some((use_insert_offset, event_name)) = use_insert_offset.zip(event_name) {
results.push(TextEdit::insert(
format!("use super::{event_name};"),
use_insert_offset,
));
}
// Remove legacy event.
results.push(TextEdit::delete(event.syntax().text_range()));
}
}
}
}
/// Computes text edits for migrating ink! chain extension to ink! 5.0.
fn chain_extensions(results: &mut Vec<TextEdit>, file: &InkFile) {
let mut unavailable_ids = file
.chain_extensions()
.iter()
.filter_map(ChainExtension::id)
.collect();
for chain_extension in file.chain_extensions() {
// Add `extension` arg to `chain_extension` attribute macro, if it's missing.
if chain_extension.extension_arg().is_none() {
if let Some(ink_attr) = chain_extension.ink_attr() {
if let Some((insert_offset, insert_prefix, insert_suffix)) =
utils::ink_arg_insert_offset_and_affixes(ink_attr, Some(InkArgKind::Extension))
{
let id = utils::suggest_unique_id(None, &unavailable_ids).unwrap_or(1);
unavailable_ids.insert(id);
results.push(TextEdit::insert(
format!(
"{}extension = {id}{}",
insert_prefix.unwrap_or_default(),
insert_suffix.unwrap_or_default()
),
insert_offset,
));
}
}
}
// Rename `extension` args on associated `fn`s to `function`.
for extension in chain_extension.extensions() {
if let Some(arg_name) = extension.extension_arg().as_ref().and_then(InkArg::name) {
results.push(TextEdit::replace(
"function".to_owned(),
arg_name.syntax().text_range(),
));
}
}
}
}
/// Computes text edits for migrating built-in `derive`s of SCALE codec traits to ink! 5.0 `scale_derive` macro.
fn scale_derive(results: &mut Vec<TextEdit>, file: &InkFile) {
// Mapping from target item (via location/start offset) to scale traits to derive and their insert offset.
// Used to consolidate scale item traits from multiple attributes into a single new `scale_derive` attribute.
let mut scale_items_map: HashMap<TextSize, (TextSize, Vec<InkArgKind>)> = HashMap::new();
let scale_trait_options: [(&str, &[&str], InkArgKind); 3] = [
("Encode", &resolution::SCALE_QUALIFIERS, InkArgKind::Encode),
("Decode", &resolution::SCALE_QUALIFIERS, InkArgKind::Decode),
(
"TypeInfo",
&resolution::SCALE_INFO_QUALIFIERS,
InkArgKind::TypeInfo,
),
];
for attr in file.syntax().descendants().filter_map(ast::Attr::cast) {
let is_standalone_derive = attr
.path()
.is_some_and(|path| path.to_string().trim() == "derive");
let is_cfg_attr = !is_standalone_derive
&& attr
.path()
.is_some_and(|path| path.to_string().trim() == "cfg_attr");
// Extracts derive token tree (if any).
let derive_meta = if is_standalone_derive {
attr.token_tree()
} else if is_cfg_attr {
attr.token_tree().and_then(|token_tree| {
token_tree.syntax().children().find_map(|node| {
let is_after_derive = || {
node.first_token()
.and_then(|token| {
ink_analyzer_ir::closest_non_trivia_token(
&token,
SyntaxToken::prev_token,
)
})
.is_some_and(|token| token.text() == "derive")
};
if ast::TokenTree::can_cast(node.kind()) && is_after_derive() {
ast::TokenTree::cast(node)
} else {
None
}
})
})
} else {
None
};
if let Some(derive_meta) = derive_meta {
let mut scale_items = Vec::new();
let mut non_scale_items = Vec::new();
for name in utils::token_tree_to_non_delimited_meta_string(&derive_meta)
.replace(' ', "")
.split(',')
{
if let Some(path) = ink_analyzer_ir::path_from_str(name) {
let ref_node = attr
.syntax()
.parent()
.unwrap_or_else(|| file.syntax().clone());
let scale_arg_kind = scale_trait_options.iter().find_map(
|(trait_name, qualifiers, arg_kind)| {
resolution::is_external_crate_item(
trait_name, &path, qualifiers, &ref_node,
)
.then_some(arg_kind)
},
);
if let Some(scale_arg_kind) = scale_arg_kind {
scale_items.push(*scale_arg_kind);
} else {
non_scale_items.push(name.to_owned());
}
} else {
non_scale_items.push(name.to_owned());
}
}
// Refactors SCALE codec trait derives.
if !scale_items.is_empty() {
// Track SCALE code traits to migrate by target item or insert offset.
let attr_start = attr.syntax().text_range().start();
let parent_or_attr_start = ink_analyzer_ir::parent_ast_item(attr.syntax())
.map(|parent| parent.syntax().text_range().start())
.unwrap_or(attr_start);
if let Some((_, items)) = scale_items_map.get_mut(&parent_or_attr_start) {
items.extend(scale_items);
} else {
scale_items_map.insert(parent_or_attr_start, (attr_start, scale_items));
}
// Modifies attribute to remove SCALE codec trait derives (if any).
if non_scale_items.is_empty() {
if is_standalone_derive {
// Removes `derive` attribute if it only includes SCALE codec trait derives.
results.push(TextEdit::delete(attr.syntax().text_range()));
} else {
// Finds derive token.
let derive_token = derive_meta
.syntax()
.first_token()
.and_then(|token| {
ink_analyzer_ir::closest_non_trivia_token(
&token,
SyntaxToken::prev_token,
)
})
.filter(|token| token.text() == "derive")
.expect("Expected a `derive` token before the token tree");
let derive_start = derive_token.text_range().start();
// Determines if `cfg_attr` has other attributes apart from the `derive` attribute.
let has_other_attrs = attr.token_tree().is_some_and(|cfg_attr_meta| {
let mut has_seen_comma = false;
let r_paren_option = cfg_attr_meta.r_paren_token();
cfg_attr_meta
.syntax()
.children_with_tokens()
.skip_while(|it| {
let skip_current = !has_seen_comma;
if !has_seen_comma && it.kind() == SyntaxKind::COMMA {
has_seen_comma = true;
}
skip_current
})
.take_while(|it| {
r_paren_option.is_none()
|| it.as_token() != r_paren_option.as_ref()
})
.any(|elem| {
!elem.kind().is_trivia()
&& (elem.text_range().start() < derive_start
|| derive_meta.syntax().text_range().end()
< elem.text_range().end())
})
});
if has_other_attrs {
// Removes `derive` attr if it only contains SCALE codec trait derives
// but the `cfg_attr` attribute contains other attributes.
let derive_end = derive_meta.syntax().text_range().end();
let delimiter_after = utils::node_and_delimiter_range(
derive_meta.syntax(),
SyntaxKind::COMMA,
);
// Determines delete range (including the delimiter if present).
let range = if delimiter_after.end() == derive_end {
let delimiter_before = utils::token_and_delimiter_range(
&derive_token,
SyntaxKind::COMMA,
);
TextRange::new(delimiter_before.start(), derive_end)
} else {
TextRange::new(derive_start, delimiter_after.end())
};
results.push(TextEdit::delete(range));
} else {
// Removes `cfg_attr` attribute if it only contains a `derive` attr with
// only SCALE codec trait derives.
results.push(TextEdit::delete(attr.syntax().text_range()));
}
}
} else {
// Updates derive meta.
results.push(TextEdit::replace(
format!("({})", non_scale_items.join(", ")),
derive_meta.syntax().text_range(),
));
}
}
}
}
// Add `ink::scale_derive` attributes.
for (insert_offset, scale_items) in scale_items_map.values() {
results.push(TextEdit::insert(
format!("#[ink::scale_derive({})]", scale_items.iter().join(", ")),
*insert_offset,
));
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_utils::text_edits_from_fixtures;
use quote::quote;
use test_utils::quote_as_pretty_string;
#[test]
fn events_works() {
for (code, expected_results) in [
(
quote! {
#[ink(event)]
pub struct MyEvent {}
},
vec![
(
"#[ink::event]\npub struct MyEvent {}",
Some("<-#[ink::contract]"),
Some("<-#[ink::contract]"),
),
(
"use super::MyEvent;",
Some("mod my_contract {"),
Some("mod my_contract {"),
),
("", Some("<-#[ink(event)]"), Some("pub struct MyEvent {}")),
],
),
(
quote! {
#[ink(event, anonymous)]
pub struct MyEvent {}
},
vec![
(
"#[ink::event(anonymous)]\npub struct MyEvent {}",
Some("<-#[ink::contract]"),
Some("<-#[ink::contract]"),
),
(
"use super::MyEvent;",
Some("mod my_contract {"),
Some("mod my_contract {"),
),
(
"",
Some("<-#[ink(event, anonymous)]"),
Some("pub struct MyEvent {}"),
),
],
),
(
quote! {
#[ink(event)]
#[ink(anonymous)]
pub struct MyEvent {}
},
vec![
(
"#[ink::event(anonymous)]\n\npub struct MyEvent {}",
Some("<-#[ink::contract]"),
Some("<-#[ink::contract]"),
),
(
"use super::MyEvent;",
Some("mod my_contract {"),
Some("mod my_contract {"),
),
("", Some("<-#[ink(event)]"), Some("pub struct MyEvent {}")),
],
),
(
quote! {
#[ink(event)]
pub struct MyEvent {}
#[ink(event, anonymous)]
pub struct MyEvent2 {}
},
vec![
(
"#[ink::event]\npub struct MyEvent {}",
Some("<-#[ink::contract]"),
Some("<-#[ink::contract]"),
),
(
"use super::MyEvent;",
Some("mod my_contract {"),
Some("mod my_contract {"),
),
("", Some("<-#[ink(event)]"), Some("pub struct MyEvent {}")),
(
"#[ink::event(anonymous)]\npub struct MyEvent2 {}",
Some("<-#[ink::contract]"),
Some("<-#[ink::contract]"),
),
(
"use super::MyEvent2;",
Some("mod my_contract {"),
Some("mod my_contract {"),
),
(
"",
Some("<-#[ink(event, anonymous)]"),
Some("pub struct MyEvent2 {}"),
),
],
),
] {
let code = quote_as_pretty_string! {
#[ink::contract]
mod my_contract {
#code
}
};
let mut results = Vec::new();
events(&mut results, &InkFile::parse(&code));
assert_eq!(results, text_edits_from_fixtures(&code, expected_results));
}
}
#[test]
fn chain_extensions_works() {
for (code, expected_results) in [
(
quote_as_pretty_string! {
#[ink::chain_extension]
pub trait MyChainExtension {
#[ink(extension = 1)]
fn my_extension();
#[ink(extension = 2, handle_status = false)]
fn my_extension2();
#[ink(extension = 3)]
#[ink(handle_status = false)]
fn my_extension3();
}
},
vec![
(
"(extension = 1)",
Some("#[ink::chain_extension"),
Some("#[ink::chain_extension"),
),
("function", Some("<-extension = 1"), Some("<- = 1")),
("function", Some("<-extension = 2"), Some("<- = 2")),
("function", Some("<-extension = 3"), Some("<- = 3")),
],
),
(
quote_as_pretty_string! {
#[ink::chain_extension]
pub trait MyChainExtension {
#[ink(extension = 1)]
fn my_extension();
}
#[ink::chain_extension]
pub trait MyOtherChainExtension {
#[ink(extension = 2)]
fn my_extension();
}
},
vec![
(
"(extension = 1)",
Some("#[ink::chain_extension"),
Some("#[ink::chain_extension"),
),
("function", Some("<-extension = 1"), Some("<- = 1")),
(
"(extension = 2)",
Some("#[ink::chain_extension->"),
Some("#[ink::chain_extension->"),
),
("function", Some("<-extension = 2"), Some("<- = 2")),
],
),
] {
let mut results = Vec::new();
chain_extensions(&mut results, &InkFile::parse(&code));
assert_eq!(results, text_edits_from_fixtures(&code, expected_results));
}
}
#[test]
fn scale_derive_works() {
for (code, expected_results) in [
(
quote_as_pretty_string! {
#[derive(scale::Encode, scale::Decode, scale_info::TypeInfo)]
pub struct MyType {}
},
vec![
(
"",
Some("<-#[derive(scale::Encode, scale::Decode, scale_info::TypeInfo)]"),
Some("#[derive(scale::Encode, scale::Decode, scale_info::TypeInfo)]"),
),
(
"#[ink::scale_derive(Encode, Decode, TypeInfo)]",
Some("<-#[derive(scale::Encode, scale::Decode, scale_info::TypeInfo)]"),
Some("<-#[derive(scale::Encode, scale::Decode, scale_info::TypeInfo)]"),
),
],
),
(
quote_as_pretty_string! {
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct MyType {}
},
vec![
(
"",
Some(r#"<-#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]"#),
Some(r#"#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]"#),
),
(
"#[ink::scale_derive(TypeInfo)]",
Some("<-#[cfg_attr("),
Some("<-#[cfg_attr("),
),
],
),
(
quote_as_pretty_string! {
#[derive(scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
pub struct MyType {}
},
vec![
(
"",
Some("<-#[derive(scale::Encode, scale::Decode)]"),
Some("#[derive(scale::Encode, scale::Decode)]"),
),
(
"",
Some(r#"<-#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]"#),
Some(r#"#[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]"#),
),
(
"#[ink::scale_derive(Encode, Decode, TypeInfo)]",
Some("<-#[derive(scale::Encode, scale::Decode)]"),
Some("<-#[derive(scale::Encode, scale::Decode)]"),
),
],
),
(
quote_as_pretty_string! {
#[derive(Clone, Copy, scale::Encode, scale::Decode, scale_info::TypeInfo)]
pub struct MyType {}
},
vec![
("(Clone, Copy)", Some("#[derive"), Some("<-]")),
(
"#[ink::scale_derive(Encode, Decode, TypeInfo)]",
Some("<-#[derive("),
Some("<-#[derive("),
),
],
),
(
quote_as_pretty_string! {
#[cfg_attr(feature = "std", derive(Clone, scale_info::TypeInfo), doc = "Hello")]
pub struct MyType {}
},
vec![
(
"(Clone)",
Some("<-(Clone, scale_info::TypeInfo)"),
Some("(Clone, scale_info::TypeInfo)"),
),
(
"#[ink::scale_derive(TypeInfo)]",
Some("<-#[cfg_attr("),
Some("<-#[cfg_attr("),
),
],
),
(
quote_as_pretty_string! {
#[cfg_attr(feature = "std", derive(scale_info::TypeInfo), doc = "Hello")]
pub struct MyType {}
},
vec![
(
"",
Some("<-derive(scale_info::TypeInfo)"),
Some("derive(scale_info::TypeInfo),"),
),
(
"#[ink::scale_derive(TypeInfo)]",
Some("<-#[cfg_attr("),
Some("<-#[cfg_attr("),
),
],
),
(
quote_as_pretty_string! {
#[derive(Clone, scale::Encode, scale::Decode)]
#[cfg_attr(feature = "std", derive(Copy, scale_info::TypeInfo), doc = "Hello")]
pub struct MyType {}
},
vec![
(
"(Clone)",
Some("#[derive"),
Some("#[derive(Clone, scale::Encode, scale::Decode)"),
),
(
"(Copy)",
Some("<-(Copy, scale_info::TypeInfo)"),
Some("(Copy, scale_info::TypeInfo)"),
),
(
"#[ink::scale_derive(Encode, Decode, TypeInfo)]",
Some("<-#[derive(Clone, scale::Encode, scale::Decode)]"),
Some("<-#[derive(Clone, scale::Encode, scale::Decode)]"),
),
],
),
] {
let mut results = Vec::new();
scale_derive(&mut results, &InkFile::parse(&code));
assert_eq!(results, text_edits_from_fixtures(&code, expected_results));
}
}
}