Add additional features for Tobira integration #878

owi92 · 2024-08-12T13:41:11Z

This adds most of the additional requirements in #311.
Needs elan-ev/tobira#1225 and opencast/opencast#6091 to work correctly.
Only the last 7 10 commits need to be reviewed here, as the rest is based on #313.

Key changes/features:
(Edit: see updated screenshots in my comment further below)

The event details modal now has a Tobira tab which provides a direct link and list any pages in Tobira that feature the event:
The Tobira tab of the series details modal got the addition of an "edit path" button that lets admins edit paths of series that are already mounted in Tobira (with the condition that the page where the series is mounted does not contain any other blocks)
Selectable pages for adding and moving (i.e. updating the path of) series now feature an additional checkbox that shows which page is currently selected (and selectable at all)

Notable omissions/deviations:

@oas777 suggested to also add editing host-page paths of events. While technically possible, we don't allow choosing a host-page for events via the admin UI in the first place, so that would need to be added first. This needs some discussing and is currently out of scope for this PR.
@dagraf suggested adding a green checkmark when creating new subpages for hosting a series. Clicking that would then confirm the creation and disable editing the title and path. I decided against that since I already added the checkbox as per David's other suggestion, which serves a similar purpose. I feel like adding yet another checkmark to that is unnecessary and may wrongly suggest that the path will already be created when that is clicked.

If these omissions are dealbreakers, we should discuss them in an upcoming meeting.

Note: This PR is based on #313 which adds the Tobira integration. That should definitely be merged prior to this one! (it's only been open for like 4 months..)
I'll mark this as a draft until #313 is merged.
Closes #311

github-actions · 2024-08-12T13:42:30Z

Use docker or podman to test this pull request locally.

Run test server using develop.opencast.org as backend:

podman run --rm -it -p 127.0.0.1:3000:3000 ghcr.io/opencast/opencast-admin-interface:pr-878

Specify a different backend like stable.opencast.org:

podman run --rm -it -p 127.0.0.1:3000:3000 -e PROXY_TARGET=https://stable.opencast.org ghcr.io/opencast/opencast-admin-interface:pr-878

It may take a few seconds for the interface to spin up.
It will then be available at http://127.0.0.1:3000.
For more options you can pass on to the proxy, take a look at the README.md.

github-actions · 2024-08-12T14:55:44Z

This pull request is deployed at test.admin-interface.opencast.org/878/2024-10-29_16-08-10/ .
It might take a few minutes for it to become available.

owi92 · 2024-08-13T17:26:36Z

I tried to make the Tobira tabs a little less "matryoschka"-like, as suggested in todays technical Meeting. This does however mean that these tabs won't follow the design examples set by other tabs.

They are still built like russian dolls (I didn't come up with that analogy but it's fitting).
Though I think that should be fixed in another PR.

Some updated screenshots:

github-actions · 2024-09-02T15:11:50Z

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

) This is necessary for an upcoming admin UI feature which will allow admins to change the path of series pages with no other blocks (part of opencast/opencast-admin-interface#311). This shouldn't break any existing behaviour. Related Opencast and admin UI PRs: opencast/opencast#6091, opencast/opencast-admin-interface#878.

github-actions · 2024-10-15T15:06:59Z

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

This adds - a) an endpoint to get paths of pages in Tobira that host an event - b) an endpoint to update the path of a series in Tobira This shouldn't break any existing behaviour. These are needed for additional requirements of opencast/opencast-admin-interface#311. Corresponding Tobira and admin-UI PRs: elan-ev/tobira#1225, opencast/opencast-admin-interface#878. ### Your pull request should… * [ ] have a concise title * [ ] [close an accompanying issue](https://docs.opencast.org/develop/developer/#participate/development-process/#automatically-closing-issues-when-a-pr-is-merged) if one exists * [ ] [be against the correct branch](https://docs.opencast.org/develop/developer/development-process#acceptance-criteria-for-patches-in-different-versions) * [ ] include migration scripts and documentation, if appropriate * [ ] pass automated tests * [ ] have a clean commit history * [ ] [have proper commit messages (title and body) for all commits](https://medium.com/@steveamaza/e028865e5791)

