overleaf/services/spelling/app/js/SpellingAPIManager.js
Jakob Ackermann 033af5091f [SpellingAPIManager] get the list of ignored misspellings from settings
The settings will allow overrides via the environment variable
 `IGNORED_MISSPELLINGS`.
2020-10-08 09:36:47 +01:00

91 lines
2.6 KiB
JavaScript

// TODO: This file was created by bulk-decaffeinate.
// Sanity-check the conversion and remove this comment.
/*
* decaffeinate suggestions:
* DS102: Remove unnecessary code created because of implicit returns
* DS207: Consider shorter variations of null checks
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
const ASpell = require('./ASpell')
const LearnedWordsManager = require('./LearnedWordsManager')
const { callbackify } = require('util')
const OError = require('@overleaf/o-error')
const Settings = require('settings-sharelatex')
// The max number of words checked in a single request
const REQUEST_LIMIT = 10000
const SpellingAPIManager = {
whitelist: Settings.ignoredMisspellings,
learnWord(token, request, callback) {
if (callback == null) {
callback = () => {}
}
if (request.word == null) {
return callback(new OError('malformed JSON'))
}
if (token == null) {
return callback(new OError('no token provided'))
}
return LearnedWordsManager.learnWord(token, request.word, callback)
},
unlearnWord(token, request, callback) {
if (callback == null) {
callback = () => {}
}
if (request.word == null) {
return callback(new OError('malformed JSON'))
}
if (token == null) {
return callback(new OError('no token provided'))
}
return LearnedWordsManager.unlearnWord(token, request.word, callback)
},
deleteDic(token, callback) {
return LearnedWordsManager.deleteUsersLearnedWords(token, callback)
},
getDic(token, callback) {
return LearnedWordsManager.getLearnedWords(token, callback)
}
}
const promises = {
async runRequest(token, request) {
if (!request.words) {
throw new OError('malformed JSON')
}
const lang = request.language || 'en'
// only the first 10K words are checked
const wordSlice = request.words.slice(0, REQUEST_LIMIT)
const misspellings = await ASpell.promises.checkWords(lang, wordSlice)
if (token) {
const learnedWords = await LearnedWordsManager.promises.getLearnedWords(
token
)
const notLearntMisspellings = misspellings.filter((m) => {
const word = wordSlice[m.index]
return (
learnedWords.indexOf(word) === -1 &&
SpellingAPIManager.whitelist.indexOf(word) === -1
)
})
return { misspellings: notLearntMisspellings }
} else {
return { misspellings }
}
}
}
SpellingAPIManager.runRequest = callbackify(promises.runRequest)
SpellingAPIManager.promises = promises
module.exports = SpellingAPIManager