1361375 - implement query string options for the testAuthenticate endpoint

Status: RESOLVED WONTFIX

(Taskcluster :: Services, enhancement, P4)

Description

[John Ford [:jhford] CET/CEST Berlin Time]

https://docs.taskcluster.net/reference/platform/taskcluster-auth/references/api#testAuthenticate

I'd like to be able to test that query string options don't interfere with authentication while working on the python client.  Since this is the method we're using to do client auth tests, I'd like to ensure that the code that I'm adding to inject the options into the query string are not breaking signed URLs, which also have query string additions.

Comment 1

[Dustin J. Mitchell [:dustin] (he/him)]

Is this still useful?  It sounds pretty quick -- maybe easier to just make a PR than to describe what you're looking for?

Comment 2

[Jonas Finnemann Jensen (:jonasfj)]

I think this might be a good first bug.

Comment 3

[John Ford [:jhford] CET/CEST Berlin Time]

Yes, I think it's still useful to be able to test query string stuff.

Comment 4

[Dustin J. Mitchell [:dustin] (he/him)]

Can you explain the request a little more?  I don't understand what to do based on comment 0.

Comment 5

[Jonas Finnemann Jensen (:jonasfj)]

I think the request is that the testAuthenticate end-point show allow for a query string option, so that authentication with querystrings can be tested too.

Comment 6

[John Ford [:jhford] CET/CEST Berlin Time]

If I remember correctly, this endpoint is used to smoketest various clients.  What I'd like is to have a smoketest style endpoint where I can pass in query string options to ensure that all the various query string parsing operations I have work correctly.

Comment 7

[Chris Cooper [:coop] (he/him)]

John: are you willing to mentor this if someone comes knocking?

Comment 8

[John Ford [:jhford] CET/CEST Berlin Time]

sure!

Comment 9

[Sudipt Dabral [:sudipt]]

I would like on this bug ! Some pointers would be really helpful ! Thanks

Comment 10

[Dustin J. Mitchell [:dustin] (he/him)]

John, can you provide some pointers to sudipt?

Comment 11

[John Ford [:jhford] CET/CEST Berlin Time]

Sure!

The method is located here:

https://github.com/taskcluster/taskcluster/blob/c7670d403092259fe67ac1010e95275a09088e92/services/auth/src/v1.js#L1022

The request object has query string parameters which are used similar to:

https://github.com/taskcluster/taskcluster/blob/c7670d403092259fe67ac1010e95275a09088e92/services/index/src/api.js#L191

That request object is documented here:

https://expressjs.com/en/api.html#req

and here:

https://nodejs.org/api/http.html#http_class_http_incomingmessage

As for the goal of this bug, this endpoint is used to test API clients. I think being able to set a query string parameter (e.g. ?qs1=abcde) and have that echoed back as a response header verbatim (e.g. 'X-QS1: abcde') would be really helpful.

Comment 12

[Sudipt Dabral [:sudipt]]

Thanks a lot ! Will start working on this asap>

Comment 13

[Sudipt Dabral [:sudipt]]

Are the headers we are setting , somewhat related to the artifacts as given in

https://docs.taskcluster.net/docs/manual/tasks/artifacts

and setting HTTP entity , as described in

https://stackoverflow.com/questions/9197745/what-exactly-is-an-http-entity

Comment 14

[Dustin J. Mitchell [:dustin] (he/him)]

Per discussion in the PR, we're going to call this WONTFIX at this point.