New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow overwriting log functions #2625

Merged
merged 11 commits into from May 29, 2018

Conversation

Projects
None yet
5 participants
@wubzz
Collaborator

wubzz commented May 23, 2018

The idea is knex has some built-in log functions just as before, but allow the user to overwrite these functions as such:

const knex = require('knex')({
    client: 'pg',
    connection: {...},
    log: {
      warn(message) {
      },
      error(message) {
      },
      deprecate(message) {
      },
      debug(message) {
      },
    }
});

This also means seperate clients can use seperate log handlers. Relates to a lot of issues..

There's another ongoing build with similar feature. I'm not clear on what the differences are between the two.

This may be completely wrong way of implementing this, I'm mostly creating the PR solely to give the topic a rebirth, since it has been requested many times before.

@wubzz wubzz changed the title from Allow overwrite of log functions to Allow overwriting log functions May 23, 2018

@elhigu

This comment has been minimized.

Collaborator

elhigu commented May 25, 2018

Looks like the difference is that your logger allows to pass different logger handler for every knex instance and the other solution used global logger, which is easier to use by the library (you can just require it in in everywhere without need to pass it everywhere separately).

Personally I like the less intrusive way of doing it a bit more, but I don't have very strong opinion about it. It is quite easy to change to global logger, if passing the logger instance around gets annoying.

@elhigu

All good 👍

@elhigu

elhigu approved these changes May 25, 2018

