1067384 - [Rooms] Handle multiple simple push urls at registration time

Status: RESOLVED FIXED

(Hello (Loop) :: Server, defect)

Description

[Alexis Metaireau (:alexis)]

https://wiki.mozilla.org/Loop/Architecture/Rooms#Loop_Server_API_Changes states that we should have multiple SP urls at registration time.

Comment 1

[Rémy Hubscher (:natim)]

So the proposed API is:

POST /registration HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: localhost:5000

{
    "callsSimplePushURL": "https://example.org/wg0asg83t_74s",
    "roomsSimplePushURL": "https://example.org/vnd7a85ls9gh"
}

Today's API is 

POST /registration HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: localhost:5000

{
    "simplePushURL": "https://example.org/wg0asg83t_74s"
}

I would like to make it looks like:

POST /registration HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Host: localhost:5000

{
    "simplePushURL": "https://example.org/wg0asg83t_74s",
    "simplePushURLs": {
        "calls": "https://example.org/vnd7a85ls9gh",
        "rooms": "https://example.org/mvc_9834dser"
    }
}

The idea behind that is to keep the current simplePushURL parameter to no break the API and use it as the default one if provided.

But also let the user define different SimplePushURLs per channels and let the ability in the future to add more channels.

So the simplePushURL will be optional and if provided used as the default SimplePushURL for all topics.
If the simplePushURLs is provided, topic inside will be set.

If one topic is missing a 400 error will be raised.

Does this would work for you?

Comment 2

[Rémy Hubscher (:natim)]

I mixed channels and topics for the same thing, also I think we should use topics in the future because channel are already used to define something else in loop-server.

Comment 3

[Adam Roach [:abr]]

(In reply to Rémy Hubscher (:natim) from comment #1)
> So the proposed API is:
> 
> POST /registration HTTP/1.1
> Accept: application/json
> Content-Type: application/json; charset=utf-8
> Host: localhost:5000
> 
> {
>     "callsSimplePushURL": "https://example.org/wg0asg83t_74s",
>     "roomsSimplePushURL": "https://example.org/vnd7a85ls9gh"
> }
> 
> Today's API is 
> 
> POST /registration HTTP/1.1
> Accept: application/json
> Content-Type: application/json; charset=utf-8
> Host: localhost:5000
> 
> {
>     "simplePushURL": "https://example.org/wg0asg83t_74s"
> }
> 
> I would like to make it looks like:
> 
> POST /registration HTTP/1.1
> Accept: application/json
> Content-Type: application/json; charset=utf-8
> Host: localhost:5000
> 
> {
>     "simplePushURL": "https://example.org/wg0asg83t_74s",
>     "simplePushURLs": {
>         "calls": "https://example.org/vnd7a85ls9gh",
>         "rooms": "https://example.org/mvc_9834dser"
>     }
> }
> 
> The idea behind that is to keep the current simplePushURL parameter to no
> break the API and use it as the default one if provided.
> 
> But also let the user define different SimplePushURLs per channels and let
> the ability in the future to add more channels.
> 
> So the simplePushURL will be optional and if provided used as the default
> SimplePushURL for all topics.
> If the simplePushURLs is provided, topic inside will be set.
> 
> If one topic is missing a 400 error will be raised.
> 
> Does this would work for you?

Sure, that seems reasonable. I'll update the wiki page when I get a moment (which might not be right away; this week will be pretty busy for me).

Just to make sure we have a common understanding of how this works: simplePushURL and simplePushURLs.call should have the same value. Is that what you expect also?

Comment 4

[Rémy Hubscher (:natim)]

Yes I have updated the wiki page: https://wiki.mozilla.org/Loop/Architecture/Rooms#Loop_Server_API_Changes

So basically if simplePushURL is provided, it will be used as simplePushURLs.calls

Comment 5

[Rémy Hubscher (:natim)]

Attachment: Link to Github PR — #207

Comment 6

[Alexis Metaireau (:alexis)]

Yes, that works for me, I prefer this way of dealing with it.

Comment 7

[Rémy Hubscher (:natim)]

https://github.com/mozilla-services/loop-server/commit/cadd7828ba092a34098eb78530b6584d59e76a9a

Comment 8

[Alexis Metaireau (:alexis)]

Comment on attachment 8490074 [details] [review]
Link to Github PR — #207

clearing the r? on myself. This landed already.