SWAMPy

✎ CARVE FLESH

EDITING: useRollups.test.js

/*
 * Copyright (C) 2021 - present Instructure, Inc.
 *
 * This file is part of Canvas.
 *
 * Canvas is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3 of the License.
 *
 * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

import {renderHook, act} from '@testing-library/react-hooks/dom'
import axios from '@canvas/axios'
import * as FlashAlert from '@canvas/alerts/react/FlashAlert'
import useRollups from '../useRollups'

jest.useFakeTimers()

describe('useRollups', () => {
  let fetchMock
  const mockedUsers = [
    {
      id: '1',
      name: 'Student 1',
      display_name: 'Student 1',
      avatar_url: 'url',
    },
  ]

const mockedRatings = [
    {
      color: 'green',
      description: 'mastery!',
      mastery: true,
      points: 3,
    },
    {
      color: 'red',
      description: 'not great',
      mastery: false,
      points: 0,
    },
  ]

const mockedOutcomes = [
    {
      id: '1',
      title: 'outcome 1',
      ratings: mockedRatings,
    },
  ]

const mockedRollups = [
    {
      links: {
        user: '1',
      },
      scores: [
        {
          score: 4,
          links: {
            outcome: '1',
          },
        },
      ],
    },
  ]

beforeEach(() => {
    const promise = Promise.resolve({
      status: 200,
      data: {
        linked: {
          users: mockedUsers,
          outcomes: mockedOutcomes,
        },
        rollups: mockedRollups,
      },
    })
    fetchMock = jest.spyOn(axios, 'get').mockResolvedValue(promise)
  })

describe('useRollups hook', () => {
    it('returns defaults until the request finishes loading', async () => {
      const {result} = renderHook(() => useRollups({courseId: '1'}))
      const {isLoading, students, outcomes, rollups} = result.current
      expect(isLoading).toEqual(true)
      expect(students).toEqual([])
      expect(outcomes).toEqual([])
      expect(rollups).toEqual([])
      await act(async () => jest.runAllTimers())
      expect(result.current.isLoading).toEqual(false)
    })

it('returns the response after the request finishes', async () => {
      const {result} = renderHook(() => useRollups({courseId: '1'}))
      await act(async () => jest.runAllTimers())
      const {students, outcomes, rollups} = result.current
      expect(fetchMock).toHaveBeenCalled()
      expect(students).toEqual(mockedUsers)
      expect(outcomes).toEqual(mockedOutcomes)
      expect(rollups).toStrictEqual([
        {
          studentId: '1',
          outcomeRollups: [
            {outcomeId: '1', rating: {...mockedRatings[0], color: `#${mockedRatings[0].color}`}},
          ],
        },
      ])
    })

it('calls the /rollups URL with the right parameters', async () => {
      renderHook(() => useRollups({courseId: '1'}))
      await act(async () => jest.runAllTimers())
      const params = {
        params: {
          rating_percents: true,
          per_page: 20,
          include: ['outcomes', 'users', 'outcome_paths', 'alignments'],
          sort_by: 'student',
          add_defaults: true,
          page: 1,
        },
      }
      expect(fetchMock).toHaveBeenCalledWith('/api/v1/courses/1/outcome_rollups', params)
    })

it('renders a flashAlert if the request fails', async () => {
      fetchMock = jest.spyOn(axios, 'get').mockRejectedValue({})
      const showFlashAlertSpy = jest.spyOn(FlashAlert, 'showFlashAlert')
      renderHook(() => useRollups({courseId: '1'}))
      await act(async () => jest.runAllTimers())
      expect(fetchMock).toHaveBeenCalled()
      expect(showFlashAlertSpy).toHaveBeenCalledWith({
        message: 'Error loading rollups',
        type: 'error',
      })
    })
  })
})

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 useRollups.test.js	JS	4.1 KB	2023-09-24 03:36	EDIT