Skip to content
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

chore: Migrate useSelfHostedUserList to TS Query V5 #3575

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import {
QueryClientProvider as QueryClientProviderV5,
QueryClient as QueryClientV5,
} from '@tanstack/react-queryV5'
import { render, screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { graphql, http, HttpResponse } from 'msw'
Expand Down Expand Up @@ -61,22 +65,29 @@ const mockOpenSeatsTaken = {
const queryClient = new QueryClient({
defaultOptions: { queries: { retry: false, cacheTime: Infinity } },
})
const queryClientV5 = new QueryClientV5({
defaultOptions: { queries: { retry: false, cacheTime: Infinity } },
})

const wrapper = ({ children }) => (
<QueryClientProvider client={queryClient}>
<MemoryRouter initialEntries={['/admin/gh/members']}>
<Route path="/admin/:provider/members">{children}</Route>
</MemoryRouter>
</QueryClientProvider>
<QueryClientProviderV5 client={queryClientV5}>
<QueryClientProvider client={queryClient}>
<MemoryRouter initialEntries={['/admin/gh/members']}>
<Route path="/admin/:provider/members">{children}</Route>
</MemoryRouter>
</QueryClientProvider>
</QueryClientProviderV5>
)

const server = setupServer()
beforeAll(() => {
server.listen()
})

beforeEach(() => {
server.resetHandlers()
afterEach(() => {
queryClient.clear()
queryClientV5.clear()
server.resetHandlers()
})

afterAll(() => {
Expand Down
49 changes: 39 additions & 10 deletions src/pages/AdminSettings/AdminMembers/MemberList/MemberTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import {
useMutation,
useQueryClient,
} from '@tanstack/react-query'
import {
useInfiniteQuery as useInfiniteQueryV5,
useQueryClient as useQueryClientV5,
} from '@tanstack/react-queryV5'
import {
createColumnHelper,
flexRender,
Expand All @@ -14,11 +18,11 @@ import { useEffect, useMemo } from 'react'
import { useInView } from 'react-intersection-observer'

import { useLocationParams } from 'services/navigation'
import { useSelfHostedSettings } from 'services/selfHosted'
import {
SelfHostedUserListQueryOpts,
UserListOwner,
useSelfHostedSettings,
useSelfHostedUserList,
} from 'services/selfHosted'
} from 'services/selfHosted/SelfHostedUserListQueryOpts'
import Api from 'shared/api'
import Spinner from 'ui/Spinner'
import Toggle from 'ui/Toggle'
Expand Down Expand Up @@ -57,11 +61,6 @@ const columns = [
}),
]

interface MutationArgs {
activated: boolean
ownerid: number
}

interface CreateTableArgs {
tableData: UserListOwner[]
seatData: SelfHostedSettings
Expand Down Expand Up @@ -94,6 +93,28 @@ const createTable = ({ tableData, seatData, mutate }: CreateTableArgs) => {
)
}

interface Params {
activated?: boolean
search?: string
isAdmin?: boolean
}

const useQueryMembersList = (params: Params) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Im also kinda curious why we pulled the memo out of the query and into this new query in the component itself

const { data: queryData, ...rest } = useInfiniteQueryV5(
SelfHostedUserListQueryOpts(params)
)

const flatUsersList = useMemo(
() => queryData?.pages?.flatMap((page) => page.results) ?? [],
[queryData?.pages]
)

return {
...rest,
Copy link
Contributor

Choose a reason for hiding this comment

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

any chance we can avoid using ...rest here? Do we really need everything coming back from this query call?

data: flatUsersList,
}
}

const Loader = () => (
<div className="mb-4 flex justify-center pt-4">
<Spinner />
Expand All @@ -115,8 +136,14 @@ function LoadMoreTrigger({
)
}

interface MutationArgs {
activated: boolean
ownerid: number
}

function MemberTable() {
const queryClient = useQueryClient()
const queryClientV5 = useQueryClientV5()
const { ref, inView } = useInView()
const { data: seatData } = useSelfHostedSettings()
const { params } = useLocationParams({
Expand All @@ -126,7 +153,7 @@ function MemberTable() {
})

const { data, isFetchingNextPage, hasNextPage, fetchNextPage, isLoading } =
useSelfHostedUserList(params)
useQueryMembersList(params)

const { mutate } = useMutation({
mutationFn: ({ activated, ownerid }: MutationArgs) =>
Expand All @@ -135,7 +162,9 @@ function MemberTable() {
onSuccess: () => {
queryClient.invalidateQueries(['SelfHostedSettings'])
queryClient.invalidateQueries(['Seats'])
queryClient.invalidateQueries(['SelfHostedUserList'])
queryClientV5.invalidateQueries({
queryKey: SelfHostedUserListQueryOpts(params).queryKey,
})
},
})

Expand Down
Loading
Loading