Skip to content

Topcoder Admin App - Consolidate Gamification #1119

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 24, 2025
Merged

Topcoder Admin App - Consolidate Gamification #1119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions src/apps/admin/src/admin-app.routes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { baseDetailPath, createBadgePath } from '~/apps/gamification-admin'
Copy link

Choose a reason for hiding this comment

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

The import statement for baseDetailPath and createBadgePath should be verified to ensure these paths are correct and that the modules exist in the specified location. If these are new modules, ensure they are properly implemented and tested.

import { AppSubdomain, ToolTitle } from '~/config'
import {
lazyLoad,
Expand All @@ -9,9 +10,11 @@ import {

import {
billingAccountRouteId,
gamificationAdminRouteId,
manageChallengeRouteId,
manageReviewRouteId,
permissionManagementRouteId,
platformRouteId,
rootRoute,
userManagementRouteId,
} from './config/routes.config'
Expand Down Expand Up @@ -107,6 +110,17 @@ const PermissionAddGroupMembersPage: LazyLoadedComponent = lazyLoad(
'PermissionAddGroupMembersPage',
)

const Platform: LazyLoadedComponent = lazyLoad(() => import('./platform/Platform'))
Copy link

Choose a reason for hiding this comment

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

Consider renaming the variable Platform to something more descriptive, as it might be confused with a generic platform concept. A more specific name could improve code readability.

const BadgeDetailPage: LazyLoadedComponent = lazyLoad(
() => import('../../gamification-admin/src/pages/badge-detail/BadgeDetailPage'),
)
const BadgeListingPage: LazyLoadedComponent = lazyLoad(
() => import('../../gamification-admin/src/pages/badge-listing/BadgeListingPage'),
)
const CreateBadgePage: LazyLoadedComponent = lazyLoad(
() => import('../../gamification-admin/src/pages/create-badge/CreateBadgePage'),
)

export const toolTitle: string = ToolTitle.admin

export const adminRoutes: ReadonlyArray<PlatformRoute> = [
Expand Down Expand Up @@ -256,6 +270,29 @@ export const adminRoutes: ReadonlyArray<PlatformRoute> = [
id: permissionManagementRouteId,
route: permissionManagementRouteId,
},
{
children: [
{
element: (
<BadgeListingPage
rootPage={`${rootRoute}/${platformRouteId}/${gamificationAdminRouteId}`}
/>
),
route: gamificationAdminRouteId,
},
{
element: <CreateBadgePage />,
route: `${gamificationAdminRouteId}${createBadgePath}`,
},
{
element: <BadgeDetailPage />,
route: `${gamificationAdminRouteId}${baseDetailPath}/:id`,
},
],
element: <Platform />,
Copy link

Choose a reason for hiding this comment

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

The element property here is set to <Platform />, but it might be more appropriate to use a more descriptive component name if available, such as <GamificationPlatform />, to better reflect the purpose of this route.

id: platformRouteId,
route: platformRouteId,
},
],
domain: AppSubdomain.admin,
element: <AdminApp />,
Expand Down
2 changes: 2 additions & 0 deletions src/apps/admin/src/config/routes.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ export const manageReviewRouteId = 'review-management'
export const userManagementRouteId = 'user-management'
export const billingAccountRouteId = 'billing-account'
export const permissionManagementRouteId = 'permission-management'
export const gamificationAdminRouteId = 'gamification-admin'
export const platformRouteId = 'platform'
9 changes: 9 additions & 0 deletions src/apps/admin/src/lib/components/common/Layout/Layout.module.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@
@include ltelg {
padding: $sp-4;
}

&.isPlatformPage {
padding: 0;
background-color: white;
Copy link

Choose a reason for hiding this comment

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

Consider using a variable for the background-color instead of hardcoding white. This can improve maintainability and consistency across the application.


@include ltelg {
padding: 0;
}
}
}
}

Expand Down
45 changes: 29 additions & 16 deletions src/apps/admin/src/lib/components/common/Layout/Layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
import { FC, PropsWithChildren } from 'react'
import { FC, PropsWithChildren, useMemo } from 'react'
import { useLocation } from 'react-router-dom'
import classNames from 'classnames'

