Skip to content

Add series video management #1365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 19 commits into
base: next
Choose a base branch
from
Draft

Conversation

owi92
Copy link
Member

@owi92 owi92 commented Mar 18, 2025

This adds an interface to add and remove videos from series. The same interface can later also be used for playlists.
For series in particular, there are two constraints for videos to be added:

  • the user needs to have write access for that video
  • the video must not be part of any other series

Based on #1325 (and through that on #1313). These need to be reviewed and merged prior to this, which will be marked as draft util they are.

Resolves #355

owi92 added 19 commits March 12, 2025 11:07
This generalizes the `Nav` and `Details` code that
was used for videos, and repurposes it for series
as well.

With these changes, it should also be fairly
easy to add this for playlists later on.
This required a bunch of changes:
- The `update_acl` endpoint which talks to Opencast
  was generalized to work for both events and series,
  as their acl `put` endpoints pretty much work the same.
- The access page of events was refactored and most code
  is now usable for both events and series. This tries to
  walk the thin line between modularity and overspecialization
  by attempting to balance out reusablility and complexity,
  limiting both duplicated code and prop drilling.
This adds a somewhat generic function that can be used
to send `update metadata` put requests to Opencast for
both events and series, as their respective endpoints
only differ in one string (i.e. `series` vs `events`).

For now, the function is only used to update title and
description, but it can be used for any kind of dublincore
metadata.
This refactors the metadata form to be more generic. Again,
it's a tradeoff between limiting duplication and making the
code more complicated.

I also changed the naming convention of the series/video
details and access pages to use more specific names, which
will hopefully be less confusing.
This repurposes the `delete` endpoint previously used
by events, and basically mirrors everything done when
an event is deleted.

This means the series table is renamed to `all_series`
and gets a field `tobiraDeletionTimestamp`, which is
used to mark a series as deleted. The original series
table is moved to a view.

When a series is deleted in Tobira, the timestamp is saved
and series marked as deleted, but still present in Opencast
get a special entry in the `My series` table. Every other
place uses the series view without deleted series.

When the series is actually deleted in Opencast and removed
from the DB with sync, the entry from the `My series` table
also disappears.
This, once again, is a bunch of generalization to leverage
the fact that we already have basically all that is needed
for this.
While that makes it sound relatively simple, this was still
a lot of work, mostly to not just copy everything but factor
out as much as possible and make it usable for both events and
series, and possibly also playlists in the future.
There are still some things that need ironing out:
- There is a deserialization error where postgres complains
about a null value
- The translation/i18n doesn't seem to be working correctly for all
cases
This page uses the `series_by_id` api, which doesn't
use the new `thumbnailStack` field. It could, but that would
need some additional mapping in backend and should then
probably also be used in all other places that need
a series thumbnail.
That would have the added benefit of these thumbnails always
having the same order everywhere. Right now, that's not given
since the only place the `thumbnailStack` is used as of now
orders them in backend by their creation date (ascending),
which we don't do for the other occurences that are mapped in
frontend.
So this is super annoying. The endpoint in opencast will
start `republish metadata` workflows for each event in the
series. This takes roughly 10 second **per video**.
Not in parallel but.. in.. series (pun intended? idk).

So long story short, it could take several minutes to return,
at which point it probably just responds with a `503`.
The series is still being deleted though, so I don't know how
to handle that case.

Anyway, this workaround will send the request, mark the series
as deleted and then just return without waiting. If it fails,
it will **eventually** become apparent, but until then it's just
showing as `deletion pending`, or sth. Actually, depending on
the configured interval, it will already show `deletion failed`
after a couple of minutes or sooner, when the "deletion process"
is still running in Opencast. So all in all a poor solution but
idk what else to do here other than an Opencast rewrite™.
This could also be used for other purposes, but is
currently only used for displaying a message on
the "My series" table when a series gets deleted.
The notification will clear when the user navigates away
from the table.

This commit also fixes the table layout on narrow screens.
Previously, the table would squish the "Title" column
and overlap it with the one right next to it. Now each
column uses a fixed width on smaller screens and adds
a scrollbar, it it gets too crammed.
All this did was provide a timeout option and some states
that weren't even used in all cases. That really wasn't
worth the added complexity.

The timeout was moved to the `SubmitButtonWithStatus` and
when the states are really needed, they can be added in
the parent component that uses them.
This adds:
- a function to send a `create` request to Opencast
- the graphQL endpoint to call that function from the frontend

The function needs to be given ACL and a title as parameters,
and can be given a description. It then constructs the
metadata json that is expected by the Opencast endpoint and
appends this and the serialized ACL information.

The Opencast endpoint returns a new Opencast ID for the
series, which in conjunction with the title and ACL  can be
used to "prefigure" the series in Tobira.
Doing so allows a new series entry to be shown in the
"My series" table without having to wait for sync.
This route features an interface with can be used to configure
title, description and ACL for a new series and create said
series using the API endpoint from the previous commit.
This utilizes the recently added notification context
to show a note "Series has been created" on the
series details page. The user will be redirected to that
page after a series has been freshly created.
The note will clear when the user navigates away from
that page.
This adds the necessary logic to send metadata updates
about added and removed videos of a series to Opencast.
As with similar endpoints, the database in Tobira is
updated optimistically, so the user doesn't have to
wait for sync to see the updates reflected in the UI.
The core component of this is the table for adding and removing
videos from video lists. This is written in a way that should
allow it to also be used for playlists later on, by passing
a custom base mutation - though this will probably still need
further adjustments to make that truly the case. But these
adjustments should be made when that playlist feature is actually
getting implemented.

For series video management I had to add two new
query parameters to the video list selector. These can be used
to (a) set a boolean which when set will filter out all events
that are already part of a series, and (b) pass a list of
event ids that will also be filtered out (these are events that
are being added to the list but not submitted yet).
Copy link

This pull request has conflicts ☹
Please resolve those so we can review the pull request.
Thanks.

@github-actions github-actions bot added the status:conflicts This PR has conflicts that need to be resolved label Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:user User facing changes status:conflicts This PR has conflicts that need to be resolved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant