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

Feature/update bulk ops serialization #2697

Conversation

ElizabethOkerio
Copy link
Contributor

@ElizabethOkerio ElizabethOkerio commented Aug 11, 2022

Issues

This pull request fixes #xxx.

Description

This pull request is a sub of this big PR #2656. We have broken the big PR into 3PRs - deserialization/serialization/ApiHandlers to hasten the review. This PR contains only serialization changes for bulk operations.

This PR adds changes for serializing a DeltaSet. This is a new structure for bulk operations.
We've removed changes for serializing a response in a deep insert in this pr as there are some redesigning that need to be done for proper serialization to the required level to happen.

Checklist (Uncheck if it is not completed)

  • Test cases added
  • Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from e493e2a to c8650c9 Compare September 12, 2022 07:18
@ElizabethOkerio ElizabethOkerio marked this pull request as ready for review September 12, 2022 08:11
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch 3 times, most recently from 8299888 to c0ded4a Compare September 28, 2022 12:16
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from 24157e0 to 3082d76 Compare September 29, 2022 07:55
@habbes
Copy link
Contributor

habbes commented Oct 13, 2022

Could you add some context and overview of the changes in the description?

@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from 068fb6b to 0427985 Compare October 13, 2022 08:31
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from 53ad3c2 to c078018 Compare October 14, 2022 12:07
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch 2 times, most recently from 82432b1 to 519fd8f Compare October 17, 2022 14:30
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from 9229e22 to d1353ca Compare October 18, 2022 04:14
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from 11b8d3b to 380de65 Compare October 18, 2022 04:55
@ElizabethOkerio ElizabethOkerio force-pushed the feature/update_bulk_ops_serialization branch from a6f010f to 22bd66b Compare October 18, 2022 10:20
@pull-request-quantifier-deprecated

This PR has 677 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       : +627 -50
Percentile : 89.23%

Total files changed: 21

Change summary by file extension:
.cs : +580 -44
.projitems : +1 -0
.csproj : +4 -0
.bsl : +42 -6

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.

Copy link
Contributor

@gathogojr gathogojr left a comment

Choose a reason for hiding this comment

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

LGTM

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.

4 participants