Send an "edited" event to all viewers when an "edit" event occurred in the streaming plugin

[amoizard]

When someone sends an "edit" request to modify a streaming plugin mountpoint, viewers are not aware of the "edit".

This PR is used within our deployments so that all viewers will receive an "edited" event containing the id, permanent and metadata parameters. There are 2 purposes: being aware of a change for the mountpoint definition and retrieving immediately the updated metadata, if any.

{
"streaming" : "edited",
"id" : ,
"permanent" : <true|false, depending on whether the changes were saved to configuration file or not>
"metadata" : "<updated metadata for the mountpoint; optional>",
}

Feel free to send any comments.
Kind Regards,

[januscla]

Thanks for your contribution, @amoizard! Please make sure you sign our CLA, as it's a required step before we can merge this.

[lminiero]

Thanks for the contribution, but I'd rather this functionality was optional, possibly as an argument passed to edit itself and false by default for backwards compatibility. There may be reasons why a mass notification is not wanted, and I don't want to force it on people.

On the PR itself, the documentation says "permanent" is sent as well, but that's not the case: in the code you only push "metadata". I'm personally ok with that, as I don't see why users would care about a change being permanent or not. Besides, I'd only send an update on "metadata" if a new "metadata" was provided in the first place: if you send an edit that changes other things and not "metadata", why send an event to everyone about something that stayed the same?

[amoizard]

Hi Lorenzo,

Following your advise, I pushed another commit:

• I have added an optional edited_event (false by default) in the edit request.
• I have also made sure that the edited event will not be sent if there is no update of the metadata parameter.
• I have fixed the documentation by removing the extra permanent parameter.
• I finally updated the documentation with the new edited_event parameter for the edit request.

Thanks!

[lminiero]

Thanks for the fixes! I've noticed a few other things, which you can find below. Mostly editorial, so nothing big!

[amoizard]

The newer commit should take into account all your comments.

I also added new_metadata to the object that performs the automated validation checks on incoming JSON payloads.
It seems it was also missing there?

[lminiero]

I also added new_metadata to the object that performs the automated validation checks on incoming JSON payloads.
It seems it was also missing there?

Thanks and good catch!

[lminiero]

Thanks again, merging then 👍