import { platformRouteId } from '~/apps/admin/src/config/routes.config'
import { ContentLayout } from '~/libs/ui'

import { SystemAdminTabs } from '../Tab'

import styles from './Layout.module.scss'

export const NullLayout: FC<PropsWithChildren> = props => (
<>{props.children}</>
)
export const NullLayout: FC<PropsWithChildren> = props => <>{props.children}</>

export const Layout: FC<PropsWithChildren> = props => (
<ContentLayout
innerClass={styles.contantentLayoutInner}
outerClass={styles.contentLayoutOuter}
>
<div className={styles.layout}>
<SystemAdminTabs />
export const Layout: FC<PropsWithChildren> = props => {
const { pathname }: { pathname: string } = useLocation()
const isPlatformPage = useMemo(
() => pathname.indexOf(platformRouteId) >= 0,
[pathname],
)

<div className={styles.main}>
{props.children}
return (
<ContentLayout
innerClass={styles.contantentLayoutInner}
Copy link

Choose a reason for hiding this comment

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

Typo in class name: contantentLayoutInner should be contentLayoutInner.

outerClass={styles.contentLayoutOuter}
>
<div className={styles.layout}>
<SystemAdminTabs />

<div
className={classNames(styles.main, {
[styles.isPlatformPage]: isPlatformPage,
})}
>
{props.children}
</div>
</div>
</div>
</ContentLayout>
)
</ContentLayout>
)
}

export default Layout
12 changes: 12 additions & 0 deletions src/apps/admin/src/lib/components/common/Tab/config/system-admin-tabs-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ import _ from 'lodash'
import { TabsNavItem } from '~/libs/ui'
import {
billingAccountRouteId,
gamificationAdminRouteId,
manageChallengeRouteId,
manageReviewRouteId,
permissionManagementRouteId,
platformRouteId,
userManagementRouteId,
} from '~/apps/admin/src/config/routes.config'

Expand Down Expand Up @@ -50,6 +52,16 @@ export const SystemAdminTabsConfig: TabsNavItem[] = [
id: permissionManagementRouteId,
title: 'Permission Management',
},
{
children: [
{
id: `${platformRouteId}/${gamificationAdminRouteId}`,
Copy link

Choose a reason for hiding this comment

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

Consider using a template literal for id only if platformRouteId and gamificationAdminRouteId are guaranteed to be strings. Otherwise, ensure they are converted to strings to avoid potential runtime errors.

title: 'Badges',
},
],
id: platformRouteId,
title: 'Platform',
},
]

