Fix relative context Uri resolution #1211

biaol-odata · 2018-07-13T00:41:40Z

Issues

This pull request fixes issue #1208.

Description

Fix error for relative context Uri resolution using the request uri passed in from the reader settings, applying similar logic from ODL-6.x branch.

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.

AlanWong-MS · 2018-07-13T01:00:40Z

...nalTests/Microsoft.OData.Core.Tests/ScenarioTests/Reader/JsonLight/RelativeUriReaderTests.cs

+            }
+        }
+
+        private ODataResource CreateResource1(Uri id = null)


Can we consolidate the CreateResource# into one method? #Closed

done.

In reply to: 202220090 [](ancestors = 202220090)

AlanWong-MS · 2018-07-13T01:06:19Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightContextUriParser.cs

            Uri contextUri;
-            if (!Uri.TryCreate(contextUriFromPayload, UriKind.Absolute, out contextUri))
+            if (!Uri.TryCreate(baseUri, contextUriFromPayload, out contextUri))


What will happen if contextUriFromPayload is absolute? I'm reading the API here and it says that the second Uri is relative. #ByDesign

I believe it might be some doc issue. The actual implementation of Uri.TryCreate(Uri, string, out Uri) first tries to convert the string to absolute uri first if possible; otherwise it tries to use the baseUri to resolve the string representing relative url to get the result. See here: https://github.com/Microsoft/referencesource/blob/master/System/net/System/UriExt.cs#L315
Added inline comment.

In reply to: 202220739 [](ancestors = 202220739)

Thanks for looking into this! #ByDesign

AlanWong-MS

Left some small comments.

… uri.

mikepizzo · 2018-07-19T22:51:24Z

src/Microsoft.OData.Core/ODataMessageReaderSettings.cs

+        /// <summary>
+        /// Gets or sets current request Uri.
+        /// </summary>
+        public Uri RequestUri { get; set; }


What's the relationship between the new RequestUri property and the existing BaseUri property? When does RequestUri get set? Can we just use BaseUri? #ByDesign

BaseUri is for Atom format and may be deprecated in the future. See

odata.net/src/Microsoft.OData.Core/ODataMessageReaderSettings.cs

Line 98 in 9d625ff

/// This URI will be used in ATOM format only, it would be overridden by <xml:base /> element in ATOM payload.

.

In reply to: 203896122 [](ancestors = 203896122)

The reason it was to be deprecated was because it was only used in Atom. The reason it was only used in Atom was because we previously didn't support relative URLs in JSON. Now that we support relative URLs in JSON, it seems like we should use this (existing) property, rather than deprecate it and add a new one for the same purpose.

In reply to: 204170332 [](ancestors = 204170332,203896122)

I tried using BaseUrl but it fails in multiple cases when the baseurl is the $metadata url, which is common, among other failing cases.

In reply to: 205241623 [](ancestors = 205241623,204170332,203896122)

mikepizzo · 2018-07-19T23:02:03Z

Does this fix the issue with OData Client? I don't see where RelativeUrl gets set in MessageWriterSettings.

Could it use BaseUri instead? #ByDesign

mikepizzo · 2018-07-19T23:05:15Z

src/Microsoft.OData.Core/JsonLight/ODataJsonLightContextUriParser.cs

        /// <param name="needParseFragment">Whether the fragment after $metadata should be parsed, if set to false, only MetadataDocumentUri is parsed.</param>
        /// <param name="throwIfMetadataConflict">Whether to throw if a type specified in the ContextUri is not found in metadata.</param>
+        /// <param name="baseUri">Optional value (with default value of null) of base Uri used for resolving the context url.
+        /// It should be a non-null value when resolving a top-level relative context Uri.


a top-level [](start = 57, length = 12)

Why call out "a top level"? Shouldn't it be non-null for resolving any relative context Url? Note that relative nested context urls should be resolved using the parent absolute contextUrl as a base; is this supported? #Resolved

Should be any relative context url. Removed "a top level".

In reply to: 203898403 [](ancestors = 203898403)

But changing the comment doesn't change how this works.
If I have a contextUrl nested within another contextUrl "scope", that nested context URL needs to be resolved relative to the outer contextUrl.

For example:

{
"@context" : "http://sampleservice/$externalMetadata#employees",
"value" : [
{
"id":"00001",
"name":"Kathy Smith",
...
"company" :
{
"@context": "#company",
"name":"FirstCompany"
}
}
]
}

or

