search

uisautomation / media-webapp

Web application for the University Media Platform
https://alpha.media.cam.ac.uk
MIT License
4 stars 7 forks source link

Add a playlist embed view #404

Closed rjw57 closed 5 years ago

rjw57 commented 5 years ago

This PR is big. Sorry. I've spent some time trying to split it down into commits which can be understood individually. Generally there are individual commits which implement various bits of infrastructure and then a commit which makes use of it. If you review better seeing the use of components before looking at their implementation I recommend you review from the last commit back. If you review better by looking at components first and then seeing how they are put together, review from the first commit forward.

Note that GitHub is very poor at ordering commits properly. I recommend using local tooling.

This PR is so large because we change the way we handle embedding. Instead of using traditional Django templates, we render the embed view now like any other UI view. To this end the UI implements a specialised API which can be used to get configuration for the JWPlayer JavaScript API. This API is used by the frontend to configure the JWPlayer API manually rather than relying on JWPlatform to do it for us.

This gives us a nice degree of flexibility in how we structure the UI and lets us add our own playlist UI in the embed view.

Some time has been taken to perform JWPlayer integration "the React way" so that the various bits of the UI are decoupled from each other.

Since the media and playlist embed pages are so similar, a lot of the shared functionality has been broken out into generic components along with specialisations.

I've taken some care to write long commit messages for the trickier commits and tried to document what is going on through comments but ultimately some of this code is quite complex and may take a little time to get one's head around. I'm sorry for this but I don't think the problem can be solved in a simpler way without either a) copying and pasting a lot of code between the playlist and media embed pages or b) having to have everything JWPlayer related in a single "mega component".

If you are having trouble following what a component does, I suggest seeing how it is used in the rest of the code.

I've tested the playlist UI in Firefox on my machine and in IE11 on Windows 7 via browser stack.

It is also worth testing that the legacy embeds have not broken.

Closes #356. Closes #360.

rjw57 commented 5 years ago

Closing as I opened the PR from the wrong fork.