ReferencesHandler.js 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. /* eslint-disable
  2. n/handle-callback-err,
  3. max-len,
  4. no-unused-vars,
  5. */
  6. // TODO: This file was created by bulk-decaffeinate.
  7. // Fix any style issues and re-enable lint.
  8. /*
  9. * decaffeinate suggestions:
  10. * DS102: Remove unnecessary code created because of implicit returns
  11. * DS103: Rewrite code to no longer use __guard__
  12. * DS207: Consider shorter variations of null checks
  13. * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
  14. */
  15. let ReferencesHandler
  16. const OError = require('@overleaf/o-error')
  17. const logger = require('@overleaf/logger')
  18. const request = require('request')
  19. const settings = require('@overleaf/settings')
  20. const Features = require('../../infrastructure/Features')
  21. const ProjectGetter = require('../Project/ProjectGetter')
  22. const UserGetter = require('../User/UserGetter')
  23. const DocumentUpdaterHandler = require('../DocumentUpdater/DocumentUpdaterHandler')
  24. const _ = require('lodash')
  25. const Async = require('async')
  26. const Errors = require('../Errors/Errors')
  27. if (!Features.hasFeature('references')) {
  28. logger.debug('references search not enabled')
  29. }
  30. module.exports = ReferencesHandler = {
  31. _buildDocUrl(projectId, docId) {
  32. return `${settings.apis.docstore.url}/project/${projectId}/doc/${docId}/raw`
  33. },
  34. _buildFileUrl(projectId, fileId) {
  35. return `${settings.apis.filestore.url}/project/${projectId}/file/${fileId}`
  36. },
  37. _findBibFileIds(project) {
  38. const ids = []
  39. function _process(folder) {
  40. _.forEach(folder.fileRefs || [], function (file) {
  41. if (
  42. __guard__(file != null ? file.name : undefined, x1 =>
  43. x1.match(/^.*\.bib$/)
  44. )
  45. ) {
  46. return ids.push(file._id)
  47. }
  48. })
  49. return _.forEach(folder.folders || [], folder => _process(folder))
  50. }
  51. _.forEach(project.rootFolder || [], rootFolder => _process(rootFolder))
  52. return ids
  53. },
  54. _findBibDocIds(project) {
  55. const ids = []
  56. function _process(folder) {
  57. _.forEach(folder.docs || [], function (doc) {
  58. if (
  59. __guard__(doc != null ? doc.name : undefined, x1 =>
  60. x1.match(/^.*\.bib$/)
  61. )
  62. ) {
  63. return ids.push(doc._id)
  64. }
  65. })
  66. return _.forEach(folder.folders || [], folder => _process(folder))
  67. }
  68. _.forEach(project.rootFolder || [], rootFolder => _process(rootFolder))
  69. return ids
  70. },
  71. _isFullIndex(project, callback) {
  72. if (callback == null) {
  73. callback = function () {}
  74. }
  75. return UserGetter.getUser(
  76. project.owner_ref,
  77. { features: true },
  78. function (err, owner) {
  79. if (err != null) {
  80. return callback(err)
  81. }
  82. const features = owner != null ? owner.features : undefined
  83. return callback(
  84. null,
  85. (features != null ? features.references : undefined) === true ||
  86. (features != null ? features.referencesSearch : undefined) === true
  87. )
  88. }
  89. )
  90. },
  91. indexAll(projectId, callback) {
  92. if (callback == null) {
  93. callback = function () {}
  94. }
  95. return ProjectGetter.getProject(
  96. projectId,
  97. { rootFolder: true, owner_ref: 1 },
  98. function (err, project) {
  99. if (err) {
  100. OError.tag(err, 'error finding project', {
  101. projectId,
  102. })
  103. return callback(err)
  104. }
  105. if (!project) {
  106. return callback(
  107. new Errors.NotFoundError(`project does not exist: ${projectId}`)
  108. )
  109. }
  110. logger.debug({ projectId }, 'indexing all bib files in project')
  111. const docIds = ReferencesHandler._findBibDocIds(project)
  112. const fileIds = ReferencesHandler._findBibFileIds(project)
  113. return ReferencesHandler._doIndexOperation(
  114. projectId,
  115. project,
  116. docIds,
  117. fileIds,
  118. callback
  119. )
  120. }
  121. )
  122. },
  123. _doIndexOperation(projectId, project, docIds, fileIds, callback) {
  124. if (!Features.hasFeature('references')) {
  125. return callback()
  126. }
  127. return ReferencesHandler._isFullIndex(project, function (err, isFullIndex) {
  128. if (err) {
  129. OError.tag(err, 'error checking whether to do full index', {
  130. projectId,
  131. })
  132. return callback(err)
  133. }
  134. logger.debug(
  135. { projectId, docIds },
  136. 'flushing docs to mongo before calling references service'
  137. )
  138. return Async.series(
  139. docIds.map(
  140. docId => cb =>
  141. DocumentUpdaterHandler.flushDocToMongo(projectId, docId, cb)
  142. ),
  143. function (err) {
  144. // continue
  145. if (err) {
  146. OError.tag(err, 'error flushing docs to mongo', {
  147. projectId,
  148. docIds,
  149. })
  150. return callback(err)
  151. }
  152. const bibDocUrls = docIds.map(docId =>
  153. ReferencesHandler._buildDocUrl(projectId, docId)
  154. )
  155. const bibFileUrls = fileIds.map(fileId =>
  156. ReferencesHandler._buildFileUrl(projectId, fileId)
  157. )
  158. const allUrls = bibDocUrls.concat(bibFileUrls)
  159. return request.post(
  160. {
  161. url: `${settings.apis.references.url}/project/${projectId}/index`,
  162. json: {
  163. docUrls: allUrls,
  164. fullIndex: isFullIndex,
  165. },
  166. },
  167. function (err, res, data) {
  168. if (err) {
  169. OError.tag(err, 'error communicating with references api', {
  170. projectId,
  171. })
  172. return callback(err)
  173. }
  174. if (res.statusCode >= 200 && res.statusCode < 300) {
  175. logger.debug({ projectId }, 'got keys from references api')
  176. return callback(null, data)
  177. } else {
  178. err = new Error(
  179. `references api responded with non-success code: ${res.statusCode}`
  180. )
  181. return callback(err)
  182. }
  183. }
  184. )
  185. }
  186. )
  187. })
  188. },
  189. }
  190. function __guard__(value, transform) {
  191. return typeof value !== 'undefined' && value !== null
  192. ? transform(value)
  193. : undefined
  194. }