fix(types): allow specifying additional options for db.query and add missing retry (#10512)

types/lib/model.d.ts

@@ -1688,7 +1688,7 @@ export abstract class Model<T = any, T2 = any> extends Hooks {
    *   where: ...,
    *   limit: 12,
    *   offset: 12
-   * }).then(function (result) {
+   * }).then(result => {
    *   ...
    * })
    * ```
@@ -1776,7 +1776,7 @@ export abstract class Model<T = any, T2 = any> extends Hooks {
 
   /**
    * Find a row that matches the query, or build (but don't save) the row if none is found.
-   * The successfull result of the promise will be (instance, initialized) - Make sure to use .spread()
+   * The successfull result of the promise will be (instance, initialized) - Make sure to use `.then(([...]))`
    */
   public static findOrBuild<M extends Model>(
     this: { new (): M } & typeof Model,
@@ -1785,7 +1785,7 @@ export abstract class Model<T = any, T2 = any> extends Hooks {
 
   /**
    * Find a row that matches the query, or build and save the row if none is found
-   * The successful result of the promise will be (instance, created) - Make sure to use .spread()
+   * The successful result of the promise will be (instance, created) - Make sure to use `.then(([...]))`
    *
    * If no transaction is passed in the `options` object, a new transaction will be created internally, to
    * prevent the race condition where a matching row is created by another connection after the find but
@@ -2291,7 +2291,7 @@ export abstract class Model<T = any, T2 = any> extends Hooks {
    * Similarily, when fetching through a join table with custom attributes, these attributes will be
    * available as an object with the name of the through model.
    * ```js
-   * user.getProjects().then(function (projects) {
+   * user.getProjects().then(projects => {
    *   var p1 = projects[0]
    *   p1.userprojects.started // Is this project started yet?
    * })
@@ -2340,8 +2340,8 @@ export abstract class Model<T = any, T2 = any> extends Hooks {
    * Similarily, when fetching through a join table with custom attributes, these attributes will be
    * available as an object with the name of the through model.
    * ```js
-   * user.getProjects().then(function (projects) {
-   *   var p1 = projects[0]
+   * user.getProjects().then(projects => {
+   *   const p1 = projects[0]
    *   p1.userprojects.started // Is this project started yet?
    * })
    * ```

types/lib/query-interface.d.ts

@@ -2,7 +2,7 @@ import { DataType } from './data-types';
 import { Logging, Model, ModelAttributeColumnOptions, ModelAttributes, Transactionable, WhereOptions, Filterable } from './model';
 import { Promise } from './promise';
 import QueryTypes = require('./query-types');
-import { Sequelize } from './sequelize';
+import { Sequelize, RetryOptions } from './sequelize';
 import { Transaction } from './transaction';
 
 /**
@@ -55,13 +55,15 @@ export interface QueryOptions extends Logging, Transactionable {
    * A sequelize instance used to build the return instance
    */
   instance?: Model;
+
+  retry?: RetryOptions;
 }
 
 export interface QueryOptionsWithWhere extends QueryOptions, Filterable {
 
 }
 
-export interface QueryOptionsWithModel {
+export interface QueryOptionsWithModel extends QueryOptions {
   /**
    * A sequelize model used to build the returned model instances (used to be called callee)
    */

types/lib/sequelize.d.ts

@@ -143,6 +143,11 @@ export interface Config {
 
 export type Dialect =  'mysql' | 'postgres' | 'sqlite' | 'mariadb' | 'mssql' | 'mariadb';
 
+export interface RetryOptions {
+  match?: (RegExp | string | Function)[];
+  max?: number;
+}
+
 /**
  * Options for the constructor of Sequelize main class
  */
@@ -307,7 +312,9 @@ export interface Options extends Logging {
   /**
    * Sets global permanent hooks.
    */
-  hooks?: Partial<SequelizeHooks>
+  hooks?: Partial<SequelizeHooks>;
+
+  retry?: RetryOptions;
 }
 
 export interface QueryOptionsTransactionRequired {}
@@ -1034,17 +1041,17 @@ export class Sequelize extends Hooks {
    * Execute a query on the DB, with the posibility to bypass all the sequelize goodness.
    *
    * By default, the function will return two arguments: an array of results, and a metadata object,
-   * containing number of affected rows etc. Use `.spread` to access the results.
+   * containing number of affected rows etc. Use `.then(([...]))` to access the results.
    *
    * If you are running a type of query where you don't need the metadata, for example a `SELECT` query, you
    * can pass in a query type to make sequelize format the results:
    *
    * ```js
-   * sequelize.query('SELECT...').spread(function (results, metadata) {
+   * sequelize.query('SELECT...').then(([results, metadata]) {
    *   // Raw query - use spread
    * });
    *
-   * sequelize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(function (results) {
+   * sequelize.query('SELECT...', { type: sequelize.QueryTypes.SELECT }).then(results => {
    *   // SELECT query - use then
    * })
    * ```
@@ -1175,8 +1182,8 @@ export class Sequelize extends Hooks {
    * in order for the query to happen under that transaction
    *
    * ```js
-   * sequelize.transaction().then(function (t) {
-   *   return User.findOne(..., { transaction: t}).then(function (user) {
+   * sequelize.transaction().then(t => {
+   *   return User.findOne(..., { transaction: t}).then(user => {
    *   return user.update(..., { transaction: t});
    *   })
    *   .then(t.commit.bind(t))
@@ -1188,13 +1195,13 @@ export class Sequelize extends Hooks {
    * supported:
    *
    * ```js
-   * sequelize.transaction(function (t) { // Note that we use a callback rather than a promise.then()
-   *   return User.findOne(..., { transaction: t}).then(function (user) {
+   * sequelize.transaction(t => { // Note that we use a callback rather than a promise.then()
+   *   return User.findOne(..., { transaction: t}).then(user => {
    *    return user.update(..., { transaction: t});
    *   });
-   * }).then(function () {
+   * }).then(() => {
    *   // Commited
-   * }).catch(function (err) {
+   * }).catch(err => {
    *   // Rolled back
    *   console.error(err);
    * });

types/test/connection.ts

 import { QueryTypes, Sequelize, SyncOptions } from 'sequelize';
+import { User } from 'models/User';
 
 export const sequelize = new Sequelize('uri');
 
@@ -23,3 +24,15 @@ sequelize
 .then(([aiId, affected]) => {
   console.log(aiId, affected);
 });
+
+sequelize.transaction<void>(async transaction => {
+  const rows = await sequelize
+    .query('SELECT * FROM `user`', {
+      retry: {
+        max: 123,
+      },
+      model: User,
+      transaction,
+      logging: true,
+    })
+})

types/test/sequelize.ts

@@ -5,6 +5,10 @@ export const sequelize = new Sequelize({
     afterConnect: (connection, config: Config) => {
       // noop
     }
+  },
+  retry: {
+    max: 123,
+    match: ['hurr'],
   }
 });