Skip to content

refactor: Refactor update check banner #5708

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 1 commit into from
Jan 13, 2023
Merged

refactor: Refactor update check banner #5708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 0 additions & 4 deletions site/src/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import CssBaseline from "@material-ui/core/CssBaseline"
import ThemeProvider from "@material-ui/styles/ThemeProvider"
import { LicenseBanner } from "components/LicenseBanner/LicenseBanner"
import { ServiceBanner } from "components/ServiceBanner/ServiceBanner"
import { FC } from "react"
import { HelmetProvider } from "react-helmet-async"
import { BrowserRouter as Router } from "react-router-dom"
Expand All @@ -20,8 +18,6 @@ export const App: FC = () => {
<CssBaseline />
<ErrorBoundary>
<XServiceProvider>
<ServiceBanner />
<LicenseBanner />
<AppRouter />
<GlobalSnackbar />
</XServiceProvider>
Expand Down
73 changes: 40 additions & 33 deletions site/src/components/DashboardLayout/DashboardLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,56 @@
import { makeStyles } from "@material-ui/core/styles"
import { useActor } from "@xstate/react"
import { useMachine } from "@xstate/react"
import { Loader } from "components/Loader/Loader"
import { FC, Suspense, useContext, useEffect } from "react"
import { XServiceContext } from "../../xServices/StateContext"
import { FC, Suspense } from "react"
import { Navbar } from "../Navbar/Navbar"
import { UpdateCheckBanner } from "components/UpdateCheckBanner/UpdateCheckBanner"
import { Margins } from "components/Margins/Margins"
import { Outlet } from "react-router-dom"
import { LicenseBanner } from "components/LicenseBanner/LicenseBanner"
import { ServiceBanner } from "components/ServiceBanner/ServiceBanner"
import { updateCheckMachine } from "xServices/updateCheck/updateCheckXService"
import { usePermissions } from "hooks/usePermissions"
import { UpdateCheckResponse } from "api/typesGenerated"

export const DashboardLayout: FC = () => {
const styles = useStyles()
const xServices = useContext(XServiceContext)
const [authState] = useActor(xServices.authXService)
const [updateCheckState, updateCheckSend] = useActor(
xServices.updateCheckXService,
)

useEffect(() => {
if (authState.matches("signedIn")) {
updateCheckSend("CHECK")
} else {
updateCheckSend("CLEAR")
}
}, [authState, updateCheckSend])
const permissions = usePermissions()
const [updateCheckState, updateCheckSend] = useMachine(updateCheckMachine, {
context: {
permissions,
},
})
const { error: updateCheckError, updateCheck } = updateCheckState.context

return (
<div className={styles.site}>
<Navbar />
{updateCheckState.context.show && (
<div className={styles.updateCheckBanner}>
<Margins>
<UpdateCheckBanner
updateCheck={updateCheckState.context.updateCheck}
error={updateCheckState.context.error}
onDismiss={() => updateCheckSend("DISMISS")}
/>
</Margins>
<>
<ServiceBanner />
<LicenseBanner />

<div className={styles.site}>
<Navbar />

{updateCheckState.matches("show") && (
<div className={styles.updateCheckBanner}>
<Margins>
<UpdateCheckBanner
// We can trust when it is show, the update check is filled
// unfortunately, XState does not has typed state - context yet
updateCheck={updateCheck as UpdateCheckResponse}
error={updateCheckError}
onDismiss={() => updateCheckSend("DISMISS")}
/>
</Margins>
</div>
)}

<div className={styles.siteContent}>
<Suspense fallback={<Loader />}>
<Outlet />
</Suspense>
</div>
)}
<div className={styles.siteContent}>
<Suspense fallback={<Loader />}>
<Outlet />
</Suspense>
</div>
</div>
</>
)
}

Expand Down
51 changes: 0 additions & 51 deletions site/src/components/UpdateCheckBanner/UpdateCheckBanner.test.tsx
View file
Open in desktop

This file was deleted.

74 changes: 31 additions & 43 deletions site/src/components/UpdateCheckBanner/UpdateCheckBanner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,58 +2,46 @@ import Link from "@material-ui/core/Link"
import { AlertBanner } from "components/AlertBanner/AlertBanner"
import { Trans, useTranslation } from "react-i18next"
import * as TypesGen from "api/typesGenerated"
import { FC, useState } from "react"
import { FC } from "react"

export interface UpdateCheckBannerProps {
updateCheck?: TypesGen.UpdateCheckResponse
error?: Error | unknown
onDismiss?: () => void
updateCheck: TypesGen.UpdateCheckResponse
error?: unknown
onDismiss: () => void
}

export const UpdateCheckBanner: FC<
React.PropsWithChildren<UpdateCheckBannerProps>
> = ({ updateCheck, error, onDismiss }) => {
const { t } = useTranslation("common")

const isOutdated = updateCheck && !updateCheck.current

const [show, setShow] = useState(error || isOutdated)

const dismiss = () => {
onDismiss && onDismiss()
setShow(false)
}

return (
<>
{show && (
<AlertBanner
severity={error ? "error" : "info"}
error={error}
onDismiss={dismiss}
dismissible
>
<>
{error && <>{t("updateCheck.error")} </>}
{isOutdated && (
<div>
<Trans
t={t}
i18nKey="updateCheck.message"
values={{ version: updateCheck.version }}
>
Coder {"{{version}}"} is now available. View the{" "}
<Link href={updateCheck.url}>release notes</Link> and{" "}
<Link href="https://coder.com/docs/coder-oss/latest/admin/upgrade">
upgrade instructions
</Link>{" "}
for more information.
</Trans>
</div>
)}
</>
</AlertBanner>
)}
</>
<AlertBanner
severity={error ? "error" : "info"}
error={error}
onDismiss={onDismiss}
dismissible
>
<>
{error ? (
t("updateCheck.error")
) : (
<div>
<Trans
t={t}
i18nKey="updateCheck.message"
values={{ version: updateCheck.version }}
>
Coder {"{{version}}"} is now available. View the{" "}
<Link href={updateCheck.url}>release notes</Link> and{" "}
<Link href="https://coder.com/docs/coder-oss/latest/admin/upgrade">
upgrade instructions
</Link>{" "}
for more information.
</Trans>
</div>
)}
</>
</AlertBanner>
)
}
1 change: 1 addition & 0 deletions site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1096,6 +1096,7 @@ export const MockPermissions: Permissions = {
updateUsers: true,
viewAuditLog: true,
viewDeploymentConfig: true,
viewUpdateCheck: true,
}

export const MockAppearance: TypesGen.AppearanceConfig = {
Expand Down
3 changes: 0 additions & 3 deletions site/src/xServices/StateContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { createContext, FC, ReactNode } from "react"
import { ActorRefFrom } from "xstate"
import { authMachine } from "./auth/authXService"
import { buildInfoMachine } from "./buildInfo/buildInfoXService"
import { updateCheckMachine } from "./updateCheck/updateCheckXService"
import { entitlementsMachine } from "./entitlements/entitlementsXService"
import { appearanceMachine } from "./appearance/appearanceXService"

Expand All @@ -12,7 +11,6 @@ interface XServiceContextType {
buildInfoXService: ActorRefFrom<typeof buildInfoMachine>
entitlementsXService: ActorRefFrom<typeof entitlementsMachine>
appearanceXService: ActorRefFrom<typeof appearanceMachine>
updateCheckXService: ActorRefFrom<typeof updateCheckMachine>
}

/**
Expand All @@ -33,7 +31,6 @@ export const XServiceProvider: FC<{ children: ReactNode }> = ({ children }) => {
buildInfoXService: useInterpret(buildInfoMachine),
entitlementsXService: useInterpret(entitlementsMachine),
appearanceXService: useInterpret(appearanceMachine),
updateCheckXService: useInterpret(updateCheckMachine),
}}
>
{children}
Expand Down
7 changes: 7 additions & 0 deletions site/src/xServices/auth/authXService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export const checks = {
viewAuditLog: "viewAuditLog",
viewDeploymentConfig: "viewDeploymentConfig",
createGroup: "createGroup",
viewUpdateCheck: "viewUpdateCheck",
} as const

export const permissionsToCheck = {
Expand Down Expand Up @@ -67,6 +68,12 @@ export const permissionsToCheck = {
},
action: "create",
},
[checks.viewUpdateCheck]: {
object: {
resource_type: "update_check",
},
action: "read",
},
} as const

export type Permissions = Record<keyof typeof permissionsToCheck, boolean>
Expand Down
Loading