[fix] #3031: Fix the UI/UX of missing configuration parameters #3321

appetrosyan · 2023-03-22T19:49:19Z

Description of the Change

Improve UI/UX of incorrect configuration specification.

Issue

Closes #3031

Benefits

Better UI

Possible Drawbacks

Slightly worse readability of the iroha_cli crate, particularly the main.rs file.

Usage Examples or Tests [optional]

codecov · 2023-03-22T20:00:52Z

Codecov Report

Merging #3321 (9b338ba) into iroha2-dev (a4d5c9f) will decrease coverage by 6.51%.
The diff coverage is 47.01%.

@@              Coverage Diff               @@
##           iroha2-dev    #3321      +/-   ##
==============================================
- Coverage       62.33%   55.82%   -6.51%     
==============================================
  Files             169      158      -11     
  Lines           31218    29885    -1333     
==============================================
- Hits            19459    16684    -2775     
- Misses          11759    13201    +1442

Impacted Files	Coverage Δ
cli/src/lib.rs	`0.58% <0.00%> (-68.85%)`	⬇️
cli/src/main.rs	`0.66% <0.00%> (-0.44%)`	⬇️
cli/src/samples.rs	`0.00% <0.00%> (-61.85%)`	⬇️
cli/src/style.rs	`0.00% <0.00%> (ø)`
cli/src/torii/mod.rs	`0.00% <0.00%> (-27.66%)`	⬇️
cli/src/torii/routing.rs	`0.00% <0.00%> (-57.11%)`	⬇️
cli/src/torii/utils.rs	`0.00% <0.00%> (-84.85%)`	⬇️
client/src/http_default.rs	`0.00% <0.00%> (-38.94%)`	⬇️
client_cli/src/main.rs	`0.25% <0.00%> (+<0.01%)`	⬆️
config/base/src/lib.rs	`95.08% <ø> (+58.71%)`	⬆️
... and 100 more

... and 51 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

config/src/lib.rs

config/src/iroha.rs

cli/src/main.rs

config/src/path.rs

config/src/lib.rs

config/src/client.rs

config/base/src/lib.rs

cli/src/lib.rs

logger/src/lib.rs

cli/src/lib.rs

cli/src/main.rs

Addressed

cli/src/main.rs

config/base/src/lib.rs

config/src/client.rs

data_model/src/asset.rs

data_model/src/isi.rs

crypto/src/lib.rs

mversic · 2023-04-20T06:05:15Z

config/base/derive/src/documented.rs

+								field: stringify!(#ident),
+								error
+							}
+						)?


cli/src/main.rs

…parameters Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

mversic · 2023-04-24T10:55:16Z

config/Cargo.toml

@@ -24,6 +24,8 @@ serde_json = "1.0.91"
 json5 = "0.4.1"
 thiserror = "1.0.38"
 derive_more = "0.99.17"
+cfg-if = "1.0.0"


Suggested change

cfg-if = "1.0.0"

cli/src/lib.rs

cli/src/style.rs

config/src/iroha.rs

crypto/src/lib.rs

appetrosyan requested review from s8sato, mversic, Arjentix, SamHSmith, QuentinI, outoftardis, ilchu, pesterev and Erigara as code owners March 22, 2023 19:49

github-actions bot added the iroha2-dev The re-implementation of a BFT hyperledger in RUST label Mar 22, 2023

appetrosyan force-pushed the i2-ui-ux branch from 0667010 to a55c917 Compare March 22, 2023 19:49

mversic assigned mversic and appetrosyan Mar 23, 2023

mversic previously requested changes Mar 23, 2023

View reviewed changes

config/src/lib.rs Outdated Show resolved Hide resolved

config/src/iroha.rs Outdated Show resolved Hide resolved

cli/src/main.rs Outdated Show resolved Hide resolved

cli/src/main.rs Outdated Show resolved Hide resolved

appetrosyan force-pushed the i2-ui-ux branch from a55c917 to 7708cfe Compare March 23, 2023 11:20

appetrosyan requested a review from mversic March 23, 2023 11:20

ilchu reviewed Mar 23, 2023

View reviewed changes

ilchu self-assigned this Mar 23, 2023