{
"@context" : "http://sampleservice/externalMetadata#company",
"name":"FirstCompany",
"employees@context": "#employees"
"value" : [
{
"id":"00001",
"name":"Kathy Smith",
...
}
]
}

It's possible (likely) that our stack doesn't support this type of nested contextUrls, but I still want to make sure that we can support relative urls if we add support for nested context Urls in the future.

In reply to: 204168642 [](ancestors = 204168642,203898403)

Since we are not sure how exactly nested contextUrl is going to be supported, its relative url support should be part of the future task when it comes up. Right?

In reply to: 205245558 [](ancestors = 205245558,204168642,203898403)

biaol-odata · 2018-07-20T21:17:57Z

I believe the the ODataJsonLightContextUriParser.Parse() is invoked when client is reading the payload using reader settings. This change is to fix the issue of reading payload with relative url by, form example, OData Client; not the writing part.
See above related to BaseUri vs. RequestUri.

In reply to: 406439921 [](ancestors = 406439921)

mikepizzo · 2018-07-25T19:52:36Z

Sorry, I meant MessageReaderSettings.

How/where does RequestUri get set when using ODataClient to read a result with relative URLs?

In reply to: 406729387 [](ancestors = 406729387,406439921)

mikepizzo · 2018-07-25T20:11:06Z

This fix appears to be specific to the contextUrl. how do we resolve relative urls in nextLinks, edit/readLinks, mediaLInks, relationshipLinks, etc.? #Resolved

biaol-odata · 2018-07-25T21:19:02Z

See RelativeUriReaderTests.cs L249 as an example.

In reply to: 407874612 [](ancestors = 407874612,406729387,406439921)

biaol-odata · 2018-07-25T21:20:08Z

This issue is for relative contextUrl only, not including other relative urls.

In reply to: 407879722 [](ancestors = 407879722)

biaol-odata · 2018-07-25T21:29:15Z

@mikepizzo Please see replies above. Not sure why my replies to your comments seem to be dislocated on the web page. If you can open CodeFlow, you can see that they are aligned much better there. #Resolved

biaol-odata · 2018-08-30T22:24:53Z

🕐

nils · 2019-06-17T09:28:38Z

I'm also affected by this issue, is there any way I can help unblocking this pull request?

Tiberriver256 · 2021-01-07T13:37:04Z

Anything we can help out on with this PR @mikepizzo?

ruza-kavanka · 2021-11-25T11:33:07Z

Hi guys, I face the same issue, is there any progress? Thanks a lot!

biaol-odata requested review from raheph, mikepizzo, xuzhg and AlanWong-MS July 13, 2018 00:42

biaol-odata self-assigned this Jul 13, 2018

AlanWong-MS reviewed Jul 13, 2018

View reviewed changes

biaol-odata force-pushed the relativeContextUrl branch from 38c09ec to 3319a96 Compare July 13, 2018 18:02

AlanWong-MS previously approved these changes Jul 13, 2018

View reviewed changes

biaol-odata force-pushed the relativeContextUrl branch from 3319a96 to c92c1b8 Compare July 14, 2018 06:47

Fix error for relative context Uri resolution with additional request…

e483895

… uri.

biaol-odata force-pushed the relativeContextUrl branch from c92c1b8 to e483895 Compare July 17, 2018 23:12

mikepizzo reviewed Jul 19, 2018

View reviewed changes

Address CR comments.

d9e47be

xuzhg added the under-review label Oct 24, 2018

xuzhg added this to the 7.6 milestone Oct 24, 2018

KanishManuja-MS removed the Ready for review label Nov 6, 2018

biaol-odata added the Ready for review Use this label if a pull request is ready to be reviewed label Nov 12, 2018

madansr7 removed the Ready for review Use this label if a pull request is ready to be reviewed label Dec 17, 2018

madansr7 modified the milestones: 7.6, vNext Dec 17, 2018

madansr7 unassigned biaol-odata Dec 17, 2018

xuzhg force-pushed the master branch 2 times, most recently from f9519fd to 14a4b12 Compare September 22, 2019 21:12

nobyk mentioned this pull request Feb 12, 2022

#1208 Support relative context URI starting with "$metadata" #2313

Merged

2 tasks

KenitoInc dismissed AlanWong-MS’s stale review via d9e47be March 4, 2022 06:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix relative context Uri resolution #1211

Fix relative context Uri resolution #1211

biaol-odata commented Jul 13, 2018 •

edited

Loading

AlanWong-MS Jul 13, 2018 •

