PR for 7.6 Beta by making Patchhandler and related classes internal by Sreejithpin · Pull Request #2606 · OData/WebApi

Sreejithpin · 2021-12-02T07:38:05Z

Issues

This pull request fixes #xxx.

Description

PR for 7.6 Beta by making Patchhandler and related classes internal

Changes:

DeltaOfT
internal void Patch(

DeltaSetOfT
internal DeltaSet Patch(IC
internal DeltaSet Patch(

EdmChangedObjectcollection
internal EdmChangedObjectCollection Patch(OD

EdmODataAPIHandler
internal abstract class EdmODataAPIHandler

IODataAPIHandler
internal interface IODataAPIHandler

ODataAPIHandler
internal abstract class ODataAPIHandler: IO

ODataAPIHandlerFactory
internal abstract class ODataAPIHandlerFactory

ODataAPIResponseStatus
internal enum ODataAPIResponseStatus

ODataEdmAPIHandlerFactory
internal abstract class ODataEdmAPIHandlerFactory

ODataIDResolver
internal abstract class ODataIDResolver

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.

* Bulk operations6 (#2) * BulkInsert1 draft * Bulk insert changes * deleted old test * updates * Update ODataResourceSetWrapper.cs * updates * Updated addressing comments * updates * updates updates * Updates * Updates * Minor updates * comments * updates * update publicapi for core * Address comments * Cleanup and additional tests Cleanup and additional tests * Updated code * BulkInsert1 draft * Bulk insert changes * deleted old test * updates * updates * Updated addressing comments * updates * updates updates * Updates * Updates * Minor updates * updates * Address comments * Cleanup and additional tests Cleanup and additional tests * DataAnnotationException updates * comments * small updates * updates * small update * updates * Updates * Update DeltaSetOfT.cs * Updates with Patch * updates * updates * Update WebHostTestFixture.cs * updates * Update DeltaOfTStructuralType.cs * Updates * Updates for serializer etc * Update WebHostTestFixture.cs * updates * updates * updates * Bulk Operations Updates * Review comments addressed * Updates * updated for deltaentity * Update Microsoft.AspNet.OData.Test.csproj * Update Microsoft.AspNet.OData.PublicApi.bsl * update public api * test fix * Update EdmStructuredObject.cs * Update EdmStructuredObject.cs * Update BulkInsertTest.cs * update * public api * review comments * Review comments updates * smalll update * updates * updates * updates

* support for odata.bind * support for odata.bind

* Bulk operations6 (#2) * BulkInsert1 draft * Bulk insert changes * deleted old test * updates * Update ODataResourceSetWrapper.cs * updates * Updated addressing comments * updates * updates updates * Updates * Updates * Minor updates * comments * updates * update publicapi for core * Address comments * Cleanup and additional tests Cleanup and additional tests * Updated code * BulkInsert1 draft * Bulk insert changes * deleted old test * updates * updates * Updated addressing comments * updates * updates updates * Updates * Updates * Minor updates * updates * Address comments * Cleanup and additional tests Cleanup and additional tests * DataAnnotationException updates * comments * small updates * updates * small update * updates * Updates * Update DeltaSetOfT.cs * Updates with Patch * updates * updates * Update WebHostTestFixture.cs * updates * Update DeltaOfTStructuralType.cs * Updates * Updates for serializer etc * Update WebHostTestFixture.cs * updates * updates * updates * Bulk Operations Updates * Review comments addressed * Updates * updated for deltaentity * Update Microsoft.AspNet.OData.Test.csproj * Update Microsoft.AspNet.OData.PublicApi.bsl * update public api * test fix * Update EdmStructuredObject.cs * Update EdmStructuredObject.cs * Update BulkInsertTest.cs * update * public api * review comments * Review comments updates * smalll update * updates * updates * updates

* support for odata.bind * support for odata.bind

Squashing Commits Update DeltaOfTStructuralType.cs test change Update Microsoft.AspNetCore.OData.Test.csproj Update Microsoft.Test.E2E.AspNetCore3x.OData.csproj updates Update WebStack.versions.settings.targets Update WebStack.versions.settings.targets Update GetNugetPackageMetadata.proj Update WebStack.versions.settings.targets For testing update Update BulkInsertController.cs Updates updates updates Update NuGet.Config Update BulkOperationPatchHandlersEF.cs updates

xuzhg · 2021-12-03T18:42:36Z

src/Microsoft.AspNet.OData.Shared/DataModificationExceptionType.cs

@@ -0,0 +1,115 @@
+// Copyright (c) Microsoft Corporation.  All rights reserved.
+// Licensed under the MIT License.  See License.txt in the project root for license information.
+


change all copyrights using existing one. #Resolved

for other new added files.

mikepizzo · 2022-01-04T00:09:35Z

src/Microsoft.AspNet.OData.Shared/NavigationPath.cs

+        /// To Get ODataId in Parsed format
+        /// </summary>
+        /// <returns>Array of PathItems</returns>
+        public PathItem[] GetNavigationPathItems()


GetNavigationPathItems

This is the main logic/use of the class, right? getting the path items?

Maybe make this just public PathItem[] PathItems? #Resolved

mikepizzo · 2022-01-04T00:10:26Z

src/Microsoft.AspNet.OData.Shared/NavigationPath.cs

+        /// Initializes a new instance of the <see cref="NavigationPath"/> class.
+        /// </summary>        
+        /// <param name="pathSegments">Pathsegment collection</param>
+        public NavigationPath(ReadOnlyCollection<ODataPathSegment> pathSegments)


NavigationPath

Do we need a public constructor at all for this (at least initially), or will we always create the NavigationPath object? #Resolved

Did you mean internal constructor? Initially internal will be fine to see if any user wants to use /create it

Yes; if we can make internal that would be great.

Ok doing it

-remove NavigationPath from ODataIdContainer -make it easy for developer to create a NavigationPath from id/Model -Add model to APIHandlerFactory base class as a way to provide the model to the methods that require it -Experiment with setting the id during deserialization in cases where only key values are provided. Should we get this from ODL? -use the actual path for nested resources in readContext todo: -rationalize routing odatapath and uriparser odatapath usage -build out logic/add tests for the path in nested resources for readContext -should we get the id for key properties during deserialization from ODL? -handle edge cases throughout

…lues, if specified

mikepizzo · 2022-01-24T15:45:07Z

src/Microsoft.AspNet.OData.Shared/Formatter/Deserialization/ODataResourceDeserializer.cs

+        /// <param name="resourceWrapper">The resource wrapper.</param>
+        /// <param name="readContext">The read context.</param>
+        /// <returns>The resource wrapper.</returns>
+        private ODataResourceWrapper UpdateResourceWrapper(ODataResourceWrapper resourceWrapper, ODataDeserializerContext readContext)


UpdateResourceWrapper

This method name and description are vague; they don't tell me how the resource wrapper is updated. Maybe rename "SetKeyProperties"?

…2618) * Temp commit * Updates

corranrogue9 · 2022-03-02T00:37:11Z

src/Microsoft.AspNet.OData.Shared/DefaultODataAPIHandler.cs

+
+            foreach (string key in keyValues.Keys)
+            {
+                propertyInfos.Add(key, _clrType.GetProperty(key));


Why do we need to populate this dictionary? In the for loop below, can't we just call _clrType.GetProperty(keyValue.Key).GetValue(item)? This would prevent use from having to enumerate keyValues twice, and we don't have to call GetProperty on keys that might come after we find the matching keyValue.Value

corranrogue9 · 2022-03-02T00:47:54Z

src/Microsoft.AspNet.OData.Shared/DeltaSetOfT.cs

+        /// <param name="keys">List of key names for the type</param>        
+        public DeltaSet(IList<string> keys)           
+        {
+            _keys = keys;            


It seems that later on we assume that _keys is not null; since this is a public API, it's probably best to throw if keys is null.

corranrogue9 · 2022-03-02T00:49:05Z

src/Microsoft.AspNet.OData.Shared/DeltaSetOfT.cs

+        public DeltaSet(IList<string> keys)           
+        {
+            _keys = keys;            
+            _clrType = typeof(TStructuralType);            


I'm not certain if there's any perf impact, but it might make more sense to have _clrType be static so that we don't have to call typeof as often. At the very least, it seems like good practice to follow DRY.

corranrogue9 · 2022-03-02T00:56:13Z

src/Microsoft.AspNet.OData.Shared/DeltaSetOfT.cs

+
+        private DeltaSet<TStructuralType> CreateDeltaSet()
+        {
+            Type type = typeof(DeltaSet<>).MakeGenericType(_clrType);


Is it not legal to just write typeof(DeltaSet<TStructuralType>)?

corranrogue9 · 2022-03-02T01:00:48Z

src/Microsoft.AspNet.OData.Shared/DeltaSetOfT.cs

+
+            if (hasnullKeys)
+            {               
+                edmDeletedObject.Id = new Uri(string.Empty);                


Small optimization, I think that Uri is immutable (or functionally immutable), so we can reduce object allocations if we have a singleton definition of new Uri(string.Empty)

corranrogue9 · 2022-03-02T01:09:55Z

src/Microsoft.AspNet.OData.Shared/EdmChangedObjectCollection.cs

+        internal EdmChangedObjectCollection CopyChangedValues(EdmODataAPIHandler apiHandler, ODataEdmAPIHandlerFactory apiHandlerFactory = null)
+        {
+            EdmChangedObjectCollection changedObjectCollection = new EdmChangedObjectCollection(_entityType);
+            IEdmStructuralProperty[] keys = _entityType.Key().ToArray();


I think there must be a better approach than this. I was initially suspicious because of the ToArray call, but then I saw it makes sense because it is possible for keys to be enumerated multiple times. However, at least for the failed case, we are doing the same .Name deference for the keys. Maybe here we should do _entityType.Key().Select(key => key.Name).ToArray() so that we don't have to deference the name so many times? #Resolved

corranrogue9 · 2022-03-02T01:12:36Z

src/Microsoft.AspNet.OData.Shared/EdmODataAPIHandler.cs

+        /// <param name="createdObject">The created object (Typeless)</param>
+        /// <param name="errorMessage">Any error message in case of an exception</param>
+        /// <returns>The status of the TryCreate Method, statuses are <see cref="ODataAPIResponseStatus"/></returns>
+        public abstract ODataAPIResponseStatus TryCreate(IEdmChangedObject changedObject, out IEdmStructuredObject createdObject, out string errorMessage);


I would prefer the return type be a structure that has both ODataAPIResponseStatus and errorMessage as properties. I think it makes the pattern of having both return values clearer. Do you have any thoughts on this?

src/Microsoft.AspNet.OData.Shared/EdmODataAPIHandler.cs

corranrogue9 · 2022-03-02T01:16:07Z

src/Microsoft.AspNet.OData.Shared/EdmStructuredObject.cs

                {
+
+                    bool hasDefaultConstructor = (!clrType.IsClass) || clrType.GetConstructors(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static).
+                                                 Any(x => x.GetParameters().Count() == 0);


GetParameters returns an array, so calling Length instead of Count() should save us a cast

corranrogue9 · 2022-03-02T01:25:24Z

src/Microsoft.AspNet.OData.Shared/Formatter/Deserialization/ODataResourceDeserializer.cs

+
+                if (keySegment != null)
+                {
+                    foreach (KeyValuePair<string, object> key in keySegment.Keys)


I don't really see the value of doing this over keySegment.Keys.Select(key => new ODataProperty { Name = key.Key, Value = key.Value }).ToList(). If KeySegment has a count on it, then maybe it makes sense to initialize a new list with that capacity, but otherwise this just seems verbose.

corranrogue9 · 2022-03-02T01:42:54Z

src/Microsoft.AspNet.OData.Shared/Formatter/Deserialization/ODataResourceDeserializer.cs

+                    if (property == null && !readContext.DisableCaseInsensitiveRequestPropertyBinding)
+                    {
+                        //try case insensitive
+                        List<ODataProperty> candidates = resourceWrapper.ResourceBase.Properties.Where(p => String.Equals(p.Name, keyName, StringComparison.InvariantCultureIgnoreCase)).ToList();


I strongly suggest implementing an extension method on IEnumerable for this. I always thought it was weird that this wasn't the functionality for SingleOrDefault in the first place.

corranrogue9 · 2022-03-02T01:50:32Z

src/Microsoft.AspNet.OData.Shared/Formatter/Serialization/ODataDeltaFeedSerializer.cs

+
+                if (deletedResource != null)
+                {
+                    await writer.WriteStartAsync(deletedResource);


Do we need to continue execution on the same thread that awaited? I wonder if we want to call ConfigureAwait(false) here

src/Microsoft.AspNet.OData.Shared/IDeltaDeletedEntityObject.cs

corranrogue9 · 2022-03-02T02:51:03Z

src/Microsoft.AspNet.OData.Shared/NavigationPath.cs

+    /// <summary>
+    /// Navigation Path of an OData ID
+    /// </summary>
+    public class NavigationPath : List<PathItem>


I don't realize understand the need for the NavigationPath type in the first place, but we always seems to be operating on the end of the sequence, so maybe a stack makes more sense than list here?

corranrogue9 · 2022-03-02T02:52:48Z

src/Microsoft.AspNet.OData.Shared/ODataAPIHandler.cs

+    /// Handler Class to handle users methods for create, delete and update.
+    /// This is the handler for data modification where there is a CLR type.
+    /// </summary>
+    internal abstract class ODataAPIHandler<TStructuralType>: IODataAPIHandler where TStructuralType : class


It seems weird that we are constraining the generic type parameter to just class. Why is that restriction necessary? #ByDesign

It is used to handle delta request and it should be only for class types

corranrogue9 · 2022-03-02T02:54:26Z

src/Microsoft.AspNet.OData.Shared/ODataEdmAPIHandlerFactory.cs

+        /// </summary>
+        /// <param name="navigationPath">Navigation path corresponding to an odataid</param>
+        /// <returns></returns>
+        public abstract EdmODataAPIHandler GetHandler(NavigationPath navigationPath);


Does it make sense for GetHandler to be able to add new PathItems to navigationPath?

corranrogue9 · 2022-03-02T02:59:42Z

...t/Microsoft.Test.E2E.AspNet.OData/Build.AspNet/Formatter/ODataEntityReferenceLinkE2ETests.cs

+            "\"Author@odata.bind\":\"Authors(1)\"}";
+
+            string Uri = BaseAddress + "/odata/Books";
+            HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, Uri);


This implements IDisposable. Please wrap it in a using block

corranrogue9 · 2022-03-02T03:00:30Z

...t/Microsoft.Test.E2E.AspNet.OData/Build.AspNet/Formatter/ODataEntityReferenceLinkE2ETests.cs

+            request.Content.Headers.ContentType = MediaTypeWithQualityHeaderValue.Parse("application/json");
+
+            // Act
+            HttpResponseMessage response = await Client.SendAsync(request);


This also implements IDisposable. Please check for other types in the tests as well

pull-request-quantifier-deprecated · 2022-03-03T23:34:29Z

This PR has 5787 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       : +5285 -502
Percentile : 100%

Total files changed: 111

Change summary by file extension:
.csproj : +114 -43
.config : +103 -100
.cs : +4735 -333
.resx : +18 -0
.projitems : +25 -0
.bsl : +285 -24
.proj : +3 -0
.targets : +2 -2

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 detetcted.
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.

Sreejithpin and others added 27 commits October 28, 2021 14:49

Feature/new add support for odata bind (#2506)

7c3f404

* support for odata.bind * support for odata.bind

updates

cebba7f

small update

f9acd98

Code review comments

627276d

update for odataid _temp

6789fb9

updates

9286d98

updates to use only factory

0f85f26

updates

82823d0

Feature/new add support for odata bind (#2506)

f18e40f

* support for odata.bind * support for odata.bind

updates

5d2926a

Code review comments

8fe74af

update for odataid _temp

7670ab7

updates

cf028e4

updates to use only factory

76aec31

updates

5d20b2d

Merged updates

0a202ce

Update Microsoft.AspNetCore.OData.PublicApi.bsl

763e474

Update DeltaTests.cs

8b92a31

test update

847c235

test update

80d27dd

test update

4778fd0

test update

524b2c6

Update DeltaTests.cs

f0dbf65

Updates for 7.6 release

8b96a5b

pull-request-quantifier-deprecated bot added the Extra Large label Dec 2, 2021

Update WebStack.versions.settings.targets

c15e90a

xuzhg reviewed Dec 3, 2021

View reviewed changes

mikepizzo reviewed Jan 4, 2022

View reviewed changes

mikepizzo added 2 commits January 11, 2022 14:51

Improve logic for setting id on resourceWrapper using path and key va…

3c790d0

…lues, if specified

mikepizzo reviewed Jan 24, 2022

View reviewed changes

Sreejithpin and others added 4 commits February 1, 2022 12:58

Update ODataResourceDeserializer.cs

2d4ac72

New PR for Serializers for Bulk Operation with Updated ContextPath (#…

044fa48

…2618) * Temp commit * Updates

Updates

ca4750b

updates for casttype

3792f0c

corranrogue9 reviewed Mar 2, 2022

View reviewed changes

src/Microsoft.AspNet.OData.Shared/EdmODataAPIHandler.cs Show resolved Hide resolved

corranrogue9 reviewed Mar 2, 2022

View reviewed changes

src/Microsoft.AspNet.OData.Shared/IDeltaDeletedEntityObject.cs Show resolved Hide resolved

corranrogue9 reviewed Mar 2, 2022

View reviewed changes

updates

14e5111

xuzhg dismissed their stale review via 14e5111 March 8, 2022 19:33

		@@ -0,0 +1,115 @@
		// Copyright (c) Microsoft Corporation. All rights reserved.
		// Licensed under the MIT License. See License.txt in the project root for license information.

Conversation

Sreejithpin commented Dec 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

Uh oh!

xuzhg Dec 3, 2021 • edited by Sreejithpin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikepizzo Jan 4, 2022 • edited by Sreejithpin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikepizzo Jan 4, 2022 • edited by Sreejithpin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corranrogue9 Mar 2, 2022 • edited by Sreejithpin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corranrogue9 Mar 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corranrogue9 Mar 2, 2022 • edited by Sreejithpin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pull-request-quantifier-deprecated bot commented Mar 3, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

Reviewers

Assignees

Sreejithpin commented Dec 2, 2021 •

edited

Loading

xuzhg Dec 3, 2021 •

edited by Sreejithpin

Loading

mikepizzo Jan 4, 2022 •

edited by Sreejithpin

Loading

mikepizzo Jan 4, 2022 •

edited by Sreejithpin

Loading

corranrogue9 Mar 2, 2022 •

edited by Sreejithpin

Loading

corranrogue9 Mar 2, 2022 •

edited

Loading

corranrogue9 Mar 2, 2022 •

edited by Sreejithpin

Loading