RustLayout rework, Global Layout object #3686

matejcik · 2024-04-07T12:38:52Z

Ladies and gentlemen, this is what you've been waiting for

fixes #2299
fixes #3280

Main features:

unified ui.Layout and ui.ProgressLayout classes
- instead of per-model RustLayout that is kind-of-but-not-really a copypaste job
Global ui.CURRENT_LAYOUT that always unambiguously refers to the layout that is on the screen, or None if the screen is dark
Total overhaul of debuglink internals, leading, hopefully, to greater test stability and less races
- client.debug.wait_layout() is now almost never needed, except in very special cases. read_layout() Does The Right Thing.
- deadlock detection when you miss a ButtonAck
- it "worked on my PC" but i'm sure you guys will figure out a way to break it anyway 🤷‍♀️

Minor niceties

timeout for loop.wait() so you usually don't need to use loop.race(xyz, loop.wait(...)) e8990ce
- paving way to fixing Trezor UI freeze while waiting for host response #3117
loop.chan is unused now. I left it in just in case but we can probably remove it 9f01c9f
nice simplification of handle_session now that it does not need to support debuglink 06cad6f
bug with make test_emu_ui in zsh not being random is fixed eb65cf6
WipeDevice will show a progress screen for the 2 seconds it takes to wipe storage. c98e54b
- it's "stuck" because we can't animate, but at least the user is not staring at a black screen
if a timeout kills your test, you'll see where in the input flow it froze 1a9d022
detection of invalid input flows that don't run all the way through fd914bd
reduces chattiness of error output when your UI tests are failing (e15c4e8, same as feat(tests): reduce ui error spam #3665)

Supersedes

#2335
#3083
#3665

github-actions · 2024-04-07T12:43:38Z

legacy UI changes	device test(screens) main(screens)

github-actions · 2024-04-07T12:43:38Z

core UI changes	device test	click test	persistence test
T2T1 Model T	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3B1 Safe 3	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3T1 Safe 5	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
All	main(screens)

matejcik · 2024-04-07T12:57:56Z

UI changes summary:

all progress steps of all loaders are removed, we only screenshot the first time a loader is shown
- except for "hold to lock", because the loader starts in progress already
some "loading transaction" screens are gone
- previously, a "loading transaction" screen would blink inbetween every Bitcoin confirmation dialog
- now it only shows up if there is in fact a loading step (so e.g., between the last output and the total confirmation screen there is nothing happening to warrant a loader)
some screens are now recorded that are immediately canceled
- in test_cancel, in cancellation versions of various reset/backup/recovery flows
WipeDevice now starts progress earlier

Learn more

https://github.com/trezor/trezor-firmware/blob/matejcik/global-layout-only3/docs/core/misc/layout-lifecycle.md

Reviewer instructions

I strongly recommend going by commits. There's a big one that does most of the things (b75dbe1), the other ones are more reasonable.

Please also point out if you feel that something is not documented that should be.

matejcik · 2024-04-07T13:05:48Z

TODO: this definitely wants a changelog entry

matejcik · 2024-04-07T13:56:15Z

seems that there's a progress related piece of code that I didn't manage to commit. stay tuned for fixes.

matejcik · 2024-04-07T13:57:56Z

also this does not feel like I added 11k of code, not sure what is going on...

docs/core/misc/layout-lifecycle.md

mmilata

Mostly nits, let's fix the backlight & tests and merge soon so it gets some testing before next release.

mmilata · 2024-09-27T16:57:11Z

core/embed/rust/src/ui/layout/obj.rs

+        // invoke the initial placement
+        new.root_mut().obj_place(constant::screen());
+        // cause a repaint pass to update the number of pages
+        let msg = new.obj_event(Event::RequestPaint);


I think until now Event::Attach was the first event sent after construction, pleasantly surprised this change did not break anything.

mmilata · 2024-09-27T17:00:52Z

core/src/trezor/workflow.py

@@ -27,6 +27,7 @@
    MessageType.DoPreauthorized,
    MessageType.WipeDevice,
    MessageType.SetBusy,
+    MessageType.Ping,


We can ask Suite just to be sure but given that it's this way on T1 they probably don't rely on it.

core/embed/rust/src/ui/layout/base.rs

mmilata · 2024-09-30T16:10:27Z

common/protob/messages-debug.proto

+    // Trezor T < 2.6.0 only - wait until reset word position is requested
+    optional bool wait_word_pos = 2  [deprecated=true];
+    // trezor-core only - wait until current layout changes
+    // changed in 2.6.4: multiple wait types instead of true/false.


Nit: version does not match anymore

mmilata · 2024-09-30T18:57:12Z

tests/device_handler.py

-        self.debuglink().wait_layout(wait_for_external_change=True)
+
+        # make sure we start the wait while a layout is up
+        # TODO should this be part of "wait_for_layout_change"?


core/src/trezor/ui/layouts/common.py

core/src/trezor/ui/layouts/homescreen.py

core/src/trezor/ui/__init__.py

mmilata · 2024-09-30T22:37:57Z

docs/core/misc/layout-lifecycle.md

@@ -0,0 +1,196 @@
+# UI Layout Lifecycle


IIRC you mentioned that this is now outdated, though it doesn't seems so on the first look.

obrusvit

Some points, mostly nits.
In addition: docs/event-loop.msd could be updated with mailbox description.

core/embed/rust/src/ui/flow/swipe.rs

core/src/trezor/loop.py

core/mocks/generated/trezorui2.pyi

core/src/apps/debug/__init__.py

python/src/trezorlib/debuglink.py

docs/core/misc/layout-lifecycle.md

[no changelog]

Submodule update only. [no changelog]

- some non-english texts do not fit on the screen and are paginated, these tests cannot handle it - commented out not to block GFL PR, to be resolved later

…eRequest legacy < 1.11.0 will never answer those because PinRequest and PassphraseRequest block waiting for PinAck / PassphraseAck over wirelink and ignore debuglink

matejcik self-assigned this Apr 7, 2024

matejcik requested review from andrewkozlik and prusnak as code owners April 7, 2024 12:38

matejcik requested review from mmilata and obrusvit and removed request for prusnak and andrewkozlik April 7, 2024 12:39

matejcik force-pushed the matejcik/global-layout-only3 branch from 11180d3 to 5c45151 Compare April 7, 2024 12:43

matejcik added the translations Put this label on a PR to run tests in all languages label Apr 7, 2024

matejcik mentioned this pull request Apr 8, 2024

core UI: single global layout #2335

Closed

obrusvit mentioned this pull request Apr 8, 2024

feat(core/ui): swipe navigation using rust-based UI flows #3661

Closed

obrusvit reviewed Apr 8, 2024

View reviewed changes

docs/core/misc/layout-lifecycle.md Show resolved Hide resolved

mmilata mentioned this pull request May 1, 2024

T3T1 - Receive flow #3760

Merged

mmilata mentioned this pull request May 15, 2024

T3T1 UI: SignTx flow #3822

Merged

matejcik mentioned this pull request May 22, 2024

Move backlight control fully into Rust #3849

Open

matejcik mentioned this pull request Jun 6, 2024

Device tests don't work against T3T1 hardware #3915

Closed

mmilata mentioned this pull request Jun 11, 2024

T3T1 UI: flows that run after final message is sent to host #3666

Open

matejcik removed the translations Put this label on a PR to run tests in all languages label Jul 1, 2024

matejcik force-pushed the matejcik/global-layout-only3 branch from 9177d75 to f535960 Compare September 26, 2024 12:55

matejcik requested a review from obrusvit September 26, 2024 12:55

obrusvit mentioned this pull request Sep 30, 2024

refactor(core/mercury): separate upy args parsing #4182

Merged

mmilata reviewed Sep 30, 2024

View reviewed changes

obrusvit reviewed Oct 1, 2024

View reviewed changes

matejcik force-pushed the matejcik/global-layout-only3 branch from f84d33e to 5d9d97e Compare October 9, 2024 11:52

matejcik and others added 23 commits November 12, 2024 15:55

fix(tests): correctly check that backup flow was aborted

b9bda5e

fix(core): restore ellipsis functionality on TR

e05e349

style(core/rust): fix linter complaints

ae95079

style: make style_check passing

43ecc72

fix(tests): fix persistence tests, enable T3B1

3f59318

fix(tests): assert multiple in slip39 checklist

6a57853

fix(tests): fix click tests race condition

5c7cb03

fix(tests): fix T3B1 persistance test

88993e8

test(core): fix test_reset_bip39_t2

172141a

[no changelog]

test(core): fix T3T1 U2F test

bd8d090

[no changelog]

test(core): fix T2T1 FIDO2 test

4bd7fa6

Submodule update only. [no changelog]

tests(core): fix upgrade tests

98bdc9e

style(python): upgrade debuglink.py to 3.10 style type annotations

9a6af3b

fix(tests): patch over confirm_blob buttonrequest problems

a235f4f

chore: update fixtures

96e54a0

feat(core): log ButtonRequests with names for easier debugging

9d13311

feat(core): enforce return type annotations

1d52081

fix(core): patch over problems with confirm_blob_pagination

f8b1876

chore: update fixtures

74763a8

fix(tests): show_multisig title assertions

15dc234

chore: update fixtures for translations

429a9d0

chore: update FIDO2 test helpers

3c65bad

fix(tests): remove lang asserts from click slip39

aec8794

- some non-english texts do not fit on the screen and are paginated, these tests cannot handle it - commented out not to block GFL PR, to be resolved later

matejcik removed the translations Put this label on a PR to run tests in all languages label Nov 12, 2024

matejcik force-pushed the matejcik/global-layout-only3 branch from 80fef26 to 9297722 Compare November 12, 2024 14:55

fix(python): do not take legacy snapshots on PinRequest and Passphras…

6b8585b

…eRequest legacy < 1.11.0 will never answer those because PinRequest and PassphraseRequest block waiting for PinAck / PassphraseAck over wirelink and ignore debuglink

matejcik force-pushed the matejcik/global-layout-only3 branch from 9297722 to 6b8585b Compare November 12, 2024 15:21

matejcik merged commit dd770ba into main Nov 12, 2024
93 of 94 checks passed

matejcik deleted the matejcik/global-layout-only3 branch November 12, 2024 15:55

M1nd3r mentioned this pull request Nov 14, 2024

chore(core): remove loop.chan #4348

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RustLayout rework, Global Layout object #3686

RustLayout rework, Global Layout object #3686

matejcik commented Apr 7, 2024 •

edited

Loading

github-actions bot commented Apr 7, 2024 •

edited

Loading

github-actions bot commented Apr 7, 2024 •

edited

Loading

matejcik commented Apr 7, 2024

matejcik commented Apr 7, 2024

matejcik commented Apr 7, 2024

matejcik commented Apr 7, 2024

mmilata left a comment

mmilata Sep 27, 2024

mmilata Sep 27, 2024

mmilata Sep 30, 2024

mmilata Sep 30, 2024

mmilata Sep 30, 2024

obrusvit left a comment

RustLayout rework, Global Layout object #3686

RustLayout rework, Global Layout object #3686

Conversation

matejcik commented Apr 7, 2024 • edited Loading

Ladies and gentlemen, this is what you've been waiting for

Main features:

Minor niceties

Supersedes

github-actions bot commented Apr 7, 2024 • edited Loading

github-actions bot commented Apr 7, 2024 • edited Loading

matejcik commented Apr 7, 2024

UI changes summary:

Learn more

Reviewer instructions

matejcik commented Apr 7, 2024

matejcik commented Apr 7, 2024

matejcik commented Apr 7, 2024

mmilata left a comment

Choose a reason for hiding this comment

mmilata Sep 27, 2024

Choose a reason for hiding this comment

mmilata Sep 27, 2024

Choose a reason for hiding this comment

mmilata Sep 30, 2024

Choose a reason for hiding this comment

mmilata Sep 30, 2024

Choose a reason for hiding this comment

mmilata Sep 30, 2024

Choose a reason for hiding this comment

obrusvit left a comment

Choose a reason for hiding this comment

matejcik commented Apr 7, 2024 •

edited

Loading

github-actions bot commented Apr 7, 2024 •

edited

Loading

github-actions bot commented Apr 7, 2024 •

edited

Loading