Skip to content

fixes #2816: Set the response version to delta response and delta patch response - #2829

Merged
xuzhg merged 4 commits into
masterfrom
issue2816_2
Jan 26, 2024
Merged

fixes #2816: Set the response version to delta response and delta patch response#2829
xuzhg merged 4 commits into
masterfrom
issue2816_2

Conversation

@xuzhg

@xuzhg xuzhg commented Jan 25, 2024

Copy link
Copy Markdown
Member

Issues

This pull request fixes #2816.

Description

Currently, ODataVersion.4.01 is hard coded for all delta response. So, customer can't switch between 4.0 and 4.01.

However, it may be true for delta patch since it's only included in OData version 4.01, but not in OData version 4.0. For other delta responses, it should be valid in both versions.

This PR is to change to 4.01 only for delta patch response but use the version setting for other delta response.

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.

…delta patch, but not any time for delta response payload
@xuzhg xuzhg changed the title fixes #2816: Set the response version to v4.01 when the request is a … fixes #2816: Set the response version to delta response and delta patch response Jan 25, 2024
mikepizzo
mikepizzo previously approved these changes Jan 25, 2024

@mikepizzo mikepizzo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

gathogojr
gathogojr previously approved these changes Jan 25, 2024
@pull-request-quantifier-deprecated

Copy link
Copy Markdown

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


Quantification details

Label      : Extra Small
Size       : +31 -3
Percentile : 13.6%

Total files changed: 3

Change summary by file extension:
.cs : +31 -3

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.


if (serializer.ODataPayloadKind == ODataPayloadKind.Delta)
// Set the response version to v4.01 when the request is a delta patch, but not any time we write a delta response payload.
if (serializer.ODataPayloadKind == ODataPayloadKind.Delta && internalRequest.Method == ODataRequestMethod.Patch)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What's the internal request method of a normal delta response? Isn't it Patch also?

@ElizabethOkerio ElizabethOkerio Jan 26, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

or this is for other methods like GET etc

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That's 'Get', right?!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PATCH is the verb used when the client is doing a delta (aka bulk) update.

The delta response payload is also used when the client retrieves changes using the deltaLink using GET.

Bulk updates are only supported for 4.01, so it's appropriate for the response from a delta update to be 4.01, but a request to get changes (which also returns in delta format) has been around since 4.0, and is valid in either 4.0 or 4.01 format.

@xuzhg
xuzhg merged commit 3067b88 into master Jan 26, 2024
xuzhg added a commit that referenced this pull request May 29, 2026
…ch response (#2829)

* fixes #2816: Set the response version to v4.01 when the request is a delta patch, but not any time for delta response payload

* Fix the failing test cases

* Fix the failing test case

* Remove unused codes
pull Bot pushed a commit to ehtick/WebApi that referenced this pull request May 29, 2026
…a patch response (OData#2829)

* fixes OData#2816: Set the response version to v4.01 when the request is a delta patch, but not any time for delta response payload

* Fix the failing test cases

* Fix the failing test case

* Remove unused codes
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.

OData-prefix missing in delta responses

4 participants