promise.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. 'use strict';
  2. const SqlString = require('sql-escaper');
  3. const EventEmitter = require('events').EventEmitter;
  4. const parserCache = require('./lib/parsers/parser_cache.js');
  5. const PoolCluster = require('./lib/pool_cluster.js');
  6. const createConnection = require('./lib/create_connection.js');
  7. const createPool = require('./lib/create_pool.js');
  8. const createPoolCluster = require('./lib/create_pool_cluster.js');
  9. const PromiseConnection = require('./lib/promise/connection.js');
  10. const PromisePool = require('./lib/promise/pool.js');
  11. const makeDoneCb = require('./lib/promise/make_done_cb.js');
  12. const PromisePoolConnection = require('./lib/promise/pool_connection.js');
  13. const inheritEvents = require('./lib/promise/inherit_events.js');
  14. const PromisePoolNamespace = require('./lib/promise/pool_cluster');
  15. function createConnectionPromise(opts) {
  16. const coreConnection = createConnection(opts);
  17. const thePromise = opts.Promise || Promise;
  18. if (!thePromise) {
  19. throw new Error(
  20. 'no Promise implementation available.' +
  21. 'Use promise-enabled node version or pass userland Promise' +
  22. " implementation as parameter, for example: { Promise: require('bluebird') }"
  23. );
  24. }
  25. return new thePromise((resolve, reject) => {
  26. coreConnection.once('connect', () => {
  27. resolve(new PromiseConnection(coreConnection, thePromise));
  28. });
  29. coreConnection.once('error', (err) => {
  30. const createConnectionErr = new Error();
  31. createConnectionErr.message = err.message;
  32. createConnectionErr.code = err.code;
  33. createConnectionErr.errno = err.errno;
  34. createConnectionErr.sqlState = err.sqlState;
  35. reject(createConnectionErr);
  36. });
  37. });
  38. }
  39. // note: the callback of "changeUser" is not called on success
  40. // hence there is no possibility to call "resolve"
  41. function createPromisePool(opts) {
  42. const corePool = createPool(opts);
  43. const thePromise = opts.Promise || Promise;
  44. if (!thePromise) {
  45. throw new Error(
  46. 'no Promise implementation available.' +
  47. 'Use promise-enabled node version or pass userland Promise' +
  48. " implementation as parameter, for example: { Promise: require('bluebird') }"
  49. );
  50. }
  51. return new PromisePool(corePool, thePromise);
  52. }
  53. class PromisePoolCluster extends EventEmitter {
  54. constructor(poolCluster, thePromise) {
  55. super();
  56. this.poolCluster = poolCluster;
  57. this.Promise = thePromise || Promise;
  58. inheritEvents(poolCluster, this, ['warn', 'remove', 'online', 'offline']);
  59. }
  60. getConnection(pattern, selector) {
  61. const corePoolCluster = this.poolCluster;
  62. return new this.Promise((resolve, reject) => {
  63. corePoolCluster.getConnection(
  64. pattern,
  65. selector,
  66. (err, coreConnection) => {
  67. if (err) {
  68. reject(err);
  69. } else {
  70. resolve(new PromisePoolConnection(coreConnection, this.Promise));
  71. }
  72. }
  73. );
  74. });
  75. }
  76. query(sql, args) {
  77. const corePoolCluster = this.poolCluster;
  78. if (typeof args === 'function') {
  79. throw new Error(
  80. 'Callback function is not available with promise clients.'
  81. );
  82. }
  83. return new this.Promise((resolve, reject) => {
  84. const done = makeDoneCb(resolve, reject);
  85. corePoolCluster.query(sql, args, done);
  86. });
  87. }
  88. execute(sql, args) {
  89. const corePoolCluster = this.poolCluster;
  90. if (typeof args === 'function') {
  91. throw new Error(
  92. 'Callback function is not available with promise clients.'
  93. );
  94. }
  95. return new this.Promise((resolve, reject) => {
  96. const done = makeDoneCb(resolve, reject);
  97. corePoolCluster.execute(sql, args, done);
  98. });
  99. }
  100. of(pattern, selector) {
  101. return new PromisePoolNamespace(
  102. this.poolCluster.of(pattern, selector),
  103. this.Promise
  104. );
  105. }
  106. end() {
  107. const corePoolCluster = this.poolCluster;
  108. return new this.Promise((resolve, reject) => {
  109. corePoolCluster.end((err) => {
  110. if (err) {
  111. const localErr = new Error();
  112. localErr.message = err.message;
  113. localErr.code = err.code;
  114. localErr.errno = err.errno;
  115. localErr.sqlState = err.sqlState;
  116. localErr.sqlMessage = err.sqlMessage;
  117. reject(localErr);
  118. } else {
  119. resolve();
  120. }
  121. });
  122. });
  123. }
  124. async [Symbol.asyncDispose]() {
  125. if (!this.poolCluster._closed) {
  126. await this.end();
  127. }
  128. }
  129. }
  130. /**
  131. * proxy poolCluster synchronous functions
  132. */
  133. (function (functionsToWrap) {
  134. for (let i = 0; functionsToWrap && i < functionsToWrap.length; i++) {
  135. const func = functionsToWrap[i];
  136. if (
  137. typeof PoolCluster.prototype[func] === 'function' &&
  138. PromisePoolCluster.prototype[func] === undefined
  139. ) {
  140. PromisePoolCluster.prototype[func] = (function factory(funcName) {
  141. return function () {
  142. return PoolCluster.prototype[funcName].apply(
  143. this.poolCluster,
  144. arguments
  145. );
  146. };
  147. })(func);
  148. }
  149. }
  150. })(['add', 'remove']);
  151. function createPromisePoolCluster(opts) {
  152. const corePoolCluster = createPoolCluster(opts);
  153. const thePromise = (opts && opts.Promise) || Promise;
  154. if (!thePromise) {
  155. throw new Error(
  156. 'no Promise implementation available.' +
  157. 'Use promise-enabled node version or pass userland Promise' +
  158. " implementation as parameter, for example: { Promise: require('bluebird') }"
  159. );
  160. }
  161. return new PromisePoolCluster(corePoolCluster, thePromise);
  162. }
  163. exports.createConnection = createConnectionPromise;
  164. exports.createPool = createPromisePool;
  165. exports.createPoolCluster = createPromisePoolCluster;
  166. exports.escape = SqlString.escape;
  167. exports.escapeId = SqlString.escapeId;
  168. exports.format = SqlString.format;
  169. exports.raw = SqlString.raw;
  170. exports.Connection = PromiseConnection;
  171. exports.PoolConnection = PromisePoolConnection;
  172. exports.PromisePool = PromisePool;
  173. exports.PromiseConnection = PromiseConnection;
  174. exports.PromisePoolConnection = PromisePoolConnection;
  175. exports.__defineGetter__('Types', () => require('./lib/constants/types.js'));
  176. exports.__defineGetter__('Charsets', () =>
  177. require('./lib/constants/charsets.js')
  178. );
  179. exports.__defineGetter__('CharsetToEncoding', () =>
  180. require('./lib/constants/charset_encodings.js')
  181. );
  182. exports.setMaxParserCache = function (max) {
  183. parserCache.setMaxCache(max);
  184. };
  185. exports.clearParserCache = function () {
  186. parserCache.clearCache();
  187. };