Current File : //usr/lib/node_modules/bower/packages/bower-registry-client/lib/search.js |
var path = require('path');
var url = require('url');
var async = require('async');
var request = require('request');
var replay = require('request-replay');
var Cache = require('./util/Cache');
var createError = require('./util/createError');
// TODO:
// The search cache simply stores a specific search result
// into a file. This is a very rudimentary algorithm but
// works to support elementary offline support
// Once the registry server is rewritten, a better strategy
// can be implemented (with diffs and local search), similar to npm.
function search(name, callback) {
var data = [];
var that = this;
var registry = this._config.registry.search;
var total = registry.length;
var index = 0;
// If no registry entries were passed, simply
// error with package not found
if (!total) {
return callback(null, []);
}
// Search package in series in each registry,
// merging results together
async.doUntil(
function(next) {
var remote = url.parse(registry[index]);
var searchCache = that._searchCache[remote.host];
// If offline flag is passed, only query the cache
if (that._config.offline) {
return searchCache.get(name, function(err, results) {
if (err || !results || !results.length) {
return next(err);
}
// Add each result
results.forEach(function(result) {
addResult.call(that, data, result);
});
next();
});
}
// Otherwise make a request to always obtain fresh data
doRequest.call(that, name, index, function(err, results) {
if (err || !results || !results.length) {
return next(err);
}
// Add each result
results.forEach(function(result) {
addResult.call(that, data, result);
});
// Store in cache for future offline usage
searchCache.set(name, results, getMaxAge(), next);
});
},
function() {
// Until the data is unknown or there's still registries to test
return ++index === total;
},
function(err) {
// Clear runtime cache, keeping the persistent data
// in files for future offline usage
resetCache();
// If some of the registry entries failed, error out
if (err) {
return callback(err);
}
callback(null, data);
}
);
}
function addResult(accumulated, result) {
var exists = accumulated.some(function(current) {
return current.name === result.name;
});
if (!exists) {
accumulated.push(result);
}
}
function doRequest(name, index, callback) {
var req;
var msg;
var requestUrl =
this._config.registry.search[index] +
'/packages/search/' +
encodeURIComponent(name);
var remote = url.parse(requestUrl);
var headers = {};
var that = this;
if (this._config.userAgent) {
headers['User-Agent'] = this._config.userAgent;
}
req = replay(
request.get(
requestUrl,
{
headers: headers,
ca: this._config.ca.search[index],
strictSSL: this._config.strictSsl,
timeout: this._config.timeout,
json: true
},
function(err, response, body) {
// If there was an internal error (e.g. timeout)
if (err) {
return callback(
createError(
'Request to ' +
requestUrl +
' failed: ' +
err.message,
err.code
)
);
}
// Abort if there was an error (range different than 2xx)
if (response.statusCode < 200 || response.statusCode > 299) {
return callback(
createError(
'Request to ' +
requestUrl +
' failed with ' +
response.statusCode,
'EINVRES'
)
);
}
// Validate response body, since we are expecting a JSON object
// If the server returns an invalid JSON, it's still a string
if (typeof body !== 'object') {
return callback(
createError(
'Response of request to ' +
requestUrl +
' is not a valid json',
'EINVRES'
)
);
}
callback(null, body);
}
)
);
if (this._logger) {
req.on('replay', function(replay) {
msg =
'Request to ' +
requestUrl +
' failed with ' +
replay.error.code +
', ';
msg += 'retrying in ' + (replay.delay / 1000).toFixed(1) + 's';
that._logger.warn('retry', msg);
});
}
}
function getMaxAge() {
// Make it 5 minutes
return 5 * 60 * 60 * 1000;
}
function initCache() {
this._searchCache = this._cache.search || {};
// Generate a cache instance for each registry endpoint
this._config.registry.search.forEach(function(registry) {
var cacheDir;
var host = url.parse(registry).host;
// Skip if there's a cache for the same host
if (this._searchCache[host]) {
return;
}
if (this._config.cache) {
cacheDir = path.join(
this._config.cache,
encodeURIComponent(host),
'search'
);
}
this._searchCache[host] = new Cache(cacheDir, {
max: 250,
// If offline flag is passed, we use stale entries from the cache
useStale: this._config.offline
});
}, this);
}
function clearCache(name, callback) {
var searchCache = this._searchCache;
var remotes = Object.keys(searchCache);
if (typeof name === 'function') {
callback = name;
name = null;
}
// Simply erase everything since other searches could
// contain the "name" package
// One possible solution would be to read every entry from the cache and
// delete if the package is contained in the search results
// But this is too expensive
async.forEach(
remotes,
function(remote, next) {
searchCache[remote].clear(next);
},
callback
);
}
function resetCache() {
var remote;
for (remote in this._searchCache) {
this._searchCache[remote].reset();
}
}
search.initCache = initCache;
search.clearCache = clearCache;
search.resetCache = resetCache;
module.exports = search;