Eric Mc Sween
f2a70de6ef
[web] Add event for package usage GitOrigin-RevId: e994becf01e7e4c8642cd1815ffe05907a5fd63c
92 lines
2.6 KiB
JavaScript
92 lines
2.6 KiB
JavaScript
import OError from '@overleaf/o-error'
|
|
import EditorRealTimeController from '../Editor/EditorRealTimeController.mjs'
|
|
import MetaHandler from './MetaHandler.mjs'
|
|
import logger from '@overleaf/logger'
|
|
import { expressify } from '@overleaf/promise-utils'
|
|
import Analytics from '../Analytics/AnalyticsManager.mjs'
|
|
import SplitTestHandler from '../SplitTests/SplitTestHandler.mjs'
|
|
|
|
async function getMetadata(req, res) {
|
|
const { project_id: projectId } = req.params
|
|
|
|
logger.debug({ projectId }, 'getting all labels for project')
|
|
|
|
let projectMeta
|
|
try {
|
|
projectMeta = await MetaHandler.promises.getAllMetaForProject(projectId)
|
|
} catch (error) {
|
|
throw OError.tag(
|
|
error,
|
|
'[MetaController] error getting all labels from project',
|
|
{
|
|
project_id: projectId,
|
|
}
|
|
)
|
|
}
|
|
|
|
const assignment = await SplitTestHandler.promises.getAssignment(
|
|
req,
|
|
res,
|
|
'emit-package-usage-statistics'
|
|
)
|
|
if (assignment.variant === 'enabled') {
|
|
sendAnalyticsEventForPackageUsage(projectId, projectMeta)
|
|
}
|
|
|
|
res.json({ projectId, projectMeta })
|
|
}
|
|
|
|
function sendAnalyticsEventForPackageUsage(projectId, projectMeta) {
|
|
const packagesSet = new Set()
|
|
const documentClassesSet = new Set()
|
|
for (const docMeta of Object.values(projectMeta)) {
|
|
if (docMeta.documentClass != null) {
|
|
documentClassesSet.add(docMeta.documentClass)
|
|
}
|
|
|
|
for (const packageName of docMeta.packageNames) {
|
|
if (packageName.match(/^[a-zA-Z0-9-_]+$/)) {
|
|
packagesSet.add(packageName)
|
|
}
|
|
}
|
|
}
|
|
const packages = Array.from(packagesSet)
|
|
const documentClasses = Array.from(documentClassesSet)
|
|
Analytics.emitPackageUsage(projectId, { documentClasses, packages })
|
|
}
|
|
|
|
async function broadcastMetadataForDoc(req, res) {
|
|
const { project_id: projectId } = req.params
|
|
const { doc_id: docId } = req.params
|
|
const { broadcast } = req.body
|
|
|
|
logger.debug({ projectId, docId, broadcast }, 'getting labels for doc')
|
|
|
|
let docMeta
|
|
try {
|
|
docMeta = await MetaHandler.promises.getMetaForDoc(projectId, docId)
|
|
} catch (error) {
|
|
throw OError.tag(error, '[MetaController] error getting labels from doc', {
|
|
project_id: projectId,
|
|
doc_id: docId,
|
|
})
|
|
}
|
|
|
|
// default to broadcasting, unless explicitly disabled (for backwards compatibility)
|
|
if (broadcast === false) {
|
|
return res.json({ docId, meta: docMeta })
|
|
}
|
|
|
|
EditorRealTimeController.emitToRoom(projectId, 'broadcastDocMeta', {
|
|
docId,
|
|
meta: docMeta,
|
|
})
|
|
|
|
res.sendStatus(200) // 204?
|
|
}
|
|
|
|
export default {
|
|
getMetadata: expressify(getMetadata),
|
|
broadcastMetadataForDoc: expressify(broadcastMetadataForDoc),
|
|
}
|