@@ -35,6 +35,7 @@ module.exports = function(tableName, knex) {
var val = cb(t)
if (val && typeof val.then === 'function') {
return val.catch(function(err) {
console.error(err);

This comment has been minimized.

@tgriesser

tgriesser May 29, 2018

Owner

Was this intentional related to logging or can we remove it?

This comment has been minimized.

@wubzz

wubzz May 29, 2018

Collaborator

Ah that's my bad. Stacktraces aren't printed when running tape and I had an issue in maria or oracle which I couldn't run locally at the time of making this, so abused Travis. 😄 I'll revert this back.

@tgriesser

This comment has been minimized.

Owner

tgriesser commented May 29, 2018

Damn @wubzz this is awesome! Just had one comment, otherwise yeah this is what I was eventually hoping we would get to, with this branch being an incremental step but this looks much better!

wubzz added some commits May 29, 2018

@tgriesser tgriesser merged commit 65509c3 into tgriesser:master May 29, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@tgriesser

This comment has been minimized.

Owner

tgriesser commented May 29, 2018

Awesome!

tgriesser added a commit that referenced this pull request May 29, 2018

Merge branch 'master' into remove-lodash-babel-plugin
* master:
  Allow overwriting log functions (#2625)
@wubzz

This comment has been minimized.

Collaborator

wubzz commented Jun 1, 2018

import {isFunction, isNil} from 'lodash';
function log(message, userFn, colorFn) {
if(!isNil(userFn) && !isFunction(userFn)) {

This comment has been minimized.

@kibertoad

kibertoad Jun 1, 2018

Collaborator

wouldn't logic be simpler if you didn't have to do the check on each log action and instead filled undefined methods in config with dummy console.log implementation?

this._deprecate = deprecate;
}
debug(message) {

This comment has been minimized.

@kibertoad

kibertoad Jun 1, 2018

Collaborator

this is going to swallow any parameters passed to the logger (e. g. error instance). Using 'arguments' instead is going to be much more robust.

@@ -412,7 +413,7 @@ function validateMigrationList(migrations) {
function warnPromise(value, name, fn) {
if (!value || typeof value.then !== 'function') {
helpers.warn(`migration ${name} did not return a promise`);
this.knex.client.logger.warn(`migration ${name} did not return a promise`);

This comment has been minimized.

@leontastic

leontastic Jul 22, 2018

@wubzz This gives a fatal TypeError Cannot read property 'knex' of undefined when a migration does not return a Promise.

veikovx added a commit to veikovx/knex that referenced this pull request Sep 17, 2018

Allow overwriting log functions (tgriesser#2625)
* Example build of custom log functions
* Handle logger object better for transactions
* Adjust test to ignore sqlite warning message

elhigu added a commit that referenced this pull request Sep 26, 2018

Kill queries after timeout for PostgreSQL (#2636)
* Kill queries after timeout for PostgreSQL

* Fix cancellation connection acquiring and test.

* Fix releasing connection in case query cancellation fails

* Add support for native enums on Postgres (#2632)

Reference https://www.postgresql.org/docs/current/static/sql-createtype.html

Closes #394

Signed-off-by: Will Soto <will.soto9@gmail.com>

* Removal of 'skim' (#2520)

* Allow overwriting log functions (#2625)

* Example build of custom log functions
* Handle logger object better for transactions
* Adjust test to ignore sqlite warning message

* Fixed onIn with empty values array (#2513)

* Drop support for strong-oracle (#2487)

* Remove babel-plugin-lodash (#2634)

While in theory, this may reduce the bundle size,
in practice it adds a ton of overhead during startup
due to the number of additional requires. Bundle
size also shouldn't matter for server side modules.

* Add json support to the query builder for mysql (#2635)

* Add json support to the query builder for mysql

refs #1036

Based on #1902

* Clarify supported version

* fix wrapIdentifier not being called in postgres alter column (#2612)

* fix wrapIdentifier not being called in postgres alter column

* add test for wrapIdentifier call in postgres alter column

* add comment regarding issue

* add issue & PR #'s in comment

* Remove readable-stream and safe-buffer (#2640)

* Add json support to the query builder for mysql

refs #1036

Based on #1902

* Clarify supported version

* Use native Buffer and Stream implementations

* fixes 2630 (#2642)

* Timeout errors shouldn't silently ignore the passed errors, but rather reject with original error. Fixes #2582 (#2626)

* chore: add Node.js 10 (#2594)

* chore: add Node.js 10

* chore: trigger new build

* chore: update lockfile

* chore: trigger new build

* fix: use npm i instead of npm ci

* Fix mssql driver crashing (#2637)

* Run SQL Server tests locally running SQL server in docker

* WIP mssql test stuff

* Patched MSSQL driver to not crash knex anymore

* Removed semicolon from rollback stmt for oracle (#2564)

* Remove WebSQL dialect (#2647)

* Add json support to the query builder for mysql

refs #1036

Based on #1902

* Clarify supported version

* Use native Buffer and Stream implementations

* Remove WebSQL dialect

* add homepage field to package.json (#2650)

* Make the stream catch errors in the query (#2638)

* Make the stream catch errors in the query

* Fix another case in which stream doesnt emits error

* Linter stuff

* Remove setTimeout in tests

* Make a test not to check the MySQL error code

* Fix stream error catching for MariaDB and PostgreSQL

* Fix stream error catching in Oracle

* Throw the error after emitting it to the stream

* Throw the error without instantiating a new Error

* Various fixes to mssql dialect (#2653)

* Fixed float type of mssql to be float

* Many tests where postgres test was not actually ran at all

* Migrations to be mssql compatible

Mssql driver doesn't handle if multiple queries are sent to same transaction concurrently.

* Prevented mssql failing when invalid schema builder was executed by accident

Instead of trying to generate sql from broken schema calls, just make exception to leak before query compiling is started

* Fixed mssql trx rollback to always throw an error

Also modified some connection test query to be mssql compatible

* Fixed various bugs from MSSQL driver to make tests run

* Fixed mssql unique index to be compatible with other dialect implementations

* Enable running mssql tests on CI

* Test for #2588

* Updated tests to not be dependend on tables left from previous test rans

* Trying to make mssql server work on travis

* Updated changelog and version

* Drop mariadb support  (#2681)

* Dropped support for mariasql

* ESLint

* Fixed docs to build again

* Fix knex.initialize() and adds test (#2477)

* Fix knex.initialize() and adds test

* Fix knex.initialize() and adds test

* Added test for reinitializing pool after destroy

* Fixed destroy / reinitialization test

* Fixed the fix

* Implement missing schema support for mssql dialect

* chore: Update dependencies. Remove estraverse (#2691)

* Update dependencies. Remove estraverse

* Fix compatibility with new Sinon

* Increase mssql timeout

* Normalized and validated driverNames of test db clients and fixed oracle test setup (#2692)

* Normalized and validated driverNames of test db clients and fixed oracle test setup

* Fixed failed queries from old query building tests which hadn't been ran in ages

* Allow selecting node version which is used to run oracledb docker tests

* Improved sql tester error messages

* Fixed rest of the oracledb tests

* Removed invalid flag from docker-compose

* Print mssql logs if initialization fails

* Fixed syntax error + final tests

* Added restart of failure for mssql DB initialization to try again if server was not ready

* Printout always mssql logs after container is started

* Fixed wait time printing after trying to connect

* Use npm run oracledb:test for testing oracle in travis

* Add Prettier (#2697)

* Add prettier
* Run files through prettier

* Istanbul -> NYC (#2700)

* istanbul -> nyc

* Update mocha

* Enforce code coverage (#2702)

* Enforce code coverage
* Update coverage numbers with current values

* version assignment on base class, copy on tx client, fix #2705

* Update changelog

* v0.15.1

* Added build step to test script. Fixes #2541 (#2712)

* Revert "Added build step to test script. Fixes #2541 (#2712)" (#2714)

This reverts commit 90ed8db.

* Allow oracle failures for now

* Fix issue with select(0) (#2711)

* Fix issue with select(0). Fixes #2658

* Refactor migrator (#2695)

* Refactor migrator

* Fix exports

* Fix ESLint

* Fix migrator

* Fix reference to config

* Split some more

* Fix table builder

* Fix argument order

* Merge branch 'master' of https://github.com/tgriesser/knex into feature/2690-support-multiple-migration-dirs

# Conflicts:
#	src/migrate/index.js
#	test/index.js
#	test/unit/migrate/migrator.js

* Fix #2715 (#2721)

* Fix #2715, explicitly set precision in datetime & timestamp
* Allow for precision in knex.fn.now, mysql time
* Add test for datetime with precision

* Bump changelog

* 0.15.2

* Fix issues with warnPromise when migration does not return a promise. Fixes #2725 (#2730)

* Add tests for multiple union arguments with callbacks and builders (#2749)

* Add tests for multiple union arguments

* Add some callback and raw tests to union unit tests

* Compile with before update so that bindings are put in correct order (#2733)

* Fix join using builder withSchema. (#2744)

* Use Datetime2 for MSSQL datetime + timestamp types (#2757)

* Use Datetime2 for MSSQL datetime + timestamp types

Datetime2 is now the recommended column type for new date work: https://docs.microsoft.com/en-us/sql/t-sql/data-types/datetime-transact-sql?view=sql-server-2017

* Add tests for MSSQL datetime2 changes

* General/document breaking change (#2774)

* Add changelog entry for a breaking change

* Improve entry

* Allow timestamp with timezone on mssql databases (#2724)

* Allow timestamp with timezone on mssql databases

* Change timestamp parameter to use object instead of boolean

* Update dependencies (#2772)

* Feature/2690: Multiple migration directories (#2735)

* Implement support for multiple migration directories

* Add tests for new functionality

* Fix tape tests

* Pass migration directory upwards

* Fix multiple directory support

* Fix bugs

* Rollback correctly

* Fix remaining tests

* Address comments

* #2758: Implement fail-fast logic for dialect resolution (#2776)

* Implement fail-fast logic for dialect resolution, clean-up code around.

* Remove method that was deprecated long time ago

* Address additional comments

* Try addressing comments

* Set client explicitly

* Fix compatibility with older Node versions

* Use columnize instead of wrap in using(). (#2713)

* Use columnize instead of wrap in using().

This is an attempt to fix #2136. Also added an integration test, couldn't find any existing.

* Exclude MSSQL from test as it does not support .using

* Change test to not use subquery

* Change test

* Introduced abstraction for getting migrations (#2775)

* Introduced abstraction for getting migrations

This would allow a webpack migration source which is compatible with bundling.

* Fixed migration validation with custom migration source

* Fixed issues after rebasing on muti directory PR

* Renamed parameter and fixed error message

* Addressed some PR comments

* Finished comment

* Moved filename extension filtering into fs-migrator

* Added test showing in memory custom migration source

* Cleaned up how to get config

* Fixed failing test

* Hopefully fix tests

* Fix Node.js 10 support in tests

* Test for correctly releasing cancel query connection
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment