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

ref: Move useReposBackfilled off Repo Deprecated #2862

Merged
merged 4 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ const mockBackfillData = {
},
owner: {
repository: {
__typename: 'Repository',
flagsMeasurementsActive: true,
flagsMeasurementsBackfilled: true,
flagsCount: 4,
Expand Down Expand Up @@ -313,6 +314,9 @@ describe('FileExplorer', () => {
}),
graphql.query('GetRepoSettingsTeam', (req, res, ctx) => {
return res(ctx.status(200), ctx.data(mockRepoSettings))
}),
graphql.query('GetRepoOverview', (req, res, ctx) => {
return res(ctx.status(200), ctx.data({}))
})
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ const mockBackfillHasFlagsAndActive = {
},
owner: {
repository: {
__typename: 'Repository',
flagsMeasurementsActive: true,
flagsMeasurementsBackfilled: true,
flagsCount: 4,
Expand All @@ -88,6 +89,7 @@ const mockBackfillTimeScaleDisabled = {
},
owner: {
repository: {
__typename: 'Repository',
flagsMeasurementsActive: true,
flagsMeasurementsBackfilled: true,
flagsCount: 4,
Expand All @@ -101,6 +103,7 @@ const mockBackfillNoFlagsPresent = {
},
owner: {
repository: {
__typename: 'Repository',
flagsMeasurementsActive: true,
flagsMeasurementsBackfilled: true,
flagsCount: 0,
Expand All @@ -114,6 +117,7 @@ const mockBackfillFlagMeasureNotActive = {
},
owner: {
repository: {
__typename: 'Repository',
flagsMeasurementsActive: false,
flagsMeasurementsBackfilled: true,
flagsCount: 4,
Expand Down
132 changes: 108 additions & 24 deletions src/services/repo/hooks.spec.js → src/services/repo/hooks.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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]}>
Expand All @@ -31,15 +32,20 @@ const wrapper =
const server = setupServer()

beforeAll(() => server.listen())
afterEach(() => server.resetHandlers())
afterEach(() => {
queryClient.clear()
server.resetHandlers()
})
afterAll(() => server.close())

console.error = () => {}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you mock this console in a setup, but also reset it after the test is finished, just to ensure that the console is back and running normally.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep yep! Fixed in 5ef5686


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))
Expand Down Expand Up @@ -137,7 +143,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({}))
}
)
)
Expand All @@ -154,7 +160,7 @@ describe('useEraseRepoContent', () => {
wrapper: wrapper(),
})

result.current.mutate(null)
result.current.mutate()

await waitFor(() => expect(result.current.isSuccess).toBeTruthy())
})
Expand Down Expand Up @@ -212,6 +218,7 @@ describe('useUpdateRepo', () => {
wrapper: wrapper(),
})

// @ts-expect-error
Copy link
Contributor

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?

result.current.mutate({})

await waitFor(() => expect(result.current.isSuccess).toBeTruthy())
Expand All @@ -224,40 +231,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,
}
Expand All @@ -266,5 +302,53 @@ describe('useRepoBackfilled', () => {
)
})
})

describe('can throw errors', () => {
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 () => {
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,
})
)
)
})
})
})
})
File renamed without changes.
73 changes: 0 additions & 73 deletions src/services/repo/useRepoBackfilled.ts

This file was deleted.