Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix bug preventing prefetch data from being loaded if local data was provided #39

Merged
merged 3 commits into from
Feb 24, 2013
Merged

Fix bug preventing prefetch data from being loaded if local data was provided #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9677dc3
Add jasmine ajax helper.
Feb 24, 2013
f04c8f9
Fix bug that prevented local and prefetch from working together.
Feb 24, 2013
1b2070e
Update dataset test suite.
Feb 24, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 86 additions & 93 deletions src/js/dataset.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,50 +15,111 @@ var Dataset = (function() {

this.name = o.name;
this.resetDataOnProtocolSwitch = o.resetDataOnProtocolSwitch || false;
this.prefetchUrl = o.prefetch;
this.queryUrl = o.remote;
this.rawData = o.local;
this.transport = o.transport;
this.limit = o.limit || 10;
this._customMatcher = o.matcher || null;
this._customRanker = o.ranker || null;
this._ttl_ms = o.ttl_ms || 3 * 24 * 60 * 60 * 1000;// 3 days;
this._ttl_ms = o.ttl_ms || 3 * 24 * 60 * 60 * 1000; // 3 days;

this.storageAdjacencyList = 'adjacencyList';
this.storageHash = 'itemHash';
this.storageProtocol = 'protocol';
this.storageVersion = 'version';
this.keys = {
version: 'version',
protocol: 'protocol',
itemHash: 'itemHash',
adjacencyList: 'adjacencyList'
};

this._loadData();
o.local && this._processLocalData(o.local);
o.prefetch && this._loadPrefetchData(o.prefetch);
}

utils.mixin(Dataset.prototype, {

// private methods
// ---------------

_isMetadataExpired: function() {
// TODO: disable protocol check by default and add to global config API
var isExpired = this.storage.isExpired(this.storageProtocol);
var isCacheStale = this.storage.isExpired(this.storageAdjacencyList) || this.storage.isExpired(this.storageHash);
var resetForProtocolSwitch = this.resetDataOnProtocolSwitch && this.storage.get(this.storageProtocol) != utils.getProtocol();
if (VERSION == this.storage.get(this.storageVersion) && !resetForProtocolSwitch && !isExpired && !isCacheStale) {
return false;
}
return true;
_processLocalData: function(data) {
data && this._mergeProcessedData(this._processData(data));
},

_loadData: function() {
this.rawData && this._processRawData(this.rawData);
this._getDataFromLocalStorage();
if (this._isMetadataExpired() || this.itemHash === {}) {
this.prefetchUrl && this._prefetch(this.prefetchUrl);
_loadPrefetchData: function(url) {
var that = this,
itemHash = this.storage.get(this.keys.itemHash),
adjacencyList = this.storage.get(this.keys.adjacencyList),
protocol = this.storage.get(this.keys.protocol),
version = this.storage.get(this.keys.version),
isExpired = version !== VERSION || protocol !== utils.getProtocol();

// data was available in local storage, use it
if (itemHash && adjacencyList && !isExpired) {
this._mergeProcessedData({
itemHash: itemHash,
adjacencyList: adjacencyList
});
}

else {
$.getJSON(url).done(processPrefetchData);
}

function processPrefetchData(data) {
var processedData = that._processData(data),
itemHash = processedData.itemHash,
adjacencyList = processedData.adjacencyList;

// store process data in local storage
// this saves us from processing the data on every page load
that.storage.set(that.keys.itemHash, itemHash, that._ttl_ms);
that.storage.set(that.keys.adjacencyList, adjacencyList, that._ttl_ms);
that.storage.set(that.keys.version, VERSION, that._ttl_ms);
that.storage.set(that.keys.protocol, utils.getProtocol(), that._ttl_ms);

that._mergeProcessedData(processedData);
}
},

_getDataFromLocalStorage: function() {
this.itemHash = this.storage.get(this.storageHash) || this.itemHash;
this.adjacencyList = this.storage.get(this.storageAdjacencyList) || this.adjacencyList;
_processData: function(data) {
var itemHash = {}, adjacencyList = {};

utils.each(data, function(i, item) {
var id;

// convert string datums to datum objects
if (utils.isString(item)) {
item = { value: item, tokens: utils.tokenizeText(item) };
}

// normalize tokens
item.tokens = utils.map(item.tokens || [], function(token) {
return token.toLowerCase();
});

itemHash[id = utils.getUniqueId(item.value)] = item;

utils.each(item.tokens, function(i, token) {
var char = token.charAt(0),
adjacency = adjacencyList[char] || (adjacencyList[char] = [id]);

!~utils.indexOf(adjacency, id) && adjacency.push(id);
});
});

return { itemHash: itemHash, adjacencyList: adjacencyList };
},

_mergeProcessedData: function(processedData) {
var that = this;

// merge item hash
utils.mixin(this.itemHash, processedData.itemHash);

// merge adjacency list
utils.each(processedData.adjacencyList, function(char, adjacency) {
var masterAdjacency = that.adjacencyList[char];

that.adjacencyList[char] = masterAdjacency ?
masterAdjacency.concat(adjacency) : adjacency;
});
},

_getPotentiallyMatchingIds: function(terms) {
Expand Down Expand Up @@ -152,73 +213,6 @@ var Dataset = (function() {
}
},

//takes an array of strings and creates a hash and an adjacency list
_processRawData: function(data) {
this.itemHash = {};
this.adjacencyList = {};
utils.map(data, utils.bind(function(item) {
var tokens;
if (item.tokens) {
tokens = utils.map(item.tokens, function(t) { return t.toLowerCase(); });
} else {
item = {
tokens: utils.tokenizeText(item.toLowerCase()),
value: item
};
tokens = item.tokens;
}
item.id = utils.getUniqueId(item.value);
utils.map(tokens, utils.bind(function(token) {
var firstChar = token.charAt(0);
if (!this.adjacencyList[firstChar]) {
this.adjacencyList[firstChar] = [item.id];
}
else {
if (utils.indexOf(this.adjacencyList[firstChar], item.id) === -1) {
this.adjacencyList[firstChar].push(item.id);
}
}
}, this));
this.itemHash[item.id] = item;
}, this));

this.storage.set(this.storageHash, this.itemHash, this._ttl_ms);
this.storage.set(this.storageAdjacencyList, this.adjacencyList, this._ttl_ms);
this.storage.set(this.storageVersion, VERSION, this._ttl_ms);
this.storage.set(this.storageProtocol, utils.getProtocol(), this._ttl_ms);
},

_prefetch: function(url) {
var processPrefetchSuccess = function (data) {
if (!data) { return; }
utils.map(data, function(item) {
if (utils.isString(item)) {
return {
value: item,
tokens: utils.tokenizeText(item.toLowerCase())
};
}
else {
utils.map(item.tokens, function(token, i) {
item.tokens[i] = token.toLowerCase();
});
return item;
}
});
this._processRawData(data);
};

var processPrefetchError = function () {
this._getDataFromLocalStorage();
};

$.ajax({
url: url,
success: utils.bind(processPrefetchSuccess, this),
error: utils.bind(processPrefetchError, this)
});
},

_processRemoteSuggestions: function(callback, matchedItems) {
return function(data) {
var remoteAndLocalSuggestions = {}, dedupedSuggestions = [];
Expand Down Expand Up @@ -266,7 +260,6 @@ var Dataset = (function() {
this.transport.get(this.queryUrl, query, this._processRemoteSuggestions(callback, matchedItems));
}
}

});

return Dataset;
Expand Down
Loading