appetrosyan mentioned this pull request Mar 23, 2023

Or maybe generating a link such as iroha/docs/source/references/config.md#queuetransaction_time_to_live_ms would be easier? #3326

Closed

appetrosyan force-pushed the i2-ui-ux branch from 7708cfe to bd85566 Compare March 24, 2023 06:07

appetrosyan requested a review from ilchu March 24, 2023 06:08

appetrosyan marked this pull request as draft March 24, 2023 06:09

0x009922 reviewed Mar 31, 2023

View reviewed changes

cli/src/main.rs Outdated Show resolved Hide resolved

config/base/src/lib.rs Show resolved Hide resolved

config/src/client.rs Show resolved Hide resolved

appetrosyan assigned 0x009922 and unassigned mversic Apr 13, 2023

appetrosyan force-pushed the i2-ui-ux branch 3 times, most recently from ac5eff5 to 4ee7a63 Compare April 19, 2023 07:19

appetrosyan commented Apr 19, 2023

View reviewed changes

data_model/src/asset.rs Show resolved Hide resolved

appetrosyan commented Apr 19, 2023

View reviewed changes

data_model/src/isi.rs Show resolved Hide resolved

appetrosyan force-pushed the i2-ui-ux branch 3 times, most recently from cf3c803 to 2eaac44 Compare April 19, 2023 07:49

appetrosyan marked this pull request as ready for review April 19, 2023 07:50

mversic reviewed Apr 20, 2023

View reviewed changes

crypto/src/lib.rs Show resolved Hide resolved

mversic reviewed Apr 20, 2023

View reviewed changes

cli/src/main.rs Show resolved Hide resolved

mversic previously approved these changes Apr 20, 2023

View reviewed changes

mversic requested a review from 0x009922 April 20, 2023 06:08

appetrosyan added 7 commits April 24, 2023 11:47

[fix] hyperledger-iroha#3031: Fix the UI/UX of missing configuration …

1221e3f

…parameters Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[refactor]: improve tracing spans

d618e57

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[refactor]: Improve log readability.

e813d4c

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[refactor]: Improve log readability.

6cc9a6f

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[feature]: Add spantrace capture to color_eyre

095ea43

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[refactor]: Extract style module

89877bf

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

[fix]: regression when overspecified type for param

9b338ba

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

appetrosyan dismissed mversic’s stale review via 9b338ba April 24, 2023 08:00

appetrosyan force-pushed the i2-ui-ux branch from 2bff32a to 9b338ba Compare April 24, 2023 08:00

mversic approved these changes Apr 24, 2023

View reviewed changes

mversic reviewed Apr 24, 2023

View reviewed changes

QuentinI approved these changes Apr 24, 2023

View reviewed changes

cli/src/lib.rs Show resolved Hide resolved

cli/src/style.rs Show resolved Hide resolved

config/src/iroha.rs Show resolved Hide resolved

crypto/src/lib.rs Show resolved Hide resolved

appetrosyan merged commit d5fbb2a into hyperledger-iroha:iroha2-dev Apr 24, 2023

0x009922 mentioned this pull request May 12, 2023

[suggestion] Enhance configuration parsing with precise field locations #3470

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fix] #3031: Fix the UI/UX of missing configuration parameters #3321

[fix] #3031: Fix the UI/UX of missing configuration parameters #3321

appetrosyan commented Mar 22, 2023

codecov bot commented Mar 22, 2023 •

edited

Loading

mversic Apr 20, 2023

mversic Apr 24, 2023

mversic Apr 24, 2023

[fix] #3031: Fix the UI/UX of missing configuration parameters #3321

[fix] #3031: Fix the UI/UX of missing configuration parameters #3321

Conversation

appetrosyan commented Mar 22, 2023

Description of the Change

Issue

Benefits

Possible Drawbacks

Usage Examples or Tests [optional]

codecov bot commented Mar 22, 2023 • edited Loading

Codecov Report

mversic Apr 20, 2023

Choose a reason for hiding this comment

mversic Apr 24, 2023

Choose a reason for hiding this comment

mversic Apr 24, 2023

Choose a reason for hiding this comment

codecov bot commented Mar 22, 2023 •

edited

Loading