CartoDB-SQL-API/test/acceptance/surrogate-key-test.js

'use strict';

require('../helper');

var server = require('../../lib/server')();
var assert = require('../support/assert');
var querystring = require('querystring');
var QueryTables = require('cartodb-query-tables').queryTables;
var _ = require('underscore');

describe('Surrogate-Key header', function () {
    function createGetRequest (sqlQuery) {
        var query = querystring.stringify({
            q: sqlQuery,
            api_key: 1234
        });
        return {
            url: '/api/v1/sql?' + query,
            headers: {
                host: 'vizzuality.cartodb.com'
            },
            method: 'GET'
        };
    }

    var RESPONSE_OK = {
        statusCode: 200
    };

    function surrogateKeyHasTables (surrogateKey, expectedTables) {
        var surrogateKeys = surrogateKey.split(' ');

        var expectedSurrogateKeys = new QueryTables.QueryMetadata(expectedTables).key();

        assert.strictEqual(surrogateKeys.length, expectedSurrogateKeys.length);

        var tablesDiff = _.difference(surrogateKeys, expectedSurrogateKeys);
        assert.strictEqual(tablesDiff.length, 0, 'Surrogate-Key missing tables: ' + tablesDiff.join(','));
    }

    function tableNamesInSurrogateKeyHeader (expectedTableNames, done) {
        return function (err, res) {
            assert.ifError(err);
            surrogateKeyHasTables(res.headers['surrogate-key'], expectedTableNames);
            done();
        };
    }

    it('supports joins', function (done) {
        var sql = 'SELECT a.name as an, b.name as bn FROM untitle_table_4 a ' +
                'left join private_table b ON (a.cartodb_id = b.cartodb_id)';

        assert.response(server, createGetRequest(sql), RESPONSE_OK, tableNamesInSurrogateKeyHeader([
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'private_table' },
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'untitle_table_4' }
        ], done));
    });

    it('supports multistatements', function (done) {
        var sql = 'SELECT * FROM untitle_table_4; SELECT * FROM private_table';

        assert.response(server, createGetRequest(sql), RESPONSE_OK, tableNamesInSurrogateKeyHeader([
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'private_table' },
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'untitle_table_4' }
        ], done));
    });

    it('supports explicit transactions', function (done) {
        var sql = 'BEGIN; SELECT * FROM untitle_table_4; COMMIT; BEGIN; SELECT * FROM private_table; COMMIT;';

        assert.response(server, createGetRequest(sql), RESPONSE_OK, tableNamesInSurrogateKeyHeader([
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'private_table' },
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'untitle_table_4' }
        ], done));
    });

    it('survives partial transactions', function (done) {
        var sql = 'BEGIN; SELECT * FROM untitle_table_4';

        assert.response(server, createGetRequest(sql), RESPONSE_OK, tableNamesInSurrogateKeyHeader([
            { dbname: 'cartodb_test_user_1_db', schema_name: 'public', table_name: 'untitle_table_4' }
        ], done));
    });

    it('should not add header for functions', function (done) {
        var sql = "SELECT format('%s', 'wadus')";
        assert.response(server, createGetRequest(sql), RESPONSE_OK, function (err, res) {
            assert.ifError(err);
            assert.ok(!Object.prototype.hasOwnProperty.call(res.headers, 'surrogate-key'), res.headers['surrogate-key']);
            done();
        });
    });

    it('should not add header for CDB_QueryTables', function (done) {
        var sql = "SELECT cartodb.CDB_QueryTablesText('select * from untitle_table_4')";
        assert.response(server, createGetRequest(sql), RESPONSE_OK, function (err, res) {
            assert.ifError(err);
            assert.ok(!Object.prototype.hasOwnProperty.call(res, 'surrogate-key'), res.headers['surrogate-key']);
            done();
        });
    });

    it('should not add header for non table results', function (done) {
        var sql = "SELECT 'wadus'::text";
        assert.response(server, createGetRequest(sql), RESPONSE_OK, function (err, res) {
            assert.ifError(err);
            assert.ok(!Object.prototype.hasOwnProperty.call(res.headers, 'surrogate-key'), res.headers['surrogate-key']);
            done();
        });
    });
});