SWAMPy

✎ CARVE FLESH

EDITING: ApiSpec.js

/*
 * Copyright (C) 2019 - 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 MockCanvasClient from '../../../support/MockCanvasClient'
import * as Api from '@canvas/hide-assignment-grades-tray/react/Api'

QUnit.module('HideAssignmentGradesTray Api', suiteHooks => {
  const ASSIGNMENT_ID = '23'
  const BAD_ASSIGNMENT_ID = '24'
  const PROGRESS_ID = 7331
  const SECTION_IDS = ['2001', '2002', '2003']

suiteHooks.beforeEach(() => {
    MockCanvasClient.install([
      {
        request: {
          query: Api.HIDE_ASSIGNMENT_GRADES,
          variables: {assignmentId: ASSIGNMENT_ID},
        },
        result: {
          data: {
            hideAssignmentGrades: {
              __typename: 'hideAssignmentGrades',
              progress: {
                __typename: 'Progress',
                _id: PROGRESS_ID,
                state: 'queued',
              },
            },
          },
        },
      },
      {
        request: {
          query: Api.HIDE_ASSIGNMENT_GRADES,
          variables: {assignmentId: BAD_ASSIGNMENT_ID},
        },
        result: {
          data: null,
          errors: [{message: 'a graphql error'}],
        },
      },
      {
        request: {
          query: Api.HIDE_ASSIGNMENT_GRADES_FOR_SECTIONS,
          variables: {assignmentId: ASSIGNMENT_ID, sectionIds: SECTION_IDS},
        },
        result: {
          data: {
            hideAssignmentGradesForSections: {
              __typename: 'hideAssignmentGradesForSections',
              progress: {
                __typename: 'Progress',
                _id: PROGRESS_ID,
                state: 'queued',
              },
            },
          },
        },
      },
      {
        request: {
          query: Api.HIDE_ASSIGNMENT_GRADES_FOR_SECTIONS,
          variables: {assignmentId: BAD_ASSIGNMENT_ID, sectionIds: SECTION_IDS},
        },
        result: {
          data: null,
          errors: [{message: 'a graphql error'}],
        },
      },
    ])
  })

suiteHooks.afterEach(() => {
    MockCanvasClient.uninstall()
  })

QUnit.module('.hideAssignmentGrades()', () => {
    test('returns the Progress id', async () => {
      const progress = await Api.hideAssignmentGrades(ASSIGNMENT_ID)
      const expectedProgress = {id: PROGRESS_ID, workflowState: 'queued'}
      deepEqual(progress, expectedProgress)
    })

test('consumers are required to handle when mutating rejects', async () => {
      try {
        await Api.hideAssignmentGrades(BAD_ASSIGNMENT_ID)
      } catch (error) {
        strictEqual(error.message, 'GraphQL error: a graphql error')
      }
    })
  })

QUnit.module('.hideAssignmentGradesForSections()', () => {
    test('returns the Progress', async () => {
      const progress = await Api.hideAssignmentGradesForSections(ASSIGNMENT_ID, SECTION_IDS)
      const expectedProgress = {id: PROGRESS_ID, workflowState: 'queued'}
      deepEqual(progress, expectedProgress)
    })

test('consumers are required to handle when mutating rejects', async () => {
      try {
        await Api.hideAssignmentGradesForSections(BAD_ASSIGNMENT_ID, SECTION_IDS)
      } catch (error) {
        strictEqual(error.message, 'GraphQL error: a graphql error')
      }
    })
  })

QUnit.module('.resolveHideAssignmentGradesStatus', contextHooks => {
    let server

contextHooks.beforeEach(() => {
      server = sinon.createFakeServer()
      server.respondImmediately = true
    })

contextHooks.afterEach(() => {
      server.restore()
    })

test('returns ids of submissions hidden when job finishes', async () => {
      const responseData = {
        results: {submission_ids: ['201', '202', '203']},
        url: `/api/v1/progress/${PROGRESS_ID}`,
        workflow_state: 'completed',
      }
      server.respondWith('GET', `/api/v1/progress/${PROGRESS_ID}`, [
        200,
        {},
        JSON.stringify(responseData),
      ])
      const results = await Api.resolveHideAssignmentGradesStatus({
        id: PROGRESS_ID,
        workflowState: 'queued',
      })
      deepEqual(results.submissionIds, ['201', '202', '203'])
    })

test('consumers are required to handle when job fails', async () => {
      const responseData = {
        message: 'job failed',
        url: `/api/v1/progress/${PROGRESS_ID}`,
        workflow_state: 'failed',
      }
      server.respondWith('GET', `/api/v1/progress/${PROGRESS_ID}`, [
        200,
        {},
        JSON.stringify(responseData),
      ])

try {
        await Api.resolveHideAssignmentGradesStatus({id: PROGRESS_ID, workflowState: 'queued'})
      } catch (error) {
        strictEqual(error, 'job failed')
      }
    })
  })
})

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 ApiSpec.js	JS	5.2 KB	2023-09-24 03:36	EDIT
📄 FormContentSpec.js	JS	6.2 KB	2023-09-24 03:39	EDIT
📄 HideAssignmentGradesTraySpec.js	JS	13.3 KB	2023-09-24 03:39	EDIT
📄 LayoutSpec.js	JS	5.4 KB	2023-09-24 03:39	EDIT