| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907 |
- // @ts-check
- import Crypto from 'node:crypto'
- import Events from 'node:events'
- import fs from 'node:fs'
- import Path from 'node:path'
- import { performance } from 'node:perf_hooks'
- import Stream from 'node:stream'
- import zLib from 'node:zlib'
- import { setTimeout } from 'node:timers/promises'
- import { Binary, ObjectId } from 'mongodb'
- import logger from '@overleaf/logger'
- import {
- batchedUpdate,
- READ_PREFERENCE_SECONDARY,
- } from '@overleaf/mongo-utils/batchedUpdate.js'
- import OError from '@overleaf/o-error'
- import {
- AlreadyWrittenError,
- NoKEKMatchedError,
- NotFoundError,
- } from '@overleaf/object-persistor/src/Errors.js'
- import { promiseMapWithLimit } from '@overleaf/promise-utils'
- import { backupPersistor, projectBlobsBucket } from '../lib/backupPersistor.mjs'
- import {
- BlobStore,
- GLOBAL_BLOBS,
- loadGlobalBlobs,
- makeProjectKey,
- } from '../lib/blob_store/index.js'
- import { backedUpBlobs, db } from '../lib/mongodb.js'
- import filestorePersistor from '../lib/persistor.js'
- // Silence warning.
- Events.setMaxListeners(20)
- // Enable caching for ObjectId.toString()
- ObjectId.cacheHexString = true
- /**
- * @typedef {import("overleaf-editor-core").Blob} Blob
- * @typedef {import("perf_hooks").EventLoopUtilization} EventLoopUtilization
- * @typedef {import("mongodb").Collection} Collection
- * @typedef {import("@overleaf/object-persistor/src/PerProjectEncryptedS3Persistor").CachedPerProjectEncryptedS3Persistor} CachedPerProjectEncryptedS3Persistor
- */
- /**
- * @typedef {Object} FileRef
- * @property {ObjectId} _id
- * @property {string} hash
- */
- /**
- * @typedef {Object} Folder
- * @property {Array<Folder>} folders
- * @property {Array<FileRef>} fileRefs
- */
- /**
- * @typedef {Object} DeletedFileRef
- * @property {ObjectId} _id
- * @property {ObjectId} projectId
- * @property {string} hash
- */
- /**
- * @typedef {Object} Project
- * @property {ObjectId} _id
- * @property {Array<Folder>} rootFolder
- * @property {Array<string>} deletedFileIds
- * @property {{history: {id: string}}} overleaf
- */
- /**
- * @typedef {Object} QueueEntry
- * @property {ProjectContext} ctx
- * @property {string} fileId
- * @property {string} path
- * @property {string} [hash]
- */
- // Time of closing the ticket for adding hashes: https://github.com/overleaf/internal/issues/464#issuecomment-492668129
- const ALL_PROJECTS_HAVE_FILE_HASHES_AFTER = new Date('2019-05-15T14:02:00Z')
- const PUBLIC_LAUNCH_DATE = new Date('2012-01-01T00:00:00Z')
- const BATCH_RANGE_START =
- process.env.BATCH_RANGE_START ||
- ObjectId.createFromTime(PUBLIC_LAUNCH_DATE.getTime() / 1000).toString()
- const BATCH_RANGE_END =
- process.env.BATCH_RANGE_END ||
- ObjectId.createFromTime(
- ALL_PROJECTS_HAVE_FILE_HASHES_AFTER.getTime() / 1000
- ).toString()
- // We need to control the start and end as ids of deleted projects are created at time of deletion.
- delete process.env.BATCH_RANGE_START
- delete process.env.BATCH_RANGE_END
- // Concurrency for downloading from GCS and updating hashes in mongo
- const CONCURRENCY = parseInt(process.env.CONCURRENCY || '100', 10)
- // Retries for processing a given file
- const RETRIES = parseInt(process.env.RETRIES || '10', 10)
- const RETRY_DELAY_MS = parseInt(process.env.RETRY_DELAY_MS || '100', 10)
- const USER_FILES_BUCKET_NAME = process.env.USER_FILES_BUCKET_NAME || ''
- if (!USER_FILES_BUCKET_NAME) {
- throw new Error('env var USER_FILES_BUCKET_NAME is missing')
- }
- const RETRY_FILESTORE_404 = process.env.RETRY_FILESTORE_404 === 'true'
- const BUFFER_DIR = fs.mkdtempSync(
- process.env.BUFFER_DIR_PREFIX || '/tmp/back_fill_file_hash-'
- )
- // https://nodejs.org/api/stream.html#streamgetdefaulthighwatermarkobjectmode
- const STREAM_HIGH_WATER_MARK = parseInt(
- process.env.STREAM_HIGH_WATER_MARK || (64 * 1024).toString(),
- 10
- )
- const LOGGING_INTERVAL = parseInt(process.env.LOGGING_INTERVAL || '60000', 10)
- const projectsCollection = db.collection('projects')
- const deletedProjectsCollection = db.collection('deletedProjects')
- const deletedFilesCollection = db.collection('deletedFiles')
- const STATS = {
- projects: 0,
- filesWithoutHash: 0,
- filesDuplicated: 0,
- filesRetries: 0,
- filesFailed: 0,
- fileTreeUpdated: 0,
- globalBlobsCount: 0,
- globalBlobsEgress: 0,
- projectDeleted: 0,
- projectHardDeleted: 0,
- fileHardDeleted: 0,
- mongoUpdates: 0,
- deduplicatedWriteToAWSLocalCount: 0,
- deduplicatedWriteToAWSLocalEgress: 0,
- deduplicatedWriteToAWSRemoteCount: 0,
- deduplicatedWriteToAWSRemoteEgress: 0,
- readFromGCSCount: 0,
- readFromGCSIngress: 0,
- writeToAWSCount: 0,
- writeToAWSEgress: 0,
- }
- const processStart = performance.now()
- let lastLogTS = processStart
- let lastLog = Object.assign({}, STATS)
- let lastEventLoopStats = performance.eventLoopUtilization()
- /**
- * @param {number} v
- * @param {number} ms
- */
- function toMiBPerSecond(v, ms) {
- const ONE_MiB = 1024 * 1024
- return v / ONE_MiB / (ms / 1000)
- }
- /**
- * @param {any} stats
- * @param {number} ms
- * @return {{writeToAWSThroughputMiBPerSecond: number, readFromGCSThroughputMiBPerSecond: number}}
- */
- function bandwidthStats(stats, ms) {
- return {
- readFromGCSThroughputMiBPerSecond: toMiBPerSecond(
- stats.readFromGCSIngress,
- ms
- ),
- writeToAWSThroughputMiBPerSecond: toMiBPerSecond(
- stats.writeToAWSEgress,
- ms
- ),
- }
- }
- /**
- * @param {EventLoopUtilization} nextEventLoopStats
- * @param {number} now
- * @return {Object}
- */
- function computeDiff(nextEventLoopStats, now) {
- const ms = now - lastLogTS
- lastLogTS = now
- const diff = {
- eventLoop: performance.eventLoopUtilization(
- nextEventLoopStats,
- lastEventLoopStats
- ),
- }
- for (const [name, v] of Object.entries(STATS)) {
- diff[name] = v - lastLog[name]
- }
- return Object.assign(diff, bandwidthStats(diff, ms))
- }
- function printStats() {
- const now = performance.now()
- const nextEventLoopStats = performance.eventLoopUtilization()
- console.log(
- JSON.stringify({
- time: new Date(),
- ...STATS,
- ...bandwidthStats(STATS, now - processStart),
- eventLoop: nextEventLoopStats,
- diff: computeDiff(nextEventLoopStats, now),
- })
- )
- lastEventLoopStats = nextEventLoopStats
- lastLog = Object.assign({}, STATS)
- }
- setInterval(printStats, LOGGING_INTERVAL)
- /**
- * @param {QueueEntry} entry
- * @return {Promise<string>}
- */
- async function processFile(entry) {
- for (let attempt = 0; attempt < RETRIES; attempt++) {
- try {
- return await processFileOnce(entry)
- } catch (err) {
- if (err instanceof NotFoundError) {
- const { bucketName } = OError.getFullInfo(err)
- if (bucketName === USER_FILES_BUCKET_NAME && !RETRY_FILESTORE_404) {
- throw err // disable retries for not found in filestore bucket case
- }
- }
- if (err instanceof NoKEKMatchedError) {
- throw err // disable retries when upload to S3 will fail again
- }
- STATS.filesRetries++
- const {
- ctx: { projectId },
- fileId,
- path,
- } = entry
- logger.warn(
- { err, projectId, fileId, path, attempt },
- 'failed to process file, trying again'
- )
- await setTimeout(RETRY_DELAY_MS)
- }
- }
- return await processFileOnce(entry)
- }
- /**
- * @param {QueueEntry} entry
- * @return {Promise<string>}
- */
- async function processFileOnce(entry) {
- const { fileId } = entry
- const { projectId, historyId } = entry.ctx
- const filePath = Path.join(
- BUFFER_DIR,
- projectId.toString() + fileId.toString()
- )
- const dst = fs.createWriteStream(filePath, {
- highWaterMark: STREAM_HIGH_WATER_MARK,
- })
- STATS.readFromGCSCount++
- const src = await filestorePersistor.getObjectStream(
- USER_FILES_BUCKET_NAME,
- `${projectId}/${fileId}`
- )
- try {
- await Stream.promises.pipeline(src, dst)
- } finally {
- STATS.readFromGCSIngress += dst.bytesWritten
- }
- const blobStore = new BlobStore(historyId)
- const blob = await blobStore.putFile(filePath)
- const hash = blob.getHash()
- if (GLOBAL_BLOBS.has(hash)) {
- STATS.globalBlobsCount++
- STATS.globalBlobsEgress += estimateBlobSize(blob)
- return hash
- }
- if (entry.ctx.hasBackedUpBlob(hash)) {
- STATS.deduplicatedWriteToAWSLocalCount++
- STATS.deduplicatedWriteToAWSLocalEgress += estimateBlobSize(blob)
- return hash
- }
- entry.ctx.recordPendingBlob(hash)
- let backupSource
- let contentEncoding
- const md5 = Crypto.createHash('md5')
- let size
- if (blob.getStringLength()) {
- const filePathCompressed = filePath + '.gz'
- backupSource = filePathCompressed
- contentEncoding = 'gzip'
- size = 0
- await Stream.promises.pipeline(
- fs.createReadStream(filePath, { highWaterMark: STREAM_HIGH_WATER_MARK }),
- zLib.createGzip(),
- async function* (source) {
- for await (const chunk of source) {
- size += chunk.byteLength
- md5.update(chunk)
- yield chunk
- }
- },
- fs.createWriteStream(filePathCompressed, {
- highWaterMark: STREAM_HIGH_WATER_MARK,
- })
- )
- } else {
- backupSource = filePath
- size = blob.getByteLength()
- await Stream.promises.pipeline(
- fs.createReadStream(filePath, { highWaterMark: STREAM_HIGH_WATER_MARK }),
- md5
- )
- }
- const backendKeyPath = makeProjectKey(historyId, blob.getHash())
- const persistor = await entry.ctx.getCachedPersistor(backendKeyPath)
- try {
- STATS.writeToAWSCount++
- await persistor.sendStream(
- projectBlobsBucket,
- backendKeyPath,
- fs.createReadStream(backupSource, {
- highWaterMark: STREAM_HIGH_WATER_MARK,
- }),
- {
- contentEncoding,
- contentType: 'application/octet-stream',
- contentLength: size,
- sourceMd5: md5.digest('hex'),
- ifNoneMatch: '*', // de-duplicate write (we pay for the request, but avoid egress)
- }
- )
- STATS.writeToAWSEgress += size
- } catch (err) {
- if (err instanceof AlreadyWrittenError) {
- STATS.deduplicatedWriteToAWSRemoteCount++
- STATS.deduplicatedWriteToAWSRemoteEgress += size
- } else {
- STATS.writeToAWSEgress += size
- entry.ctx.recordFailedBlob(hash)
- throw err
- }
- }
- entry.ctx.recordBackedUpBlob(hash)
- return hash
- }
- /**
- * @param {Array<QueueEntry>} files
- * @return {Promise<void>}
- */
- async function processFiles(files) {
- if (files.length === 0) return // all processed
- await fs.promises.mkdir(BUFFER_DIR, { recursive: true })
- try {
- await promiseMapWithLimit(
- CONCURRENCY,
- files,
- /**
- * @param {QueueEntry} entry
- * @return {Promise<void>}
- */
- async function (entry) {
- try {
- await entry.ctx.processFile(entry)
- } catch (err) {
- STATS.filesFailed++
- const {
- ctx: { projectId },
- fileId,
- path,
- } = entry
- logger.error(
- { err, projectId, fileId, path },
- 'failed to process file'
- )
- }
- }
- )
- } finally {
- await fs.promises.rm(BUFFER_DIR, { recursive: true, force: true })
- }
- }
- /**
- * @param {Array<Project>} batch
- * @param {string} prefix
- * @return {Promise<void>}
- */
- async function handleLiveTreeBatch(batch, prefix = 'rootFolder.0') {
- if (process.argv.includes('deletedFiles')) {
- await collectDeletedFiles(batch)
- }
- const files = Array.from(findFileInBatch(batch, prefix))
- STATS.projects += batch.length
- STATS.filesWithoutHash += files.length
- batch.length = 0 // GC
- // The files are currently ordered by project-id.
- // Order them by file-id to
- // - avoid head-of-line blocking from many project-files waiting on the generation of the projects DEK (round trip to AWS)
- // - bonus: increase chance of de-duplicating write to AWS
- files.sort((a, b) => (a.fileId > b.fileId ? 1 : -1))
- await processFiles(files)
- await promiseMapWithLimit(
- CONCURRENCY,
- files,
- /**
- * @param {QueueEntry} entry
- * @return {Promise<void>}
- */
- async function (entry) {
- await entry.ctx.flushMongoQueues()
- }
- )
- }
- /**
- * @param {Array<{project: Project}>} batch
- * @return {Promise<void>}
- */
- async function handleDeletedFileTreeBatch(batch) {
- await handleLiveTreeBatch(
- batch.map(d => d.project),
- 'project.rootFolder.0'
- )
- }
- /**
- * @param {QueueEntry} entry
- * @return {Promise<boolean>}
- */
- async function tryUpdateFileRefInMongo(entry) {
- if (entry.path === '') {
- return await tryUpdateDeletedFileRefInMongo(entry)
- } else if (entry.path.startsWith('project.')) {
- return await tryUpdateFileRefInMongoInDeletedProject(entry)
- }
- STATS.mongoUpdates++
- const result = await projectsCollection.updateOne(
- {
- _id: entry.ctx.projectId,
- [`${entry.path}._id`]: new ObjectId(entry.fileId),
- },
- {
- $set: { [`${entry.path}.hash`]: entry.hash },
- }
- )
- return result.matchedCount === 1
- }
- /**
- * @param {QueueEntry} entry
- * @return {Promise<boolean>}
- */
- async function tryUpdateDeletedFileRefInMongo(entry) {
- STATS.mongoUpdates++
- const result = await deletedFilesCollection.updateOne(
- {
- _id: new ObjectId(entry.fileId),
- projectId: entry.ctx.projectId,
- },
- { $set: { hash: entry.hash } }
- )
- return result.matchedCount === 1
- }
- /**
- * @param {QueueEntry} entry
- * @return {Promise<boolean>}
- */
- async function tryUpdateFileRefInMongoInDeletedProject(entry) {
- STATS.mongoUpdates++
- const result = await deletedProjectsCollection.updateOne(
- {
- 'deleterData.deletedProjectId': entry.ctx.projectId,
- [`${entry.path}._id`]: new ObjectId(entry.fileId),
- },
- {
- $set: { [`${entry.path}.hash`]: entry.hash },
- }
- )
- return result.matchedCount === 1
- }
- const RETRY_UPDATE_HASH = 100
- /**
- * @param {QueueEntry} entry
- * @return {Promise<void>}
- */
- async function updateFileRefInMongo(entry) {
- if (await tryUpdateFileRefInMongo(entry)) return
- const { fileId } = entry
- const { projectId } = entry.ctx
- for (let i = 0; i < RETRY_UPDATE_HASH; i++) {
- let prefix = 'rootFolder.0'
- let p = await projectsCollection.findOne(
- { _id: projectId },
- { projection: { rootFolder: 1 } }
- )
- if (!p) {
- STATS.projectDeleted++
- prefix = 'project.rootFolder.0'
- const deletedProject = await deletedProjectsCollection.findOne(
- {
- 'deleterData.deletedProjectId': projectId,
- project: { $exists: true },
- },
- { projection: { 'project.rootFolder': 1 } }
- )
- p = deletedProject?.project
- if (!p) {
- STATS.projectHardDeleted++
- console.warn(
- 'bug: project hard-deleted while processing',
- projectId,
- fileId
- )
- return
- }
- }
- let found = false
- for (const e of findFiles(entry.ctx, p.rootFolder[0], prefix)) {
- found = e.fileId === fileId
- if (!found) continue
- if (await tryUpdateFileRefInMongo(e)) return
- break
- }
- if (!found) {
- if (await tryUpdateDeletedFileRefInMongo(entry)) return
- STATS.fileHardDeleted++
- console.warn('bug: file hard-deleted while processing', projectId, fileId)
- return
- }
- STATS.fileTreeUpdated++
- }
- throw new OError(
- 'file-tree updated repeatedly while trying to add hash',
- entry
- )
- }
- /**
- * @param {ProjectContext} ctx
- * @param {Folder} folder
- * @param {string} path
- * @return Generator<QueueEntry>
- */
- function* findFiles(ctx, folder, path) {
- let i = 0
- for (const child of folder.folders) {
- yield* findFiles(ctx, child, `${path}.folders.${i}`)
- i++
- }
- i = 0
- for (const fileRef of folder.fileRefs) {
- if (!fileRef.hash) {
- yield {
- ctx,
- fileId: fileRef._id.toString(),
- path: `${path}.fileRefs.${i}`,
- }
- }
- i++
- }
- }
- /**
- * @param {Array<Project>} projects
- * @param {string} prefix
- */
- function* findFileInBatch(projects, prefix) {
- for (const project of projects) {
- const ctx = new ProjectContext(project)
- yield* findFiles(ctx, project.rootFolder[0], prefix)
- for (const fileId of project.deletedFileIds || []) {
- yield { ctx, fileId, path: '' }
- }
- }
- }
- /**
- * @param {Array<Project>} projects
- * @return {Promise<void>}
- */
- async function collectDeletedFiles(projects) {
- const cursor = deletedFilesCollection.find(
- {
- projectId: { $in: projects.map(p => p._id) },
- hash: { $exists: false },
- },
- {
- projection: { _id: 1, projectId: 1 },
- readPreference: READ_PREFERENCE_SECONDARY,
- sort: { projectId: 1 },
- }
- )
- const processed = projects.slice()
- for await (const deletedFileRef of cursor) {
- const idx = processed.findIndex(
- p => p._id.toString() === deletedFileRef.projectId.toString()
- )
- if (idx === -1) {
- throw new Error(
- `bug: order of deletedFiles mongo records does not match batch of projects (${deletedFileRef.projectId} out of order)`
- )
- }
- processed.splice(0, idx)
- const project = processed[0]
- project.deletedFileIds = project.deletedFileIds || []
- project.deletedFileIds.push(deletedFileRef._id.toString())
- }
- }
- const BATCH_HASH_WRITES = 1_000
- const BATCH_FILE_UPDATES = 100
- class ProjectContext {
- /** @type {Promise<CachedPerProjectEncryptedS3Persistor> | null} */
- #cachedPersistorPromise = null
- /**
- * @param {Project} project
- */
- constructor(project) {
- this.projectId = project._id
- this.historyId = project.overleaf.history.id.toString()
- }
- /**
- * @param {string} key
- * @return {Promise<CachedPerProjectEncryptedS3Persistor>}
- */
- getCachedPersistor(key) {
- if (!this.#cachedPersistorPromise) {
- // Fetch DEK once, but only if needed -- upon the first use
- this.#cachedPersistorPromise = this.#getCachedPersistorWithRetries(key)
- }
- return this.#cachedPersistorPromise
- }
- /**
- * @param {string} key
- * @return {Promise<CachedPerProjectEncryptedS3Persistor>}
- */
- async #getCachedPersistorWithRetries(key) {
- for (let attempt = 0; attempt < RETRIES; attempt++) {
- try {
- return await backupPersistor.forProject(projectBlobsBucket, key)
- } catch (err) {
- if (err instanceof NoKEKMatchedError) {
- throw err
- } else {
- logger.warn(
- { err, projectId: this.projectId, attempt },
- 'failed to get DEK, trying again'
- )
- await setTimeout(RETRY_DELAY_MS)
- }
- }
- }
- return await backupPersistor.forProject(projectBlobsBucket, key)
- }
- async flushMongoQueuesIfNeeded() {
- if (this.#completedBlobs.size > BATCH_HASH_WRITES) {
- await this.#storeBackedUpBlobs()
- }
- if (this.#pendingFileWrites.length > BATCH_FILE_UPDATES) {
- await this.#storeFileHashes()
- }
- }
- async flushMongoQueues() {
- await this.#storeBackedUpBlobs()
- await this.#storeFileHashes()
- }
- /** @type {Set<string>} */
- #pendingBlobs = new Set()
- /** @type {Set<string>} */
- #completedBlobs = new Set()
- async #storeBackedUpBlobs() {
- if (this.#completedBlobs.size === 0) return
- const blobs = Array.from(this.#completedBlobs).map(
- hash => new Binary(Buffer.from(hash, 'hex'))
- )
- this.#completedBlobs.clear()
- STATS.mongoUpdates++
- await backedUpBlobs.updateOne(
- { _id: this.projectId },
- { $addToSet: { blobs: { $each: blobs } } },
- { upsert: true }
- )
- }
- /**
- * @param {string} hash
- */
- recordPendingBlob(hash) {
- this.#pendingBlobs.add(hash)
- }
- /**
- * @param {string} hash
- */
- recordFailedBlob(hash) {
- this.#pendingBlobs.delete(hash)
- }
- /**
- * @param {string} hash
- */
- recordBackedUpBlob(hash) {
- this.#completedBlobs.add(hash)
- this.#pendingBlobs.delete(hash)
- }
- /**
- * @param {string} hash
- * @return {boolean}
- */
- hasBackedUpBlob(hash) {
- return this.#pendingBlobs.has(hash) || this.#completedBlobs.has(hash)
- }
- /** @type {Array<QueueEntry>} */
- #pendingFileWrites = []
- /**
- * @param {QueueEntry} entry
- */
- queueFileForWritingHash(entry) {
- this.#pendingFileWrites.push(entry)
- }
- /**
- * @param {Collection} collection
- * @param {Array<QueueEntry>} entries
- * @param {Object} query
- * @return {Promise<Array<QueueEntry>>}
- */
- async #tryBatchHashWrites(collection, entries, query) {
- if (entries.length === 0) return []
- const update = {}
- for (const entry of entries) {
- query[`${entry.path}._id`] = new ObjectId(entry.fileId)
- update[`${entry.path}.hash`] = entry.hash
- }
- STATS.mongoUpdates++
- const result = await collection.updateOne(query, { $set: update })
- if (result.matchedCount === 1) {
- return [] // all updated
- }
- return entries
- }
- async #storeFileHashes() {
- if (this.#pendingFileWrites.length === 0) return
- const individualUpdates = []
- const projectEntries = []
- const deletedProjectEntries = []
- for (const entry of this.#pendingFileWrites) {
- if (entry.path === '') {
- individualUpdates.push(entry)
- } else if (entry.path.startsWith('project.')) {
- deletedProjectEntries.push(entry)
- } else {
- projectEntries.push(entry)
- }
- }
- this.#pendingFileWrites.length = 0
- // Try to process them together, otherwise fallback to individual updates and retries.
- individualUpdates.push(
- ...(await this.#tryBatchHashWrites(projectsCollection, projectEntries, {
- _id: this.projectId,
- }))
- )
- individualUpdates.push(
- ...(await this.#tryBatchHashWrites(
- deletedProjectsCollection,
- deletedProjectEntries,
- { 'deleterData.deletedProjectId': this.projectId }
- ))
- )
- for (const entry of individualUpdates) {
- await updateFileRefInMongo(entry)
- }
- }
- /** @type {Map<string, Promise<string>>} */
- #pendingFiles = new Map()
- /**
- * @param {QueueEntry} entry
- */
- async processFile(entry) {
- if (this.#pendingFiles.has(entry.fileId)) {
- STATS.filesDuplicated++
- } else {
- this.#pendingFiles.set(entry.fileId, processFile(entry))
- }
- entry.hash = await this.#pendingFiles.get(entry.fileId)
- this.queueFileForWritingHash(entry)
- await this.flushMongoQueuesIfNeeded()
- }
- }
- /**
- * @param {Blob} blob
- * @return {number}
- */
- function estimateBlobSize(blob) {
- let size = blob.getByteLength()
- if (blob.getStringLength()) {
- // approximation for gzip (25 bytes gzip overhead and 20% compression ratio)
- size = 25 + Math.ceil(size * 0.2)
- }
- return size
- }
- async function updateLiveFileTrees() {
- await batchedUpdate(
- projectsCollection,
- { 'overleaf.history.id': { $exists: true } },
- handleLiveTreeBatch,
- { rootFolder: 1, _id: 1, 'overleaf.history.id': 1 },
- {},
- {
- BATCH_RANGE_START,
- BATCH_RANGE_END,
- }
- )
- console.warn('Done updating live projects')
- }
- async function updateDeletedFileTrees() {
- await batchedUpdate(
- deletedProjectsCollection,
- {
- 'deleterData.deletedProjectId': {
- $gt: new ObjectId(BATCH_RANGE_START),
- $lte: new ObjectId(BATCH_RANGE_END),
- },
- 'project.overleaf.history.id': { $exists: true },
- },
- handleDeletedFileTreeBatch,
- {
- 'project.rootFolder': 1,
- 'project._id': 1,
- 'project.overleaf.history.id': 1,
- }
- )
- console.warn('Done updating deleted projects')
- }
- async function main() {
- await loadGlobalBlobs()
- if (process.argv.includes('live')) {
- await updateLiveFileTrees()
- }
- if (process.argv.includes('deleted')) {
- await updateDeletedFileTrees()
- }
- console.warn('Done.')
- }
- try {
- try {
- await main()
- } finally {
- printStats()
- }
- let code = 0
- if (STATS.filesFailed > 0) {
- console.warn('Some files could not be processed, see logs and try again')
- code++
- }
- if (STATS.fileHardDeleted > 0) {
- console.warn(
- 'Some hashes could not be updated as the files were hard-deleted, this should not happen'
- )
- code++
- }
- if (STATS.projectHardDeleted > 0) {
- console.warn(
- 'Some hashes could not be updated as the project was hard-deleted, this should not happen'
- )
- code++
- }
- process.exit(code)
- } catch (err) {
- console.error(err)
- process.exit(1)
- }
|