Arnei

Found a page crasher:

Go to the tobira tab in either the series details or when creating a new series.
Click on the "+ add subpage" button.
Try to switch to a different page (e.g. from a subpage to the homepage)
Observe blank page and "Uncaught Error: Maximum update depth exceeded." in the browser console.

Arnei

This is an event without a series, so "Mount series" does not make sense here? Should it say "Mount event"? Also when clicking on the "Mount series" button and trying to mount, the mount post request seems to fail.

owi92 · 2024-10-29T15:57:36Z

Found a page crasher (...)

Hm I can't reproduce that. Is this happening every time you try that, even with a freshly started Admin UI, or are there some actions done before that might possibly provoke this?

This is an event without a series, so "Mount series" does not make sense here? Should it say "Mount event"? Also when clicking on the "Mount series" button and trying to mount, the mount post request seems to fail.

Yeah that shouldn't be there. Mounting events via Admin UI is not a thing (yet).

Arnei

Nitpicks below. Looks good generally.

src/components/events/partials/ModalTabsAndPages/DetailsTobiraTab.tsx

src/slices/shared/tobiraErrors.ts

Arnei · 2024-10-29T16:24:28Z

Hm I can't reproduce that. Is this happening every time you try that, even with a freshly started Admin UI, or are there some actions done before that might possibly provoke this?

Was happening consistently for me.

Arnei · 2024-10-29T16:26:04Z

Quick screencap: Bildschirmaufzeichnung vom 2024-10-29 17-25-18.webm

Edit: I now see that my mouse is missing, hope this is clear enough anyway (the last click is on "Homepage")

This adapts the Tobira details component from series details to be usable in both series and event context. Note that an Opencast patch (todo: link that patch) is necessary for this to work.

This was requested by Bern. It is still possible to select and deselect the path by clicking it's name, but next to that a checkbox was added for visual clarity. The checkbox is only shown when the path can be selected (the page needs to be empty).

github-actions · 2024-11-06T16:21:40Z

Use docker or podman to test this pull request locally.

Run test server using develop.opencast.org as backend:

podman run --rm -it -p 127.0.0.1:3000:3000 ghcr.io/opencast/opencast-admin-interface:pr-878

Specify a different backend like stable.opencast.org:

podman run --rm -it -p 127.0.0.1:3000:3000 -e PROXY_TARGET=https://stable.opencast.org ghcr.io/opencast/opencast-admin-interface:pr-878

It may take a few seconds for the interface to spin up.
It will then be available at http://127.0.0.1:3000.
For more options you can pass on to the proxy, take a look at the README.md.

owi92

I have added a commit that might fix the crashing error you reported, but I can't say for sure.

src/components/events/partials/ModalTabsAndPages/DetailsTobiraTab.tsx

src/slices/shared/tobiraErrors.ts

github-actions · 2024-11-06T16:22:24Z

This pull request is deployed at test.admin-interface.opencast.org/878/2024-11-06_16-20-35/ .
It might take a few minutes for it to become available.

Arnei · 2024-11-07T08:21:29Z

I have added a commit that might fix the crashing error you reported, but I can't say for sure.

Now crashes with a different error, see below. When creating a news series, this error also occurs immediately upon switching to the tobira tab.

Uncaught TypeError: formik.values.breadcrumbs[(formik.values.breadcrumbs.length - 1)] is undefined
    NewTobiraPage NewTobiraPage.tsx:148
    React 15
    nextPage NewSeriesWizard.tsx:107
    onClick NewAccessPage.tsx:364
    React 15
NewTobiraPage.tsx:148:6

This factors out some code and applies some (yet non-inforced) linting rules, ES6 syntax and formatting to limit some indentation levels and improve readability.

Another feature requested by Bern, this adds the necessary API and UI functions/components to edit existing series paths. Editing is only allowed if the page with that path has no other blocks than that of the series.