export function getTabIdFromPathName(pathname: string): string {
Expand Down
37 changes: 37 additions & 0 deletions src/apps/admin/src/platform/Platform.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/**
* Wrapper for permission managment
*/
import { FC, useContext, useMemo } from 'react'
import { Outlet, Routes } from 'react-router-dom'

import { routerContext, RouterContextData } from '~/libs/core'

import { adminRoutes } from '../admin-app.routes'
import { platformRouteId } from '../config/routes.config'

/**
* The router outlet with layout.
*/
export const Platform: FC = () => {
const childRoutes = useChildRoutes()

return (
<>
<Outlet />
<Routes>{childRoutes}</Routes>
</>
)
}

function useChildRoutes(): Array<JSX.Element> | undefined {
const { getRouteElement }: RouterContextData = useContext(routerContext)
const childRoutes = useMemo(
() => adminRoutes[0].children
?.find(r => r.id === platformRouteId)
?.children?.map(getRouteElement),
[], // eslint-disable-line react-hooks/exhaustive-deps -- missing dependency: getRouteElement
Copy link

Choose a reason for hiding this comment

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

The useMemo hook has a dependency array that is empty, which means it will only recompute the memoized value when the component mounts. If getRouteElement or any other variables used inside the useMemo callback can change, they should be included in the dependency array to ensure the memoized value is updated correctly.

)
return childRoutes
}

export default Platform
29 changes: 0 additions & 29 deletions src/apps/gamification-admin/src/GamificationAdmin.tsx
View file
Open in desktop

This file was deleted.

17 changes: 0 additions & 17 deletions src/apps/gamification-admin/src/game-lib/hooks/use-gamification-breadcrumb.hook.tsx
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion src/apps/gamification-admin/src/game-lib/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
export * from './game-badge.model'
export * from './hooks/use-get-game-badges-page.hook'
export * from './hooks/use-gamification-breadcrumb.hook'
export * from './hooks/use-get-game-badge-details.hook'
export * from './member-autocomplete'
export * from './pagination'
3 changes: 2 additions & 1 deletion src/apps/gamification-admin/src/game-lib/modals/badge-created-modal/BadgeCreatedModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export interface BadgeCreatedModalProps {
badge: GameBadge
isOpen: boolean
onClose: () => void
rootPage: string;
}

const BadgeCreatedModal: FC<BadgeCreatedModalProps> = (props: BadgeCreatedModalProps) => {
Expand Down Expand Up @@ -52,7 +53,7 @@ const BadgeCreatedModal: FC<BadgeCreatedModalProps> = (props: BadgeCreatedModalP
label='View'
primary
size='lg'
to={badgeDetailPath(props.badge.id)}
to={badgeDetailPath(props.rootPage, props.badge.id)}
Copy link

Choose a reason for hiding this comment

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

The function badgeDetailPath now takes an additional argument props.rootPage. Ensure that this change is reflected in the definition of badgeDetailPath and that props.rootPage is always provided and valid in the context where BadgeCreatedModal is used.

/>
<Button
label='Create a new badge'
Expand Down
52 changes: 9 additions & 43 deletions src/apps/gamification-admin/src/gamification-admin.routes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,14 @@
import { AppSubdomain, EnvironmentConfig } from '~/config'
import { lazyLoad, LazyLoadedComponent, PlatformRoute, UserRole } from '~/libs/core'

import { toolTitle } from './GamificationAdmin'

const GamificationAdmin: LazyLoadedComponent = lazyLoad(() => import('./GamificationAdmin'))
const BadgeDetailPage: LazyLoadedComponent = lazyLoad(() => import('./pages/badge-detail/BadgeDetailPage'))
const BadgeListingPage: LazyLoadedComponent = lazyLoad(() => import('./pages/badge-listing/BadgeListingPage'))
const CreateBadgePage: LazyLoadedComponent = lazyLoad(() => import('./pages/create-badge/CreateBadgePage'))

export const rootRoute: string = (
EnvironmentConfig.SUBDOMAIN === AppSubdomain.gamificationAdmin ? '' : `/${AppSubdomain.gamificationAdmin}`
)
export const baseDetailPath: string = '/badge-detail'
export const createBadgePath: string = '/create-badge'

export function badgeDetailPath(badgeId: string, view?: 'edit' | 'award'): string {
return `${rootRoute}${baseDetailPath}/${badgeId}${!!view ? `#${view}` : ''}`
export function badgeDetailPath(
rootPage: string,
Copy link

Choose a reason for hiding this comment

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

The rootPage parameter is introduced but not documented in the function signature. Ensure that the usage of rootPage is consistent and clear throughout the application.

badgeId: string,
view?: 'edit' | 'award',
): string {
return `${rootPage}${baseDetailPath}/${badgeId}${!!view ? `#${view}` : ''}`
}

export const createBadgeRoute: string = `${rootRoute}${createBadgePath}`

export const gamificationAdminRoutes: ReadonlyArray<PlatformRoute> = [
{
authRequired: true,
children: [
{
element: <BadgeListingPage />,
route: '/',
},
{
element: <CreateBadgePage />,
route: createBadgePath,
},
{
element: <BadgeDetailPage />,
route: `${baseDetailPath}/:id`,
},
],
domain: AppSubdomain.gamificationAdmin,
element: <GamificationAdmin />,
id: toolTitle,
rolesRequired: [
UserRole.gamificationAdmin,
],
route: rootRoute,
},
]
export const createBadgeRoute: (rootPage: string) => string = (
Copy link

Choose a reason for hiding this comment

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

Consider providing a more descriptive name for the createBadgeRoute function to clarify its purpose, as it now takes a rootPage parameter.

rootPage: string,
) => `${rootPage}${createBadgePath}`
Loading