Introduce ability to pass platform parameter to the login request

[piterfm]

The mobile team needs to write a thorn test to verify the /metadata endpoint. For that, the test setup needs to login as a mobile user. Add ability to specify the platform parameter for the test set-up proc.

[rhoggSugarcrm]

@piterfm just want to make sure we have all the requirements here. My understanding is:

• Mobile logs in by adding platform=mobile to all OAuth2 login requests
• Mobile adds platform=mobile to all refresh requests

Let me know if there's a misunderstanding or there are any other requirements that I'm missing.

Thanks!

[piterfm]

@rhoggSugarcrm that's correct.

[jcsmorais]

Currently we support Agent.as(username) which does two different things:

1. creates and logs username in, if he's not instantiated yet
2. If there's already a UserAgent instance associated with given username, that same instance is returned

Both login and refresh flows currently work under the assumption that platform is undefined, meaning it defaults to whatever the server decides, in this case base.

We can introduce support for this to be configurable at the Agent layer, where by default it remains undefined, but if one states that Agent.platform = 'base'; all subsequent Agent.as calls that fall into 1. (above) are going to use that same platform for both login and refresh flows.

Thoughts @rhoggSugarcrm , @khigakisugar, @yvan33 ?

[rhoggSugarcrm]

At first glance, that sounds significantly better then the approach of complicating the Agent.as interface.

Here's something Joao whiteboarded for me earlier today:

let joao = Agent.as('Joao'); // defaults to base
Agent.platform = 'mobile';
let bob = Agent.as('Bob'); // Bob is logged in as mobile. Joao remains logged in as base.

[rhoggSugarcrm]

Side note: This will probably also allow us to test Portal using Thorn.