Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
var { CalDAVServer } = ChromeUtils.importESModule(
);
add_setup(async function () {
CalDAVServer.open();
await CalDAVServer.putItemInternal(
"5a9fa76c-93f3-4ad8-9f00-9e52aedd2821.ics",
CalendarTestUtils.dedent`
BEGIN:VCALENDAR
BEGIN:VEVENT
UID:5a9fa76c-93f3-4ad8-9f00-9e52aedd2821
SUMMARY:exists before time
DTSTART:20210401T120000Z
DTEND:20210401T130000Z
END:VEVENT
END:VCALENDAR
`
);
});
registerCleanupFunction(() => CalDAVServer.close());
add_task(async function () {
calendarObserver._onAddItemPromise = Promise.withResolvers();
calendarObserver._onLoadPromise = Promise.withResolvers();
const calendar = createCalendar("caldav", CalDAVServer.url, true);
await calendarObserver._onAddItemPromise.promise;
await calendarObserver._onLoadPromise.promise;
info("calendar set-up complete");
Assert.ok(await calendar.getItem("5a9fa76c-93f3-4ad8-9f00-9e52aedd2821"));
info("creating the item");
calendarObserver._batchRequired = true;
calendarObserver._onLoadPromise = Promise.withResolvers();
await runAddItem(calendar);
await calendarObserver._onLoadPromise.promise;
info("modifying the item");
calendarObserver._onLoadPromise = Promise.withResolvers();
await runModifyItem(calendar);
await calendarObserver._onLoadPromise.promise;
info("deleting the item");
await runDeleteItem(calendar);
cal.manager.unregisterCalendar(calendar);
});
/**
* Tests calendars that return status 404 for "current-user-privilege-set" are
* not flagged read-only.
*/
add_task(async function testCalendarWithNoPrivSupport() {
CalDAVServer.privileges = null;
calendarObserver._onLoadPromise = Promise.withResolvers();
const calendar = createCalendar("caldav", CalDAVServer.url, true);
await calendarObserver._onLoadPromise.promise;
info("calendar set-up complete");
Assert.ok(!calendar.readOnly, "calendar was not marked read-only");
cal.manager.unregisterCalendar(calendar);
});
/**
* Tests modifyItem() does not hang when the server reports no actual
* modifications were made.
*/
add_task(async function testModifyItemWithNoChanges() {
const event = new CalEvent();
const calendar = createCalendar("caldav", CalDAVServer.url, false);
event.id = "6f6dd7b6-0fbd-39e4-359a-a74c4c3745bb";
event.title = "A New Event";
event.startDate = cal.createDateTime("20200303T205500Z");
event.endDate = cal.createDateTime("20200303T210200Z");
await calendar.addItem(event);
const clone = event.clone();
clone.title = "A Modified Event";
const putItemInternal = CalDAVServer.putItemInternal;
CalDAVServer.putItemInternal = () => {};
const modifiedEvent = await calendar.modifyItem(clone, event);
CalDAVServer.putItemInternal = putItemInternal;
Assert.ok(modifiedEvent, "an event was returned");
Assert.equal(modifiedEvent.title, event.title, "the un-modified event is returned");
await calendar.deleteItem(modifiedEvent);
cal.manager.unregisterCalendar(calendar);
});
/**
* Test that adding an ICS item with some special characters in its UID
* generates a correct HTTP PUT request.
*/
add_task(async function testPutSpecialCharactersInUID() {
const calendar = createCalendar("caldav", CalDAVServer.url, false);
const event = new CalEvent();
event.id = "this/id@has/weird characters#in-it";
event.title = "A New Event with weird characters in its UID";
event.startDate = cal.createDateTime("20200303T205500Z");
event.endDate = cal.createDateTime("20200303T210200Z");
calendarObserver._batchRequired = true;
calendarObserver._onLoadPromise = Promise.withResolvers();
calendarObserver._onAddItemPromise = Promise.withResolvers();
const storedEvent = await calendar.addItem(event);
await Promise.any([
calendarObserver._onLoadPromise.promise,
calendarObserver._onAddItemPromise.promise,
]);
// The event is stored with its original uid in the calendar.
Assert.ok(
await calendar.getItem("this/id@has/weird characters#in-it"),
"the event has not been stored successfully"
);
await calendar.deleteItem(storedEvent);
cal.manager.unregisterCalendar(calendar);
});
/**
* Tests that an error response from the server when syncing doesn't delete
* items from the local calendar.
*/
add_task(async function testSyncError1() {
calendarObserver._onAddItemPromise = Promise.withResolvers();
calendarObserver._onLoadPromise = Promise.withResolvers();
const calendar = createCalendar("caldav", CalDAVServer.url, true);
await calendarObserver._onAddItemPromise.promise;
await calendarObserver._onLoadPromise.promise;
info("calendar set-up complete");
Assert.ok(
await calendar.getItem("5a9fa76c-93f3-4ad8-9f00-9e52aedd2821"),
"item should exist when first connected"
);
info("syncing with rate limit error");
CalDAVServer.throwRateLimitErrors = true;
calendarObserver._onLoadPromise = Promise.withResolvers();
calendar.refresh();
await calendarObserver._onLoadPromise.promise;
CalDAVServer.throwRateLimitErrors = false;
info("sync with rate limit error complete");
Assert.equal(
calendar.getProperty("currentStatus"),
Cr.NS_OK,
"calendar should not be in an error state"
);
Assert.equal(calendar.getProperty("disabled"), null, "calendar should not be disabled");
Assert.ok(
await calendar.getItem("5a9fa76c-93f3-4ad8-9f00-9e52aedd2821"),
"item should still exist after error response"
);
info("syncing without rate limit error");
calendarObserver._onLoadPromise = Promise.withResolvers();
calendar.refresh();
await calendarObserver._onLoadPromise.promise;
info("sync without rate limit error complete");
Assert.ok(
await calendar.getItem("5a9fa76c-93f3-4ad8-9f00-9e52aedd2821"),
"item should still exist after successful sync"
);
cal.manager.unregisterCalendar(calendar);
});
/**
* Tests that multiple pages of item responses from the server when syncing
* doesn't result in items being deleted from the local calendar.
*
* The server has a page size of 3, although this test should pass regardless
* of the page size.
*/
add_task(async function testSyncError2() {
// Add some items to the server so multiple requests are required to get
// them all. There's already one item on the server.
for (let i = 0; i < 3; i++) {
await CalDAVServer.putItemInternal(
`fake-uid-${i}.ics`,
CalendarTestUtils.dedent`
BEGIN:VCALENDAR
BEGIN:VEVENT
UID:fake-uid-${i}
SUMMARY:event ${i}
DTSTART:20210401T120000Z
DTEND:20210401T130000Z
END:VEVENT
END:VCALENDAR
`
);
}
calendarObserver._onAddItemPromise = Promise.withResolvers();
calendarObserver._onLoadPromise = Promise.withResolvers();
const calendar = createCalendar("caldav", CalDAVServer.url, true);
await calendarObserver._onAddItemPromise.promise;
await calendarObserver._onLoadPromise.promise;
info("calendar set-up complete");
let items = await calendar.getItemsAsArray(Ci.calICalendar.ITEM_FILTER_TYPE_ALL, 0, null, null);
Assert.equal(items.length, 4, "all items added to calendar when first connected");
info("forced syncing with multiple pages");
calendar.wrappedJSObject.mUncachedCalendar.wrappedJSObject.mWebdavSyncToken = null;
calendar.wrappedJSObject.mUncachedCalendar.wrappedJSObject.saveCalendarProperties();
calendarObserver._onLoadPromise = Promise.withResolvers();
calendar.refresh();
await calendarObserver._onLoadPromise.promise;
info("forced sync with multiple pages complete");
items = await calendar.getItemsAsArray(Ci.calICalendar.ITEM_FILTER_TYPE_ALL, 0, null, null);
Assert.equal(items.length, 4, "all items still in calendar after forced refresh");
cal.manager.unregisterCalendar(calendar);
// Delete the added items.
for (let i = 0; i < 3; i++) {
CalDAVServer.deleteItemInternal(`fake-uid-${i}.ics`);
}
});