Skip to content

refactor(site): Improve workspaces filtering #7681

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

Merged
merged 25 commits into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
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
Prev Previous commit
Next Next commit
Fix errors
  • Loading branch information
BrunoQuaresma committed May 25, 2023
commit 8fe547cfbaf7f4f59ff0149df4080487192318d8
3 changes: 3 additions & 0 deletions site/src/api/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ export const isApiValidationError = (error: unknown): error is ApiError => {
return isApiError(error) && hasApiFieldErrors(error)
}

export const hasError = (error: unknown) =>
error !== undefined && error !== null

export const mapApiErrorToFieldErrors = (
apiErrorResponse: ApiErrorResponse,
): FieldErrors => {
Expand Down
12 changes: 12 additions & 0 deletions site/src/pages/WorkspacesPage/Filter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ import { useQuery } from "@tanstack/react-query"
import { getUsers, getTemplates } from "api/api"
import Skeleton, { SkeletonProps } from "@mui/material/Skeleton"
import CheckOutlined from "@mui/icons-material/CheckOutlined"
import {
getValidationErrorMessage,
hasError,
isApiValidationError,
} from "api/errors"

/** Filter */

Expand Down Expand Up @@ -323,14 +328,17 @@ const FilterSkeleton = (props: SkeletonProps) => {
export const Filter = ({
filter,
autocomplete,
error,
}: {
filter: UseFilterResult
error?: unknown
autocomplete: {
users?: UsersAutocomplete
templates: TemplatesAutocomplete
status: StatusAutocomplete
}
}) => {
const shouldDisplayError = hasError(error) && isApiValidationError(error)
const hasFilterQuery = filter.query !== ""
const isIinitializingFilters =
autocomplete.status.isInitializing ||
Expand All @@ -351,6 +359,10 @@ export const Filter = ({
return (
<Box display="flex" sx={{ gap: 1, mb: 2 }}>
<TextField
error={shouldDisplayError}
helperText={
shouldDisplayError ? getValidationErrorMessage(error) : undefined
}
sx={{ width: "100%" }}
color="success"
size="small"
Expand Down
5 changes: 3 additions & 2 deletions site/src/pages/WorkspacesPage/WorkspacesPageView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import difference from "lodash/difference"
import { ImpendingDeletionBanner } from "components/WorkspaceDeletion"
import { ErrorAlert } from "components/Alert/ErrorAlert"
import { Filter } from "./Filter"
import { hasError, isApiValidationError } from "api/errors"

export const Language = {
pageTitle: "Workspaces",
Expand Down Expand Up @@ -98,7 +99,7 @@ export const WorkspacesPageView: FC<
</PageHeader>

<Stack>
<Maybe condition={Boolean(error)}>
<Maybe condition={hasError(error) && !isApiValidationError(error)}>
<ErrorAlert error={error} />
</Maybe>
<ImpendingDeletionBanner
Expand All @@ -112,7 +113,7 @@ export const WorkspacesPageView: FC<
}
/>

<Filter {...filterProps} />
<Filter error={error} {...filterProps} />
</Stack>
<WorkspacesTable
workspaces={workspaces}
Expand Down
3 changes: 2 additions & 1 deletion site/src/pages/WorkspacesPage/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ export const useWorkspacesData = ({
limit,
query,
}: UseWorkspacesDataParams) => {
const queryKey = ["workspaces", query, page]
const debouncedQuery = useState(query)
const queryKey = ["workspaces", debouncedQuery, page]
const [shouldRefetch, setShouldRefetch] = useState(true)
const result = useQuery({
queryKey,
Expand Down