edited by mikepizzo

Loading

biaol-odata Jul 13, 2018

AlanWong-MS Jul 13, 2018 •

edited by biaol-odata

Loading

biaol-odata Jul 13, 2018 •

edited

Loading

AlanWong-MS Jul 13, 2018 •

edited by biaol-odata

Loading

AlanWong-MS left a comment

mikepizzo Jul 19, 2018 •

edited by biaol-odata

Loading

biaol-odata Jul 20, 2018

mikepizzo Jul 25, 2018

biaol-odata Jul 25, 2018

mikepizzo commented Jul 19, 2018 •

edited by biaol-odata

Loading

mikepizzo Jul 19, 2018 •

edited by biaol-odata

Loading

biaol-odata Jul 20, 2018

mikepizzo Jul 25, 2018 •

edited

Loading

biaol-odata Jul 25, 2018

biaol-odata commented Jul 20, 2018 •

edited

Loading

mikepizzo commented Jul 25, 2018

mikepizzo commented Jul 25, 2018 •

edited by biaol-odata

Loading

biaol-odata commented Jul 25, 2018

biaol-odata commented Jul 25, 2018

biaol-odata commented Jul 25, 2018 •

edited

Loading

biaol-odata commented Aug 30, 2018

nils commented Jun 17, 2019

Tiberriver256 commented Jan 7, 2021

ruza-kavanka commented Nov 25, 2021

Fix relative context Uri resolution #1211

Are you sure you want to change the base?

Fix relative context Uri resolution #1211

Conversation

biaol-odata commented Jul 13, 2018 • edited Loading

Issues

Description

Checklist (Uncheck if it is not completed)

Additional work necessary

AlanWong-MS Jul 13, 2018 • edited by mikepizzo Loading

Choose a reason for hiding this comment

biaol-odata Jul 13, 2018

Choose a reason for hiding this comment

AlanWong-MS Jul 13, 2018 • edited by biaol-odata Loading

Choose a reason for hiding this comment

biaol-odata Jul 13, 2018 • edited Loading

Choose a reason for hiding this comment

AlanWong-MS Jul 13, 2018 • edited by biaol-odata Loading

Choose a reason for hiding this comment

AlanWong-MS left a comment

Choose a reason for hiding this comment

mikepizzo Jul 19, 2018 • edited by biaol-odata Loading

Choose a reason for hiding this comment

biaol-odata Jul 20, 2018

Choose a reason for hiding this comment

mikepizzo Jul 25, 2018

Choose a reason for hiding this comment

biaol-odata Jul 25, 2018

Choose a reason for hiding this comment

mikepizzo commented Jul 19, 2018 • edited by biaol-odata Loading

mikepizzo Jul 19, 2018 • edited by biaol-odata Loading

Choose a reason for hiding this comment

biaol-odata Jul 20, 2018

Choose a reason for hiding this comment

mikepizzo Jul 25, 2018 • edited Loading

Choose a reason for hiding this comment

biaol-odata Jul 25, 2018

Choose a reason for hiding this comment

biaol-odata commented Jul 20, 2018 • edited Loading

mikepizzo commented Jul 25, 2018

mikepizzo commented Jul 25, 2018 • edited by biaol-odata Loading

biaol-odata commented Jul 25, 2018

biaol-odata commented Jul 25, 2018

biaol-odata commented Jul 25, 2018 • edited Loading

biaol-odata commented Aug 30, 2018

nils commented Jun 17, 2019

Tiberriver256 commented Jan 7, 2021

ruza-kavanka commented Nov 25, 2021

biaol-odata commented Jul 13, 2018 •

edited

Loading

AlanWong-MS Jul 13, 2018 •

edited by mikepizzo

Loading

AlanWong-MS Jul 13, 2018 •

edited by biaol-odata

Loading

biaol-odata Jul 13, 2018 •

edited

Loading

AlanWong-MS Jul 13, 2018 •

edited by biaol-odata

Loading

mikepizzo Jul 19, 2018 •

edited by biaol-odata

Loading

mikepizzo commented Jul 19, 2018 •

edited by biaol-odata

Loading

mikepizzo Jul 19, 2018 •

edited by biaol-odata

Loading

mikepizzo Jul 25, 2018 •

edited

Loading

biaol-odata commented Jul 20, 2018 •

edited

Loading

mikepizzo commented Jul 25, 2018 •

edited by biaol-odata

Loading

biaol-odata commented Jul 25, 2018 •

edited

Loading