Skip to content
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

Add utility functions for building GraphQL event and series IDs #981

Merged
merged 2 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions frontend/src/routes/Embed.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Translation, useTranslation } from "react-i18next";
import { graphql, PreloadedQuery, usePreloadedQuery } from "react-relay";
import { unreachable } from "@opencast/appkit";

import { isSynced } from "../util";
import { eventId, isSynced } from "../util";
import { GlobalErrorBoundary } from "../util/err";
import { loadQuery } from "../relay";
import { makeRoute } from "../rauta";
Expand Down Expand Up @@ -46,9 +46,8 @@ export const EmbedVideoRoute = makeRoute(url => {
return null;
}
const videoId = decodeURIComponent(params[1]);
const eventId = `ev${videoId}`;

const queryRef = loadQuery<EmbedQuery>(query, { id: eventId });
const queryRef = loadQuery<EmbedQuery>(query, { id: eventId(videoId) });

return {
render: () => <ErrorBoundary>
Expand Down
5 changes: 3 additions & 2 deletions frontend/src/routes/Search.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { MissingRealmName } from "./util";
import { ellipsisOverflowCss } from "../ui";
import { COLORS } from "../color";
import { BREAKPOINT_SMALL } from "../GlobalStyle";
import { keyOfId } from "../util";


export const isSearchActive = (): boolean => document.location.pathname === "/~search";
Expand Down Expand Up @@ -195,8 +196,8 @@ const SearchEvent: React.FC<SearchEventProps> = ({
// TODO: decide what to do in the case of more than two host realms. Direct
// link should be avoided.
const link = hostRealms.length !== 1
? `/!v/${id.slice(2)}`
: `${hostRealms[0].path.replace(/^\/$/, "")}/v/${id.slice(2)}`;
? `/!v/${(keyOfId(id))}`
: `${hostRealms[0].path.replace(/^\/$/, "")}/v/${keyOfId(id)}`;

return (
<Item key={id} link={link}>
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/routes/Series.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { RootLoader } from "../layout/Root";
import { Nav } from "../layout/Navigation";
import { PageTitle } from "../layout/header/ui";
import { WaitingPage } from "../ui/Waiting";
import { isSynced } from "../util";
import { isSynced, seriesId } from "../util";

import { NotFound } from "./NotFound";
import { SeriesByOpencastIdQuery } from "./__generated__/SeriesByOpencastIdQuery.graphql";
Expand Down Expand Up @@ -65,7 +65,7 @@ export const DirectSeriesRoute = makeRoute(url => {
rootRealm { ... NavigationData }
}
`;
const queryRef = loadQuery<SeriesByIdQuery>(query, { id: `sr${id}` });
const queryRef = loadQuery<SeriesByIdQuery>(query, { id: seriesId(id) });


return {
Expand Down
7 changes: 3 additions & 4 deletions frontend/src/routes/Video.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import {
translatedConfig,
currentRef,
secondsToTimeString,
eventId,
} from "../util";
import { BREAKPOINT_SMALL, BREAKPOINT_MEDIUM } from "../GlobalStyle";
import { Button, LinkButton } from "../ui/Button";
Expand Down Expand Up @@ -102,8 +103,7 @@ export const VideoRoute = makeRoute(url => {
}
`;
const realmPath = "/" + realmPathParts.join("/");
const eventId = `ev${videoId}`;
const queryRef = loadQuery<VideoPageInRealmQuery>(query, { id: eventId, realmPath });
const queryRef = loadQuery<VideoPageInRealmQuery>(query, { id: eventId(videoId), realmPath });

return {
render: () => <RootLoader
Expand Down Expand Up @@ -154,8 +154,7 @@ export const DirectVideoRoute = makeRoute(url => {
}
`;
const videoId = decodeURIComponent(params[1]);
const eventId = `ev${videoId}`;
const queryRef = loadQuery<VideoPageDirectLinkQuery>(query, { id: eventId });
const queryRef = loadQuery<VideoPageDirectLinkQuery>(query, { id: eventId(videoId) });

return matchedDirectRoute(query, queryRef);
});
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/routes/manage/Video/Access.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { isRealUser, useUser } from "../../../User";
import { NotAuthorized } from "../../../ui/error";
import { WithTooltip } from "@opencast/appkit";
import { Modal, ModalHandle } from "../../../ui/Modal";
import { currentRef } from "../../../util";
import { currentRef, keyOfId } from "../../../util";
import { COMMON_ROLES } from "../../../util/roles";
import { Acl, AclSelector, knownRolesFragement } from "../../../ui/Access";
import { useNavBlocker } from "../../util";
Expand Down Expand Up @@ -45,7 +45,7 @@ const AclPage: React.FC<AclPageProps> = ({ event, data }) => {
const breadcrumbs = [
{ label: t("user.manage-content"), link: "/~manage" },
{ label: t("manage.my-videos.title"), link: "/~manage/videos" },
{ label: event.title, link: `/~manage/videos/${event.id.substring(2)}` },
{ label: event.title, link: `/~manage/videos/${keyOfId(event.id)}` },
];

return <>
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/routes/manage/Video/Details.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { AuthorizedEvent, makeManageVideoRoute, PAGE_WIDTH } from "./Shared";
import { ExternalLink } from "../../../relay/auth";
import { buttonStyle } from "../../../ui/Button";
import { COLORS } from "../../../color";
import { secondsToTimeString } from "../../../util";
import { keyOfId, secondsToTimeString } from "../../../util";


export const ManageVideoDetailsRoute = makeManageVideoRoute(
Expand Down Expand Up @@ -79,7 +79,7 @@ const DirectLink: React.FC<Props> = ({ event }) => {
const [timestamp, setTimestamp] = useState(0);
const [checkboxChecked, setCheckboxChecked] = useState(false);

let url = new URL(`/!v/${event.id.slice(2)}`, document.baseURI);
let url = new URL(`/!v/${keyOfId(event.id)}`, document.baseURI);
if (timestamp && checkboxChecked) {
url = new URL(url + `?t=${secondsToTimeString(timestamp)}`);
}
Expand Down
6 changes: 3 additions & 3 deletions frontend/src/routes/manage/Video/Shared.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { b64regex } from "../../util";
import { Thumbnail } from "../../../ui/Video";
import { SharedVideoManageQuery } from "./__generated__/SharedVideoManageQuery.graphql";
import { Link } from "../../../router";
import { isExperimentalFlagSet } from "../../../util";
import { eventId, isExperimentalFlagSet, keyOfId } from "../../../util";


export const PAGE_WIDTH = 1100;
Expand All @@ -38,7 +38,7 @@ export const makeManageVideoRoute = (
}

const videoId = decodeURIComponent(params[1]);
const queryRef = loadQuery<SharedVideoManageQuery>(query, { id: `ev${videoId}` });
const queryRef = loadQuery<SharedVideoManageQuery>(query, { id: eventId(videoId) });

return {
render: () => <RootLoader
Expand Down Expand Up @@ -133,7 +133,7 @@ const ManageVideoNav: React.FC<ManageVideoNavProps> = ({ event, active }) => {
return null;
}

const id = event.id.substring(2);
const id = keyOfId(event.id);

const entries = [
{
Expand Down
3 changes: 2 additions & 1 deletion frontend/src/routes/manage/Video/TechnicalDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { PageTitle } from "../../../layout/header/ui";
import { AuthorizedEvent, makeManageVideoRoute, PAGE_WIDTH } from "./Shared";
import { CopyableInput } from "../../../ui/Input";
import { COLORS } from "../../../color";
import { keyOfId } from "../../../util";


export const ManageVideoTechnicalDetailsRoute = makeManageVideoRoute(
Expand Down Expand Up @@ -35,7 +36,7 @@ const Page: React.FC<Props> = ({ event }) => {
const breadcrumbs = [
{ label: t("user.manage-content"), link: "/~manage" },
{ label: t("manage.my-videos.title"), link: "/~manage/videos" },
{ label: event.title, link: `/~manage/videos/${event.id.substring(2)}` },
{ label: event.title, link: `/~manage/videos/${keyOfId(event.id)}` },
];

const user = useUser();
Expand Down
6 changes: 6 additions & 0 deletions frontend/src/util/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export function keyOfId(id: string): string {
return id.substring(2);
}

/** Constructs event ID for graphQL by adding the "ev" prefix. */
export const eventId = (key: string) => `ev${key}`;

/** Constructs series ID for graphQL by adding the "sr" prefix. */
export const seriesId = (key: string) => `sr${key}`;

/**
* Create a comparison function for `Array.prototype.sort` comparing whatever
* the given key function returns as numbers.
Expand Down