-
Notifications
You must be signed in to change notification settings - Fork 17
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
ref: Move useReposBackfilled off Repo Deprecated #2862
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,7 @@ import { QueryClient, QueryClientProvider } from '@tanstack/react-query' | |
import { renderHook, waitFor } from '@testing-library/react' | ||
import { graphql, rest } from 'msw' | ||
import { setupServer } from 'msw/node' | ||
import React from 'react' | ||
import { MemoryRouter, Route } from 'react-router-dom' | ||
|
||
import { | ||
|
@@ -16,7 +17,7 @@ const queryClient = new QueryClient({ | |
}) | ||
|
||
const wrapper = | ||
(initialEntries = '/gh/codecov/test') => | ||
(initialEntries = '/gh/codecov/test'): React.FC<React.PropsWithChildren> => | ||
({ children }) => | ||
( | ||
<MemoryRouter initialEntries={[initialEntries]}> | ||
|
@@ -31,15 +32,18 @@ const wrapper = | |
const server = setupServer() | ||
|
||
beforeAll(() => server.listen()) | ||
afterEach(() => server.resetHandlers()) | ||
afterEach(() => { | ||
queryClient.clear() | ||
server.resetHandlers() | ||
}) | ||
afterAll(() => server.close()) | ||
|
||
const provider = 'gh' | ||
const owner = 'RulaKhaled' | ||
const repo = 'test' | ||
const owner = 'cool-guy' | ||
const repo = 'cool-repo' | ||
|
||
describe('useRepo', () => { | ||
function setup(apiData) { | ||
function setup(apiData: any) { | ||
server.use( | ||
graphql.query('GetRepo', (req, res, ctx) => { | ||
return res(ctx.status(200), ctx.data(apiData)) | ||
|
@@ -57,12 +61,17 @@ describe('useRepo', () => { | |
}, | ||
} | ||
|
||
beforeEach(() => { | ||
setup(badData) | ||
beforeAll(() => { | ||
console.error = () => {} | ||
}) | ||
|
||
afterAll(() => { | ||
jest.resetAllMocks() | ||
}) | ||
|
||
describe('when incorrect data is loaded', () => { | ||
it('throws an error', async () => { | ||
setup(badData) | ||
const { result } = renderHook( | ||
() => useRepo({ provider, owner, repo }), | ||
{ | ||
|
@@ -137,7 +146,7 @@ describe('useEraseRepoContent', () => { | |
rest.patch( | ||
`internal/github/codecov/repos/test/erase/`, | ||
(req, res, ctx) => { | ||
return res(ctx.status(200), ctx.json()) | ||
return res(ctx.status(200), ctx.json({})) | ||
} | ||
) | ||
) | ||
|
@@ -154,7 +163,7 @@ describe('useEraseRepoContent', () => { | |
wrapper: wrapper(), | ||
}) | ||
|
||
result.current.mutate(null) | ||
result.current.mutate() | ||
|
||
await waitFor(() => expect(result.current.isSuccess).toBeTruthy()) | ||
}) | ||
|
@@ -212,6 +221,7 @@ describe('useUpdateRepo', () => { | |
wrapper: wrapper(), | ||
}) | ||
|
||
// @ts-expect-error | ||
result.current.mutate({}) | ||
|
||
await waitFor(() => expect(result.current.isSuccess).toBeTruthy()) | ||
|
@@ -224,40 +234,69 @@ describe('useRepoBackfilled', () => { | |
const dataReturned = { | ||
owner: { | ||
repository: { | ||
__typename: 'Repository', | ||
flagsMeasurementsActive: true, | ||
flagsMeasurementsBackfilled: true, | ||
}, | ||
}, | ||
} | ||
|
||
function setup() { | ||
const mockUnsuccessfulParseError = {} | ||
|
||
const mockRepoNotFound = { | ||
owner: { | ||
repository: { | ||
__typename: 'NotFoundError', | ||
message: 'Repository not found', | ||
}, | ||
}, | ||
} | ||
|
||
const mockOwnerNotActivated = { | ||
owner: { | ||
repository: { | ||
__typename: 'OwnerNotActivatedError', | ||
message: 'Owner not activated', | ||
}, | ||
}, | ||
} | ||
|
||
interface SetupArgs { | ||
isNotFoundError?: boolean | ||
isOwnerNotActivatedError?: boolean | ||
isUnsuccessfulParseError?: boolean | ||
} | ||
|
||
function setup({ | ||
isNotFoundError = false, | ||
isOwnerNotActivatedError = false, | ||
isUnsuccessfulParseError = false, | ||
}: SetupArgs) { | ||
server.use( | ||
graphql.query('BackfillFlagMemberships', (req, res, ctx) => { | ||
return res(ctx.status(200), ctx.data(dataReturned)) | ||
if (isNotFoundError) { | ||
return res(ctx.status(200), ctx.data(mockRepoNotFound)) | ||
} else if (isOwnerNotActivatedError) { | ||
return res(ctx.status(200), ctx.data(mockOwnerNotActivated)) | ||
} else if (isUnsuccessfulParseError) { | ||
return res(ctx.status(200), ctx.data(mockUnsuccessfulParseError)) | ||
} else { | ||
return res(ctx.status(200), ctx.data(dataReturned)) | ||
} | ||
}) | ||
) | ||
} | ||
|
||
describe('when called', () => { | ||
beforeEach(() => { | ||
setup() | ||
}) | ||
|
||
describe('when data is loaded', () => { | ||
it('returns the data', async () => { | ||
const { result } = renderHook( | ||
() => | ||
useRepoBackfilled({ | ||
provider: 'gh', | ||
owner: 'owner', | ||
repo: 'another-test', | ||
}), | ||
{ | ||
wrapper: wrapper(), | ||
} | ||
) | ||
setup({}) | ||
const { result } = renderHook(() => useRepoBackfilled(), { | ||
wrapper: wrapper(), | ||
}) | ||
|
||
const expectedResponse = { | ||
__typename: 'Repository', | ||
flagsMeasurementsActive: true, | ||
flagsMeasurementsBackfilled: true, | ||
} | ||
|
@@ -266,5 +305,60 @@ describe('useRepoBackfilled', () => { | |
) | ||
}) | ||
}) | ||
|
||
describe('can throw errors', () => { | ||
beforeAll(() => { | ||
console.error = () => {} | ||
}) | ||
|
||
afterAll(() => { | ||
jest.resetAllMocks() | ||
}) | ||
it('can return unsuccessful parse error', async () => { | ||
setup({ isUnsuccessfulParseError: true }) | ||
const { result } = renderHook(() => useRepoBackfilled(), { | ||
wrapper: wrapper(), | ||
}) | ||
|
||
await waitFor(() => expect(result.current.isError).toBeTruthy()) | ||
await waitFor(() => | ||
expect(result.current.error).toEqual( | ||
expect.objectContaining({ | ||
status: 404, | ||
}) | ||
) | ||
) | ||
}) | ||
it('can return not found error', async () => { | ||
setup({ isNotFoundError: true }) | ||
const { result } = renderHook(() => useRepoBackfilled(), { | ||
wrapper: wrapper(), | ||
}) | ||
|
||
await waitFor(() => expect(result.current.isError).toBeTruthy()) | ||
await waitFor(() => | ||
expect(result.current.error).toEqual( | ||
expect.objectContaining({ | ||
status: 404, | ||
}) | ||
) | ||
) | ||
}) | ||
it('can return owner not activated error', async () => { | ||
Comment on lines
+316
to
+347
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just me being a little picky, moving forward if you're working on tests do you mind adding in an empty line in between these test blocks, I feel like it makes things a lot cleaning when you're working around the tests and "mini-mizing" them in your editor. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For sure, I think stylistic things like this could be brought up in our weekly meeting as well if we want to make team norms around them! |
||
setup({ isOwnerNotActivatedError: true }) | ||
const { result } = renderHook(() => useRepoBackfilled(), { | ||
wrapper: wrapper(), | ||
}) | ||
|
||
await waitFor(() => expect(result.current.isError).toBeTruthy()) | ||
await waitFor(() => | ||
expect(result.current.error).toEqual( | ||
expect.objectContaining({ | ||
status: 403, | ||
}) | ||
) | ||
) | ||
}) | ||
}) | ||
}) | ||
}) |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interested as to what's going on here? is it just that the current hook that returns the mutation hasn't been uploaded to TS yet?