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

Expose more information about path segments and selected items #2354

Open
wants to merge 7 commits into
base: release-7.x
Choose a base branch
from

Conversation

ificator
Copy link
Contributor

Issues

Improve ODataPath and SelectExpandClause so more information is exposed through the abstractions.

Description

This small PR contains a few changes:

  1. Allow specific segments to be retrieved from ODataPath to avoid unnecessary enumeration.
  2. Expose a struct enumerator on ODataPath to avoid boxing. We could have directly exposed List<ODataPathSegment>.Enumerator but the fact it's using a List<T> is an implementation detail.
  3. Return IList<SelectItem> instead of an IEnumerable<SelectItem> so the count can be efficiently obtained, and indexing can be performed for random access.

Checklist (Uncheck if it is not completed)

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

@ificator
Copy link
Contributor Author

ificator commented Mar 17, 2022

So it turns out when I ran all the unit tests in Visual Studio 2022 Preview the PublicApiTests did not run. I cannot make them run either (0 Passed, 0 Failed, 0 Skipped)... is there a trick to this?

Found the output logs and the test process is crashing:

[xUnit.net 00:00:00.00] xUnit.net VSTest Adapter v2.4.1 (64-bit .NET Core 3.1.23)
[xUnit.net 00:00:00.32]   Starting:    Microsoft.OData.PublicApi.Tests
The active test run was aborted. Reason: Test host process crashed

Edit:
I was able to get ONE of the tests working on my home machine (the other still crashes the test host process), which was enough for me to diff the bsl files to update them correctly.

@xuzhg
Copy link
Member

xuzhg commented Mar 28, 2022

Others look good to me. :shipit:

@ificator
Copy link
Contributor Author

ificator commented Apr 4, 2022

@corranrogue9 / @gathogojr any feedback on this PR?

@ificator
Copy link
Contributor Author

@corranrogue9 / @gathogojr ping?

@pull-request-quantifier-deprecated

This PR has 159 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       : +117 -42
Percentile : 51.8%

Total files changed: 10

Change summary by file extension:
.txt : +29 -1
.cs : +37 -26
.bsl : +51 -15

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.

/// </summary>
public int Count
internal IList<ODataPathSegment> Segments
Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants