Skip to content

feat: Add support for update checks and notifications #4810

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 14 commits into from
Dec 1, 2022
Merged

feat: Add support for update checks and notifications #4810

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
cc28c1b
feat: Add support for checking for updates
mafredri Oct 31, 2022
c163af8
wip(site): Add support for informing of updates
mafredri Oct 31, 2022
e9ed0b7
Add /api/v2/updatecheck to noauthorize list
mafredri Oct 31, 2022
64ad0f5
Fix edge case where update check has never succeeded
mafredri Oct 31, 2022
0238d5a
Fix logging
mafredri Oct 31, 2022
9e1ea9e
Use AlertBanner for coder version notice
mafredri Nov 29, 2022
979ff80
Update golden files
mafredri Nov 29, 2022
b80de3c
Fix margins, improve alert banner and add stories
mafredri Nov 30, 2022
81d11dd
Add authorization, dismissal and fetch after login
mafredri Nov 30, 2022
392d06e
Apply suggestions from code review
mafredri Dec 1, 2022
ad38c3b
Add forgotten UpdateCheckBanner.stories.tsx
mafredri Nov 30, 2022
1c9dbc1
fix(api): Amend PR comments
mafredri Dec 1, 2022
49a7bfc
fix(site): Always show prefix for update check errors, remove as const
mafredri Dec 1, 2022
44f6475
fix(site): Add jest tests for UpdateCheckBanner
mafredri Dec 1, 2022
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
Prev Previous commit
fix(site): Add jest tests for UpdateCheckBanner
  • Loading branch information
@mafredri
mafredri committed Dec 1, 2022
commit 44f6475db8f6c2f378f06915ad05ec00cab76fa9
9 changes: 0 additions & 9 deletions site/src/components/UpdateCheckBanner/UpdateCheckBanner.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,6 @@ UpdateAvailable.args = {
},
}

export const NoUpdateAvailable = Template.bind({})
NoUpdateAvailable.args = {
updateCheck: {
current: true,
version: "v0.12.9",
url: "https://github.com/coder/coder/releases/tag/v0.12.9",
},
}

export const UpdateCheckError = Template.bind({})
UpdateCheckError.args = {
error: new Error("Something went wrong."),
Expand Down
51 changes: 51 additions & 0 deletions site/src/components/UpdateCheckBanner/UpdateCheckBanner.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import { fireEvent, screen, waitFor } from "@testing-library/react"
import i18next from "i18next"
import { MockUpdateCheck, render } from "testHelpers/renderHelpers"
import { UpdateCheckBanner } from "./UpdateCheckBanner"

describe("UpdateCheckBanner", () => {
it("shows an update notification when one is available", () => {
const { t } = i18next
render(
<UpdateCheckBanner
updateCheck={{ ...MockUpdateCheck, current: false }}
/>,
)

const updateText = t("updateCheck.message", {
ns: "common",
version: MockUpdateCheck.version,
})
// Message contatins HTML elements so we check it in parts.
for (const text of updateText.split(/<\/?[0-9]+>/)) {
expect(screen.getByText(text, { exact: false })).toBeInTheDocument()
}

expect(screen.getAllByRole("link")[0]).toHaveAttribute(
"href",
MockUpdateCheck.url,
)
})

it("is hidden when dismissed", async () => {
const dismiss = jest.fn()
const { container } = render(
<UpdateCheckBanner
onDismiss={dismiss}
updateCheck={{ ...MockUpdateCheck, current: false }}
/>,
)

fireEvent.click(screen.getByRole("button"))
await waitFor(() => expect(dismiss).toBeCalledTimes(1), { timeout: 2000 })

expect(container.firstChild).toBeNull()
})

it("does not show when up-to-date", async () => {
const { container } = render(
<UpdateCheckBanner updateCheck={{ ...MockUpdateCheck, current: true }} />,
)
expect(container.firstChild).toBeNull()
})
})