This pulls the code into a component to limit duplication. The component can be used when "cancel" and "save" buttons are needed in modal tabs that allow editing things like access policies. This makes it easier to reuse and limits duplicated code.

Most notably the series title (in Tobira context) was made optional, so we don't have to pass an empty string to Tobira when it's not specified.

This came up and was suggested in the technical meeting. It does however mean that the Tobira tab will not really follow the examplary design-"principles" of the other tabs.

Previously I had them hidden if they couldn't be checked. After some feedback from Bern we decided to show them anyway, but add a tooltip to explain why they can't be checked. The disabled style isn't really that striking or self explanatory. I hope this will prevent at least some confusion.

503 errors mean that Tobira either isn't configured, or not configured correcty in Opencast. Unfortunately, it doesn't distinguish between the two. Since it might very well be the former, I think we shouldn't show the error as a notification in the UI. Instead there will be an info in console saying "Tobira isn't configured (correctly)" and the Tobira tab will be hidden. This solution isn't optimal but I think it's the best we can do for now. The other errors (404, 500) will trigger notifications that are shown in the respective Tobira tab.

Something was causing a crash when using the breadcrumb links to navigate to another page in the path editing menu while being in "edit mode" (i.e. in the process of adding a new page). This resulted in a "Maximum update depth exceeded" error, crashing the interface. The error hints at circular rendering dependendies, but unfortunately I couldn't reproduce this myself. But by attempting to do that I noticed another bug that may or may not be related: The list of children was missing an entry. I removed the code doing that, since it didn't seem to be necessary anyway - this also removed a state setting call that might have caused too many rerenders.

owi92 · 2024-11-07T09:33:56Z

Yeah ok, that I could reproduce. Made a silly code change 🤦 , but should be unrelated to the other crash.

github-actions · 2024-11-07T09:34:10Z

Use docker or podman to test this pull request locally.

Run test server using develop.opencast.org as backend:

podman run --rm -it -p 127.0.0.1:3000:3000 ghcr.io/opencast/opencast-admin-interface:pr-878

Specify a different backend like stable.opencast.org:

podman run --rm -it -p 127.0.0.1:3000:3000 -e PROXY_TARGET=https://stable.opencast.org ghcr.io/opencast/opencast-admin-interface:pr-878

It may take a few seconds for the interface to spin up.
It will then be available at http://127.0.0.1:3000.
For more options you can pass on to the proxy, take a look at the README.md.

github-actions · 2024-11-07T09:35:11Z

This pull request is deployed at test.admin-interface.opencast.org/878/2024-11-07_09-33-13/ .
It might take a few minutes for it to become available.

This was referenced Aug 12, 2024

Change mount_series endpoint to accept and move existing series elan-ev/tobira#1225

Merged

Add more admin-UI Tobira endpoints opencast/opencast#6091

Merged

owi92 added the type:enhancement New feature or request label Aug 12, 2024

owi92 force-pushed the tobira-things branch 2 times, most recently from eb18e6e to 89d6d5f Compare August 12, 2024 14:54

owi92 force-pushed the tobira-things branch from 89d6d5f to ccdd703 Compare August 13, 2024 15:00

owi92 force-pushed the tobira-things branch 5 times, most recently from 3838172 to 9f543db Compare August 15, 2024 09:54

github-actions bot added the status:conflicts label Sep 2, 2024

Arnei mentioned this pull request Sep 5, 2024

Port Tobira integration #313

Merged

owi92 force-pushed the tobira-things branch from 9f543db to fc0ebb0 Compare September 18, 2024 09:45

github-actions bot removed the status:conflicts label Sep 18, 2024

owi92 force-pushed the tobira-things branch from fc0ebb0 to 3ca089a Compare September 30, 2024 11:13

github-actions bot added the status:conflicts label Oct 15, 2024

owi92 force-pushed the tobira-things branch from 3ca089a to bbff0ac Compare October 21, 2024 15:31

