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

PDX-19: Add UnloadFromGarages Action #2197

Merged
merged 7 commits into from
Nov 6, 2023

Conversation

XxshiftxX
Copy link
Contributor

@XxshiftxX XxshiftxX commented Nov 2, 2023

Add UnloadFromGarages action with data structure and serialize/deserialize code.
Implementation of execution will be added following PR.

.Lib9c.Tests/Action/Garages/UnloadFromGaragesTest.cs Outdated Show resolved Hide resolved
Lib9c.Abstractions/IUnloadFromGaragesV1.cs Outdated Show resolved Hide resolved

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


Quantification details

Label      : Medium
Size       : +184 -0
Percentile : 56.8%

Total files changed: 3

Change summary by file extension:
.cs : +184 -0

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.

Comment on lines +41 to +45
Address recipientAvatarAddress,
IEnumerable<(Address balanceAddress, FungibleAssetValue value)>?
fungibleAssetValues,
IEnumerable<(HashDigest<SHA256> fungibleId, int count)>? fungibleIdAndCounts,
string? memo)> unloadData)
Copy link
Contributor

Choose a reason for hiding this comment

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

It is too sad to duplicate codes for type because of csharplang's limitation. 😢

Copy link
Contributor Author

Choose a reason for hiding this comment

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

type Foo = (...)

😢

Comment on lines +88 to +95
var fungibleAssetValues =
GarageUtils.MergeAndSort(
(value[1] as List)?.Select(raw =>
{
var fungibleAssetValue = (List)raw;
return (fungibleAssetValue[0].ToAddress(),
fungibleAssetValue[1].ToFungibleAssetValue());
}));
Copy link
Contributor

Choose a reason for hiding this comment

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

It will be treated as null instead of throwing an error, even if invalid items like Dictionary became.

Copy link
Contributor

@moreal moreal left a comment

Choose a reason for hiding this comment

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

Also, we should consider unload_from_garages as good naming 🤔 Should it be bulk_unload_from_my_garages? 🤔 @boscohyun Please leave your opinion 🙏🏻

@boscohyun
Copy link
Contributor

Also, we should consider unload_from_garages as good naming 🤔 Should it be bulk_unload_from_my_garages? 🤔 @boscohyun Please leave your opinion 🙏🏻

Thanks for mentioning me.

  1. It's OK to remove my from action identifier. Because the action use signer address basically.
  2. Choosing to add bulk to the action identifier is easy and reasonable.

@XxshiftxX
Copy link
Contributor Author

Also, we should consider unload_from_garages as good naming 🤔 Should it be bulk_unload_from_my_garages? 🤔 @boscohyun Please leave your opinion 🙏🏻

Thanks for mentioning me.

  1. It's OK to remove my from action identifier. Because the action use signer address basically.
  2. Choosing to add bulk to the action identifier is easy and reasonable.

@boscohyun @moreal Thank you for your opinion. I think build_unload_from_garages is nice option to represent how it works.
It seems to hard to change names now because it has many following PR/branches. So I'll apply this after bunch of branches merge into a single branch so that there's no remaining branch dependency.

@XxshiftxX XxshiftxX merged commit 85ae9dd into PDX-18-base Nov 6, 2023
11 checks passed
@XxshiftxX XxshiftxX deleted the PDX-19-bulk-unload-from-garages branch November 6, 2023 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants