give old list of abilities

MystenLabs · Nov 20, 2024 · de081ab · de081ab
1 parent a5ef0a2
commit de081ab
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 20 deletions.
diff --git a/...it_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__all_fail.snap b/...it_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__all_fail.snap
@@ -27,7 +27,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^^^^^^ Unexpected ability: 'copy'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'StructAbilityMismatchAdd': none.
+   = Restore the original abilities of the struct: none for struct 'StructAbilityMismatchAdd'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:14:19
@@ -36,7 +36,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing ability: 'copy'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'StructAbilityMismatchRemove': 'copy'.
+   = Restore the original ability of the struct: 'copy' for struct 'StructAbilityMismatchRemove'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:17:19
@@ -45,7 +45,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Mismatched abilities: missing 'copy', unexpected 'drop'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'StructAbilityMismatchChange': 'copy'.
+   = Restore the original ability of the struct: 'copy' for struct 'StructAbilityMismatchChange'.
 
 error[Compatibility E01005]: type parameter mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:20:19
@@ -93,7 +93,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^ Unexpected ability: 'copy'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumAbilityMismatchAdd': none.
+   = Restore the original abilities of the enum: none for enum 'EnumAbilityMismatchAdd'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:50:17
@@ -102,7 +102,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^^^^ Missing ability: 'copy'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumAbilityMismatchRemove': 'copy'.
+   = Restore the original ability of the enum: 'copy' for enum 'EnumAbilityMismatchRemove'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:55:17
@@ -111,7 +111,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^^^^ Mismatched abilities: missing 'copy', unexpected 'drop'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumAbilityMismatchChange': 'copy'.
+   = Restore the original ability of the enum: 'copy' for enum 'EnumAbilityMismatchChange'.
 
 error[Compatibility E02001]: variant mismatch
    ┌─ /fixtures/upgrade_errors/all_v2/sources/UpgradeErrors.move:64:9

diff --git a/...c/unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__enum.snap b/...c/unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__enum.snap
@@ -9,7 +9,7 @@ error[Compatibility E01003]: ability mismatch
   │                 ^^^^^^^^^^^^^^ Unexpected ability: 'drop'
   │
   = Enums are part of a module's public interface and cannot be changed during an upgrade.
-  = Restore the original enum's abilities for enum 'EnumAddAbility': 'copy'.
+  = Restore the original ability of the enum: 'copy' for enum 'EnumAddAbility'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/enum_errors_v2/sources/UpgradeErrors.move:13:17
@@ -18,7 +18,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^ Missing ability: 'drop'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumRemoveAbility': 'copy' and 'drop'.
+   = Restore the original abilities of the enum: 'copy' and 'drop' for enum 'EnumRemoveAbility'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/enum_errors_v2/sources/UpgradeErrors.move:17:17
@@ -27,7 +27,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^^ Mismatched abilities: missing 'drop', unexpected 'store'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumAddAndRemoveAbility': 'copy' and 'drop'.
+   = Restore the original abilities of the enum: 'copy' and 'drop' for enum 'EnumAddAndRemoveAbility'.
 
 error[Compatibility E02001]: variant mismatch
    ┌─ /fixtures/upgrade_errors/enum_errors_v2/sources/UpgradeErrors.move:23:9
@@ -126,7 +126,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^^ Unexpected ability: 'drop'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumAddAbilityWithTypes': 'copy'.
+   = Restore the original ability of the enum: 'copy' for enum 'EnumAddAbilityWithTypes'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/enum_errors_v2/sources/UpgradeErrors.move:53:17
@@ -135,7 +135,7 @@ error[Compatibility E01003]: ability mismatch
    │                 ^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing ability: 'drop'
    │
    = Enums are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original enum's abilities for enum 'EnumRemoveAbilityWithTypes': 'copy' and 'drop'.
+   = Restore the original abilities of the enum: 'copy' and 'drop' for enum 'EnumRemoveAbilityWithTypes'.
 
 error[Compatibility E02001]: variant mismatch
    ┌─ /fixtures/upgrade_errors/enum_errors_v2/sources/UpgradeErrors.move:59:9

