Merge pull request #23209 from overleaf/jdt-async-await-prj-entity-handler

Async/await the ProjectEntityHandler

GitOrigin-RevId: 873106c4ea56e13d864407b338a1924370ba6709
This commit is contained in:
Jimmy Domagala-Tang
2025-02-03 11:32:36 -05:00
committed by Copybot
parent e73b3b4c9f
commit 98b5bf2694
2 changed files with 343 additions and 422 deletions
@@ -2,260 +2,211 @@ const path = require('path')
const DocstoreManager = require('../Docstore/DocstoreManager')
const Errors = require('../Errors/Errors')
const ProjectGetter = require('./ProjectGetter')
const { promisifyAll } = require('@overleaf/promise-utils')
const { callbackifyAll } = require('@overleaf/promise-utils')
const OError = require('@overleaf/o-error')
const { iterablePaths } = require('./IterablePath')
const ProjectEntityHandler = {
getAllDocs(projectId, callback) {
// We get the path and name info from the project, and the lines and
// version info from the doc store.
DocstoreManager.getAllDocs(projectId, (error, docContentsArray) => {
if (error != null) {
return callback(error)
}
async function getAllDocs(projectId) {
// We get the path and name info from the project, and the lines and
// version info from the doc store.
const docContentsArray = await DocstoreManager.promises.getAllDocs(projectId)
// Turn array from docstore into a dictionary based on doc id
const docContents = {}
for (const docContent of docContentsArray) {
docContents[docContent._id] = docContent
}
// Turn array from docstore into a dictionary based on doc id
const docContents = {}
for (const docContent of docContentsArray) {
docContents[docContent._id] = docContent
}
ProjectEntityHandler._getAllFolders(projectId, (error, folders) => {
if (error != null) {
return callback(error)
}
const docs = {}
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
const content = docContents[doc._id.toString()]
if (content != null) {
try {
docs[path.join(folderPath, doc.name)] = {
_id: doc._id,
name: doc.name,
lines: content.lines,
rev: content.rev,
folder,
}
} catch (err) {
return callback(err)
}
}
}
}
callback(null, docs)
})
})
},
getAllFiles(projectId, callback) {
ProjectEntityHandler._getAllFolders(projectId, (err, folders) => {
if (err != null) {
return callback(err)
}
const files = {}
for (const { path: folderPath, folder } of folders) {
for (const file of iterablePaths(folder, 'fileRefs')) {
if (file != null) {
try {
files[path.join(folderPath, file.name)] = { ...file, folder }
} catch (err) {
return callback(err)
}
}
}
}
callback(null, files)
})
},
getAllEntities(projectId, callback) {
ProjectGetter.getProject(projectId, (err, project) => {
if (err != null) {
return callback(err)
}
if (project == null) {
return callback(new Errors.NotFoundError('project not found'))
}
try {
const entities = ProjectEntityHandler.getAllEntitiesFromProject(project)
callback(null, entities)
} catch (err) {
callback(err)
}
})
},
getAllEntitiesFromProject(project) {
const folders = ProjectEntityHandler._getAllFoldersFromProject(project)
const docs = []
const files = []
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
if (doc != null) {
docs.push({ path: path.join(folderPath, doc.name), doc })
}
}
for (const file of iterablePaths(folder, 'fileRefs')) {
if (file != null) {
files.push({ path: path.join(folderPath, file.name), file })
const folders = await _getAllFolders(projectId)
const docs = {}
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
const content = docContents[doc._id.toString()]
if (content != null) {
docs[path.join(folderPath, doc.name)] = {
_id: doc._id,
name: doc.name,
lines: content.lines,
rev: content.rev,
folder,
}
}
}
return { docs, files, folders }
},
}
getAllDocPathsFromProjectById(projectId, callback) {
ProjectGetter.getProjectWithoutDocLines(projectId, (err, project) => {
if (err != null) {
return callback(err)
}
if (project == null) {
return callback(Errors.NotFoundError('no project'))
}
try {
const docPaths = ProjectEntityHandler.getAllDocPathsFromProject(project)
callback(null, docPaths)
} catch (err) {
callback(err)
}
})
},
getAllDocPathsFromProject(project) {
const folders = ProjectEntityHandler._getAllFoldersFromProject(project)
const docPath = {}
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
docPath[doc._id] = path.join(folderPath, doc.name)
}
}
return docPath
},
getDoc(projectId, docId, options, callback) {
if (options == null) {
options = {}
}
if (typeof options === 'function') {
callback = options
options = {}
}
DocstoreManager.getDoc(projectId, docId, options, callback)
},
/**
* @param {ObjectId | string} projectId
* @param {ObjectId | string} docId
* @param {Function} callback
*/
getDocPathByProjectIdAndDocId(projectId, docId, callback) {
ProjectGetter.getProjectWithoutDocLines(projectId, (err, project) => {
if (err != null) {
return callback(err)
}
if (project == null) {
return callback(new Errors.NotFoundError('no project'))
}
ProjectEntityHandler.getDocPathFromProjectByDocId(
project,
docId,
(err, docPath) => {
if (err) return callback(Errors.OError.tag(err))
if (docPath == null) {
return callback(new Errors.NotFoundError('no doc'))
}
callback(null, docPath)
}
)
})
},
/**
* @param {Project} project
* @param {ObjectId | string} docId
* @param {Function} callback
*/
getDocPathFromProjectByDocId(project, docId, callback) {
function recursivelyFindDocInFolder(basePath, docId, folder) {
const docInCurrentFolder = (folder.docs || []).find(
currentDoc => currentDoc._id.toString() === docId.toString()
)
if (docInCurrentFolder != null) {
return path.join(basePath, docInCurrentFolder.name)
} else {
let docPath, childFolder
for (childFolder of iterablePaths(folder, 'folders')) {
docPath = recursivelyFindDocInFolder(
path.join(basePath, childFolder.name),
docId,
childFolder
)
if (docPath != null) {
return docPath
}
}
return null
}
}
try {
const docPath = recursivelyFindDocInFolder(
'/',
docId,
project.rootFolder[0]
)
callback(null, docPath)
} catch (err) {
callback(err)
}
},
_getAllFolders(projectId, callback) {
ProjectGetter.getProjectWithoutDocLines(projectId, (err, project) => {
if (err != null) {
return callback(err)
}
if (project == null) {
return callback(new Errors.NotFoundError('no project'))
}
try {
const folders = ProjectEntityHandler._getAllFoldersFromProject(project)
callback(null, folders)
} catch (err) {
callback(err)
}
})
},
_getAllFoldersFromProject(project) {
const folders = []
try {
const processFolder = (basePath, folder) => {
folders.push({ path: basePath, folder })
if (folder.folders) {
for (const childFolder of iterablePaths(folder, 'folders')) {
if (childFolder.name != null) {
const childPath = path.join(basePath, childFolder.name)
processFolder(childPath, childFolder)
}
}
}
}
processFolder('/', project.rootFolder[0])
return folders
} catch (err) {
throw OError.tag(err, 'Error getting folders', { projectId: project._id })
}
},
return docs
}
module.exports = ProjectEntityHandler
module.exports.promises = promisifyAll(ProjectEntityHandler, {
without: ['getAllEntitiesFromProject'],
multiResult: {
getDoc: ['lines', 'rev', 'version', 'ranges'],
},
})
async function getAllFiles(projectId) {
const folders = await _getAllFolders(projectId)
const files = {}
for (const { path: folderPath, folder } of folders) {
for (const file of iterablePaths(folder, 'fileRefs')) {
if (file != null) {
files[path.join(folderPath, file.name)] = { ...file, folder }
}
}
}
return files
}
async function getAllEntities(projectId) {
const project = await ProjectGetter.promises.getProject(projectId)
if (project == null) {
throw new Errors.NotFoundError('project not found')
}
const entities = getAllEntitiesFromProject(project)
return entities
}
function getAllEntitiesFromProject(project) {
const folders = _getAllFoldersFromProject(project)
const docs = []
const files = []
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
if (doc != null) {
docs.push({ path: path.join(folderPath, doc.name), doc })
}
}
for (const file of iterablePaths(folder, 'fileRefs')) {
if (file != null) {
files.push({ path: path.join(folderPath, file.name), file })
}
}
}
return { docs, files, folders }
}
async function getAllDocPathsFromProjectById(projectId) {
const project =
await ProjectGetter.promises.getProjectWithoutDocLines(projectId)
if (project == null) {
throw new Errors.NotFoundError('no project')
}
const docPaths = getAllDocPathsFromProject(project)
return docPaths
}
function getAllDocPathsFromProject(project) {
const folders = _getAllFoldersFromProject(project)
const docPath = {}
for (const { path: folderPath, folder } of folders) {
for (const doc of iterablePaths(folder, 'docs')) {
docPath[doc._id] = path.join(folderPath, doc.name)
}
}
return docPath
}
async function getDoc(projectId, docId) {
const { lines, rev, version, ranges } = await DocstoreManager.promises.getDoc(
projectId,
docId
)
return { lines, rev, version, ranges }
}
/**
* @param {ObjectId | string} projectId
* @param {ObjectId | string} docId
*/
async function getDocPathByProjectIdAndDocId(projectId, docId) {
const project =
await ProjectGetter.promises.getProjectWithoutDocLines(projectId)
if (project == null) {
throw new Errors.NotFoundError('no project')
}
const docPath = await getDocPathFromProjectByDocId(project, docId)
if (docPath == null) {
throw new Errors.NotFoundError('no doc')
}
return docPath
}
function _recursivelyFindDocInFolder(basePath, docId, folder) {
const docInCurrentFolder = (folder.docs || []).find(
currentDoc => currentDoc._id.toString() === docId.toString()
)
if (docInCurrentFolder != null) {
return path.join(basePath, docInCurrentFolder.name)
} else {
let docPath, childFolder
for (childFolder of iterablePaths(folder, 'folders')) {
docPath = _recursivelyFindDocInFolder(
path.join(basePath, childFolder.name),
docId,
childFolder
)
if (docPath != null) {
return docPath
}
}
return null
}
}
/**
* @param {Project} project
* @param {ObjectId | string} docId
* @param {Function} callback
*/
async function getDocPathFromProjectByDocId(project, docId) {
const docPath = _recursivelyFindDocInFolder('/', docId, project.rootFolder[0])
return docPath
}
async function _getAllFolders(projectId) {
const project =
await ProjectGetter.promises.getProjectWithoutDocLines(projectId)
if (project == null) {
throw new Errors.NotFoundError('no project')
}
const folders = _getAllFoldersFromProject(project)
return folders
}
function _getAllFoldersFromProject(project) {
const folders = []
try {
const processFolder = (basePath, folder) => {
folders.push({ path: basePath, folder })
if (folder.folders) {
for (const childFolder of iterablePaths(folder, 'folders')) {
if (childFolder.name != null) {
const childPath = path.join(basePath, childFolder.name)
processFolder(childPath, childFolder)
}
}
}
}
processFolder('/', project.rootFolder[0])
return folders
} catch (err) {
throw OError.tag(err, 'Error getting folders', { projectId: project._id })
}
}
const ProjectEntityHandler = {
getAllDocs,
getAllFiles,
getAllEntities,
getAllDocPathsFromProjectById,
getDoc,
getDocPathByProjectIdAndDocId,
getDocPathFromProjectByDocId,
_getAllFolders,
}
module.exports = {
...callbackifyAll(ProjectEntityHandler, {
multiResult: {
getDoc: ['lines', 'rev', 'version', 'ranges'],
},
}),
promises: ProjectEntityHandler,
getAllEntitiesFromProject,
getAllDocPathsFromProject,
_getAllFoldersFromProject,
}