[CLI] Add clever error support to Sui CLI #17920

tzakian · 2024-05-24T18:59:46Z

Description

Enables clever error rendering in the Sui CLI.

It also abstracts out some of the rendering logic for constants into their own file so it can be reused across the graphql and Sui CLI renderer.

This also updates the Move disassembler to use this new (nicer!) renderer to that we support rendered values for constants in the Move disassembler instead of just strings in constants.

Test plan

Added new tests for this to the Sui CLI, and updated/added additional tests for the disassembler.

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.

vercel · 2024-05-24T18:59:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sui-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 18, 2024 11:45pm

3 Ignored Deployments

Name	Status	Preview	Updated (UTC)
multisig-toolkit	⬜️ Ignored (Inspect)	Visit Preview	Jun 18, 2024 11:45pm
sui-kiosk	⬜️ Ignored (Inspect)	Visit Preview	Jun 18, 2024 11:45pm
sui-typescript-docs	⬜️ Ignored (Inspect)	Visit Preview	Jun 18, 2024 11:45pm

crates/sui/src/clever_error_rendering.rs

stefan-mysten

For the CLI part, looks good. Excited to see this rolled out!

I am curious about what are your thoughts on having these available also for dry-run?

crates/sui/src/clever_error_rendering.rs

tnowacki · 2024-05-24T20:30:32Z

crates/sui/tests/snapshots/cli_tests__body_fn.snap

+---
+Non-clever-abort
+---
+Error executing transaction: 1st command aborted within function '0xc9d9682e45a4291cf2c7d86486f604fe19451bb367cc9fa4f2149eb5f1efac8a::clever_errors::aborter' at instruction 1 with code 0


Do we have an address map or anything at this point?

I don't believe we do. But I'll look around to see -- I could look in the CLI address aliases and possibly look about using them if an address matches.

Pardon my noob question, but isn't this a package address? That would not exist in the CLI aliases' file, because it only hosts wallet's addresses and aliases?

😢 Nope, you're totally right. Nothing we can really do about it then (at least right now).

An idea I had a long time ago was to look for a Move.toml and use the address <-> name mapping that it defines for this purpose (I wanted to do this to improve our representation of PTBs in the CLI, with the idea that you could start building up a Move.toml file that depended on other packages and/or assigned names to addresses as you made more sense of a PTB).

tzakian · 2024-06-13T22:49:56Z

This should be updated so we now render clever errors in the displays as well. I had...a lot of fun with the fact that Display is not async in Rust before coming to the pre-rendering solution here.

amnn

Nice -- accepting with comments assuming that on the CLI side the majority of those changes are to tide us over until we have proper GraphQL support, in which case clever_error_rendering.rs can be swept under the rug and we can pretend we never had to resort to such things.

amnn · 2024-06-16T16:53:01Z

crates/sui/src/clever_error_rendering.rs

Some doc comments would be nice here.

This code looks suspiciously similar to the way GraphQL renders errors, but using the SDK to fetch package information rather than a package resolver. This yields many questions:

Is this only used to render errors coming from on-chain, or is it also used to render local errors, e.g. from move test?

If only from on-chain (including localnet), do you envisage this sticking around for a while, or is this a stop-gap until we have a GraphQL-backed CLI?

If also for local errors, how does it get the package information for the local package? (I'm guessing it doesn't and so it's only for on-chain).

If you do expect this logic to stick around for a while, then should we factor out the common parts with GraphQL?

Context answering these questions would be helpful to include in the aforementioned doc comment.

Happy to add some doc comments :)

Is this only used to render errors coming from on-chain, or is it also used to render local errors, e.g. from move test

Only on-chain. We render things separately in the unit test infrastructure (and based off the VM state in the unit tests) for move test. So this is really only a stop-gap for on-chain errors until we have a GraphQL-backed CLI.

amnn · 2024-06-16T16:58:21Z

crates/sui/src/clever_error_rendering.rs

+    Some(format!("{command}{suffix} command aborted within {error}"))
+}
+
+fn parse_abort_status_string(


sad. panda.

Doc comments would also be good here, to express the requisite remorse for having to resort to:

Trying to extract any kind of structure out of this unstructured error response,

regexp parsing a context-free grammar.

I felt your pain reading this function.

Yea... 😢 not the most beautiful of functions lol

Will add a doc comment saying to kill this the moment we can/have a GraphQL-backed CLI :)

amnn · 2024-06-16T17:03:45Z

crates/sui/tests/snapshots/cli_tests__body_fn.snap

+---
+Clever-error-utf8
+---
+Error executing transaction '7YmFWxA3WKzKF7Bp3sJisD83EZTGXFosD4TKmq8ughLY': 1st command aborted within function '0xb691b7e8d182a5d5c8dd834b234a2bd55d9c42210cba8e852cd134586a74390e::clever_errors::clever_aborter' at line 19. Aborted with 'ENotFound' -- 'Element not found in vector 💥 🚀 🌠'


Beautiful. I can't wait to see the first error on mainnet that uses emoji.

amnn · 2024-06-16T17:05:53Z

