Feature: UrlQueryInfo and ExtUrlQueryInfo support #4578

JoaquinBCh · 2024-09-27T20:12:22Z

This PR implements UrlQueryInfo and ExtUrlQueryInfo

Summary

Implement includeInRequests and sameOriginOnly for ExtUrlQueryInfo
Implement useMPDUrlQuery and queryString for UrlQueryInfo and ExtUrlQueryInfo
Add support for urn:mpeg:dash:urlparam:2014 scheme in the manifest
Generate finalQueryStrings when a manifest update is triggered
Append finalQueryString to the request url in HTTPLoader
Create unit tests to validate useMPDUrlQuery, queryString, includeInRequests and sameOriginOnly

Assumptions

The initialQueryString is used to build the list of parameters added to the request, not the finalQueryString. The queryTemplate is not used for the initialQueryString, so it is not considered.
For mpd and mpdpatch requests, we return the query string from the properties configured at the manifest level. Properties configured at the Period, AdaptationSet, or Representation levels are not considered.
There is no distinction between mpd and mpdpatch when deciding whether to return a query string or not; both types of requests are treated the same.
For Media Segments or Initialization Segment requests, all properties configured up to the specific Representation level (manifest, period, adaptation set, and representation) are considered. Properties configured in periods or adaptation sets not related to the representation being requested are not considered.

Testing

Manifests with different UrlQuery configurations for testing:

UseMPDUrlQuery
- The property is added in the video AdaptationSet, and the query parameters present in the manifest request are replicated because useMPDUrlQuery="true".
QueryString
- A query string is added for the video AdaptationSet and in the 1080p Representation.
UseMPDUrlQuery and QueryString
- UseMPDUrlQuery is set to true in the AdaptationSet, and a query string is configured for the video. Therefore, the query parameters from the AdaptationSet are replicated, and those defined in the query string are added.
IncludeInRequests segment
- useMPDUrlQuery="true" in the video AdaptationSet, and includeInRequests is set to segment. The requests sent in the manifest are only added to segment requests.
IncludeInRequests mpd mpdpatch
- useMPDUrlQuery="true" in the video AdaptationSet, and includeInRequests is set to mpd and mpdpatch. The requests sent in the manifest are only added to mpd or mpdpatch requests.
SameOriginOnly different origin
- useMPDUrlQuery="true" and sameOriginOnly="true" in the video AdaptationSet. The origins of the subsequent requests are different from the manifest request, so the query parameters should not be added.
SameOriginOnly same origin
- useMPDUrlQuery="true" and sameOriginOnly="true" in the video AdaptationSet. The origins of the subsequent requests are the same as the manifest request, so the query parameters should be added.
AdaptationSet and Repressentation
- AdaptationSet and Representation with different queryStrings for the same query parameter. Duplicate query parameters are not added; instead, the query parameters from the Representation are used where they are configured.

A sample page has been created to test all the listed manifests and view the requests made by the player. You can access it here:
Sample Page for URL Query Info Testing

feature: urlQueryString first version returning initialQueryString params

dsilhavy · 2024-09-30T11:35:55Z

src/core/Settings.js

