Skip to content
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

feat(constructor): detect knex on construction #1756

Merged

Conversation

cdaringe
Copy link
Contributor

@cdaringe cdaringe commented Feb 6, 2018

Introduction

a bad knex arg is allowed on construction

Motivation

fail fast

Proposed solution

disallow a bad knex arg on construction

src/bookshelf.js Outdated
@@ -24,6 +24,9 @@ import Errors from './errors';
* @param {Knex} knex Knex instance.
*/
function Bookshelf(knex) {
if (!knex || !knex.__knex__) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This started throwing a warning when running tests:

Knex:warning - knex.__knex__ is deprecated, you can get the module versionby running require('knex/package').version

Can you look into it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep. sorry i missed that.

@ricardograca ricardograca added this to To Do in Version 0.13.0 via automation Feb 7, 2018
@ricardograca ricardograca moved this from To Do to In Progress in Version 0.13.0 Feb 7, 2018
BREAKING CHANGE: although uncommon and unlikely, invalid construction was permissible in the past.  now, we eagerly throw.  this has a low but feasible  chance of breaking some existing installs/usages.
@cdaringe cdaringe force-pushed the feat/detect-knex-on-construction branch from 9e3ab74 to 4906279 Compare February 7, 2018 22:30
@cdaringe
Copy link
Contributor Author

cdaringe commented Feb 7, 2018

knex returns one of many dialect objects, of which there is no common base class/proto. therefore, a direct type check on the passed knex obj isn't an option. however, all dialects use the same client, which is a robust and easy assertion.

@ricardograca ricardograca merged commit 0c7b726 into bookshelf:master Feb 8, 2018
Version 0.13.0 automation moved this from In Progress to Done Feb 8, 2018
@ricardograca
Copy link
Member

Many thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants