Merge pull request #360 from Rushikesh-Sonawane99/shiksha-2.0

Issue #PS-1157 feat: Implemented Role based access for TL and Facilitator on all pages in app
tekdi · Jul 9, 2024 · 9682db3 · 9682db3
2 parents 7752d5e + 169249e
commit 9682db3
Show file tree

Hide file tree

Showing 11 changed files with 78 additions and 34 deletions.
diff --git a/app.config.ts b/app.config.ts
@@ -26,7 +26,18 @@ export const dropoutReasons = [
 ];
 
 export const accessControl: { [key: string]: Role[] } = {
-  viewDashboard: [Role.TEACHER, Role.TEAM_LEADER],
-  viewAttendance: [Role.TEACHER, Role.TEAM_LEADER],
-  createLearner: [Role.TEACHER, Role.TEAM_LEADER],
+  accessDashboard: [Role.TEACHER, Role.TEAM_LEADER],
+  accessAttendanceHistory: [Role.TEACHER, Role.TEAM_LEADER],
+  accessAttendanceOverview: [Role.TEACHER, Role.TEAM_LEADER],
+  accessProfile: [Role.TEACHER, Role.TEAM_LEADER],
+  accessLearnerProfile: [Role.TEACHER, Role.TEAM_LEADER],
+  accessLearnerAttendanceHistory: [Role.TEACHER, Role.TEAM_LEADER],
+  showTeachingCenter : [Role.TEAM_LEADER],
+  showBlockLevelCohort : [Role.TEAM_LEADER],
+  showTeacherCohorts: [Role.TEACHER],
+  showBlockLevelData: [Role.TEAM_LEADER],
+  showCreateCenterButton: [Role.TEAM_LEADER],
+  showBlockLevelCenterData: [Role.TEAM_LEADER],
+  showTeacherLevelCenterData: [Role.TEACHER],
 };
+
diff --git a/src/components/MenuDrawer.tsx b/src/components/MenuDrawer.tsx
@@ -15,6 +15,10 @@ import { useTheme } from '@mui/material/styles';
 import { useTranslation } from 'next-i18next';
 import PeopleOutlineOutlinedIcon from '@mui/icons-material/PeopleOutlineOutlined';
 import EditNoteIcon from '@mui/icons-material/EditNote';
