Skip to content

SSO papercuts (more logs & make downloading them easier) #1930

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.

Sign up for GitHub

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 2 commits into from
Jul 28, 2023
Merged

SSO papercuts (more logs & make downloading them easier) #1930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82dd3cf
make sso logs download button look like a button
OskarDamkjaer Jul 28, 2023
6705571
improve SSO auth logging
OskarDamkjaer Jul 28, 2023
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
12 changes: 7 additions & 5 deletions src/browser/modules/Stream/Auth/ConnectForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,13 +392,15 @@ export default function ConnectForm(props: ConnectFormProps): JSX.Element {
{props.authenticationMethod === SSO &&
!SSOLoading &&
(SSOError || SSORedirectError) && (
<StyledSSOError>
<StyledCypherErrorMessage>ERROR</StyledCypherErrorMessage>
<div>{SSOError || SSORedirectError}</div>
<>
<StyledSSOError>
<StyledCypherErrorMessage>ERROR</StyledCypherErrorMessage>
<div>{SSOError || SSORedirectError}</div>
</StyledSSOError>
<StyledSSOLogDownload onClick={downloadAuthLogs}>
Download logs
Download browser SSO logs
</StyledSSOLogDownload>
</StyledSSOError>
</>
)}

{props.connecting
Expand Down
21 changes: 20 additions & 1 deletion src/browser/modules/Stream/Auth/styled.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,33 @@ export const StyledDbsRow = styled.li``
export const StyledFormContainer = styled.div`
display: flex;
`
export const StyledSSOLogDownload = styled.a`
export const StyledSSOLogDownload = styled.button`
color: ${props => props.theme.primaryButtonText};
background-color: ${props => props.theme.primary};
border: 1px solid ${props => props.theme.primary};
font-family: ${props => props.theme.primaryFontFamily};
padding: 6px 18px;
font-weight: 600;
font-size: 14px;
text-align: center;
vertical-align: middle;
cursor: pointer;
border-radius: 4px;
line-height: 20px;

&:hover {
background-color: ${props => props.theme.primary50};
color: ${props => props.theme.secondaryButtonTextHover};
border: 1px solid ${props => props.theme.primary50};
}
`

export const StyledSSOButtonContainer = styled.div`
margin-bottom: 12px;
`
export const StyledSSOError = styled.div`
margin-top: 30px;
padding: 3px;
white-space: pre-line;
display: flex;
`
11 changes: 11 additions & 0 deletions src/shared/modules/connections/connectionsDuck.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,11 @@ export const startupConnectEpic = (action$: any, store: any) => {
resolve({ type: STARTUP_CONNECTION_SUCCESS })
})
.catch(() => {
if (discovered.attemptSSOLogin) {
authLog(
'client side SSO flow completed but Neo4j Browser failed to connect to neo4j. Server side logs (security.log or debug.log) may contain more information.'
)
}
store.dispatch(setActiveConnection(null))
store.dispatch(
discovery.updateDiscoveryConnection({
Expand Down Expand Up @@ -694,6 +699,12 @@ export const connectionLostEpic = (action$: any, store: any) =>
)
} catch (e) {
authLog(`Failed to refresh token: ${e}`)
authLog(
'This could be due to the refresh token not being available, which happens if Neo4j Browser accessed via stored credentials rather than redoing the SSO flow. ' +
'If you have a short lived access token, it may be beneficial to set `browser.retain_connection_credentials=false` in neo4j.conf to make sure the refresh token is always available.'
)
// if refreshing the token failed, don't retry
return resolve({ type: UnauthorizedDriverError })
}
}
} else {
Expand Down