github-actions bot removed the status:conflicts label Oct 21, 2024

JulianKniephoff mentioned this pull request Oct 28, 2024

Tobira Integration #311

Closed

owi92 force-pushed the tobira-things branch from bbff0ac to c3a59e2 Compare October 28, 2024 14:08

owi92 marked this pull request as ready for review October 29, 2024 12:15

Arnei requested changes Oct 29, 2024

View reviewed changes

owi92 force-pushed the tobira-things branch from c3a59e2 to 773ab77 Compare October 29, 2024 16:08

Arnei requested changes Oct 29, 2024

View reviewed changes

owi92 added 2 commits October 30, 2024 12:36

Add Tobira tab to event details modal

f1de4a6

This adapts the Tobira details component from series details to be usable in both series and event context. Note that an Opencast patch (todo: link that patch) is necessary for this to work.

owi92 force-pushed the tobira-things branch from 773ab77 to b10c984 Compare November 6, 2024 16:20

owi92 commented Nov 6, 2024

View reviewed changes

src/components/events/partials/ModalTabsAndPages/DetailsTobiraTab.tsx Outdated Show resolved Hide resolved

src/slices/shared/tobiraErrors.ts Show resolved Hide resolved

owi92 added 9 commits November 7, 2024 10:29

Reformat/-factor some Tobira related files

0695129

This factors out some code and applies some (yet non-inforced) linting rules, ES6 syntax and formatting to limit some indentation levels and improve readability.

Make tobira series path editable

1f016a2

Another feature requested by Bern, this adds the necessary API and UI functions/components to edit existing series paths. Editing is only allowed if the page with that path has no other blocks than that of the series.

Adjust some typings

63bf776

Most notably the series title (in Tobira context) was made optional, so we don't have to pass an empty string to Tobira when it's not specified.

Adjust markup to be less matryoschka-like

18f9078

This came up and was suggested in the technical meeting. It does however mean that the Tobira tab will not really follow the examplary design-"principles" of the other tabs.

Allow mounting previously unmounted series

3b81870

owi92 force-pushed the tobira-things branch from b10c984 to 45814db Compare November 7, 2024 09:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add additional features for Tobira integration #878

Add additional features for Tobira integration #878

owi92 commented Aug 12, 2024 •

edited

Loading

github-actions bot commented Aug 12, 2024

github-actions bot commented Aug 12, 2024 •

edited

Loading

owi92 commented Aug 13, 2024

github-actions bot commented Sep 2, 2024

github-actions bot commented Oct 15, 2024

Arnei left a comment

Arnei left a comment

owi92 commented Oct 29, 2024

Arnei left a comment

Arnei commented Oct 29, 2024

Arnei commented Oct 29, 2024 •

edited

Loading

github-actions bot commented Nov 6, 2024

owi92 left a comment

github-actions bot commented Nov 6, 2024

Arnei commented Nov 7, 2024

owi92 commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

Add additional features for Tobira integration #878

Are you sure you want to change the base?

Add additional features for Tobira integration #878

Conversation

owi92 commented Aug 12, 2024 • edited Loading

github-actions bot commented Aug 12, 2024

github-actions bot commented Aug 12, 2024 • edited Loading

owi92 commented Aug 13, 2024

github-actions bot commented Sep 2, 2024

github-actions bot commented Oct 15, 2024

Arnei left a comment

Choose a reason for hiding this comment

Arnei left a comment

Choose a reason for hiding this comment

owi92 commented Oct 29, 2024

Arnei left a comment

Choose a reason for hiding this comment

Arnei commented Oct 29, 2024

Arnei commented Oct 29, 2024 • edited Loading

github-actions bot commented Nov 6, 2024

owi92 left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 6, 2024

Arnei commented Nov 7, 2024

owi92 commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

github-actions bot commented Nov 7, 2024

owi92 commented Aug 12, 2024 •

edited

Loading

github-actions bot commented Aug 12, 2024 •

edited

Loading

Arnei commented Oct 29, 2024 •

edited

Loading