+import { Role } from '@/utils/app.constant';
+import useStore from '@/store/store';
+import { accessGranted } from '@/utils/Helper';
+import { accessControl } from '../../app.config';
 interface DrawerProps {
   toggleDrawer: (open: boolean) => () => void;
   open: boolean;
@@ -33,6 +37,8 @@ const MenuDrawer: React.FC<DrawerProps> = ({
   const [isTeamLeader, setIsTeamLeader] = useState(false);
   const { t } = useTranslation();
   const router = useRouter();
+  const store = useStore();
+  const userRole = store.userRole;
 
   useEffect(() => setIsOpen(open), [open]);
 
@@ -206,7 +212,7 @@ const MenuDrawer: React.FC<DrawerProps> = ({
               router.push(`/centers`); // Check route
             }}
           >
-            {isTeamLeader
+            {accessGranted('showTeachingCenter', accessControl, userRole)
               ? t('DASHBOARD.TEACHING_CENTERS')
               : t('DASHBOARD.MY_TEACHING_CENTERS')}
           </Button>

diff --git a/src/pages/attendance-history.tsx b/src/pages/attendance-history.tsx
@@ -49,6 +49,8 @@ import { logEvent } from '@/utils/googleAnalytics';
 import { showToastMessage } from '@/components/Toastify';
 import { Status } from '@/utils/app.constant';
 import CohortSelectionSection from '@/components/CohortSelectionSection';
+import withAccessControl from '@/utils/hoc/withAccessControl';
+import { accessControl } from '../../app.config';
 
 interface user {
   memberStatus: string;
@@ -829,4 +831,5 @@ export async function getStaticProps({ locale }: any) {
   };
 }
 
-export default UserAttendanceHistory;
+// export default UserAttendanceHistory;
+export default withAccessControl('accessAttendanceHistory', accessControl)(UserAttendanceHistory);
diff --git a/src/pages/attendance-overview.tsx b/src/pages/attendance-overview.tsx
@@ -42,7 +42,7 @@ import SortingModal from '@/components/SortingModal';
 import StudentsStatsList from '@/components/LearnerAttendanceStatsListView';
 import UpDownButton from '@/components/UpDownButton';
 import { getMyCohortMemberList } from '@/services/MyClassDetailsService';
-import { lowLearnerAttendanceLimit } from './../../app.config';
+import { accessControl, lowLearnerAttendanceLimit } from './../../app.config';
 import { serverSideTranslations } from 'next-i18next/serverSideTranslations';
 import { usePathname } from 'next/navigation';
 import { useRouter } from 'next/router';
@@ -51,6 +51,7 @@ import { useTranslation } from 'next-i18next';
 import { logEvent } from '@/utils/googleAnalytics';
 import { showToastMessage } from '@/components/Toastify';
 import CohortSelectionSection from '@/components/CohortSelectionSection';
+import withAccessControl from '@/utils/hoc/withAccessControl';
 
 interface AttendanceOverviewProps {
   //   buttonText: string;
@@ -798,4 +799,6 @@ export async function getStaticProps({ locale }: any) {
   };
 }
 
-export default AttendanceOverview;
+// export default AttendanceOverview;
+export default withAccessControl('accessAttendanceOverview', accessControl)(AttendanceOverview);
+
diff --git a/src/pages/centers/index.tsx b/src/pages/centers/index.tsx
@@ -31,13 +31,19 @@ import ManageUser from '@/components/ManageUser';
 import { setTimeout } from 'timers';
 import SmartDisplayOutlinedIcon from '@mui/icons-material/SmartDisplayOutlined';
 import CreateCenterModal from '@/components/center/CreateCenterModal';
-import { toPascalCase } from '@/utils/Helper';
+import { accessGranted, toPascalCase } from '@/utils/Helper';
+import { Role } from '@/utils/app.constant';
+import useStore from '@/store/store';
+import { accessControl } from '../../../app.config';
 
 const TeachingCenters = () => {
   const [loading, setLoading] = React.useState(false);
   const { t } = useTranslation();
   const theme = useTheme<any>();
   const router = useRouter();
+  const store = useStore();
+  const userRole = store.userRole;
+
   const [cohortsData, setCohortsData] = React.useState<Array<cohort>>([]);
   const [value, setValue] = React.useState(1);
   const [blockData, setBlockData] =
@@ -71,7 +77,7 @@ const TeachingCenters = () => {
       try {
         if (typeof window !== 'undefined' && window.localStorage) {
           const userId = localStorage.getItem('userId');
-          if (userId && isTeamLeader) {
+          if (userId && accessGranted('showBlockLevelCohort', accessControl, userRole)) {
             const response = await getCohortList(userId, {
               customField: 'true',
             });
@@ -107,7 +113,7 @@ const TeachingCenters = () => {
               setCenterData(centerData);
             });
           }
-          if (userId && !isTeamLeader) {
+          if (userId && accessGranted('showTeacherCohorts', accessControl, userRole)) {
             const response = await getCohortList(userId);
             const cohortData = response.map((block: any) => {
               const cohortName = block.cohortName;
@@ -136,7 +142,7 @@ const TeachingCenters = () => {
       <Header />
       {loading && <Loader showBackdrop={true} loadingText={t('LOADING')} />}
       <Box sx={{ padding: '0 18px' }}>
-        {isTeamLeader ? (
+        {accessGranted('showBlockLevelData', accessControl, userRole) ? (
           <>
             {blockData?.length !== 0 &&
               blockData?.map((block: any) => (
@@ -166,7 +172,7 @@ const TeachingCenters = () => {
             {t('DASHBOARD.MY_TEACHING_CENTERS')}
           </Box>
         )}
-        {isTeamLeader && (
+        {accessGranted('showBlockLevelData', accessControl, userRole) && (
           <Box sx={{ width: '100%' }}>
             <Tabs
               value={value}
@@ -257,7 +263,7 @@ const TeachingCenters = () => {
                     </FormControl>
                   </Box>
                 </Grid>
-                {isTeamLeader && (
+                {accessGranted('showCreateCenterButton', accessControl, userRole) && (
                   <Box mt={'18px'} px={'18px'}>
                     <Button
                       sx={{
@@ -290,7 +296,7 @@ const TeachingCenters = () => {
                 sx={{ borderRadius: '16px', mt: 2 }}
                 padding={'10px 16px 2px'}
               >
-                {isTeamLeader && centerData && (
+                {accessGranted('showBlockLevelCenterData', accessControl, userRole) && centerData && (
                   <>
                     {/* Regular Centers */}
                     {centerData.some(
@@ -458,7 +464,7 @@ const TeachingCenters = () => {
                   </>
                 )}
 
-                {!isTeamLeader &&
+                {accessGranted('showTeacherLevelCenterData', accessControl, userRole)  &&
                   cohortsData &&
                   cohortsData?.map((cohort: any) => {
                     return (

diff --git a/src/pages/dashboard.tsx b/src/pages/dashboard.tsx
@@ -37,7 +37,7 @@ import { calculatePercentage } from '@/utils/attendanceStats';
 import calendar from '../assets/images/calendar.svg';
 import { getMyCohortMemberList } from '@/services/MyClassDetailsService';
 import { logEvent } from '@/utils/googleAnalytics';
-import { lowLearnerAttendanceLimit } from './../../app.config';
+import { accessControl, lowLearnerAttendanceLimit } from './../../app.config';
 import { modifyAttendanceLimit } from '../../app.config';
 import { serverSideTranslations } from 'next-i18next/serverSideTranslations';
 import { showToastMessage } from '@/components/Toastify';
@@ -46,10 +46,13 @@ import { useRouter } from 'next/navigation';
 import { useTheme } from '@mui/material/styles';
 import { useTranslation } from 'next-i18next';
 import CohortSelectionSection from '@/components/CohortSelectionSection';
-// import withAccessControl from '@/utils/hoc/withAccessControl';
-// import useStore from '@/store/store';
+
+
+import withAccessControl from '@/utils/hoc/withAccessControl';
 // import { Role } from '@/utils/app.constant';
 // import { accessControl } from '../../app.config';
+
+// import useStore from '@/store/store';
 // const store = useStore();
 // const userRole: string = store.userRole; 
 
@@ -950,6 +953,4 @@ export async function getStaticProps({ locale }: any) {
   };
 }
 
-export default Dashboard;
-
-// export default withAccessControl(Role.TEACHER, accessControl)(Dashboard);
+export default withAccessControl('accessDashboard', accessControl)(Dashboard);
diff --git a/src/pages/learner-attendance-history.tsx b/src/pages/learner-attendance-history.tsx
@@ -16,6 +16,8 @@ import { useTranslation } from 'next-i18next';
 import { useRouter } from 'next/router';
 import { logEvent } from '@/utils/googleAnalytics';
 import { showToastMessage } from '@/components/Toastify';
+import withAccessControl from '@/utils/hoc/withAccessControl';
+import { accessControl } from '../../app.config';
 
 type LearnerAttendanceData = {
   [date: string]: {
@@ -250,4 +252,5 @@ export async function getStaticProps({ locale }: any) {
     },
   };
 }
-export default LearnerAttendanceHistory;
+
+export default withAccessControl('accessLearnerAttendanceHistory', accessControl)(LearnerAttendanceHistory);
diff --git a/src/pages/learner/[userId].tsx b/src/pages/learner/[userId].tsx
@@ -65,6 +65,8 @@ import { serverSideTranslations } from 'next-i18next/serverSideTranslations';
 import { showToastMessage } from '@/components/Toastify';
 import { useRouter } from 'next/router';
 import { useTranslation } from 'next-i18next';
+import withAccessControl from '@/utils/hoc/withAccessControl';
+import { accessControl } from '../../../app.config';
 
 // import { UserData, updateCustomField } from '../utils/Interfaces';
 
@@ -1628,4 +1630,4 @@ export const getStaticPaths: GetStaticPaths<{ slug: string }> = async () => {
   };
 };
 
-export default LearnerProfile;
+export default withAccessControl('accessLearnerProfile', accessControl)(LearnerProfile);
diff --git a/src/pages/profile.tsx b/src/pages/profile.tsx
@@ -42,6 +42,8 @@ import { useTranslation } from 'next-i18next';
 import userPicture from '@/assets/images/imageOne.jpg';
 import user_placeholder from '../assets/images/user_placeholder.png';
 import { useProfileInfo } from '@/services/queries';
+import withAccessControl from '@/utils/hoc/withAccessControl';
+import { accessControl } from '../../app.config';
 
 interface FieldOption {
   name: string;
@@ -1148,4 +1150,4 @@ export async function getStaticProps({ locale }: any) {
   };
 }
 
-export default TeacherProfile;
+export default withAccessControl('accessProfile', accessControl)(TeacherProfile);
diff --git a/src/utils/Helper.ts b/src/utils/Helper.ts
@@ -1,5 +1,5 @@
 import FingerprintJS from 'fingerprintjs2';
-import { Status } from './app.constant';
+import { Role, Status } from './app.constant';
 
 export const ATTENDANCE_ENUM = {
   PRESENT: 'present',
@@ -255,3 +255,11 @@ export const sortClassesMissed = (data: any[], order: string) => {
     }
   );
 };
+
+
+export const accessGranted = (action: string, accessControl: { [key: string]: Role[] }, currentRole: Role): boolean => {
+  if (accessControl[action]?.includes(currentRole)) {
+    return true;
+  }
+  return false;
+};
diff --git a/src/utils/hoc/withAccessControl.tsx b/src/utils/hoc/withAccessControl.tsx
@@ -3,21 +3,20 @@ import { useEffect } from 'react';
 import useStore from '@/store/store';
 import { Role } from '../app.constant';
 
-const withAccessControl = (requiredRole: Role, accessControl: any) => (Component: React.ComponentType<any>) => {
+const withAccessControl = (action: string, accessControl: { [key: string]: Role[] }) => (Component: React.ComponentType<any>) => {
   return (props: any) => {
-    debugger;
     const store = useStore();
-    const userRole = store.userRole;  
+    const userRole = store.userRole;
     const router = useRouter();
-    
+
     useEffect(() => {
-      if (!userRole || !accessControl[requiredRole]?.includes(userRole)) {
-        router.replace('/unauthorized'); // Redirect to an unauthorized page
+      if (!userRole || !accessControl[action]?.includes(userRole)) {
+        router.replace('/unauthorized'); 
       }
-    }, [userRole, requiredRole, router]);
+    }, [userRole, action, router]);
 
-    if (!userRole || !accessControl[requiredRole]?.includes(userRole)) {
-      return null; // or a loading spinner
+    if (!userRole || !accessControl[action]?.includes(userRole)) {
+      return null; 
     }
 
     return <Component {...props} />;