@@ -1058,6 +1058,7 @@ function Settings() {
                supportedEssentialProperties: [
                    { schemeIdUri: Constants.FONT_DOWNLOAD_DVB_SCHEME },
                    { schemeIdUri: Constants.COLOUR_PRIMARIES_SCHEME_ID_URI, value: /1|5|6|7/ },
+                    { schemeIdUri: Constants.URL_QUERY_INFO_SCHEME },


Add this to the JSDoc description. see line 77 - 81

dsilhavy · 2024-09-30T12:34:54Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+            const queryTemplate = essentialProperty?.ExtUrlQueryInfo?.queryTemplate || essentialProperty?.UrlQueryInfo?.queryTemplate || '';
+
+            const initialQueryParams = buildInitialQueryParams(initialQueryString);
+            if (queryTemplate === '$querypart$') {


Put $querypart$ in DashConstants

dsilhavy · 2024-09-30T12:59:42Z

src/streaming/net/HTTPLoader.js

@@ -89,6 +91,7 @@ function HTTPLoader(cfg) {
        cmsdModel = CmsdModel(context).getInstance();
        customParametersModel = CustomParametersModel(context).getInstance();
        commonAccessTokenController = CommonAccessTokenController(context).getInstance();
+        extUrlQueryInfoController = ExtUrlQueryInfoController(context).getInstance();


Please add the possibility to use dependency injection here instead of instantiation. Inject the singleton instance of extUrlQueryInfoController in the setConfig function, similar to what is done for commonAccessTokenController. This allows easier unit testing later if required.

dsilhavy · 2024-09-30T13:01:30Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+        mpd;
+
+
+    function generateQueryParams(resultObject, manifestObejc, propertyString, mpdUrlQuery, defaultInitialString) {


Private function use underscore syntax: _generateQueryParams

dsilhavy · 2024-09-30T13:01:41Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+        });
+    }
+
+    function parseQueryParams(queryParamString) {


Private function use underscore syntax

dsilhavy · 2024-09-30T13:08:48Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+                }
+            }
+        }
+        else if (request.type == 'MPD') {


Use types defined in HTTPRequest class and strong equality

dsilhavy · 2024-09-30T13:09:53Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+        }
+        else if (request.type == 'MPD') {
+            if (mpd) {
+                const inRequest = ['mpd', 'mpdpatch'].some(r => mpd.includeInRequests.includes(r));


These types should also go in DashConstants

dsilhavy · 2024-09-30T13:13:17Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+
+function ExtUrlQueryInfoController() {
+    let instance,
+        mpd;


Please rename mpd to something more descriptive like mpdQueryStringInformation or sth like that

dsilhavy · 2024-09-30T13:16:20Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+        mpd.finalQueryString = '';
+        const mpdUrlQuery = manifest.url.split('?')[1];
+
+        generateQueryParams(mpd, manifest, 'SupplementalProperty', mpdUrlQuery, '');


I don't quite understand this function. The EssentialProperty descriptor can also be present at MPD level from my understanding. In addition, the SupplementalProperty descriptor can be present on AdaptationSet and Representation level.

From the 23009-1:

As defined by this specification, each of these descriptors may be present at the MPD, Adaptation Set or at the Representation level. Only SupplementalProperty descriptor may be present at the Period level.

dsilhavy · 2024-09-30T13:19:57Z

src/streaming/controllers/ExtUrlQueryInfoController.js

+        mpd;
+
+
+    function generateQueryParams(resultObject, manifestObejc, propertyString, mpdUrlQuery, defaultInitialString) {


Typo manifestObejc

dsilhavy · 2024-09-30T13:27:01Z

@JoaquinBCh : Thanks for the PR i added my review. In addition:

IncludeInRequests mpd mpdpatch does not seem to work correctly. I see query parameters being appended to media segment requests
@ZmGorynych: The reference content uses urn:mpeg:dash:urlparam:2014 instead of urn:mpeg:dash:schema:urlparam:2016 for up:ExtUrlQueryInfo. This does not seem to be specification compliant. @JoaquinBCh The urn:mpeg:dash:schema:urlparam:2016 needs to be added to the implementation as well.

dsilhavy · 2024-09-30T14:05:58Z

One more thing: Please add the sample page you implemented to the sample section in the advanced category: https://reference.dashif.org/dash.js/nightly/samples/

sebastianpiq and others added 4 commits September 4, 2024 16:52

Implement template for the UrlQueryInfo feature

c9127da

Url query info/initial query string (#25)

7bfa80c

feature: urlQueryString first version returning initialQueryString params

fix: code refactor

3fb0ace

Merge branch 'development' into feature/UrlQueryInfo

75de943

dsilhavy added this to the 5.0.0 milestone Sep 28, 2024

nicolaslevy mentioned this pull request Sep 28, 2024

Support Annex I: Flexible Insertion of URL Parameters #4440

Open

dsilhavy requested changes Sep 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: UrlQueryInfo and ExtUrlQueryInfo support #4578

Feature: UrlQueryInfo and ExtUrlQueryInfo support #4578

JoaquinBCh commented Sep 27, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy Sep 30, 2024

dsilhavy commented Sep 30, 2024

dsilhavy commented Sep 30, 2024

		mpd;


		function generateQueryParams(resultObject, manifestObejc, propertyString, mpdUrlQuery, defaultInitialString) {

Feature: UrlQueryInfo and ExtUrlQueryInfo support #4578

Are you sure you want to change the base?

Feature: UrlQueryInfo and ExtUrlQueryInfo support #4578

Conversation

JoaquinBCh commented Sep 27, 2024

Summary

Assumptions

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsilhavy commented Sep 30, 2024

dsilhavy commented Sep 30, 2024