diff --git a/...unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__struct.snap b/...unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__struct.snap
@@ -9,7 +9,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^ Unexpected ability: 'copy'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'AddExtraAbility': none.
+   = Restore the original abilities of the struct: none for struct 'AddExtraAbility'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/struct_errors_v2/sources/UpgradeErrors.move:11:19
@@ -18,7 +18,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^ Missing ability: 'copy'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'RemoveAbility': 'copy' and 'drop'.
+   = Restore the original abilities of the struct: 'copy' and 'drop' for struct 'RemoveAbility'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/struct_errors_v2/sources/UpgradeErrors.move:12:19
@@ -27,7 +27,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^ Mismatched abilities: missing 'copy', unexpected 'store'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'AddAndRemoveAbility': 'copy' and 'drop'.
+   = Restore the original abilities of the struct: 'copy' and 'drop' for struct 'AddAndRemoveAbility'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/struct_errors_v2/sources/UpgradeErrors.move:13:19
@@ -36,7 +36,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^^^^^ Missing abilities: 'copy' and 'store'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'RemoveMultipleAbilities': 'copy', 'drop', and 'store'.
+   = Restore the original abilities of the struct: 'copy', 'drop', and 'store' for struct 'RemoveMultipleAbilities'.
 
 error[Compatibility E01003]: ability mismatch
    ┌─ /fixtures/upgrade_errors/struct_errors_v2/sources/UpgradeErrors.move:14:19
@@ -45,7 +45,7 @@ error[Compatibility E01003]: ability mismatch
    │                   ^^^^^^^^^^^^^^^^^^^^ Unexpected abilities: 'copy' and 'drop'
    │
    = Structs are part of a module's public interface and cannot be changed during an upgrade.
-   = Restore the original struct's abilities for struct 'AddMultipleAbilities': none.
+   = Restore the original abilities of the struct: none for struct 'AddMultipleAbilities'.
 
 error[Compatibility E01002]: type mismatch
    ┌─ /fixtures/upgrade_errors/struct_errors_v2/sources/UpgradeErrors.move:17:19

diff --git a/crates/sui/src/upgrade_compatibility.rs b/crates/sui/src/upgrade_compatibility.rs
@@ -1233,6 +1233,12 @@ fn struct_ability_mismatch_diag(
     let def_loc = struct_sourcemap.definition_location;
 
     if old_struct.abilities != new_struct.abilities {
+        let old_abilities: Vec<String> = old_struct
+            .abilities
+            .into_iter()
+            .map(|a| format!("'{:?}'", a).to_lowercase())
+            .collect();
+
         diags.add(Diagnostic::new(
             Declarations::AbilityMismatch,
             (
@@ -1245,8 +1251,9 @@ fn struct_ability_mismatch_diag(
                 cannot be changed during an upgrade."
                     .to_string(),
                 format!(
-                    "Restore the original struct's abilities \
-                    for struct '{struct_name}': {}.",
+                    "Restore the original {} of the struct: {} \
+                    for struct '{struct_name}'.",
+                    singular_or_plural(old_abilities.len(), "ability", "abilities"),
                     format_list(
                         old_struct
                             .abilities
@@ -1428,6 +1435,12 @@ fn enum_ability_mismatch_diag(
     let def_loc = enum_sourcemap.definition_location;
 
     if old_enum.abilities != new_enum.abilities {
+        let old_abilities: Vec<String> = old_enum
+            .abilities
+            .into_iter()
+            .map(|a| format!("'{:?}'", a).to_lowercase())
+            .collect();
+
         diags.add(Diagnostic::new(
             Declarations::AbilityMismatch,
             (
@@ -1440,8 +1453,9 @@ fn enum_ability_mismatch_diag(
                 and cannot be changed during an upgrade."
                     .to_string(),
                 format!(
-                    "Restore the original enum's abilities \
-                    for enum '{enum_name}': {}.",
+                    "Restore the original {} of the enum: {} \
+                    for enum '{enum_name}'.",
+                    singular_or_plural(old_abilities.len(), "ability", "abilities"),
                     format_list(
                         old_enum
                             .abilities