SWAMPy

✎ CARVE FLESH

EDITING: EventDataSourceSpec.js

/*
 * Copyright (C) 2015 - 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 EventDataSource from '@canvas/calendar/jquery/EventDataSource'
import fcUtil from '@canvas/calendar/jquery/fcUtil'
import tz from '@canvas/timezone'
import denver from 'timezone/America/Denver'

QUnit.module('EventDataSource: getEvents', {
  setup() {
    this.snapshot = tz.snapshot()
    tz.changeZone(denver, 'America/Denver')
    this.date1 = fcUtil.wrap('2015-11-01T20:00:00-07:00')
    this.date2 = fcUtil.wrap('2015-11-02T20:00:00-07:00')
    this.date3 = fcUtil.wrap('2015-11-03T20:00:00-07:00')
    this.date4 = fcUtil.wrap('2015-11-04T20:00:00-07:00')

// create the data source with a couple of recognized contexts. we'll use
    // those same context codes in querying
    this.source = new EventDataSource([
      {asset_string: 'course_1'},
      {asset_string: 'course_2'},
      {asset_string: 'course_3'},
      {asset_string: 'group_1'},
    ])
    this.contexts = ['course_1', 'course_2', 'course_3']

// a container for stubbing queries, along with helpers to populate
    // the stubbed results in individual specs and a slot for the most recent
    // query (distilled)
    this.server = {
      calendarEvents: [],
      assignments: [],
      lastQuery: null,
      reset() {
        this.calendarEvents = []
        this.assignments = []
        this.lastQuery = null
      },
      addCalendarEvent(context_code, id, start_at) {
        return this.calendarEvents.push({
          context_code,
          calendar_event: {
            id,
            start_at,
          },
        })
      },
      addAssignment(context_code, id, due_at) {
        return this.assignments.push({
          context_code,
          assignment: {
            id,
            due_at,
          },
        })
      },
      addPlannerItem(context_type, context_id, plannable_type, plannable_id, title, todo_date) {
        const item = {
          plannable_type,
          plannable_id,
          plannable: {
            title,
            todo_date,
          },
        }
        item[`${context_type}_id`] = context_id
        return this.calendarEvents.push(item)
      },
    }

// stub the fetch method on the source to just use our stubbed query
    // results, and also to record the query made
    this.source.startFetch = (requests, dataCB, doneCB, _) => {
      const {start_date, end_date, undated} = requests[0][1]
      this.server.lastQuery = {
        start_date,
        end_date,
        undated,
      }
      dataCB(this.server.calendarEvents, null, {type: 'events'})
      dataCB(this.server.assignments, null, {type: 'assignments'})
      doneCB()
    }
  },

teardown() {
    tz.restore(this.snapshot)
  },
})

test('addEventToCache handles cases where the contextCode returns a list', function () {
  const fakeEvent = {
    contextCode() {
      return 'course_1,course_2'
    },
    id: 42,
  }
  this.source.addEventToCache(fakeEvent)
  ok(this.source.cache.contexts.course_1.events[42])
})

test('addEventToCache handles the case where contextCode contains context not in the cache', function () {
  const fakeEvent = {
    contextCode() {
      return 'course_4,course_2'
    },
    id: 42,
  }
  this.source.addEventToCache(fakeEvent)
  ok(this.source.cache.contexts.course_2.events[42])
})

test('addEventToCache handles cases where the contextCode is a single item', function () {
  const fakeEvent = {
    contextCode() {
      return 'course_1'
    },
    id: 42,
  }
  this.source.addEventToCache(fakeEvent)
  ok(this.source.cache.contexts.course_1.events[42])
})

test('overlapping ranges: overlap at start shifts start to end of overlap', function () {
  this.source.getEvents(this.date1, this.date2, this.contexts, () => {})
  this.source.getEvents(this.date1, this.date4, this.contexts, () => {})
  equal(this.server.lastQuery.start_date, fcUtil.unwrap(this.date2).toISOString())
})

test('overlapping ranges: no overlap at start leaves start alone', function () {
  this.source.getEvents(this.date1, this.date2, this.contexts, () => {})
  this.source.getEvents(this.date3, this.date4, this.contexts, () => {})
  equal(this.server.lastQuery.start_date, fcUtil.unwrap(this.date3).toISOString())
})

test('overlapping ranges: no overlap at end leaves end alone', function () {
  this.source.getEvents(this.date3, this.date4, this.contexts, () => {})
  this.source.getEvents(this.date1, this.date2, this.contexts, () => {})
  equal(this.server.lastQuery.end_date, fcUtil.unwrap(this.date2).toISOString())
})

test('overlapping ranges: overlap at end shifts end to start of overlap', function () {
  this.source.getEvents(this.date3, this.date4, this.contexts, () => {})
  this.source.getEvents(this.date1, this.date4, this.contexts, () => {})
  equal(this.server.lastQuery.end_date, fcUtil.unwrap(this.date3).toISOString())
})

test('overlapping ranges: fully interior overlap leaves ends alone', function () {
  this.source.getEvents(this.date2, this.date3, this.contexts, () => {})
  this.source.getEvents(this.date1, this.date4, this.contexts, () => {})
  equal(this.server.lastQuery.start_date, fcUtil.unwrap(this.date1).toISOString())
  equal(this.server.lastQuery.end_date, fcUtil.unwrap(this.date4).toISOString())
})

test('overlapping ranges: both ends move if necessary', function () {
  this.source.getEvents(this.date1, this.date2, this.contexts, () => {})
  this.source.getEvents(this.date3, this.date4, this.contexts, () => {})
  this.source.getEvents(this.date1, this.date4, this.contexts, () => {})
  equal(this.server.lastQuery.start_date, fcUtil.unwrap(this.date2).toISOString())
  equal(this.server.lastQuery.end_date, fcUtil.unwrap(this.date3).toISOString())
})

test('overlapping ranges: full overlap means no query', function () {
  this.source.getEvents(this.date1, this.date3, this.contexts, () => {})
  this.source.getEvents(this.date2, this.date4, this.contexts, () => {})
  this.server.reset()
  this.source.getEvents(this.date1, this.date4, this.contexts, () => {})
  ok(!this.server.lastQuery)
})

test('date-only boundaries: date-only end is treated as midnight in profile timezone (excludes that date)', function () {
  const end = fcUtil.clone(this.date4).stripTime().stripZone()
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date3).toISOString())
  this.server.addCalendarEvent('course_2', '2', fcUtil.unwrap(this.date4).toISOString())
  this.source.getEvents(this.date1, end, this.contexts, list => {
    equal(list.length, 1)
    equal(list[0].id, 'calendar_event_1')
  })
  equal(this.server.lastQuery.end_date, '2015-11-04T07:00:00.000Z')
})

test('date-only boundaries: date-only start is treated as midnight in profile timezone (includes that date)', function () {
  const start = fcUtil.clone(this.date2).stripTime().stripZone()
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date1).toISOString())
  this.server.addCalendarEvent('course_2', '2', fcUtil.unwrap(this.date2).toISOString())
  this.source.getEvents(start, this.date4, this.contexts, list => {
    equal(list.length, 1)
    equal(list[0].id, 'calendar_event_2')
  })
  equal(this.server.lastQuery.start_date, '2015-11-02T07:00:00.000Z')
})

test('pagination: both pages final returns full range and leaves nextPageDate unset', function () {
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date1).toISOString())
  this.server.addCalendarEvent('course_2', '2', fcUtil.unwrap(this.date2).toISOString())
  this.server.addAssignment('course_2', '3', fcUtil.unwrap(this.date3).toISOString())
  return this.source.getEvents(this.date1, this.date4, this.contexts, list => {
    ok(!list.nextPageDate)
    equal(list.length, 3)
  })
})

test('pagination: one page final sets nextPageDate and returns only up to nextPageDate (exclusive)', function () {
  // since the max calendarEvent date is @date2, nextPageDate will be @date2
  // and nothing >= @date2 will be included
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date1).toISOString())
  this.server.addCalendarEvent('course_2', '2', fcUtil.unwrap(this.date2).toISOString())
  this.server.addAssignment('course_1', '3', fcUtil.unwrap(this.date1).toISOString())
  this.server.addAssignment('course_2', '4', fcUtil.unwrap(this.date2).toISOString())
  this.server.addAssignment('course_2', '5', fcUtil.unwrap(this.date3).toISOString())
  this.server.calendarEvents.next = true
  return this.source.getEvents(this.date1, this.date4, this.contexts, list => {
    equal(+list.nextPageDate, +this.date2)
    equal(list.length, 2)
    ok(['calendar_event_1', 'assignment_3'].indexOf(list[0].id) >= 0)
    ok(['calendar_event_1', 'assignment_3'].indexOf(list[1].id) >= 0)
  })
})

test('pagination: both pages final sets nextPageDate and returns only up to nextPageDate (exclusive)', function () {
  // since assignments has the smallest max date at @date2, nextPageDate will be
  // @date2 and nothing >= @date2 will be included
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date1).toISOString())
  this.server.addCalendarEvent('course_2', '2', fcUtil.unwrap(this.date2).toISOString())
  this.server.addAssignment('course_1', '3', fcUtil.unwrap(this.date1).toISOString())
  this.server.addAssignment('course_2', '4', fcUtil.unwrap(this.date2).toISOString())
  this.server.addAssignment('course_2', '5', fcUtil.unwrap(this.date3).toISOString())
  this.server.calendarEvents.next = true
  this.server.assignments.next = true
  return this.source.getEvents(this.date1, this.date4, this.contexts, list => {
    equal(+list.nextPageDate, +this.date2)
    equal(list.length, 2)
    ok(['calendar_event_1', 'assignment_3'].indexOf(list[0].id) >= 0)
    ok(['calendar_event_1', 'assignment_3'].indexOf(list[1].id) >= 0)
  })
})

test('pagination: calls data callback with each page of data if set', function () {
  this.server.addCalendarEvent('course_1', '1', fcUtil.unwrap(this.date1).toISOString())
  this.server.addAssignment('course_2', '3', fcUtil.unwrap(this.date3).toISOString())
  let pages = 0
  return this.source.getEvents(
    this.date1,
    this.date4,
    this.contexts,
    list => {
      equal(list.length, 2)
      equal(pages, 2)
    },
    list => {
      pages += 1
      equal(list.length, 1)
    }
  )
})

test('indexParams filters appointment_group_ids from params', function () {
  const p = this.source.indexParams({
    blah: 'blah',
    context_codes: ['course_1', 'appointment_group_2', 'group_3', 'appointment_group_1337'],
  })
  equal(p.blah, 'blah')
  deepEqual(p.context_codes, ['course_1', 'group_3'])
  equal(p.appointment_group_ids, '2,1337')
})

test('transforms course planner item', function () {
  const date = fcUtil.unwrap(this.date2).toISOString()
  this.server.addPlannerItem('course', 1, 'discussion_topic', 3, 'blah', date)
  this.source.getEvents(this.date1, this.date4, this.contexts, events => {
    equal(events.length, 1)
    const event = events[0].calendarEvent
    equal(event.context_code, 'course_1')
    equal(event.all_context_codes, 'course_1')
    equal(event.start_at, date)
    equal(event.end_at, date)
    equal(event.type, 'todo_item')
    equal(event.id, 'discussion_topic_3')
    equal(event.title, 'blah')
  })
})

test('transforms group planner item', function () {
  const date = fcUtil.unwrap(this.date2).toISOString()
  this.server.addPlannerItem('group', 1, 'assignment', 4, 'bleh', date)
  this.source.getEvents(this.date1, this.date4, ['group_1'], events => {
    equal(events.length, 1)
    const event = events[0].calendarEvent
    equal(event.context_code, 'group_1')
    equal(event.all_context_codes, 'group_1')
    equal(event.start_at, date)
    equal(event.end_at, date)
    equal(event.type, 'todo_item')
    equal(event.id, 'assignment_4')
    equal(event.title, 'bleh')
  })
})

test('filters out course pacing assignments for teachers', function () {
  ENV.CALENDAR = {
    CONTEXTS: [
      {
        asset_string: 'course_1',
        can_make_reservation: false,
        course_pacing_enabled: false,
      },
      {
        asset_string: 'course_2',
        can_make_reservation: false,
        course_pacing_enabled: true,
      },
      {
        asset_string: 'course_3',
        can_make_reservation: true,
        course_pacing_enabled: true,
      },
    ],
  }
  this.server.addAssignment('course_1', '100', fcUtil.unwrap(this.date3).toISOString())
  this.server.addAssignment('course_2', '200', fcUtil.unwrap(this.date3).toISOString())
  this.server.addAssignment('course_3', '300', fcUtil.unwrap(this.date3).toISOString())
  const params = {
    context_codes: ['course_1', 'course_2', 'course_3'],
    start_date: this.date1,
    end_date: this.date4,
  }
  const assignmentParameters = this.source.assignmentParams(params)
  equal(assignmentParameters.context_codes.length, 2)
  equal(assignmentParameters.context_codes[0], 'course_1')
  equal(assignmentParameters.context_codes[1], 'course_3')
})

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 AgendaViewSpec.js	JS	8.9 KB	2023-09-24 03:36	EDIT
📄 CalendarEventFilterSpec.js	JS	7.8 KB	2023-09-24 03:36	EDIT
📄 CalendarSpec.js	JS	6.6 KB	2023-09-24 03:36	EDIT
📄 CommonEventSpec.js	JS	6.6 KB	2023-09-24 03:36	EDIT
📄 EditAppointmentGroupDetailsSpec.js	JS	2.6 KB	2023-09-24 03:36	EDIT
📄 EditAssignmentDetailsSpec.js	JS	8.9 KB	2023-09-24 03:36	EDIT
📄 EditPlannerNoteDetailsSpec.js	JS	3 KB	2023-09-24 03:36	EDIT
📄 EventDataSourceSpec.js	JS	13.3 KB	2023-09-24 03:36	EDIT
📄 fcUtilSpec.js	JS	2.5 KB	2023-09-24 03:36	EDIT
📄 MissingDateDialogViewSpec.js	JS	2.4 KB	2023-09-24 03:36	EDIT
📄 TimeBlockListManagerSpec.js	JS	4.1 KB	2023-09-24 03:36	EDIT
📄 TimeBlockListSpec.js	JS	4.7 KB	2023-09-24 03:36	EDIT
📄 TimeBlockRowSpec.js	JS	5.7 KB	2023-09-24 03:36	EDIT