Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-26 14:22:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 636603 - Part 1: mozIAsyncHistory: only call mozIVisitInfoCallback on failure; API change. sr=rstrong, r=mak

Browse Source
This commit is contained in:
Allison Naaktgeboren 2011-08-04 16:50:17 -07:00
parent fa73fdc9a6
commit bf83252534
3 changed files with 172 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
toolkit/components/places/History.cpp
View File

@ -22,6 +22,7 @@
*
* Contributor(s):
* Shawn Wilsher <me@shawnwilsher.com> (Original Author)
* Allison Naaktgeboren <ally@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
@ -566,8 +567,13 @@ public:
nsCOMPtr<mozIPlaceInfo> place =
new PlaceInfo(mPlace.placeId, mPlace.guid, uri.forget(), mPlace.title,
-1, visits);
if (NS_SUCCEEDED(mResult)) {
(void)mCallback->HandleResult(place);
}
else {
(void)mCallback->HandleError(mResult, place);
}
(void)mCallback->OnComplete(mResult, place);
return NS_OK;
}

28
toolkit/components/places/mozIAsyncHistory.idl
View File

@ -122,20 +122,31 @@ interface mozIPlaceInfo : nsISupports
/**
* @status EXPERIMENTAL
*/
[scriptable,function, uuid(3b97ca3c-5ea8-424f-b429-797477c52302)]
[scriptable, uuid(eb0b406f-8f57-4f2b-b0da-8883684b138a)]
interface mozIVisitInfoCallback : nsISupports
{
/**
* Called for each visit added, title change, or guid change when passed to
* mozIAsyncHistory::updatePlaces.
* Called when the given mozIPlaceInfo object could not be processed.
*
* @param aResultCode
* nsresult of the change indicating success or failure reason.
* nsresult indicating the failure reason.
* @param aPlaceInfo
* The information that was being entered into the database.
*/
void onComplete(in nsresult aResultCode,
in mozIPlaceInfo aPlaceInfo);
void handleError(in nsresult aResultCode,
in mozIPlaceInfo aPlaceInfo);
/**
* Called for each visit added, title change, or guid change when passed to
* mozIAsyncHistory::updatePlaces. If more than one operation is done for
* a given visit, only one callback will be given (i.e. title change and
* add visit).
*
* @param aPlaceInfo
* The information that was being entered into the database.
*/
void handleResult(in mozIPlaceInfo aPlaceInfo);
};
/**
@ -152,9 +163,8 @@ interface mozIAsyncHistory : nsISupports
* The mozIPlaceInfo object[s] containing the information to store or
* update. This can be a single object, or an array of objects.
* @param [optional] aCallback
* Callback to be notified for each visit addition, title change, or
* guid change. If more than one operation is done for a given visit,
* only one callback will be given (i.e. title change and add visit).
* A mozIVisitInfoCallback object which consists of callbacks to be
* notified for successful and/or failed changes.
*
* @throws NS_ERROR_INVALID_ARG
* - Passing in NULL for aPlaceInfo.

236
toolkit/components/places/tests/unit/test_async_history_api.js
View File

@ -159,6 +159,38 @@ function do_check_title_for_uri(aURI,
stmt.finalize();
}
/**
* Default callback handler throws when success is unexpected.
*
* @param handleErrorFunc
* The error handling function
*/
function expectHandleError(handleErrorFunc)
{
return {
handleError: handleErrorFunc,
handleResult: function handleResult(aPlaceInfo) {
do_throw("Unexpected success.");
}
};
}
/**
* Default callback handler throws when failure is unexpected.
*
* @param handleResultFunc
* The success handling function
*/
function expectHandleResult(handleResultFunc)
{
return {
handleError: function handleError(aResultCode, aPlacesInfo) {
do_throw("Unexpected error: " + aResultCode);
},
handleResult: handleResultFunc
};
}
////////////////////////////////////////////////////////////////////////////////
//// Test Functions
@ -422,7 +454,7 @@ function test_non_addable_uri_errors()
});
let callbackCount = 0;
gHistory.updatePlaces(places, function(aResultCode, aPlaceInfo) {
gHistory.updatePlaces(places, expectHandleError(function(aResultCode, aPlaceInfo) {
do_log_info("Checking '" + aPlaceInfo.uri.spec + "'");
do_check_eq(aResultCode, Cr.NS_ERROR_INVALID_ARG);
do_check_false(gGlobalHistory.isVisited(aPlaceInfo.uri));
@ -431,7 +463,7 @@ function test_non_addable_uri_errors()
if (++callbackCount == places.length) {
waitForAsyncUpdates(run_next_test);
}
});
}));
}
function test_duplicate_guid_errors()
@ -446,8 +478,7 @@ function test_duplicate_guid_errors()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(place.uri));
let badPlace = {
@ -459,13 +490,13 @@ function test_duplicate_guid_errors()
};
do_check_false(gGlobalHistory.isVisited(badPlace.uri));
gHistory.updatePlaces(badPlace, function(aResultCode, aPlaceInfo) {
gHistory.updatePlaces(badPlace, expectHandleError(function(aResultCode, aPlaceInfo) {
do_check_eq(aResultCode, Cr.NS_ERROR_STORAGE_CONSTRAINT);
do_check_false(gGlobalHistory.isVisited(badPlace.uri));
waitForAsyncUpdates(run_next_test);
});
});
}));
}));
}
function test_invalid_referrerURI_ignored()
@ -481,8 +512,7 @@ function test_invalid_referrerURI_ignored()
do_check_false(gGlobalHistory.isVisited(place.uri));
do_check_false(gGlobalHistory.isVisited(place.visits[0].referrerURI));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
@ -501,7 +531,7 @@ function test_invalid_referrerURI_ignored()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_nonnsIURI_referrerURI_ignored()
@ -516,8 +546,7 @@ function test_nonnsIURI_referrerURI_ignored()
place.visits[0].referrerURI = place.uri.spec + "_nonnsIURI";
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
@ -533,7 +562,7 @@ function test_nonnsIURI_referrerURI_ignored()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_invalid_sessionId_ignored()
@ -548,8 +577,7 @@ function test_invalid_sessionId_ignored()
place.visits[0].sessionId = -1;
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
@ -569,7 +597,7 @@ function test_invalid_sessionId_ignored()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_unstored_sessionId_ignored()
@ -595,8 +623,7 @@ function test_unstored_sessionId_ignored()
place.visits[0].sessionId = maxSessionId + 10;
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
@ -618,7 +645,7 @@ function test_unstored_sessionId_ignored()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
@ -638,11 +665,10 @@ function test_old_referrer_ignored()
// First we must add our referrer to the history so that it is not ignored
// as being invalid.
do_check_false(gGlobalHistory.isVisited(referrerPlace.uri));
gHistory.updatePlaces(referrerPlace, function(aResultCode, aPlaceInfo) {
gHistory.updatePlaces(referrerPlace, expectHandleResult(function(aPlaceInfo) {
// Now that the referrer is added, we can add a page with a valid
// referrer to determine if the recency of the referrer is taken into
// account.
do_check_true(Components.isSuccessCode(aResultCode));
do_check_true(gGlobalHistory.isVisited(referrerPlace.uri));
let visitInfo = new VisitInfo();
@ -655,8 +681,7 @@ function test_old_referrer_ignored()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult (function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(place.uri));
// Though the visit will not contain the referrer, we must examine the
@ -674,8 +699,8 @@ function test_old_referrer_ignored()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
});
}));
}));
}
function test_place_id_ignored()
@ -688,8 +713,7 @@ function test_place_id_ignored()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(place.uri));
let placeId = aPlaceInfo.placeId;
@ -704,15 +728,18 @@ function test_place_id_ignored()
};
do_check_false(gGlobalHistory.isVisited(badPlace.uri));
gHistory.updatePlaces(badPlace, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(badPlace, {
handleResult: function handleResult(aPlaceInfo) {
do_check_neq(aPlaceInfo.placeId, placeId);
do_check_true(gGlobalHistory.isVisited(badPlace.uri));
do_check_neq(aPlaceInfo.placeId, placeId);
do_check_true(gGlobalHistory.isVisited(badPlace.uri));
waitForAsyncUpdates(run_next_test);
waitForAsyncUpdates(run_next_test);
},
handleError: function handleError(aResultCode) {
do_throw("Unexpected error: " + aResultCode);
}
});
});
}));
}
function test_observer_topic_dispatched_when_complete()
@ -737,21 +764,28 @@ function test_observer_topic_dispatched_when_complete()
do_check_false(gGlobalHistory.isVisited(places[0].uri));
do_check_false(gGlobalHistory.isVisited(places[1].uri));
const EXPECTED_COUNT = 3;
let callbackCount = 0;
const EXPECTED_COUNT_SUCCESS = 2;
const EXPECTED_COUNT_FAILURE = 1;
let callbackCountSuccess = 0;
let callbackCountFailure = 0;
gHistory.updatePlaces(places, function(aResultCode, aPlaceInfo) {
let checker = PlacesUtils.history.canAddURI(aPlaceInfo.uri) ?
do_check_true : do_check_false;
checker(Components.isSuccessCode(aResultCode));
callbackCount++;
gHistory.updatePlaces(places, {
handleResult: function handleResult(aPlaceInfo) {
let checker = PlacesUtils.history.canAddURI(aPlaceInfo.uri) ?
do_check_true : do_check_false;
callbackCountSuccess++;
},
handleError: function handleError(aResultCode, aPlaceInfo) {
callbackCountFailure++;
}
});
let observer = {
observe: function(aSubject, aTopic, aData)
{
do_check_eq(aTopic, TOPIC_UPDATEPLACES_COMPLETE);
do_check_eq(callbackCount, EXPECTED_COUNT);
do_check_eq(callbackCountSuccess, EXPECTED_COUNT_SUCCESS);
do_check_eq(callbackCountFailure, EXPECTED_COUNT_FAILURE);
Services.obs.removeObserver(observer, TOPIC_UPDATEPLACES_COMPLETE);
waitForAsyncUpdates(run_next_test);
},
@ -775,8 +809,7 @@ function test_add_visit()
do_check_false(gGlobalHistory.isVisited(place.uri));
let callbackCount = 0;
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(place.uri));
// Check mozIPlaceInfo properties.
@ -790,14 +823,14 @@ function test_add_visit()
let visit = visits[0];
do_check_eq(visit.visitDate, VISIT_TIME);
do_check_true(visit.transitionType >= TRANSITION_LINK &&
visit.transitionType <= TRANSITION_FRAMED_LINK);
visit.transitionType <= TRANSITION_FRAMED_LINK);
do_check_true(visit.referrerURI === null);
// For TRANSITION_EMBED visits, many properties will always be zero or
// undefined.
if (visit.transitionType == TRANSITION_EMBED) {
// Check mozIPlaceInfo properties.
do_check_eq(aPlaceInfo.placeId, 0);
do_check_eq(aPlaceInfo.placeId, 0, '//');
do_check_eq(aPlaceInfo.guid, null);
// Check mozIVisitInfo properties.
@ -819,7 +852,7 @@ function test_add_visit()
if (++callbackCount == place.visits.length) {
waitForAsyncUpdates(run_next_test);
}
});
}));
}
function test_properties_saved()
@ -842,8 +875,7 @@ function test_properties_saved()
}
let callbackCount = 0;
gHistory.updatePlaces(places, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(places, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
let visit = aPlaceInfo.visits[0];
@ -915,7 +947,7 @@ function test_properties_saved()
if (++callbackCount == places.length) {
waitForAsyncUpdates(run_next_test);
}
});
}));
}
function test_guid_saved()
@ -930,15 +962,13 @@ function test_guid_saved()
do_check_valid_places_guid(place.guid);
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
do_check_eq(aPlaceInfo.guid, place.guid);
do_check_guid_for_uri(uri, place.guid);
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_referrer_saved()
@ -961,8 +991,7 @@ function test_referrer_saved()
let callbackCount = 0;
let referrerSessionId;
gHistory.updatePlaces(places, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(places, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
let visit = aPlaceInfo.visits[0];
@ -993,7 +1022,7 @@ function test_referrer_saved()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_sessionId_saved()
@ -1007,8 +1036,7 @@ function test_sessionId_saved()
place.visits[0].sessionId = 3;
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
let uri = aPlaceInfo.uri;
do_check_true(gGlobalHistory.isVisited(uri));
@ -1028,7 +1056,7 @@ function test_sessionId_saved()
stmt.finalize();
waitForAsyncUpdates(run_next_test);
});
}));
}
function test_guid_change_saved()
@ -1042,19 +1070,17 @@ function test_guid_change_saved()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
// Then, change the guid with visits.
place.guid = "_GUIDCHANGE_";
place.visits = [new VisitInfo()];
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_guid_for_uri(place.uri, place.guid);
waitForAsyncUpdates(run_next_test);
});
});
}));
}));
}
function test_title_change_saved()
@ -1069,35 +1095,31 @@ function test_title_change_saved()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
// Now, make sure the empty string clears the title.
place.title = "";
place.visits = [new VisitInfo()];
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_title_for_uri(place.uri, null);
// Then, change the title with visits.
place.title = "title change";
place.visits = [new VisitInfo()];
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_title_for_uri(place.uri, place.title);
// Lastly, check that the title is cleared if we set it to null.
place.title = null;
place.visits = [new VisitInfo()];
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_title_for_uri(place.uri, place.title);
waitForAsyncUpdates(run_next_test);
});
});
});
});
}));
}));
}));
}));
}
function test_no_title_does_not_clear_title()
@ -1113,19 +1135,16 @@ function test_no_title_does_not_clear_title()
};
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
// Now, make sure that not specifying a title does not clear it.
delete place.title;
place.visits = [new VisitInfo()];
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_title_for_uri(place.uri, TITLE);
waitForAsyncUpdates(run_next_test);
});
});
}));
}));
}
function test_title_change_notifies()
@ -1229,8 +1248,7 @@ function test_referrer_sessionId_persists()
// First we add the referrer visit, and then the main visit with referrer
// attached. We ensure that the sessionId is maintained across the updates.
do_check_false(gGlobalHistory.isVisited(referrerPlace.uri));
gHistory.updatePlaces(referrerPlace, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(referrerPlace, expectHandleResult(function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(referrerPlace.uri));
let sessionId = aPlaceInfo.visits[0].sessionId;
@ -1245,15 +1263,52 @@ function test_referrer_sessionId_persists()
place.visits[0].referrerURI = referrerPlace.uri;
do_check_false(gGlobalHistory.isVisited(place.uri));
gHistory.updatePlaces(place, function(aResultCode, aPlaceInfo) {
do_check_true(Components.isSuccessCode(aResultCode));
gHistory.updatePlaces(place, expectHandleResult(function(aPlaceInfo) {
do_check_true(gGlobalHistory.isVisited(place.uri));
do_check_eq(aPlaceInfo.visits[0].sessionId, sessionId);
waitForAsyncUpdates(run_next_test);
});
}));
}));
}
// test with empty mozIVisitInfoCallback object
function test_callbacks_not_supplied()
{
const URLS = [
"imap://cyrus.andrew.cmu.edu/archive.imap", // bad URI
"http://mozilla.org/" // valid URI
];
let places = [];
URLS.forEach(function(url) {
try {
let place = {
uri: NetUtil.newURI(url),
title: "test for " + url,
visits: [
new VisitInfo(),
],
};
places.push(place);
}
catch (e if e.result === Cr.NS_ERROR_FAILURE) {
// NetUtil.newURI() can throw if e.g. our app knows about imap://
// but the account is not set up and so the URL is invalid for us.
// Note this in the log but ignore as it's not the subject of this test.
do_log_info("Could not construct URI for '" + url + "'; ignoring");
}
});
gHistory.updatePlaces(places, {} );
let observer = {
observe: function(aSubject, aTopic, aData)
{
Services.obs.removeObserver(observer, TOPIC_UPDATEPLACES_COMPLETE);
waitForAsyncUpdates(run_next_test);
},
};
Services.obs.addObserver(observer, TOPIC_UPDATEPLACES_COMPLETE, false);
}
////////////////////////////////////////////////////////////////////////////////
@ -1290,6 +1345,7 @@ function test_referrer_sessionId_persists()
test_title_change_notifies,
test_visit_notifies,
test_referrer_sessionId_persists,
test_callbacks_not_supplied,
].forEach(add_test);
function run_test()