Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ TxExecution overhaul #3429

Conversation

greymistcube
Copy link
Contributor

@greymistcube greymistcube commented Sep 21, 2023

Complete overhaul of TxExecution.

Notes:

  • TxSuccess and TxFailure have been removed.
  • Two are now differentiated by TxExecution.Fail boolean property.
  • Only TxExecution.Fail property is compatible with old saved TxExecution. This is to support TxResult's TxStatus.
    • New TxExecution can decode old saved TxExecution, but all other information is lost except TxExecution.Fail. The rest is set to null.

Todo:

  • Add InputState and OutputState of type HashDigest<SHA256> to TxResult.
  • As of this PR, there are now three commits happening. Once to validate Block, once to transform IActionEvaluations to call IActionRenderers, and once to transform IActionEvaluations to generate TxExecutions. These three should be combined to one.

@greymistcube greymistcube changed the base branch from main to migrate/iaccount-to-itrie September 21, 2023 01:02
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Merging #3429 (978b768) into migrate/iaccount-to-itrie (48a855a) will increase coverage by 2.91%.
The diff coverage is 98.75%.

❗ Current head 978b768 differs from pull request most recent head 5c3dcdb. Consider uploading reports for the commit 5c3dcdb to get more accurate results

Additional details and impacted files
@@                      Coverage Diff                      @@
##           migrate/iaccount-to-itrie    #3429      +/-   ##
=============================================================
+ Coverage                      76.35%   79.27%   +2.91%     
=============================================================
  Files                            346      344       -2     
  Lines                          11844    11855      +11     
=============================================================
+ Hits                            9044     9398     +354     
+ Misses                          2800     2457     -343     
Files Changed Coverage Δ
Libplanet.RocksDBStore/RocksDBStore.cs 75.77% <ø> (+8.22%) ⬆️
Libplanet.Types/Tx/TxExecution.cs 97.95% <97.72%> (+12.24%) ⬆️
Libplanet.Store/BaseStore.cs 50.00% <100.00%> (-32.76%) ⬇️
Libplanet.Store/DefaultStore.cs 90.15% <100.00%> (+1.68%) ⬆️
Libplanet.Store/MemoryStore.cs 100.00% <100.00%> (+7.21%) ⬆️
Libplanet/Blockchain/BlockChain.TxExecution.cs 100.00% <100.00%> (+5.71%) ⬆️

... and 51 files with indirect coverage changes

@greymistcube greymistcube force-pushed the refactor/txexecution-itrie branch from 0061777 to 9453c71 Compare September 21, 2023 05:04
@pull-request-quantifier-deprecated

This PR has 1024 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +451 -573
Percentile : 100%

Total files changed: 26

Change summary by file extension:
.md : +12 -0
.cs : +439 -573

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@greymistcube greymistcube marked this pull request as ready for review September 21, 2023 05:10
@greymistcube greymistcube changed the title Refactor/txexecution itrie ♻️ TxExecution overhaul Sep 21, 2023
}
}

nextTrie = StateStore.Commit(nextTrie);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😢

@greymistcube greymistcube merged commit c7170b1 into planetarium:migrate/iaccount-to-itrie Sep 21, 2023
11 checks passed
@greymistcube greymistcube deleted the refactor/txexecution-itrie branch September 21, 2023 08:19
@riemannulus riemannulus added this to the 3.4 milestone Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants