knex/test/integration/logger.js

'use strict';

const { expect } = require('chai');
const _ = require('lodash');
const { DRIVER_NAMES } = require('../../lib/constants');
const { isObject } = require('../../lib/util/is');

const { TEST_TIMESTAMP, TEST_ID } = require('../util/constants');

module.exports = function (knex) {
  const client = knex.client;

  // allowed driver name of a client
  const allowedClients = Object.values(DRIVER_NAMES);

  function compareBindings(gotBindings, wantedBindings) {
    if (Array.isArray(wantedBindings)) {
      wantedBindings.forEach(function (wantedBinding, index) {
        if (typeof wantedBinding === 'function') {
          expect(
            wantedBinding(gotBindings[index]),
            'binding cheker function failed got: ' + gotBindings
          ).to.equal(true);
        } else {
          expect(gotBindings[index]).to.eql(wantedBinding);
        }
      });
      expect(
        gotBindings.length,
        "length doesn't match got: " + gotBindings
      ).to.equal(wantedBindings.length);
    } else {
      expect(gotBindings).to.eql(wantedBindings);
    }
  }

  // Useful in cases where we want to just test the sql for both PG and SQLite3
  function testSqlTester(qb, driverName, statement, bindings, returnval) {
    if (Array.isArray(driverName)) {
      driverName.forEach(function (val) {
        testSqlTester(qb, val, statement, bindings, returnval);
      });
    } else if (client.driverName === driverName) {
      const sql = qb.toSQL();

      if (statement) {
        if (Array.isArray(sql)) {
          expect(_.map(sql, 'sql')).to.eql(statement);
        } else {
          expect(sql.sql).to.equal(statement);
        }
      }
      if (bindings) {
        if (Array.isArray(sql)) {
          compareBindings(_.map(sql, 'bindings'), bindings);
        } else {
          compareBindings(sql.bindings, bindings);
        }
      }
      if (returnval !== undefined && returnval !== null) {
        const oldThen = qb.then;
        qb.then = function () {
          let promise = oldThen.apply(this, []);
          promise = promise.then(function (resp) {
            if (typeof returnval === 'function') {
              expect(!!returnval(resp)).to.equal(true);
            } else {
              try {
                expect(stripDates(resp)).to.eql(returnval);
              } catch (err) {
                console.log('Actual:');
                console.log(JSON.stringify(resp));
                console.log('Expected:');
                console.log(JSON.stringify(returnval));
                throw err;
              }
            }
            return resp;
          });
          return promise.then.apply(promise, arguments);
        };
      }
    } else {
      if (!allowedClients.includes(driverName)) {
        throw new Error(
          'Invalid client name: ' +
            driverName +
            ' Should be one of: ' +
            allowedClients.join(',')
        );
      }
    }
  }

  function stripDates(resp) {
    if (!isObject(resp[0])) return resp;
    return _.map(resp, function (val) {
      return _.reduce(
        val,
        function (memo, val, key) {
          if (_.includes(['created_at', 'updated_at'], key)) {
            memo[key] = TEST_TIMESTAMP;
          } else if (_.includes(['dummy_id'], key)) {
            memo[key] = TEST_ID;
          } else {
            memo[key] = val;
          }
          return memo;
        },
        {}
      );
    });
  }

  function makeTestSQL(builder) {
    const tester = testSqlTester.bind(null, builder);
    return function (handler) {
      handler(tester);
      return this;
    };
  }

  const originalRaw = client.raw;
  const originalQueryBuilder = client.queryBuilder;
  const originalSchemaBuilder = client.schemaBuilder;
  client.raw = function () {
    const raw = originalRaw.apply(this, arguments);
    raw.testSql = makeTestSQL(raw);
    return raw;
  };
  client.queryBuilder = function () {
    const qb = originalQueryBuilder.apply(this, arguments);
    qb.testSql = makeTestSQL(qb);
    return qb;
  };
  client.schemaBuilder = function () {
    const sb = originalSchemaBuilder.apply(this, arguments);
    sb.testSql = makeTestSQL(sb);
    return sb;
  };

  return knex;
};