query-interface.js 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. 'use strict';
  2. const DataTypes = require('../../data-types');
  3. const Promise = require('../../promise');
  4. const QueryTypes = require('../../query-types');
  5. const _ = require('lodash');
  6. /**
  7. Returns an object that handles Postgres special needs to do certain queries.
  8. @class QueryInterface
  9. @static
  10. @private
  11. */
  12. /**
  13. * Ensure enum and their values.
  14. *
  15. * @param {QueryInterface} qi
  16. * @param {string} tableName Name of table to create
  17. * @param {Object} attributes Object representing a list of normalized table attributes
  18. * @param {Object} [options]
  19. * @param {Model} [model]
  20. *
  21. * @returns {Promise}
  22. * @private
  23. */
  24. function ensureEnums(qi, tableName, attributes, options, model) {
  25. const keys = Object.keys(attributes);
  26. const keyLen = keys.length;
  27. let sql = '';
  28. let promises = [];
  29. let i = 0;
  30. for (i = 0; i < keyLen; i++) {
  31. const attribute = attributes[keys[i]];
  32. const type = attribute.type;
  33. if (
  34. type instanceof DataTypes.ENUM ||
  35. type instanceof DataTypes.ARRAY && type.type instanceof DataTypes.ENUM //ARRAY sub type is ENUM
  36. ) {
  37. sql = qi.QueryGenerator.pgListEnums(tableName, attribute.field || keys[i], options);
  38. promises.push(qi.sequelize.query(
  39. sql,
  40. Object.assign({}, options, { plain: true, raw: true, type: QueryTypes.SELECT })
  41. ));
  42. }
  43. }
  44. return Promise.all(promises).then(results => {
  45. promises = [];
  46. let enumIdx = 0;
  47. // This little function allows us to re-use the same code that prepends or appends new value to enum array
  48. const addEnumValue = (field, value, relativeValue, position = 'before', spliceStart = promises.length) => {
  49. const valueOptions = _.clone(options);
  50. valueOptions.before = null;
  51. valueOptions.after = null;
  52. switch (position) {
  53. case 'after':
  54. valueOptions.after = relativeValue;
  55. break;
  56. case 'before':
  57. default:
  58. valueOptions.before = relativeValue;
  59. break;
  60. }
  61. promises.splice(spliceStart, 0, () => {
  62. return qi.sequelize.query(qi.QueryGenerator.pgEnumAdd(
  63. tableName, field, value, valueOptions
  64. ), valueOptions);
  65. });
  66. };
  67. for (i = 0; i < keyLen; i++) {
  68. const attribute = attributes[keys[i]];
  69. const type = attribute.type;
  70. const enumType = type.type || type;
  71. const field = attribute.field || keys[i];
  72. if (
  73. type instanceof DataTypes.ENUM ||
  74. type instanceof DataTypes.ARRAY && enumType instanceof DataTypes.ENUM //ARRAY sub type is ENUM
  75. ) {
  76. // If the enum type doesn't exist then create it
  77. if (!results[enumIdx]) {
  78. promises.push(() => {
  79. return qi.sequelize.query(qi.QueryGenerator.pgEnum(tableName, field, enumType, options), Object.assign({}, options, { raw: true }));
  80. });
  81. } else if (!!results[enumIdx] && !!model) {
  82. const enumVals = qi.QueryGenerator.fromArray(results[enumIdx].enum_value);
  83. const vals = enumType.values;
  84. // Going through already existing values allows us to make queries that depend on those values
  85. // We will prepend all new values between the old ones, but keep in mind - we can't change order of already existing values
  86. // Then we append the rest of new values AFTER the latest already existing value
  87. // E.g.: [1,2] -> [0,2,1] ==> [1,0,2]
  88. // E.g.: [1,2,3] -> [2,1,3,4] ==> [1,2,3,4]
  89. // E.g.: [1] -> [0,2,3] ==> [1,0,2,3]
  90. let lastOldEnumValue;
  91. let rightestPosition = -1;
  92. for (let oldIndex = 0; oldIndex < enumVals.length; oldIndex++) {
  93. const enumVal = enumVals[oldIndex];
  94. const newIdx = vals.indexOf(enumVal);
  95. lastOldEnumValue = enumVal;
  96. if (newIdx === -1) {
  97. continue;
  98. }
  99. const newValuesBefore = vals.slice(0, newIdx);
  100. const promisesLength = promises.length;
  101. // we go in reverse order so we could stop when we meet old value
  102. for (let reverseIdx = newValuesBefore.length - 1; reverseIdx >= 0; reverseIdx--) {
  103. if (~enumVals.indexOf(newValuesBefore[reverseIdx])) {
  104. break;
  105. }
  106. addEnumValue(field, newValuesBefore[reverseIdx], lastOldEnumValue, 'before', promisesLength);
  107. }
  108. // we detect the most 'right' position of old value in new enum array so we can append new values to it
  109. if (newIdx > rightestPosition) {
  110. rightestPosition = newIdx;
  111. }
  112. }
  113. if (lastOldEnumValue && rightestPosition < vals.length - 1) {
  114. const remainingEnumValues = vals.slice(rightestPosition + 1);
  115. for (let reverseIdx = remainingEnumValues.length - 1; reverseIdx >= 0; reverseIdx--) {
  116. addEnumValue(field, remainingEnumValues[reverseIdx], lastOldEnumValue, 'after');
  117. }
  118. }
  119. enumIdx++;
  120. }
  121. }
  122. }
  123. return promises
  124. .reduce((promise, asyncFunction) => promise.then(asyncFunction), Promise.resolve())
  125. .tap(() => {
  126. // If ENUM processed, then refresh OIDs
  127. if (promises.length) {
  128. return qi.sequelize.dialect.connectionManager._refreshDynamicOIDs();
  129. }
  130. });
  131. });
  132. }
  133. exports.ensureEnums = ensureEnums;