Release 2.61.1

Use mapconfig to to store/retrieve dataviews queries

NEWS.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.61.1
+
+Released 2016-07-06
+
+Enhancements:
+ - Dataviews use mapconfig to store/retrieve their queries instead of instantiating analyses again.
+
+
 ## 2.61.0
 
 Released 2016-07-06

lib/cartodb/api/filter_stats_api.js

@@ -1,6 +1,6 @@
 var _ = require('underscore');
 var step = require('step');
-var CamshaftFilter = require('../models/filter/camshaft');
+var AnalysisFilter = require('../models/filter/analysis');
 
 function FilterStatsApi(pgQueryRunner) {
     this.pgQueryRunner = pgQueryRunner;
@@ -40,8 +40,8 @@ FilterStatsApi.prototype.getFilterStats = function (username, unfiltered_query,
       },
       function getFilteredRows() {
           if ( filters && !_.isEmpty(filters)) {
-              var camshaftFilter = new CamshaftFilter(filters);
-              var query = camshaftFilter.sql(unfiltered_query);
+              var analysisFilter = new AnalysisFilter(filters);
+              var query = analysisFilter.sql(unfiltered_query);
               getEstimatedRows(self.pgQueryRunner, username, query, this);
           } else {
               this(null, null);

lib/cartodb/backends/dataview.js

@@ -2,11 +2,8 @@ var assert = require('assert');
 
 var _ = require('underscore');
 var PSQL = require('cartodb-psql');
-var camshaft = require('camshaft');
 var step = require('step');
 
-var Timer = require('../stats/timer');
-
 var BBoxFilter = require('../models/filter/bbox');
 
 var DataviewFactory = require('../models/dataview/factory');
@@ -26,110 +23,36 @@ function DataviewBackend(analysisBackend) {
 module.exports = DataviewBackend;
 
 DataviewBackend.prototype.getDataview = function (mapConfigProvider, user, params, callback) {
-    var self = this;
-
-    var timer = new Timer();
 
     var dataviewName = params.dataviewName;
-
-    var mapConfig;
-    var dataviewDefinition;
     step(
         function getMapConfig() {
             mapConfigProvider.getMapConfig(this);
         },
-        function _getDataviewDefinition(err, _mapConfig) {
+        function runDataviewQuery(err, mapConfig) {
             assert.ifError(err);
 
-            mapConfig = _mapConfig;
-
-            var _dataviewDefinition = getDataviewDefinition(mapConfig.obj(), dataviewName);
-            if (!_dataviewDefinition) {
+            var dataviewDefinition = getDataviewDefinition(mapConfig.obj(), dataviewName);
+            if (!dataviewDefinition) {
                 throw new Error("Dataview '" + dataviewName + "' does not exists");
             }
 
-            dataviewDefinition = _dataviewDefinition;
-
-            return dataviewDefinition;
-        },
-        function loadAnalysis(err) {
-            assert.ifError(err);
-
-            var analysisConfiguration = {
-                user: user,
-                db: {
-                    host: params.dbhost,
-                    port: params.dbport,
-                    dbname: params.dbname,
-                    user: params.dbuser,
-                    pass: params.dbpassword
-                },
-                batch: {
-                    username: user,
-                    apiKey: params.api_key
-                }
-            };
-
-            var sourceId = dataviewDefinition.source.id;
-            var analysisDefinition = getAnalysisDefinition(mapConfig.obj().analyses, sourceId);
-
-            var next = this;
-
-            self.analysisBackend.create(analysisConfiguration, analysisDefinition, function(err, analysis) {
-                if (err) {
-                    return next(err);
-                }
-
-                var sourceId2Node = {};
-                var rootNode = analysis.getRoot();
-                if (rootNode.params && rootNode.params.id) {
-                    sourceId2Node[rootNode.params.id] = rootNode;
-                }
-
-                analysis.getNodes().forEach(function(node) {
-                    if (node.params && node.params.id) {
-                        sourceId2Node[node.params.id] = node;
-                    }
-                });
-
-                var node = sourceId2Node[sourceId];
-
-                if (!node) {
-                    return next(new Error('Analysis node not found for dataview'));
-                }
-
-                return next(null, node);
-            });
-        },
-        function runDataviewQuery(err, node) {
-            assert.ifError(err);
-
             var pg = new PSQL(dbParamsFromReqParams(params));
 
             var ownFilter = +params.own_filter;
             ownFilter = !!ownFilter;
 
-            var query = layerQuery(node, dataviewName, ownFilter);
-
+            var query = (ownFilter) ? dataviewDefinition.sql.own_filter_on : dataviewDefinition.sql.own_filter_off;
             var sourceId =  dataviewDefinition.source.id; // node.id
-            var layer = _.find(
-                mapConfig.obj().layers,
-                function(l){ return l.options.source && (l.options.source.id === sourceId); }
-            );
+            var layer = _.find(mapConfig.obj().layers, function(l) {
+                return l.options.source && (l.options.source.id === sourceId);
+            });
             var queryRewriteData = layer && layer.options.query_rewrite_data;
-            if ( queryRewriteData ) {
-                if ( node.type === 'source' ) {
-                    var filters = node.getFilters();
-                    var filters_disabler = Object.keys(filters).reduce(
-                        function(disabler, filter_id){ disabler[filter_id] = false; return disabler; },
-                        {}
-                    );
-                    var unfiltered_query = node.getQuery(filters_disabler);
-                    queryRewriteData = _.extend(
-                        {},
-                        queryRewriteData, { filters: filters, unfiltered_query: unfiltered_query }
-                    );
-                }
+            if (queryRewriteData && dataviewDefinition.node.type === 'source') {
+                queryRewriteData = _.extend({}, queryRewriteData, {
+                    filters: dataviewDefinition.node.filters,
+                    unfiltered_query: dataviewDefinition.sql.own_filter_on
+                });
             }
 
             if (params.bbox) {
@@ -166,98 +89,32 @@ DataviewBackend.prototype.getDataview = function (mapConfigProvider, user, param
             dataview.getResult(pg, overrideParams, this);
         },
         function returnCallback(err, result) {
-            return callback(err, result, timer.getTimes());
+            return callback(err, result);
         }
     );
 };
 
 DataviewBackend.prototype.search = function (mapConfigProvider, user, params, callback) {
-    var self = this;
-
-    var timer = new Timer();
-
     var dataviewName = params.dataviewName;
 
-    var mapConfig;
-    var dataviewDefinition;
     step(
         function getMapConfig() {
             mapConfigProvider.getMapConfig(this);
         },
-        function _getDataviewDefinition(err, _mapConfig) {
+        function runDataviewSearchQuery(err, mapConfig) {
             assert.ifError(err);
 
-            mapConfig = _mapConfig;
-
-            var _dataviewDefinition = getDataviewDefinition(mapConfig.obj(), dataviewName);
-            if (!_dataviewDefinition) {
+            var dataviewDefinition = getDataviewDefinition(mapConfig.obj(), dataviewName);
+            if (!dataviewDefinition) {
                 throw new Error("Dataview '" + dataviewName + "' does not exists");
             }
 
-            dataviewDefinition = _dataviewDefinition;
-
-            return dataviewDefinition;
-        },
-        function loadAnalysis(err) {
-            assert.ifError(err);
-
-            var analysisConfiguration = {
-                user: user,
-                db: {
-                    host: params.dbhost,
-                    port: params.dbport,
-                    dbname: params.dbname,
-                    user: params.dbuser,
-                    pass: params.dbpassword
-                },
-                batch: {
-                    // TODO load this from configuration
-                    endpoint: 'http://127.0.0.1:8080/api/v1/sql/job',
-                    username: user,
-                    apiKey: params.api_key
-                }
-            };
-
-            var sourceId = dataviewDefinition.source.id;
-            var analysisDefinition = getAnalysisDefinition(mapConfig.obj().analyses, sourceId);
-
-            var next = this;
-
-            self.analysisBackend.create(analysisConfiguration, analysisDefinition, function(err, analysis) {
-                if (err) {
-                    return next(err);
-                }
-
-                var sourceId2Node = {};
-                var rootNode = analysis.getRoot();
-                if (rootNode.params && rootNode.params.id) {
-                    sourceId2Node[rootNode.params.id] = rootNode;
-                }
-
-                analysis.getNodes().forEach(function(node) {
-                    if (node.params && node.params.id) {
-                        sourceId2Node[node.params.id] = node;
-                    }
-                });
-
-                var node = sourceId2Node[sourceId];
-
-                if (!node) {
-                    return next(new Error('Analysis node not found for dataview'));
-                }
-
-                return next(null, node);
-            });
-        },
-        function runDataviewQuery(err, node) {
-            assert.ifError(err);
-
             var pg = new PSQL(dbParamsFromReqParams(params));
 
             var ownFilter = +params.own_filter;
             ownFilter = !!ownFilter;
 
-            var query = layerQuery(node, dataviewName, ownFilter);
+            var query = (ownFilter) ? dataviewDefinition.sql.own_filter_on : dataviewDefinition.sql.own_filter_off;
 
             if (params.bbox) {
                 var bboxFilter = new BBoxFilter({column: 'the_geom', srid: 4326}, {bbox: params.bbox});
@@ -270,23 +127,11 @@ DataviewBackend.prototype.search = function (mapConfigProvider, user, params, ca
             dataview.search(pg, userQuery, this);
         },
         function returnCallback(err, result) {
-            return callback(err, result, timer.getTimes());
+            return callback(err, result);
         }
     );
 };
 
-function getAnalysisDefinition(mapConfigAnalyses, sourceId) {
-    mapConfigAnalyses = mapConfigAnalyses || [];
-    for (var i = 0; i < mapConfigAnalyses.length; i++) {
-        var analysisGraph = new camshaft.reference.AnalysisGraph(mapConfigAnalyses[i]);
-        var nodes = analysisGraph.getNodesWithId();
-        if (nodes.hasOwnProperty(sourceId)) {
-            return mapConfigAnalyses[i];
-        }
-    }
-    throw new Error('There is no associated analysis for the dataview source id');
-}
-
 function getDataviewDefinition(mapConfig, dataviewName) {
     var dataviews = mapConfig.dataviews || {};
     return dataviews[dataviewName];
@@ -311,31 +156,3 @@ function dbParamsFromReqParams(params) {
     }
     return dbParams;
 }
-
-var SKIP_COLUMNS = {
-    'the_geom': true,
-    'the_geom_webmercator': true
-};
-
-function skipColumns(columnNames) {
-    return columnNames
-        .filter(function(columnName) { return !SKIP_COLUMNS[columnName]; });
-}
-
-var layerQueryTemplate = dot.template([
-    'SELECT {{=it._columns}}',
-    'FROM ({{=it._query}}) _cdb_analysis_query'
-].join('\n'));
-
-function layerQuery(node, dataviewName, ownFilter) {
-    var applyFilters = {};
-    if (!ownFilter) {
-        applyFilters[dataviewName] = false;
-    }
-
-    if (node.type === 'source') {
-        return node.getQuery(applyFilters);
-    }
-    var _columns = ['ST_Transform(the_geom, 3857) the_geom_webmercator'].concat(skipColumns(node.getColumns()));
-    return layerQueryTemplate({ _query: node.getQuery(applyFilters), _columns: _columns.join(', ') });
-}

lib/cartodb/models/filter/analysis.js

@@ -1,6 +1,6 @@
 var filters = {
-    category: require('./camshaft/category'),
-    range: require('./camshaft/range')
+    category: require('./analysis/category'),
+    range: require('./analysis/range')
 };
 
 function createFilter(filterDefinition) {
@@ -11,11 +11,11 @@ function createFilter(filterDefinition) {
     return new filters[filterType](filterDefinition.column, filterDefinition.params);
 }
 
-function CamshaftFilters(filters) {
+function AnalysisFilters(filters) {
     this.filters = filters;
 }
 
-CamshaftFilters.prototype.sql = function(rawSql) {
+AnalysisFilters.prototype.sql = function(rawSql) {
   var filters = this.filters || {};
   var applyFilters = {};
 
@@ -32,4 +32,4 @@ CamshaftFilters.prototype.sql = function(rawSql) {
       }, rawSql);
 };
 
-module.exports = CamshaftFilters;
+module.exports = AnalysisFilters;

lib/cartodb/models/filter/analysis/category.js

@@ -6,7 +6,7 @@ dot.templateSettings.strip = false;
 
 var filterQueryTpl = dot.template([
     'SELECT *',
-    'FROM ({{=it._sql}}) _camshaft_category_filter',
+    'FROM ({{=it._sql}}) _analysis_category_filter',
     'WHERE {{=it._filters}}'
 ].join('\n'));
 var escapeStringTpl = dot.template('$escape_{{=it._i}}${{=it._value}}$escape_{{=it._i}}$');

lib/cartodb/models/filter/analysis/range.js

@@ -6,7 +6,7 @@ dot.templateSettings.strip = false;
 var betweenFilterTpl = dot.template('{{=it._column}} BETWEEN {{=it._min}} AND {{=it._max}}');
 var minFilterTpl = dot.template('{{=it._column}} >= {{=it._min}}');
 var maxFilterTpl = dot.template('{{=it._column}} <= {{=it._max}}');
-var filterQueryTpl = dot.template('SELECT * FROM ({{=it._sql}}) _camshaft_range_filter WHERE {{=it._filter}}');
+var filterQueryTpl = dot.template('SELECT * FROM ({{=it._sql}}) _analysis_range_filter WHERE {{=it._filter}}');
 
 function Range(column, filterParams) {
     this.column = column;

lib/cartodb/models/mapconfig/adapter/analysis-mapconfig-adapter.js

@@ -123,14 +123,37 @@ AnalysisMapConfigAdapter.prototype.getMapConfig = function(user, requestMapConfi
             return layer;
         });
 
-
-        debug('mapconfig output', JSON.stringify(requestMapConfig, null, 4));
-
         var missingDataviewsNodesErrors = getMissingDataviewsSourceIds(dataviews, sourceId2Node);
         if (missingNodesErrors.length > 0 || missingDataviewsNodesErrors.length > 0) {
             return callback(missingNodesErrors.concat(missingDataviewsNodesErrors));
         }
 
+        // Augment dataviews with sql from analyses
+        Object.keys(dataviews).forEach(function(dataviewName) {
+            var dataview = requestMapConfig.dataviews[dataviewName];
+            var dataviewSourceId = dataview.source.id;
+            var dataviewNode = sourceId2Node[dataviewSourceId];
+            dataview.node = {
+                type: dataviewNode.type,
+                filters: dataviewNode.getFilters()
+            };
+            dataview.sql = {
+                own_filter_on: dataviewQuery(dataviewNode, dataviewName, true),
+                own_filter_off: dataviewQuery(dataviewNode, dataviewName, false),
+                no_filters: dataviewNode.getQuery(Object.keys(dataviewNode.getFilters())
+                    .reduce(function(applyFilters, filterId) {
+                        applyFilters[filterId] = false;
+                        return applyFilters;
+                    }, {})
+                )
+            };
+        });
+        if (Object.keys(dataviews).length > 0) {
+            requestMapConfig.dataviews = dataviews;
+        }
+
+        debug('mapconfig output', JSON.stringify(requestMapConfig, null, 4));
+
         context.analysesResults = analysesResults;
 
         return callback(null, requestMapConfig);
@@ -147,7 +170,7 @@ function skipColumns(columnNames) {
         .filter(function(columnName) { return !SKIP_COLUMNS[columnName]; });
 }
 
-var layerQueryTemplate = dot.template([
+var wrappedQueryTpl = dot.template([
     'SELECT {{=it._columns}}',
     'FROM ({{=it._query}}) _cdb_analysis_query'
 ].join('\n'));
@@ -157,7 +180,20 @@ function layerQuery(node) {
         return node.getQuery();
     }
     var _columns = ['ST_Transform(the_geom, 3857) the_geom_webmercator'].concat(skipColumns(node.getColumns()));
-    return layerQueryTemplate({ _query: node.getQuery(), _columns: _columns.join(', ') });
+    return wrappedQueryTpl({ _query: node.getQuery(), _columns: _columns.join(', ') });
+}
+
+function dataviewQuery(node, dataviewName, ownFilter) {
+    var applyFilters = {};
+    if (!ownFilter) {
+        applyFilters[dataviewName] = false;
+    }
+
+    if (node.type === 'source') {
+        return node.getQuery(applyFilters);
+    }
+    var _columns = ['ST_Transform(the_geom, 3857) the_geom_webmercator'].concat(skipColumns(node.getColumns()));
+    return wrappedQueryTpl({ _query: node.getQuery(applyFilters), _columns: _columns.join(', ') });
 }
 
 function appendFiltersToNodes(requestMapConfig, dataviewsFiltersBySourceId) {

lib/cartodb/utils/overviews_query_rewriter.js

@@ -2,7 +2,7 @@ var _ = require('underscore');
 var TableNameParser = require('./table_name_parser');
 
 var BBoxFilter = require('../models/filter/bbox');
-var CamshaftFilter = require('../models/filter/camshaft');
+var AnalysisFilter = require('../models/filter/analysis');
 
 // Minimim number of filtered rows to use overviews
 var FILTER_MIN_ROWS = 65536;
@@ -11,8 +11,8 @@ var FILTER_MAX_FRACTION = 0.2;
 
 function apply_filters_to_query(query, filters, bbox_filter) {
     if ( filters && !_.isEmpty(filters)) {
-        var camshaftFilter = new CamshaftFilter(filters);
-        query = camshaftFilter.sql(query);
+        var analysisFilter = new AnalysisFilter(filters);
+        query = analysisFilter.sql(query);
     }
     if ( bbox_filter ) {
         var bboxFilter = new BBoxFilter(bbox_filter.options, bbox_filter.params);

npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "windshaft-cartodb",
-  "version": "2.61.0",
+  "version": "2.61.1",
   "dependencies": {
     "body-parser": {
       "version": "1.14.2",

package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "windshaft-cartodb",
-  "version": "2.61.0",
+  "version": "2.61.1",
   "description": "A map tile server for CartoDB",
   "keywords": [
     "cartodb"

test/unit/cartodb/overviews_query_rewriter.js

@@ -527,7 +527,7 @@ describe('Overviews query rewriter', function() {
     it('generates query with filters', function(){
         var sql = "SELECT ST_Transform(the_geom, 3857) the_geom_webmercator, cartodb_id, name\
                    FROM (SELECT *\
-                   FROM (select * from table1) _camshaft_category_filter\
+                   FROM (select * from table1) _analysis_category_filter\
                    WHERE name IN ($escape_0$X$escape_0$)) _cdb_analysis_query";
         var data = {
             overviews: {
@@ -555,7 +555,7 @@ describe('Overviews query rewriter', function() {
                   SELECT * FROM table1_ov3, _vovw_scale WHERE _vovw_z = 3\
                   UNION ALL\
                   SELECT * FROM table1, _vovw_scale WHERE _vovw_z > 3\
-                ) AS _vovw_table1) _camshaft_category_filter\
+                ) AS _vovw_table1) _analysis_category_filter\
              WHERE name IN ($escape_0$X$escape_0$)\
         ";
         assertSameSql(overviews_sql, expected_sql);
@@ -564,7 +564,7 @@ describe('Overviews query rewriter', function() {
     it('generates query with filters for specific zoom level', function(){
         var sql = "SELECT ST_Transform(the_geom, 3857) the_geom_webmercator, cartodb_id, name\
                    FROM (SELECT *\
-                   FROM (select * from table1) _camshaft_category_filter\
+                   FROM (select * from table1) _analysis_category_filter\
                    WHERE name IN ($escape_0$X$escape_0$)) _cdb_analysis_query";
         var data = {
             overviews: {
@@ -581,7 +581,7 @@ describe('Overviews query rewriter', function() {
         };
         var overviews_sql = overviewsQueryRewriter.query(sql, data, { zoom_level: 2 });
         var expected_sql = "\
-            SELECT * FROM (SELECT * FROM table1_ov2) _camshaft_category_filter\
+            SELECT * FROM (SELECT * FROM table1_ov2) _analysis_category_filter\
             WHERE name IN ($escape_0$X$escape_0$)\
         ";
         assertSameSql(overviews_sql, expected_sql);
@@ -590,7 +590,7 @@ describe('Overviews query rewriter', function() {
     it('does not generates query with aggressive filtering', function(){
         var sql = "SELECT ST_Transform(the_geom, 3857) the_geom_webmercator, cartodb_id, name\
                    FROM (SELECT *\
-                   FROM (select * from table1) _camshaft_category_filter\
+                   FROM (select * from table1) _analysis_category_filter\
                    WHERE name IN ($escape_0$X$escape_0$)) _cdb_analysis_query";
         var data = {
             overviews: {