2
0
mirror of https://github.com/devbridge/jQuery-Autocomplete.git synced 2024-11-09 23:01:00 +00:00

Improve caching logic. Make cache key to be combination of the serviceUrl and parameters.

This commit is contained in:
Tomas Kirda 2013-11-23 23:12:43 -06:00
parent eb958070d4
commit 8278419a04
2 changed files with 59 additions and 13 deletions

View File

@ -537,4 +537,41 @@ describe('Autocomplete', function () {
expect(suggestionData).toBeNull();
});
it('Should use serviceUrl and params as cacheKey', function () {
var input = $('<input />'),
instance,
ajaxExecuted = false,
data = { a: 1, query: 'Jam' },
serviceUrl = '/autocomplete/cached/url',
cacheKey = serviceUrl + '?' + $.param(data);
input.autocomplete({
serviceUrl: serviceUrl,
params: data
});
$.mockjax({
url: serviceUrl,
responseTime: 5,
response: function (settings) {
ajaxExecuted = true;
var query = settings.data.query,
response = {
suggestions: [{ value: 'Jamaica' }, { value: 'Jamaica' }]
};
this.responseText = JSON.stringify(response);
}
});
input.val('Jam');
instance = input.autocomplete();
instance.onValueChange();
waits(10);
runs(function () {
expect(instance.cachedResponse[cacheKey]).toBeTruthy();
});
});
});

View File

@ -93,7 +93,7 @@
that.selectedIndex = -1;
that.currentValue = that.element.value;
that.intervalId = 0;
that.cachedResponse = [];
that.cachedResponse = {};
that.onChangeInterval = null;
that.onChange = null;
that.isLocal = false;
@ -220,7 +220,7 @@
},
clearCache: function () {
this.cachedResponse = [];
this.cachedResponse = {};
this.badQueries = [];
},
@ -463,32 +463,41 @@
var response,
that = this,
options = that.options,
serviceUrl = options.serviceUrl;
serviceUrl = options.serviceUrl,
data,
cacheKey;
response = that.isLocal ? that.getSuggestionsLocal(q) : that.cachedResponse[q];
options.params[options.paramName] = q;
data = options.ignoreParams ? null : options.params;
if (that.isLocal) {
response = that.getSuggestionsLocal(q);
} else {
if ($.isFunction(serviceUrl)) {
serviceUrl = serviceUrl.call(that.element, q);
}
cacheKey = serviceUrl + '?' + $.param(data || {});
response = that.cachedResponse[cacheKey];
}
if (response && $.isArray(response.suggestions)) {
that.suggestions = response.suggestions;
that.suggest();
} else if (!that.isBadQuery(q)) {
options.params[options.paramName] = q;
if (options.onSearchStart.call(that.element, options.params) === false) {
return;
}
if ($.isFunction(options.serviceUrl)) {
serviceUrl = options.serviceUrl.call(that.element, q);
}
if (that.currentRequest) {
that.currentRequest.abort();
}
that.currentRequest = $.ajax({
url: serviceUrl,
data: options.ignoreParams ? null : options.params,
data: data,
type: options.type,
dataType: options.dataType
}).done(function (data) {
that.currentRequest = null;
that.processResponse(data, q);
that.processResponse(data, q, cacheKey);
options.onSearchComplete.call(that.element, q);
}).fail(function (jqXHR, textStatus, errorThrown) {
options.onSearchError.call(that.element, q, jqXHR, textStatus, errorThrown);
@ -619,7 +628,7 @@
return suggestions;
},
processResponse: function (response, originalQuery) {
processResponse: function (response, originalQuery, cacheKey) {
var that = this,
options = that.options,
result = options.transformResult(response, originalQuery);
@ -628,9 +637,9 @@
// Cache results if cache is not disabled:
if (!options.noCache) {
that.cachedResponse[result[options.paramName]] = result;
that.cachedResponse[cacheKey] = result;
if (result.suggestions.length === 0) {
that.badQueries.push(result[options.paramName]);
that.badQueries.push(cacheKey);
}
}