FeaturesHelper.js 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. const _ = require('lodash')
  2. const Settings = require('@overleaf/settings')
  3. /**
  4. * merges an array of feature sets to produce a final feature set
  5. */
  6. function computeFeatureSet(featureSets) {
  7. return featureSets.reduce(mergeFeatures, {})
  8. }
  9. /**
  10. * Merge feature sets coming from different sources
  11. */
  12. function mergeFeatures(featuresA, featuresB) {
  13. const features = Object.assign({}, featuresA)
  14. for (const key in featuresB) {
  15. // Special merging logic for non-boolean features
  16. if (key === 'compileGroup') {
  17. if (
  18. features.compileGroup === 'priority' ||
  19. featuresB.compileGroup === 'priority'
  20. ) {
  21. features.compileGroup = 'priority'
  22. } else {
  23. features.compileGroup = 'standard'
  24. }
  25. } else if (key === 'collaborators') {
  26. if (features.collaborators === -1 || featuresB.collaborators === -1) {
  27. features.collaborators = -1
  28. } else {
  29. features.collaborators = Math.max(
  30. features.collaborators || 0,
  31. featuresB.collaborators || 0
  32. )
  33. }
  34. } else if (key === 'compileTimeout') {
  35. features.compileTimeout = Math.max(
  36. features.compileTimeout || 0,
  37. featuresB.compileTimeout || 0
  38. )
  39. } else {
  40. // Boolean keys, true is better
  41. features[key] = features[key] || featuresB[key]
  42. }
  43. }
  44. if (features.mendeley && features.referencesSearch && features.zotero) {
  45. // Back fill legacy feature flag for isFeatureSetBetter to work properly
  46. // with professional feature overrides.
  47. features.references = true
  48. }
  49. return features
  50. }
  51. /**
  52. * Returns whether `featuresA` is a better feature set than `featuresB`
  53. */
  54. function isFeatureSetBetter(featuresA, featuresB) {
  55. const mergedFeatures = mergeFeatures(featuresA, featuresB)
  56. return _.isEqual(featuresA, mergedFeatures)
  57. }
  58. /**
  59. * Return what's missing from `currentFeatures` to equal `expectedFeatures`
  60. */
  61. function compareFeatures(currentFeatures, expectedFeatures) {
  62. currentFeatures = _.clone(currentFeatures)
  63. expectedFeatures = _.clone(expectedFeatures)
  64. if (_.isEqual(currentFeatures, expectedFeatures)) {
  65. return {}
  66. }
  67. const mismatchReasons = {}
  68. const featureKeys = [
  69. ...new Set([
  70. ...Object.keys(currentFeatures),
  71. ...Object.keys(expectedFeatures),
  72. ]),
  73. ]
  74. featureKeys.sort().forEach(key => {
  75. if (expectedFeatures[key] !== currentFeatures[key]) {
  76. mismatchReasons[key] = expectedFeatures[key]
  77. }
  78. })
  79. if (mismatchReasons.compileTimeout) {
  80. // store the compile timeout difference instead of the new compile timeout
  81. mismatchReasons.compileTimeout =
  82. expectedFeatures.compileTimeout - currentFeatures.compileTimeout
  83. }
  84. if (mismatchReasons.collaborators) {
  85. // store the collaborators difference instead of the new number only
  86. // replace -1 by 100 to make it clearer
  87. if (expectedFeatures.collaborators === -1) {
  88. expectedFeatures.collaborators = 100
  89. }
  90. if (currentFeatures.collaborators === -1) {
  91. currentFeatures.collaborators = 100
  92. }
  93. mismatchReasons.collaborators =
  94. expectedFeatures.collaborators - currentFeatures.collaborators
  95. }
  96. return mismatchReasons
  97. }
  98. function getMatchedFeatureSet(features) {
  99. for (const [name, featureSet] of Object.entries(Settings.features)) {
  100. if (_.isEqual(features, featureSet)) {
  101. return name
  102. }
  103. }
  104. return 'mixed'
  105. }
  106. module.exports = {
  107. mergeFeatures,
  108. computeFeatureSet,
  109. isFeatureSetBetter,
  110. compareFeatures,
  111. getMatchedFeatureSet,
  112. }