Upgrade errors type params, enable upgrade errors #20321
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
jordanjennings-mysten
requested review from
amnn,
tnowacki and
stefan-mysten
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
amnn
reviewed
Nov 19, 2024
There was a problem hiding this comment.
This is shaping up very nicely, thanks @jordanjennings-mysten. Two main groups of comments:
- About formatting/wording -- here @tnowacki / @tzakian / @cgswords will probably have more insights because they are more familiar with how the compiler outputs error messages, but the main thing I wanted to flag is that the last diagnostic (the one that explains how to fix the issue) could really benefit from including a full example of what the compatibility check expected (i.e. not the delta, but here's the thing you should put back into the package). In some cases (like type and function parameters) this is not possible because we don't have parameter names from the bytecode version, but everywhere else, it should be.
- About enabling this forever -- some comments about making that more robust and giving people a way out.
- Testing -- we should add some tests for positional structs and enums, and structs/enums without any fields, because they will end up with generated fields and field names that we want to detect and eliminate from the output where possible.
.../unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__all_fail.snap
Outdated
Show resolved
Hide resolved
.../unit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__all_fail.snap
Outdated
Show resolved
Hide resolved
| │ ^^^^^^^^^^^^^^^^^^^^^^^^ Unexpected abilities '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'. |
There was a problem hiding this comment.
This message would be more useful if it mentioned what the abilities should be (i.e. not as a delta, but the original list of abilities).
There was a problem hiding this comment.
= Restore the original struct's abilities [have original list somehow (move snippet?)] for struct 'StructAbilityMismatchAdd'.
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
I'll pull this out into a separate PR so we can independently decide on it. I have a bit of |
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
| @@ -15,6 +15,7 @@ pub mod key_identity; | |||
| pub mod keytool; | |||
| pub mod shell; | |||
| pub mod sui_commands; | |||
| mod upgrade_compatibility; | |||
There was a problem hiding this comment.
TODO remove before merge
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
tnowacki
reviewed
Nov 21, 2024
...nit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__type_param.snap
Outdated
Show resolved
Hide resolved
...nit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__type_param.snap
Outdated
Show resolved
Hide resolved
...nit_tests/snapshots/sui__upgrade_compatibility__upgrade_compatibility_tests__type_param.snap
Show resolved
Hide resolved
jordanjennings-mysten
force-pushed
the
upgrade-errors-type-params
branch
from
de081ab
to
b46fae6
Compare
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
force-pushed
the
upgrade-errors-type-params
branch
from
b46fae6
to
20e450f
Compare
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
jordanjennings-mysten
force-pushed
the
upgrade-errors-type-params
branch
from
20e450f
to
848e970
Compare
jordanjennings-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
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
snapshot testing
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.