diff --git a/lib/cartodb/backends/dataview.js b/lib/cartodb/backends/dataview.js index a2f5327a..99a115e6 100644 --- a/lib/cartodb/backends/dataview.js +++ b/lib/cartodb/backends/dataview.js @@ -59,12 +59,12 @@ DataviewBackend.prototype.getDataview = function (mapConfigProvider, user, param return callback(error); } - dataview.getResult(pg, overrideParams, function (err, dataviewResult) { + dataview.getResult(pg, overrideParams, function (err, dataviewResult, stats = {}) { if (err) { return callback(err); } - return callback(null, dataviewResult); + return callback(null, dataviewResult, stats); }); }); }; diff --git a/lib/cartodb/models/dataview/base.js b/lib/cartodb/models/dataview/base.js index 80e021b1..455461a2 100644 --- a/lib/cartodb/models/dataview/base.js +++ b/lib/cartodb/models/dataview/base.js @@ -21,7 +21,7 @@ function getPGTypeName (pgType) { module.exports = class BaseDataview { getResult (psql, override, callback) { - this.sql(psql, override, (err, query) => { + this.sql(psql, override, (err, query, flags = null) => { if (err) { return callback(err); } @@ -34,8 +34,20 @@ module.exports = class BaseDataview { result = this.format(result, override); result.type = this.getType(); - return callback(null, result); + //Overviews logging + const stats = {}; + if (flags && flags.usesOverviews !== undefined) { + stats.usesOverviews = flags.usesOverviews; + } else { + stats.usesOverviews = false; + } + + if (this.getType) { + stats.dataviewType = this.getType(); + } + + return callback(null, result, stats); }, true); // use read-only transaction }); } diff --git a/lib/cartodb/models/dataview/overviews/aggregation.js b/lib/cartodb/models/dataview/overviews/aggregation.js index 5df092f4..312a398e 100644 --- a/lib/cartodb/models/dataview/overviews/aggregation.js +++ b/lib/cartodb/models/dataview/overviews/aggregation.js @@ -209,7 +209,7 @@ Aggregation.prototype.sql = function(psql, override, callback) { debug(aggregationSql); - return callback(null, aggregationSql); + return callback(null, aggregationSql, { usesOverviews: true }); }; var aggregationFnQueryTpl = { diff --git a/lib/cartodb/models/dataview/overviews/formula.js b/lib/cartodb/models/dataview/overviews/formula.js index 2a97061e..dd487ccb 100644 --- a/lib/cartodb/models/dataview/overviews/formula.js +++ b/lib/cartodb/models/dataview/overviews/formula.js @@ -74,5 +74,5 @@ Formula.prototype.sql = function (psql, override, callback) { debug(formulaSql); - return callback(null, formulaSql); + return callback(null, formulaSql, { usesOverviews: true }); }; diff --git a/lib/cartodb/models/dataview/overviews/histogram.js b/lib/cartodb/models/dataview/overviews/histogram.js index 6674f6a0..cc7e7342 100644 --- a/lib/cartodb/models/dataview/overviews/histogram.js +++ b/lib/cartodb/models/dataview/overviews/histogram.js @@ -178,7 +178,7 @@ Histogram.prototype.sql = function(psql, override, callback) { var histogramSql = this._buildQuery(override); - return callback(null, histogramSql); + return callback(null, histogramSql, { usesOverviews: true }); }; Histogram.prototype._buildQuery = function (override) { diff --git a/test/acceptance/dataviews/overviews.js b/test/acceptance/dataviews/overviews.js index 552b9ac6..3487a08b 100644 --- a/test/acceptance/dataviews/overviews.js +++ b/test/acceptance/dataviews/overviews.js @@ -48,11 +48,12 @@ describe('dataviews using tables without overviews', function() { it("should expose a formula", function(done) { var testClient = new TestClient(nonOverviewsMapConfig); - testClient.getDataview('country_places_count', { own_filter: 0 }, function(err, formula_result) { + testClient.getDataview('country_places_count', { own_filter: 0 }, function(err, formula_result, headers) { if (err) { return done(err); } assert.deepEqual(formula_result, { operation: 'count', result: 7313, nulls: 0, type: 'formula' }); + assert(getUsesOverviewsFromHeaders(headers) === false); //Overviews logging testClient.drain(done); }); @@ -257,7 +258,7 @@ describe('dataviews using tables with overviews', function() { it("should expose a sum formula", function(done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_sum', { own_filter: 0 }, function(err, formula_result) { + testClient.getDataview('test_sum', { own_filter: 0 }, function(err, formula_result, headers) { if (err) { return done(err); } @@ -269,6 +270,8 @@ describe('dataviews using tables with overviews', function() { "nulls":0, "type":"formula" }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging + assert(getDataviewTypeFromHeaders(headers) === 'formula'); //Overviews logging testClient.drain(done); }); @@ -276,7 +279,7 @@ describe('dataviews using tables with overviews', function() { it("should expose an avg formula", function(done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_avg', { own_filter: 0 }, function(err, formula_result) { + testClient.getDataview('test_avg', { own_filter: 0 }, function(err, formula_result, headers) { if (err) { return done(err); } @@ -288,6 +291,8 @@ describe('dataviews using tables with overviews', function() { "infinities": 0, "nans": 0 }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging + assert(getDataviewTypeFromHeaders(headers) === 'formula'); //Overviews logging testClient.drain(done); }); @@ -295,7 +300,7 @@ describe('dataviews using tables with overviews', function() { it("should expose a count formula", function(done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_count', { own_filter: 0 }, function(err, formula_result) { + testClient.getDataview('test_count', { own_filter: 0 }, function(err, formula_result, headers) { if (err) { return done(err); } @@ -307,6 +312,8 @@ describe('dataviews using tables with overviews', function() { "infinities": 0, "nans": 0 }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging + assert(getDataviewTypeFromHeaders(headers) === 'formula'); //Overviews logging testClient.drain(done); }); @@ -374,13 +381,16 @@ describe('dataviews using tables with overviews', function() { it("should expose a histogram", function (done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_histogram', function (err, histogram) { + testClient.getDataview('test_histogram', function (err, histogram, headers) { if (err) { return done(err); } assert.ok(histogram); assert.equal(histogram.type, 'histogram'); assert.ok(Array.isArray(histogram.bins)); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging + assert(getDataviewTypeFromHeaders(headers) === 'histogram'); //Overviews logging + testClient.drain(done); }); }); @@ -462,7 +472,7 @@ describe('dataviews using tables with overviews', function() { it("should expose a filtered sum formula", function (done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_sum', params, function (err, formula_result) { + testClient.getDataview('test_sum', params, function (err, formula_result, headers) { if (err) { return done(err); } @@ -474,13 +484,14 @@ describe('dataviews using tables with overviews', function() { "nans": 0, "type":"formula" }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging testClient.drain(done); }); }); it("should expose a filtered avg formula", function(done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_avg', params, function(err, formula_result) { + testClient.getDataview('test_avg', params, function(err, formula_result, headers) { if (err) { return done(err); } @@ -492,6 +503,7 @@ describe('dataviews using tables with overviews', function() { "nans": 0, "type":"formula" }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging testClient.drain(done); }); @@ -499,7 +511,7 @@ describe('dataviews using tables with overviews', function() { it("should expose a filtered count formula", function(done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_count', params, function(err, formula_result) { + testClient.getDataview('test_count', params, function(err, formula_result, headers) { if (err) { return done(err); } @@ -511,6 +523,7 @@ describe('dataviews using tables with overviews', function() { "nulls":0, "type":"formula" }); + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging testClient.drain(done); }); @@ -586,10 +599,11 @@ describe('dataviews using tables with overviews', function() { it("should expose an aggregation dataview filtering special float values out", function (done) { var testClient = new TestClient(overviewsMapConfig); - testClient.getDataview('test_categories_special_values', params, function (err, dataview) { + testClient.getDataview('test_categories_special_values', params, function (err, dataview, headers) { if (err) { return done(err); } + assert.deepEqual(dataview, { aggregation: 'sum', count: 5, @@ -602,6 +616,10 @@ describe('dataviews using tables with overviews', function() { categories: [ { category: 'Hawai', value: 6, agg: false } ], type: 'aggregation' }); + + assert.ok(getUsesOverviewsFromHeaders(headers)); //Overviews logging + assert(getDataviewTypeFromHeaders(headers) === 'aggregation'); //Overviews logging + testClient.drain(done); }); }); @@ -647,3 +665,11 @@ describe('dataviews using tables with overviews', function() { }); }); }); + +function getUsesOverviewsFromHeaders(headers) { + return headers && headers['x-tiler-profiler'] && JSON.parse(headers['x-tiler-profiler']).usesOverviews; +} + +function getDataviewTypeFromHeaders(headers) { + return headers && headers['x-tiler-profiler'] && JSON.parse(headers['x-tiler-profiler']).dataviewType; +} diff --git a/test/support/test-client.js b/test/support/test-client.js index db014c9a..e3172cdf 100644 --- a/test/support/test-client.js +++ b/test/support/test-client.js @@ -509,16 +509,15 @@ TestClient.prototype.getDataview = function(dataviewName, params, callback) { if (err) { return next(err); } - - next(null, JSON.parse(res.body)); + next(null, JSON.parse(res.body), res.headers); } ); }, - function finish(err, dataview) { + function finish(err, dataview, headers = null) { if (err) { return callback(err); } - return callback(null, dataview); + return callback(null, dataview, headers); } ); };