Skip to content
Open
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
90 changes: 76 additions & 14 deletions src/components/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ import languages from "../i18n/languages";
import opencastLogo from "../img/opencast-white.svg?url";
import { setSpecificServiceFilter } from "../slices/tableFilterSlice";
import { getErrorCount, getHealthStatus } from "../selectors/healthSelectors";
import {
getRegistration,
getIsRegistering,
getAgreedLatestToU,
} from "../selectors/registrationSelectors";
import {
getOrgProperties,
getUserInformation,
Expand All @@ -19,6 +24,11 @@ import HotKeyCheatSheet from "./shared/HotKeyCheatSheet";
import { useHotkeys } from "react-hotkeys-hook";
import { useAppDispatch, useAppSelector } from "../store";
import { HealthStatus, fetchHealthStatus } from "../slices/healthSlice";
import {
fetchRegistration,
fetchLatestToU,
fetchIsUpToDate,
} from "../slices/registrationSlice";
import { UserInfoState } from "../slices/userInfoSlice";
import { Tooltip } from "./shared/Tooltip";
import { HiOutlineTranslate } from "react-icons/hi";
Expand Down Expand Up @@ -50,18 +60,31 @@ const Header = () => {

const healthStatus = useAppSelector(state => getHealthStatus(state));
const errorCounter = useAppSelector(state => getErrorCount(state));
const isUpToDate = useAppSelector(state => getIsRegistering(state));
const agreedLatestToU = useAppSelector(state => getAgreedLatestToU(state));
const user = useAppSelector(state => getUserInformation(state));
const registration = useAppSelector(state => getRegistration(state));
const orgProperties = useAppSelector(state => getOrgProperties(state));
const displayTerms = (orgProperties["org.opencastproject.admin.display_terms"] || "false").toLowerCase() === "true";

const loadHealthStatus = async () => {
await dispatch(fetchHealthStatus());
};

useEffect(() => {
dispatch(fetchRegistration());
dispatch(fetchLatestToU());
dispatch(fetchIsUpToDate());
}, [dispatch]);

const hideMenuHelp = () => {
setMenuHelp(false);
};

const hideNotificationMenu = () => {
setMenuNotify(false);
};

const showRegistrationModal = () => {
registrationModalRef.current?.open();
};
Expand Down Expand Up @@ -134,18 +157,18 @@ const Header = () => {
}, []);

useEffect(() => {
if (!user) { return; }

const isAdmin = user.isAdmin || user.isOrgAdmin;
const isLocalhost = window.location.hostname === "localhost";
const lastDismissed = localStorage.getItem("adopterModalDismissed");
const THIRTY_DAYS = 30 * 24 * 60 * 60 * 1000;
const dismissedLongEnough = !lastDismissed || Date.now() - parseInt(lastDismissed) > THIRTY_DAYS;

if (isAdmin && !isLocalhost && dismissedLongEnough) {
showRegistrationModal();
}
}, [user]);
if (!user) { return; }

const isAdmin = user.isAdmin || user.isOrgAdmin;
const isLocalhost = window.location.hostname === "localhost";
const lastDismissed = localStorage.getItem("adopterModalDismissed");
const THIRTY_DAYS = 30 * 24 * 60 * 60 * 1000;
const dismissedLongEnough = !lastDismissed || Date.now() - parseInt(lastDismissed) > THIRTY_DAYS;

if (isAdmin && !isLocalhost && dismissedLongEnough && registration == null) {
showRegistrationModal();
}
}, [user, registration]);
return (
<>
<header className="primary-header">
Expand Down Expand Up @@ -210,9 +233,9 @@ const Header = () => {
<Tooltip active={!displayMenuNotify} title={t("SYSTEM_NOTIFICATIONS")}>
<BaseButton onClick={() => setMenuNotify(!displayMenuNotify)} className="nav-dd-element">
<LuBell className="header-icon"/>
{errorCounter !== 0 && (
{(errorCounter !== 0 || !agreedLatestToU || !isUpToDate) && (
<span id="error-count" className="badge">
{errorCounter}
{errorCounter + (!agreedLatestToU || !isUpToDate ? 1 : 0)}
</span>
)}
</BaseButton>
Expand All @@ -221,6 +244,10 @@ const Header = () => {
{displayMenuNotify && (
<MenuNotify
healthStatus={healthStatus}
registering={isUpToDate}
updatedToU={agreedLatestToU}
showRegistrationModal={showRegistrationModal}
hideNotificationMenu={hideNotificationMenu}
/>
)}
</div>
Expand Down Expand Up @@ -315,8 +342,16 @@ const MenuLang = ({ handleChangeLanguage }: { handleChangeLanguage: (code: strin

const MenuNotify = ({
healthStatus,
registering,
updatedToU,
showRegistrationModal,
hideNotificationMenu,
}: {
healthStatus: HealthStatus[],
registering: boolean,
updatedToU: boolean,
showRegistrationModal: () => void,
hideNotificationMenu: () => void,
}) => {
const dispatch = useAppDispatch();
const navigate = useNavigate();
Expand All @@ -327,6 +362,13 @@ const MenuNotify = ({
navigate("/systems/services");
};

// show Adopter Registration Modal and hide drop down
const showAdoptersRegistrationModal = () => {
showRegistrationModal();
hideNotificationMenu();
};


return (
<ul className="dropdown-ul">
{/* For each service in the serviceList (Background Services) one list item */}
Expand All @@ -350,6 +392,26 @@ const MenuNotify = ({
)}
</li>
))}
{!registering &&
<li>
<ButtonLikeAnchor
onClick={() => showAdoptersRegistrationModal()}
>
<span className="wide-text">Registration</span>
<span className="multi-value multi-value-yellow">Unregistered</span>
</ButtonLikeAnchor>
</li>
}
{registering && !updatedToU &&
<li>
<ButtonLikeAnchor
onClick={() => showAdoptersRegistrationModal()}
>
<span className="wide-text">Registration</span>
<span className="multi-value multi-value-yellow">Updated ToU</span>
</ButtonLikeAnchor>
</li>
}
</ul>
);
};
Expand Down
11 changes: 11 additions & 0 deletions src/selectors/registrationSelectors.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { RootState } from "../store";

/**
* This file contains selectors regarding information about the registration status
*/
// Are we registered at all
export const getRegistration = (state: RootState) => state.registration.registration;
// Are we able to talk to register.opencast.org
export const getIsRegistering = (state: RootState) => state.registration.isRegistering;
// Does our registration match the latest ToU on the core
export const getAgreedLatestToU = (state: RootState) => state.registration.agreedToToU;
110 changes: 110 additions & 0 deletions src/slices/registrationSlice.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
import { PayloadAction, createSlice } from "@reduxjs/toolkit";
import axios from "axios";
import { WritableDraft } from "immer";
import { createAppAsyncThunk } from "../createAsyncThunkWithTypes";

export type Registration = {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since all this PR really does is checking if ´/admin-ng/adopter/registration` returns null or not, creating a whole redux state is complete overkill. If you'll need this for some other PR, would it not be better to add it then?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair. The goal here is to be able to set warnings in the notification bell in a few cases. I'll rework this and come back when it's ready.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this more what you're looking for @Arnei? Or are you wanting me to completely remove the slice and selectors? There's an adopterRegistrationUtils file which powers the modal and works, but I just can't seem to get the relevant function(s) to work from the header...

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking of completely removing the slice and selectors and stuff, and do something like in About.tsx, aka just do the state thing locally in the component.

If you plan to make use of redux state in a later PR, it might make sense to use redux right now already, so you don't have to do work twice. But as a reviewer, I can't know that :D

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have inspired me to actually finish the work rather than continue stripping stuff out . State and stuff is now used, yay.

agreedToPolicy: boolean,
registered: boolean,
termsVersionAgreed: string,
}

export type RegistrationState = {
registration: Registration | null,
latestToU: string,
isRegistering: boolean,
agreedToToU: boolean,
error: boolean
};

type Temp = {
registration: Registration | null,
latestToU: string,
};

// Initial state of health status in redux store
const initialState: RegistrationState = {
registration: null,
latestToU: "uninitialized",
isRegistering: false,
agreedToToU: false,
error: false,
};

// This is the registration itself
export const fetchRegistration = createAppAsyncThunk("registration/fetchRegistration", async () => {
const res = await axios.get<Registration>("/admin-ng/adopter/registration");
return res.data;
});

// This is the latest ToU ID. It's a string like APRIL_2020.
export const fetchLatestToU = createAppAsyncThunk("registration/fetchLatestToU", async () => {
const res = await axios.get<string>("/admin-ng/adopter/latestToU");
return res.data;
});

// This is whether the core can talk to register.opencast.org.
export const fetchIsUpToDate = createAppAsyncThunk("registration/isUpToDate", async () => {
const res = await axios.get<boolean>("/admin-ng/adopter/isUpToDate");
return res.data;
});

const registrationSlice = createSlice({
name: "registration",
initialState,
reducers: {
setError(state, action: PayloadAction<{
error: RegistrationState["error"],
}>) {
state.error = action.payload.error;
},
},
// These are used for thunks
extraReducers: builder => {
builder
/* .addCase(fetchRegistration.pending, state => {
state.statusHealth = "loading";
}) */
.addCase(fetchRegistration.fulfilled, (state, action: PayloadAction<
Registration
>) => {
state.registration = action.payload;
const updatedState = {
registration: state.registration,
latestToU: state.latestToU,
};
state.agreedToToU = agreedLatestTerms(state, updatedState);
})
.addCase(fetchLatestToU.fulfilled, (state, action: PayloadAction<
string
>) => {
state.latestToU = action.payload;
const updatedState = {
registration: state.registration,
latestToU: state.latestToU,
};
state.agreedToToU = agreedLatestTerms(state, updatedState);
})
.addCase(fetchIsUpToDate.fulfilled, (state, action: PayloadAction<
boolean
>) => {
// This is true if the core can talk to https://register.opencast.org/, false otherwise
state.isRegistering = action.payload;
})
/* .addCase(fetchHealthStatus.rejected, (state, action) => {
state.error = true;
}) */;
},
});

const agreedLatestTerms = (_state: WritableDraft<RegistrationState>, updatedState: Temp) => {
if (null != updatedState.registration && "uninitialized" != updatedState.latestToU) {
return updatedState.registration.termsVersionAgreed === updatedState.latestToU;
}
return false;
};

export const { setError } = registrationSlice.actions;

// Export the slice reducer as the default export
export default registrationSlice.reducer;
2 changes: 2 additions & 0 deletions src/store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import groups from "./slices/groupSlice";
import acls from "./slices/aclSlice";
import themes from "./slices/themeSlice";
import health from "./slices/healthSlice";
import registration from "./slices/registrationSlice";
import notifications from "./slices/notificationSlice";
import workflows from "./slices/workflowSlice";
import eventDetails from "./slices/eventDetailsSlice";
Expand Down Expand Up @@ -64,6 +65,7 @@ const reducers = combineReducers({
acls: persistReducer(aclsPersistConfig, acls),
themes: persistReducer(themesPersistConfig, themes),
health,
registration,
notifications,
workflows,
eventDetails,
Expand Down
3 changes: 3 additions & 0 deletions src/styles/components/_header.scss
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@
.dropdown-ul{
width: auto;
right: 8px;
.wide-text{
padding-right: 5px;
}
}
#error-count{
min-width: 10px;
Expand Down
Loading