external-crates/move/crates/move-disassembler/src/disassembler.rs

@@ -444,6 +445,14 @@ impl<'a> Disassembler<'a> {
        }
    }

+    fn preview_string(s: &str) -> String {
+        if s.len() <= 4 {


This is a pet peeve of mine 😅 , but this bound should be 6 to make sure the preview is always smaller than the input string.

Indeed! Very good spot. Will update :)

## Description Enables clever error rendering in the Sui CLI. It also abstracts out some of the rendering logic for constants into their own file so it can be reused across the graphql and Sui CLI renderer. This also updates the Move disassembler to use this new (nicer!) renderer to that we support rendered values for constants in the Move disassembler instead of just strings in constants. ## Test plan Added new tests for this to the Sui CLI, and updated/added additional tests for the disassembler. --- ## 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: - [X] CLI: Add better rendering for Move aborts, and added support for rendering clever errors. - [ ] Rust SDK:

tzakian requested review from amnn, awelc and stefan-mysten May 24, 2024 18:59

tzakian requested review from a team and removed request for awelc May 24, 2024 18:59

stefan-mysten reviewed May 24, 2024

View reviewed changes

crates/sui/src/clever_error_rendering.rs Outdated Show resolved Hide resolved

stefan-mysten reviewed May 24, 2024

View reviewed changes

tnowacki reviewed May 24, 2024

View reviewed changes

tzakian force-pushed the tzakian/cli-clever-errors branch from 2cb4a02 to 307d510 Compare May 30, 2024 20:51

vercel bot deployed to Preview – sui-docs May 30, 2024 20:53 View deployment

tzakian force-pushed the tzakian/cli-clever-errors branch from 307d510 to adb0967 Compare June 13, 2024 22:47

tzakian requested a review from stefan-mysten June 13, 2024 22:50

vercel bot deployed to Preview – sui-docs June 13, 2024 22:51 View deployment

amnn approved these changes Jun 16, 2024

View reviewed changes

tzakian force-pushed the tzakian/cli-clever-errors branch from adb0967 to 0e4914d Compare June 17, 2024 20:03

vercel bot deployed to Preview – sui-docs June 17, 2024 20:05 View deployment

tzakian force-pushed the tzakian/cli-clever-errors branch from 0e4914d to 575354f Compare June 17, 2024 22:24

vercel bot deployed to Preview – sui-docs June 17, 2024 22:26 View deployment

tzakian force-pushed the tzakian/cli-clever-errors branch from 575354f to c4075a7 Compare June 17, 2024 22:33

vercel bot deployed to Preview – sui-docs June 17, 2024 22:34 View deployment

tzakian enabled auto-merge (squash) June 18, 2024 07:38

tzakian disabled auto-merge June 18, 2024 16:40

tzakian force-pushed the tzakian/cli-clever-errors branch from c4075a7 to e4d4115 Compare June 18, 2024 16:49

vercel bot deployed to Preview – sui-docs June 18, 2024 16:51 View deployment

tzakian added 4 commits June 18, 2024 16:43

[CLI] Add clever error support to Sui CLI

2a32a57

fixup! [CLI] Add clever error support to Sui CLI

737eff3

fixup! fixup! [CLI] Add clever error support to Sui CLI

38e2709

fixup! fixup! fixup! [CLI] Add clever error support to Sui CLI

0bbf7bb

fixup! fixup! fixup! fixup! [CLI] Add clever error support to Sui CLI

0c55e82

tzakian force-pushed the tzakian/cli-clever-errors branch from e4d4115 to 0c55e82 Compare June 18, 2024 23:43

tzakian enabled auto-merge (squash) June 18, 2024 23:44

vercel bot deployed to Preview – sui-docs June 18, 2024 23:45 View deployment

tzakian merged commit aa1ad98 into main Jun 19, 2024
47 checks passed

tzakian deleted the tzakian/cli-clever-errors branch June 19, 2024 00:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLI] Add clever error support to Sui CLI #17920

[CLI] Add clever error support to Sui CLI #17920

tzakian commented May 24, 2024

vercel bot commented May 24, 2024 •

edited

Loading

stefan-mysten left a comment

tnowacki May 24, 2024

tzakian May 30, 2024

stefan-mysten May 30, 2024 •

edited

Loading

tzakian May 30, 2024

amnn Jun 3, 2024

tzakian commented Jun 13, 2024

amnn left a comment

amnn Jun 16, 2024

amnn Jun 16, 2024

tzakian Jun 17, 2024

amnn Jun 16, 2024

amnn Jun 16, 2024

tzakian Jun 17, 2024

amnn Jun 16, 2024

amnn Jun 16, 2024

tzakian Jun 17, 2024

[CLI] Add clever error support to Sui CLI #17920

[CLI] Add clever error support to Sui CLI #17920

Conversation

tzakian commented May 24, 2024

Description

Test plan

Release notes

vercel bot commented May 24, 2024 • edited Loading

stefan-mysten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefan-mysten May 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tzakian commented Jun 13, 2024

amnn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented May 24, 2024 •

edited

Loading

stefan-mysten May 30, 2024 •

edited

Loading