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

fix: Hide tokenless banner for signed out user #3677

Merged
merged 5 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from 4 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
Expand Up @@ -5,6 +5,8 @@ import { setupServer } from 'msw/node'
import { Suspense } from 'react'
import { MemoryRouter, Route } from 'react-router-dom'

import { Plans } from 'shared/utils/billing'

import TokenlessBanner from './TokenlessBanner'

const mocks = vi.hoisted(() => ({
Expand All @@ -15,6 +17,8 @@ vi.mock('shared/featureFlags', () => ({
useFlags: mocks.useFlags,
}))

vi.mock('services/users')

vi.mock('./TokenRequiredBanner', () => ({
default: () => 'TokenRequiredBanner',
}))
Expand All @@ -41,6 +45,50 @@ afterAll(() => {
server.close()
})

const mockSignedInUser = {
me: {
owner: {
defaultOrgUsername: 'codecov',
},
email: '[email protected]',
privateAccess: true,
onboardingCompleted: true,
businessEmail: '[email protected]',
termsAgreement: true,
user: {
name: 'Jane Doe',
username: 'janedoe',
avatarUrl: 'http://127.0.0.1/avatar-url',
avatar: 'http://127.0.0.1/avatar-url',
student: false,
studentCreatedAt: null,
studentUpdatedAt: null,
customerIntent: 'PERSONAL',
},
trackingMetadata: {
service: 'github',
ownerid: 123,
serviceId: '123',
plan: Plans.USERS_BASIC,
staff: false,
hasYaml: false,
bot: null,
delinquent: null,
didTrial: null,
planProvider: null,
planUserCount: 1,
createdAt: 'timestamp',
updatedAt: 'timestamp',
profile: {
createdAt: 'timestamp',
otherGoal: null,
typeProjects: [],
goals: [],
},
},
},
}

const wrapper =
(initialEntries = ['/gh/codecov']): React.FC<React.PropsWithChildren> =>
({ children }) => (
Expand All @@ -57,9 +105,11 @@ describe('TokenlessBanner', () => {
function setup({
tokenlessSection = true,
uploadTokenRequired = false,
currentUser,
}: {
tokenlessSection?: boolean
uploadTokenRequired?: boolean
currentUser?: any
} = {}) {
mocks.useFlags.mockReturnValue({ tokenlessSection })

Expand All @@ -74,15 +124,16 @@ describe('TokenlessBanner', () => {
},
},
})
}),
graphql.query('CurrentUser', () => {
return HttpResponse.json({ data: currentUser })
})
)
}

it('renders nothing when tokenlessSection flag is false', () => {
setup({ tokenlessSection: false })
const { container } = render(<TokenlessBanner />, {
wrapper: wrapper(['/gh/codecov']),
})
setup({ tokenlessSection: false, currentUser: mockSignedInUser })
const { container } = render(<TokenlessBanner />, { wrapper: wrapper(['/gh/codecov']) })
expect(container).toBeEmptyDOMElement()
})

Expand All @@ -95,7 +146,7 @@ describe('TokenlessBanner', () => {
})

it('renders TokenRequiredBanner when uploadTokenRequired is true', async () => {
setup({ uploadTokenRequired: true })
setup({ uploadTokenRequired: true, currentUser: mockSignedInUser })
render(<TokenlessBanner />, { wrapper: wrapper(['/gh/codecov']) })

await waitFor(() => {
Expand All @@ -105,7 +156,7 @@ describe('TokenlessBanner', () => {
})

it('renders TokenNotRequiredBanner when uploadTokenRequired is false', async () => {
setup({ uploadTokenRequired: false })
setup({ uploadTokenRequired: false, currentUser: mockSignedInUser })
render(<TokenlessBanner />, { wrapper: wrapper(['/gh/codecov']) })

await waitFor(() => {
Expand All @@ -115,7 +166,7 @@ describe('TokenlessBanner', () => {
})

it('renders nothing if coming from onboarding', async () => {
setup({ uploadTokenRequired: true })
setup({ uploadTokenRequired: true, currentUser: mockSignedInUser })
render(<TokenlessBanner />, {
wrapper: wrapper(['/gh/codecov?source=onboarding']),
})
Expand All @@ -128,4 +179,10 @@ describe('TokenlessBanner', () => {
).not.toBeInTheDocument()
})
})

it('renders nothing when currentUser is not provided', () => {
setup({ uploadTokenRequired: false, currentUser: mockSignedInUser })
const { container } = render(<TokenlessBanner />, { wrapper: wrapper() })
expect(container).toBeEmptyDOMElement()
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { useParams } from 'react-router-dom'
import { ONBOARDING_SOURCE } from 'pages/TermsOfService/constants'
import { useLocationParams } from 'services/navigation'
import { useUploadTokenRequired } from 'services/uploadTokenRequired'
import { useUser } from 'services/user'
import { useFlags } from 'shared/featureFlags'

const TokenRequiredBanner = lazy(() => import('./TokenRequiredBanner'))
Expand All @@ -20,11 +21,12 @@ const TokenlessBanner: React.FC = () => {
})
const { provider, owner } = useParams<UseParams>()
const { data } = useUploadTokenRequired({ provider, owner, enabled: !!owner })
const { data: currentUser } = useUser()
const { params } = useLocationParams()
// @ts-expect-error useLocationParams needs to be typed
const cameFromOnboarding = params['source'] === ONBOARDING_SOURCE

if (!tokenlessSection || !owner || !data || cameFromOnboarding) return null
if (!tokenlessSection || !owner || !data || !currentUser?.user || cameFromOnboarding) return null

return data?.uploadTokenRequired ? (
<TokenRequiredBanner />
Expand Down
Loading