-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ui): Add support for basic CR(U)D for users to admin section
Add support for creating, listing and deleting users. Updating user data wasn't considered to be necessary at this point, so there's currently no back-end support for it, thus it is also omitted from the front-end. List users (username, first name, last name, email) in a data table which is paginated on client-side. Users can be added and deleted from this view, and because deleting a user might be considered a dangerous operation, deleting needs manual text input in the delete dialog. Signed-off-by: Jyrki Keisala <[email protected]>
- Loading branch information
Showing
2 changed files
with
209 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,205 @@ | ||
/* | ||
* Copyright (C) 2024 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>) | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* License-Filename: LICENSE | ||
*/ | ||
|
||
import { useQueryClient } from '@tanstack/react-query'; | ||
import { createFileRoute, Link } from '@tanstack/react-router'; | ||
import { | ||
createColumnHelper, | ||
getCoreRowModel, | ||
getPaginationRowModel, | ||
useReactTable, | ||
} from '@tanstack/react-table'; | ||
import { UserPlus } from 'lucide-react'; | ||
import { useState } from 'react'; | ||
|
||
import { | ||
useAdminServiceDeleteUserByUsername, | ||
useAdminServiceGetUsersKey, | ||
} from '@/api/queries'; | ||
import { prefetchUseAdminServiceGetUsers } from '@/api/queries/prefetch'; | ||
import { useAdminServiceGetUsersSuspense } from '@/api/queries/suspense'; | ||
import { ApiError, User } from '@/api/requests'; | ||
import { DataTable } from '@/components/data-table/data-table'; | ||
import { DeleteDialog } from '@/components/delete-dialog'; | ||
import { LoadingIndicator } from '@/components/loading-indicator'; | ||
import { ToastError } from '@/components/toast-error'; | ||
import { Button } from '@/components/ui/button'; | ||
import { | ||
Card, | ||
CardContent, | ||
CardDescription, | ||
CardHeader, | ||
CardTitle, | ||
} from '@/components/ui/card'; | ||
import { | ||
Tooltip, | ||
TooltipContent, | ||
TooltipTrigger, | ||
} from '@/components/ui/tooltip'; | ||
import { toast } from '@/lib/toast'; | ||
import { paginationSchema } from '@/schemas'; | ||
|
||
const defaultPageSize = 10; | ||
|
||
const columnHelper = createColumnHelper<User>(); | ||
|
||
const columns = [ | ||
columnHelper.accessor('username', { | ||
header: 'Username', | ||
cell: ({ row }) => <>{row.original.username}</>, | ||
}), | ||
columnHelper.accessor('firstName', { | ||
header: 'First name', | ||
cell: ({ row }) => <>{row.original.firstName}</>, | ||
}), | ||
columnHelper.accessor('lastName', { | ||
header: 'Last name', | ||
cell: ({ row }) => <>{row.original.lastName}</>, | ||
}), | ||
columnHelper.accessor('email', { | ||
header: 'Email address', | ||
cell: ({ row }) => <>{row.original.email}</>, | ||
}), | ||
columnHelper.display({ | ||
id: 'actions', | ||
header: () => <div className='text-right'>Actions</div>, | ||
cell: function CellComponent({ row }) { | ||
const queryClient = useQueryClient(); | ||
const [openDelDialog, setOpenDelDialog] = useState(false); | ||
|
||
const { mutateAsync: delUser, isPending: isDelPending } = | ||
useAdminServiceDeleteUserByUsername({ | ||
onSuccess() { | ||
setOpenDelDialog(false); | ||
toast.info('Delete User', { | ||
description: `User "${row.original.username}" deleted successfully.`, | ||
}); | ||
queryClient.invalidateQueries({ | ||
queryKey: [useAdminServiceGetUsersKey], | ||
}); | ||
}, | ||
onError(error: ApiError) { | ||
toast.error(error.message, { | ||
description: <ToastError error={error} />, | ||
duration: Infinity, | ||
cancel: { | ||
label: 'Dismiss', | ||
onClick: () => {}, | ||
}, | ||
}); | ||
}, | ||
}); | ||
|
||
return ( | ||
<div className='flex justify-end'> | ||
<DeleteDialog | ||
open={openDelDialog} | ||
setOpen={setOpenDelDialog} | ||
item={{ | ||
descriptor: 'user', | ||
name: row.original.username, | ||
}} | ||
onDelete={() => delUser({ username: row.original.username })} | ||
isPending={isDelPending} | ||
textConfirmation={true} | ||
/> | ||
</div> | ||
); | ||
}, | ||
}), | ||
]; | ||
|
||
const Users = () => { | ||
const search = Route.useSearch(); | ||
const pageIndex = search.page ? search.page - 1 : 0; | ||
const pageSize = search.pageSize ? search.pageSize : defaultPageSize; | ||
|
||
const { data: users } = useAdminServiceGetUsersSuspense(); | ||
|
||
const table = useReactTable({ | ||
data: users || [], | ||
columns, | ||
|
||
state: { | ||
pagination: { | ||
pageIndex, | ||
pageSize, | ||
}, | ||
}, | ||
getCoreRowModel: getCoreRowModel(), | ||
getPaginationRowModel: getPaginationRowModel(), | ||
}); | ||
|
||
return ( | ||
<Card className='h-fit'> | ||
<CardHeader> | ||
<CardTitle>Users</CardTitle> | ||
<CardDescription> | ||
These are all current users of the server. By clicking the delete | ||
button in the action column you can delete users, and a written | ||
confirmation is required to prevent accidental deletions. | ||
</CardDescription> | ||
<div className='py-2'> | ||
<Tooltip> | ||
<TooltipTrigger asChild> | ||
<Button asChild size='sm' className='ml-auto gap-1'> | ||
<Link to='/admin/users/create-user'> | ||
Add user | ||
<UserPlus className='h-4 w-4' /> | ||
</Link> | ||
</Button> | ||
</TooltipTrigger> | ||
<TooltipContent> | ||
Add a new user to the server. Note that the username has to be | ||
unique. | ||
</TooltipContent> | ||
</Tooltip> | ||
</div> | ||
</CardHeader> | ||
<CardContent> | ||
<CardContent> | ||
<DataTable | ||
table={table} | ||
setCurrentPageOptions={(currentPage) => { | ||
return { | ||
to: Route.to, | ||
search: { ...search, page: currentPage }, | ||
}; | ||
}} | ||
setPageSizeOptions={(size) => { | ||
return { | ||
to: Route.to, | ||
search: { ...search, page: 1, pageSize: size }, | ||
}; | ||
}} | ||
/> | ||
</CardContent> | ||
</CardContent> | ||
</Card> | ||
); | ||
}; | ||
|
||
export const Route = createFileRoute('/_layout/admin/users/')({ | ||
validateSearch: paginationSchema, | ||
loader: async ({ context }) => { | ||
prefetchUseAdminServiceGetUsers(context.queryClient); | ||
}, | ||
component: Users, | ||
pendingComponent: LoadingIndicator, | ||
}); |