fix(pool): show deprecation when engine is not supported (#12218)

sequelize · May 4, 2020 · 6d116f8 · 6d116f8
1 parent bc4fe8a
commit 6d116f8
Show file tree

Hide file tree

Showing 14 changed files with 59 additions and 21 deletions.
diff --git a/ENGINE.md b/ENGINE.md
@@ -2,9 +2,9 @@
 
 ## v6-beta
 |  Engine |  Minimum supported version |
-| ------------ | :------------: |
+| :------------: | :------------: |
 |  Postgre | [9.5 ](https://www.postgresql.org/docs/9.5/ ) |
 |  MySQL |  [5.7](https://dev.mysql.com/doc/refman/5.7/en/) |
 |  MariaDB |  [10.1](https://mariadb.com/kb/en/changes-improvements-in-mariadb-101/) |
-|  Microsoft SQL |  ? |
+|  Microsoft SQL |  `12.0.2000` |
 |  SQLite |  [3.0](https://www.sqlite.org/version3.html) 
diff --git a/lib/data-types.js b/lib/data-types.js
@@ -9,7 +9,7 @@ const momentTz = require('moment-timezone');
 const moment = require('moment');
 const { logger } = require('./utils/logger');
 const warnings = {};
-const { classToInvokable } = require('./utils/classToInvokable');
+const { classToInvokable } = require('./utils/class-to-invokable');
 const { joinSQLFragments } = require('./utils/join-sql-fragments');
 
 class ABSTRACT {

diff --git a/lib/dialects/abstract/connection-manager.js b/lib/dialects/abstract/connection-manager.js
@@ -5,6 +5,7 @@ const _ = require('lodash');
 const semver = require('semver');
 const errors = require('../../errors');
 const { logger } = require('../../utils/logger');
+const deprecations = require('../../utils/deprecations');
 const debug = logger.debugContext('pool');
 
 /**
@@ -260,7 +261,12 @@ class ConnectionManager {
               const parsedVersion = _.get(semver.coerce(version), 'version') || version;
               this.sequelize.options.databaseVersion = semver.valid(parsedVersion)
                 ? parsedVersion
-                : this.defaultVersion;
+                : this.dialect.defaultVersion;
+            }
+
+            if (semver.lt(this.sequelize.options.databaseVersion, this.dialect.defaultVersion)) {
+              deprecations.unsupportedEngine();
+              debug(`Unsupported database engine version ${this.sequelize.options.databaseVersion}`);
             }
 
             this.versionPromise = null;

diff --git a/lib/dialects/mariadb/connection-manager.js b/lib/dialects/mariadb/connection-manager.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const semver = require('semver');
 const AbstractConnectionManager = require('../abstract/connection-manager');
 const SequelizeErrors = require('../../errors');
 const { logger } = require('../../utils/logger');
@@ -84,7 +85,8 @@ class ConnectionManager extends AbstractConnectionManager {
 
     try {
       const connection = await this.lib.createConnection(connectionConfig);
-      this.sequelize.options.databaseVersion = connection.serverVersion();
+      this.sequelize.options.databaseVersion = semver.coerce(connection.serverVersion()).version;
+
       debug('connection acquired');
       connection.on('error', error => {
         switch (error.code) {

diff --git a/lib/dialects/mariadb/index.js b/lib/dialects/mariadb/index.js
@@ -52,7 +52,7 @@ MariadbDialect.prototype.supports = _.merge(
     REGEXP: true
   });
 
-ConnectionManager.prototype.defaultVersion = '5.5.3';
+MariadbDialect.prototype.defaultVersion = '10.1.44';
 MariadbDialect.prototype.Query = Query;
 MariadbDialect.prototype.QueryGenerator = QueryGenerator;
 MariadbDialect.prototype.DataTypes = DataTypes;

diff --git a/lib/dialects/mssql/index.js b/lib/dialects/mssql/index.js
@@ -54,7 +54,7 @@ MssqlDialect.prototype.supports = _.merge(_.cloneDeep(AbstractDialect.prototype.
   tmpTableTrigger: true
 });
 
-ConnectionManager.prototype.defaultVersion = '12.0.2000'; // SQL Server 2014 Express
+MssqlDialect.prototype.defaultVersion = '12.0.2000'; // SQL Server 2014 Express
 MssqlDialect.prototype.Query = Query;
 MssqlDialect.prototype.name = 'mssql';
 MssqlDialect.prototype.TICK_CHAR = '"';

diff --git a/lib/dialects/mysql/index.js b/lib/dialects/mysql/index.js
@@ -50,7 +50,7 @@ MysqlDialect.prototype.supports = _.merge(_.cloneDeep(AbstractDialect.prototype.
   REGEXP: true
 });
 
-ConnectionManager.prototype.defaultVersion = '5.6.0';
+MysqlDialect.prototype.defaultVersion = '5.7.0';
 MysqlDialect.prototype.Query = Query;
 MysqlDialect.prototype.QueryGenerator = QueryGenerator;
 MysqlDialect.prototype.DataTypes = DataTypes;

diff --git a/lib/dialects/postgres/connection-manager.js b/lib/dialects/postgres/connection-manager.js
@@ -132,7 +132,7 @@ class ConnectionManager extends AbstractConnectionManager {
               const version = semver.coerce(message.parameterValue).version;
               this.sequelize.options.databaseVersion = semver.valid(version)
                 ? version
-                : this.defaultVersion;
+                : this.dialect.defaultVersion;
             }
             break;
           case 'standard_conforming_strings':

diff --git a/lib/dialects/postgres/index.js b/lib/dialects/postgres/index.js
@@ -61,7 +61,7 @@ PostgresDialect.prototype.supports = _.merge(_.cloneDeep(AbstractDialect.prototy
   searchPath: true
 });
 
-ConnectionManager.prototype.defaultVersion = '9.4.0';
+PostgresDialect.prototype.defaultVersion = '9.5.0';
 PostgresDialect.prototype.Query = Query;
 PostgresDialect.prototype.DataTypes = DataTypes;
 PostgresDialect.prototype.name = 'postgres';

diff --git a/lib/dialects/sqlite/index.js b/lib/dialects/sqlite/index.js
@@ -48,7 +48,7 @@ SqliteDialect.prototype.supports = _.merge(_.cloneDeep(AbstractDialect.prototype
   JSON: true
 });
 
-ConnectionManager.prototype.defaultVersion = '3.8.0';
+SqliteDialect.prototype.defaultVersion = '3.8.0';
 SqliteDialect.prototype.Query = Query;
 SqliteDialect.prototype.DataTypes = DataTypes;
 SqliteDialect.prototype.name = 'sqlite';

diff --git a/lib/utils.js b/lib/utils.js
@@ -10,7 +10,7 @@ const operatorsSet = new Set(Object.values(operators));
 
 let inflection = require('inflection');
 
-exports.classToInvokable = require('./utils/classToInvokable').classToInvokable;
+exports.classToInvokable = require('./utils/class-to-invokable').classToInvokable;
 exports.joinSQLFragments = require('./utils/join-sql-fragments').joinSQLFragments;
 
 function useInflection(_inflection) {

diff --git a/lib/utils/classToInvokable.js → lib/utils/class-to-invokable.js b/lib/utils/classToInvokable.js → lib/utils/class-to-invokable.js
diff --git a/lib/utils/deprecations.js b/lib/utils/deprecations.js
@@ -9,3 +9,4 @@ exports.noTrueLogging = deprecate(noop, 'The logging-option should be either a f
 exports.noStringOperators = deprecate(noop, 'String based operators are deprecated. Please use Symbol based operators for better security, read more at https://sequelize.org/master/manual/querying.html#operators', 'SEQUELIZE0003');
 exports.noBoolOperatorAliases = deprecate(noop, 'A boolean value was passed to options.operatorsAliases. This is a no-op with v5 and should be removed.', 'SEQUELIZE0004');
 exports.noDoubleNestedGroup = deprecate(noop, 'Passing a double nested nested array to `group` is unsupported and will be removed in v6.', 'SEQUELIZE0005');
+exports.unsupportedEngine = deprecate(noop, 'This database engine version is not supported, please update your database server. More information https://github.com/sequelize/sequelize/blob/master/ENGINE.md', 'SEQUELIZE0006');
diff --git a/test/integration/dialects/abstract/connection-manager.test.js b/test/integration/dialects/abstract/connection-manager.test.js
@@ -2,6 +2,7 @@
 
 const chai = require('chai'),
   expect = chai.expect,
+  deprecations = require('../../../../lib/utils/deprecations'),
   Support = require('../../support'),
   sinon = require('sinon'),
   Config = require('../../../config/config'),
@@ -15,7 +16,7 @@ const poolEntry = {
   pool: {}
 };
 
-describe('Connection Manager', () => {
+describe(Support.getTestDialectTeaser('Connection Manager'), () => {
   let sandbox;
 
   beforeEach(() => {
@@ -31,7 +32,7 @@ describe('Connection Manager', () => {
       replication: null
     };
     const sequelize = Support.createSequelizeInstance(options);
-    const connectionManager = new ConnectionManager(Support.getTestDialect(), sequelize);
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
 
     connectionManager.initPools();
     expect(connectionManager.pool).to.be.instanceOf(Pool);
@@ -47,7 +48,7 @@ describe('Connection Manager', () => {
       }
     };
     const sequelize = Support.createSequelizeInstance(options);
-    const connectionManager = new ConnectionManager(Support.getTestDialect(), sequelize);
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
 
     connectionManager.initPools();
     expect(connectionManager.pool.read).to.be.instanceOf(Pool);
@@ -71,15 +72,15 @@ describe('Connection Manager', () => {
       }
     };
     const sequelize = Support.createSequelizeInstance(options);
-    const connectionManager = new ConnectionManager(Support.getTestDialect(), sequelize);
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
 
     const res = {
       queryType: 'read'
     };
 
     const connectStub = sandbox.stub(connectionManager, '_connect').resolves(res);
     sandbox.stub(connectionManager, '_disconnect').resolves(res);
-    sandbox.stub(sequelize, 'databaseVersion').resolves(res);
+    sandbox.stub(sequelize, 'databaseVersion').resolves(sequelize.dialect.defaultVersion);
     connectionManager.initPools();
 
     const queryOptions = {
@@ -104,6 +105,34 @@ describe('Connection Manager', () => {
       });
   });
 
+  it('should trigger deprecation for non supported engine version', () => {
+    const deprecationStub = sandbox.stub(deprecations, 'unsupportedEngine');
+    const sequelize = Support.createSequelizeInstance();
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
+
+    sandbox.stub(sequelize, 'databaseVersion').resolves('0.0.1');
+
+    const res = {
+      queryType: 'read'
+    };
+
+    sandbox.stub(connectionManager, '_connect').resolves(res);
+    sandbox.stub(connectionManager, '_disconnect').resolves(res);
+    connectionManager.initPools();
+
+    const queryOptions = {
+      priority: 0,
+      type: 'SELECT',
+      useMaster: true
+    };
+
+    return connectionManager.getConnection(queryOptions)
+      .then(() => {
+        chai.expect(deprecationStub).to.have.been.calledOnce;
+      });
+  });
+
+
   it('should allow forced reads from the write pool', () => {
     const master = { ...poolEntry };
     master.host = 'the-boss';
@@ -115,14 +144,15 @@ describe('Connection Manager', () => {
       }
     };
     const sequelize = Support.createSequelizeInstance(options);
-    const connectionManager = new ConnectionManager(Support.getTestDialect(), sequelize);
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
 
     const res = {
       queryType: 'read'
     };
+
     const connectStub = sandbox.stub(connectionManager, '_connect').resolves(res);
     sandbox.stub(connectionManager, '_disconnect').resolves(res);
-    sandbox.stub(sequelize, 'databaseVersion').resolves(res);
+    sandbox.stub(sequelize, 'databaseVersion').resolves(sequelize.dialect.defaultVersion);
     connectionManager.initPools();
 
     const queryOptions = {
@@ -144,7 +174,7 @@ describe('Connection Manager', () => {
       replication: null
     };
     const sequelize = Support.createSequelizeInstance(options);
-    const connectionManager = new ConnectionManager(Support.getTestDialect(), sequelize);
+    const connectionManager = new ConnectionManager(sequelize.dialect, sequelize);
 
     connectionManager.initPools();
 
@@ -156,5 +186,4 @@ describe('Connection Manager', () => {
       expect(poolClearSpy.calledOnce).to.be.true;
     });
   });
-
 });