Skip to content

Fix a flaky test #1487

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
Aug 29, 2024
Merged

Fix a flaky test #1487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72eb239
cc/fix-a-test
ChristopherChudzicki Aug 29, 2024
acf2dbb
split out tests more by channel type
ChristopherChudzicki Aug 29, 2024
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
201 changes: 109 additions & 92 deletions frontends/mit-learn/src/pages/ChannelPage/ChannelPage.test.tsx
View file
Open in desktop
Copy link
Contributor Author

@ChristopherChudzicki ChristopherChudzicki Aug 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

A test that was meant only for non-unit channels was running ~25% of the time for unit channels, too.

This PR resolves that.

Before:

describe("ChannelPage", () => {
    test.each(NON_UNIT_CHANNEL_TYPES)("test some non unit stuff", ()=>{})
    test("some stuff for all channels", () => {})
    test("some stuff for a specific channel type declared in test", () => {})
    // ...
})

describe("Unit ChannelPage", () => {
  test.each(NON_UNIT_CHANNEL_TYPES)("test some non unit stuff", ()=>{})
  test("some stuff for all channels", () => {})
  test("some stuff for a specific channel type declared in test", () => {})
  // ...
})

Now:

describe.each(ALL_CHANNEL_TYPES)("ChannelPage, common behavior ($channelType)", ...)
describe.each(NON_UNIT_CHANNEL_TYPES)("ChannelPage, common non-unit behavior ($channelType)", ...)
describe("ChannelPage, unit only", ...)

Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,100 @@ const setupApis = (
}
}

describe("ChannelPage", () => {
it.each(
Object.values(ChannelTypeEnum).filter((v) => v !== ChannelTypeEnum.Unit),
)(
"Displays the title, background, and avatar (channelType: %s)",
async (channelType) => {
const ALL_CHANNEL_TYPES = Object.values(ChannelTypeEnum).map((v) => ({
channelType: v,
}))
const NON_UNIT_CHANNEL_TYPES = Object.values(ChannelTypeEnum)
.filter((v) => v !== ChannelTypeEnum.Unit)
.map((v) => ({ channelType: v }))

describe.each(ALL_CHANNEL_TYPES)(
"ChannelPage, common behavior",
({ channelType }) => {
it("Displays the channel search if search_filter is not undefined", async () => {
const { channel } = setupApis({
search_filter:
"platform=ocw&platform=mitxonline&department=8&department=9",
channel_type: channelType,
})
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)
const expectedProps = expect.objectContaining({
constantSearchParams: {
platform: ["ocw", "mitxonline"],
department: ["8", "9"],
},
})
const expectedContext = expect.anything()

expect(mockedChannelSearch).toHaveBeenLastCalledWith(
expectedProps,
expectedContext,
)
})
it("Does not display the channel search if search_filter is undefined", async () => {
const { channel } = setupApis({
channel_type: channelType,
})
channel.search_filter = undefined
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)

expect(mockedChannelSearch).toHaveBeenCalledTimes(0)
})

it("Includes heading and subheading in banner", async () => {
const { channel } = setupApis({
channel_type: channelType,
})
channel.search_filter = undefined
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)

await waitFor(() => {
screen.getAllByText(channel.configuration.sub_heading).forEach((el) => {
expect(el).toBeInTheDocument()
})
})
await waitFor(() => {
screen.getAllByText(channel.configuration.heading).forEach((el) => {
expect(el).toBeInTheDocument()
})
})
})

it.each([{ isSubscribed: false }, { isSubscribed: true }])(
"Displays the subscribe toggle for authenticated and unauthenticated users",
async ({ isSubscribed }) => {
const { channel } = setupApis(
{ search_filter: "q=ocw", channel_type: channelType },
{},
{ isSubscribed },
)
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
const subscribedButton = await screen.findByText("Follow")
expect(subscribedButton).toBeVisible()
},
)
},
)

describe.each(NON_UNIT_CHANNEL_TYPES)(
"ChannelPage, common non-unit ($channelType)",
({ channelType }) => {
it("Does not display a featured carousel if the channel type is not 'unit'", async () => {
const { channel } = setupApis({
search_filter: "topic=physics",
channel_type: channelType,
})

renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)
const carousels = screen.queryByText("Featured Courses")
expect(carousels).toBe(null)
})

it("Displays the title, background, and avatar (channelType: %s)", async () => {
const { channel } = setupApis({
search_filter: "offered_by=ocw",
channel_type: channelType,
Expand All @@ -141,99 +229,28 @@ describe("ChannelPage", () => {
img.src.includes(channel.configuration.logo),
)
expect(logos.length).toBe(1)
},
)

it("Does not display a featured carousel if the channel type is not 'unit'", async () => {
const { channel } = setupApis({
search_filter: "topic=physics",
channel_type: "topic",
})

renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)
const carousels = screen.queryByText("Featured Courses")
expect(carousels).toBe(null)
})
it("Displays the channel search if search_filter is not undefined", async () => {
const { channel } = setupApis({
search_filter:
"platform=ocw&platform=mitxonline&department=8&department=9",
})
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)
const expectedProps = expect.objectContaining({
constantSearchParams: {
platform: ["ocw", "mitxonline"],
department: ["8", "9"],
},
})
const expectedContext = expect.anything()

expect(mockedChannelSearch).toHaveBeenLastCalledWith(
expectedProps,
expectedContext,
)
})
it("Does not display the channel search if search_filter is undefined", async () => {
const { channel } = setupApis()
channel.search_filter = undefined
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)

expect(mockedChannelSearch).toHaveBeenCalledTimes(0)
})

it("Includes heading and subheading in banner", async () => {
const { channel } = setupApis()
channel.search_filter = undefined
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
await screen.findAllByText(channel.title)

await waitFor(() => {
screen.getAllByText(channel.configuration.sub_heading).forEach((el) => {
expect(el).toBeInTheDocument()
})
})
await waitFor(() => {
screen.getAllByText(channel.configuration.heading).forEach((el) => {
expect(el).toBeInTheDocument()
test("headings", async () => {
const { channel } = setupApis({
search_filter: "topic=Physics",
channel_type: channelType,
})
})
})

it.each([{ isSubscribed: false }, { isSubscribed: true }])(
"Displays the subscribe toggle for authenticated and unauthenticated users",
async ({ isSubscribed }) => {
const { channel } = setupApis(
{ search_filter: "q=ocw" },
{},
{ isSubscribed },
)
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })
const subscribedButton = await screen.findByText("Follow")
expect(subscribedButton).toBeVisible()
},
)

test("headings", async () => {
const { channel } = setupApis({
search_filter: "topic=Physics",
})
renderTestApp({ url: `/c/${channel.channel_type}/${channel.name}` })

await waitFor(() => {
assertHeadings([
{ level: 1, name: channel.title },
{ level: 2, name: `Search within ${channel.title}` },
{ level: 3, name: "Filter" },
{ level: 3, name: "Search Results" },
])
await waitFor(() => {
assertHeadings([
{ level: 1, name: channel.title },
{ level: 2, name: `Search within ${channel.title}` },
{ level: 3, name: "Filter" },
{ level: 3, name: "Search Results" },
])
})
})
})
})
},
)

describe("Unit Channel Pages", () => {
describe("Channel Pages, Unit only", () => {
it("Sets the expected meta tags", async () => {
const { channel } = setupApis({
search_filter: "offered_by=ocw",
Expand Down