github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #17268 from overleaf/dp-remove-old-mongo-metrics

Browse source 
Remove timeAsyncMethod mongo metrics

GitOrigin-RevId: 1ba3a1fd51b9d0766355c31791ae9836d832afe8
This commit is contained in:
David 2024-02-28 11:20:53 +00:00 committed by Copybot
parent 6d99f6dfae
commit 84c3dc1fff
15 changed files with 1 additions and 350 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
libraries/metrics/index.js
View file

@ -180,4 +180,3 @@ module.exports.leaked_sockets = require('./leaked_sockets')
module.exports.event_loop = require('./event_loop')
module.exports.memory = require('./memory')
module.exports.mongodb = require('./mongodb')
module.exports.timeAsyncMethod = require('./timeAsyncMethod')

201
libraries/metrics/test/unit/js/timeAsyncMethodTests.js
View file

@ -1,201 +0,0 @@
/*
* 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 chai = require('chai')
const { expect } = chai
const path = require('path')
const modulePath = path.join(__dirname, '../../../timeAsyncMethod.js')
const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
describe('timeAsyncMethod', function () {
beforeEach(function () {
this.Timer = { done: sinon.stub() }
this.TimerConstructor = sinon.stub().returns(this.Timer)
this.metrics = {
Timer: this.TimerConstructor,
inc: sinon.stub(),
}
this.timeAsyncMethod = SandboxedModule.require(modulePath, {
requires: {
'./index': this.metrics,
},
})
return (this.testObject = {
nextNumber(n, callback) {
return setTimeout(() => callback(null, n + 1), 100)
},
})
})
it('should have the testObject behave correctly before wrapping', function (done) {
return this.testObject.nextNumber(2, (err, result) => {
expect(err).to.not.exist
expect(result).to.equal(3)
return done()
})
})
it('should wrap method without error', function (done) {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
return done()
})
it('should transparently wrap method invocation in timer', function (done) {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
return this.testObject.nextNumber(2, (err, result) => {
expect(err).to.not.exist
expect(result).to.equal(3)
expect(this.TimerConstructor.callCount).to.equal(1)
expect(this.Timer.done.callCount).to.equal(1)
return done()
})
})
it('should increment success count', function (done) {
this.metrics.inc = sinon.stub()
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
return this.testObject.nextNumber(2, (err, result) => {
if (err) {
return done(err)
}
expect(this.metrics.inc.callCount).to.equal(1)
expect(
this.metrics.inc.calledWith('someContext_result', 1, {
method: 'TestObject_nextNumber',
status: 'success',
})
).to.equal(true)
return done()
})
})
describe('when base method produces an error', function () {
beforeEach(function () {
this.metrics.inc = sinon.stub()
return (this.testObject.nextNumber = function (n, callback) {
return setTimeout(() => callback(new Error('woops')), 100)
})
})
it('should propagate the error transparently', function (done) {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
return this.testObject.nextNumber(2, (err, result) => {
expect(err).to.exist
expect(err).to.be.instanceof(Error)
expect(result).to.not.exist
return done()
})
})
return it('should increment failure count', function (done) {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
return this.testObject.nextNumber(2, (err, result) => {
expect(err).to.exist
expect(this.metrics.inc.callCount).to.equal(1)
expect(
this.metrics.inc.calledWith('someContext_result', 1, {
method: 'TestObject_nextNumber',
status: 'failed',
})
).to.equal(true)
return done()
})
})
})
describe('when a logger is supplied', function () {
beforeEach(function () {
return (this.logger = { debug: sinon.stub(), log: sinon.stub() })
})
return it('should also call logger.debug', function (done) {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject',
this.logger
)
return this.testObject.nextNumber(2, (err, result) => {
expect(err).to.not.exist
expect(result).to.equal(3)
expect(this.TimerConstructor.callCount).to.equal(1)
expect(this.Timer.done.callCount).to.equal(1)
expect(this.logger.debug.callCount).to.equal(1)
return done()
})
})
})
describe('when the wrapper cannot be applied', function () {
beforeEach(function () {})
return it('should raise an error', function () {
const badWrap = () => {
return this.timeAsyncMethod(
this.testObject,
'DEFINITELY_NOT_A_REAL_METHOD',
'someContext.TestObject'
)
}
return expect(badWrap).to.throw(
/^.*expected object property 'DEFINITELY_NOT_A_REAL_METHOD' to be a function.*$/
)
})
})
return describe('when the wrapped function is not using a callback', function () {
beforeEach(function () {
this.realMethod = sinon.stub().returns(42)
return (this.testObject.nextNumber = this.realMethod)
})
it('should not throw an error', function () {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
const badCall = () => {
return this.testObject.nextNumber(2)
}
return expect(badCall).to.not.throw(Error)
})
return it('should call the underlying method', function () {
this.timeAsyncMethod(
this.testObject,
'nextNumber',
'someContext.TestObject'
)
const result = this.testObject.nextNumber(12)
expect(this.realMethod.callCount).to.equal(1)
expect(this.realMethod.calledWith(12)).to.equal(true)
return expect(result).to.equal(42)
})
})
})

86
libraries/metrics/timeAsyncMethod.js
View file

@ -1,86 +0,0 @@
/*
* decaffeinate suggestions:
* DS101: Remove unnecessary use of Array.from
* DS102: Remove unnecessary code created because of implicit returns
* DS201: Simplify complex destructure assignments
* DS207: Consider shorter variations of null checks
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
module.exports = function (obj, methodName, prefix, logger) {
let modifedMethodName
const metrics = require('./index')
if (typeof obj[methodName] !== 'function') {
throw new Error(
`[Metrics] expected object property '${methodName}' to be a function`
)
}
const key = `${prefix}.${methodName}`
const realMethod = obj[methodName]
const splitPrefix = prefix.split('.')
const startPrefix = splitPrefix[0]
if (splitPrefix[1] != null) {
modifedMethodName = `${splitPrefix[1]}_${methodName}`
} else {
modifedMethodName = methodName
}
return (obj[methodName] = function (...originalArgs) {
const adjustedLength = Math.max(originalArgs.length, 1)
const firstArgs = originalArgs.slice(0, adjustedLength - 1)
const callback = originalArgs[adjustedLength - 1]
if (callback == null || typeof callback !== 'function') {
if (logger != null) {
logger.debug(
`[Metrics] expected wrapped method '${methodName}' to be invoked with a callback`
)
}
return realMethod.apply(this, originalArgs)
}
const timer = new metrics.Timer(startPrefix, 1, {
method: modifedMethodName,
})
return realMethod.call(
this,
...Array.from(firstArgs),
function (...callbackArgs) {
const elapsedTime = timer.done()
const possibleError = callbackArgs[0]
if (possibleError != null) {
metrics.inc(`${startPrefix}_result`, 1, {
status: 'failed',
method: modifedMethodName,
})
} else {
metrics.inc(`${startPrefix}_result`, 1, {
status: 'success',
method: modifedMethodName,
})
}
if (logger != null) {
const loggableArgs = {}
try {
for (let idx = 0; idx < firstArgs.length; idx++) {
const arg = firstArgs[idx]
if (arg.toString().match(/^[0-9a-f]{24}$/)) {
loggableArgs[`${idx}`] = arg
}
}
} catch (error) {}
logger.debug(
{ key, args: loggableArgs, elapsedTime },
'[Metrics] timed async method call'
)
}
return callback.apply(this, callbackArgs)
}
)
})
}

1
services/docstore/test/unit/js/MongoManagerTests.js
View file

@ -22,7 +22,6 @@ describe('MongoManager', function () {
db: this.db,
ObjectId,
},
'@overleaf/metrics': { timeAsyncMethod: sinon.stub() },
'@overleaf/settings': {
max_deleted_docs: 42,
docstore: { archivingLockDurationMs: 5000 },

7
services/notifications/app/js/Notifications.js
View file

@ -9,12 +9,10 @@
* DS207: Consider shorter variations of null checks
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
let Notifications
const logger = require('@overleaf/logger')
const { db, ObjectId } = require('./mongodb')
const metrics = require('@overleaf/metrics')
module.exports = Notifications = {
module.exports = {
getUserNotifications(userId, callback) {
if (callback == null) {
callback = function () {}
@ -132,6 +130,3 @@ module.exports = Notifications = {
db.notifications.deleteOne(searchOps, callback)
},
}
;['getUserNotifications', 'addNotification'].map(method =>
metrics.timeAsyncMethod(Notifications, method, 'mongo.Notifications', logger)
)

1
services/notifications/test/unit/js/NotificationsTests.js
View file

@ -41,7 +41,6 @@ describe('Notifications Tests', function () {
requires: {
'@overleaf/settings': {},
'./mongodb': { db: this.db, ObjectId },
'@overleaf/metrics': { timeAsyncMethod: sinon.stub() },
},
})

13
services/web/app/src/Features/Institutions/InstitutionsAPI.js
View file

@ -1,7 +1,6 @@
const { callbackify } = require('util')
const OError = require('@overleaf/o-error')
const logger = require('@overleaf/logger')
const metrics = require('@overleaf/metrics')
const settings = require('@overleaf/settings')
const request = require('requestretry')
const { promisifyAll } = require('@overleaf/promise-utils')
@ -373,18 +372,6 @@ function makeAffiliationRequest(options, callback) {
callback(null, body)
})
}
;[
'getInstitutionAffiliations',
'getConfirmedInstitutionAffiliations',
'getUserAffiliations',
].map(method =>
metrics.timeAsyncMethod(
InstitutionsAPI,
method,
'mongo.InstitutionsAPI',
logger
)
)
InstitutionsAPI.promises = promisifyAll(InstitutionsAPI, {
without: [

8
services/web/app/src/Features/Project/ProjectCreationHandler.js
View file

@ -1,4 +1,3 @@
const logger = require('@overleaf/logger')
const OError = require('@overleaf/o-error')
const metrics = require('@overleaf/metrics')
const Settings = require('@overleaf/settings')
@ -242,10 +241,3 @@ module.exports = {
createExampleProject,
},
}
metrics.timeAsyncMethod(
module.exports,
'createBlankProject',
'mongo.ProjectCreationHandler',
logger
)

10
services/web/app/src/Features/Spelling/LearnedWordsManager.js
View file

@ -1,6 +1,4 @@
const { db } = require('../../infrastructure/mongodb')
const logger = require('@overleaf/logger')
const metrics = require('@overleaf/metrics')
const { promisify } = require('util')
const OError = require('@overleaf/o-error')
const Settings = require('@overleaf/settings')
@ -94,11 +92,3 @@ const promises = {
LearnedWordsManager.promises = promises
module.exports = LearnedWordsManager
;['learnWord', 'unlearnWord', 'getLearnedWords'].map(method =>
metrics.timeAsyncMethod(
LearnedWordsManager,
method,
'mongo.LearnedWordsManager',
logger
)
)

12
services/web/app/src/Features/User/UserGetter.js
View file

@ -1,7 +1,5 @@
const { callbackify } = require('util')
const { db } = require('../../infrastructure/mongodb')
const metrics = require('@overleaf/metrics')
const logger = require('@overleaf/logger')
const moment = require('moment')
const settings = require('@overleaf/settings')
const { promisifyAll } = require('@overleaf/promise-utils')
@ -305,16 +303,6 @@ const decorateFullEmails = (
return emailsData
}
;[
'getUser',
'getUserEmail',
'getUserByMainEmail',
'getUserByAnyEmail',
'getUsers',
'ensureUniqueEmailAddress',
].map(method =>
metrics.timeAsyncMethod(UserGetter, method, 'mongo.UserGetter', logger)
)
UserGetter.promises = promisifyAll(UserGetter, {
without: ['getSsoUsersAtInstitution', 'getUserFullEmails'],

3
services/web/test/unit/src/Institutions/InstitutionsAPITests.js
View file

@ -20,9 +20,6 @@ describe('InstitutionsAPI', function () {
}
this.InstitutionsAPI = SandboxedModule.require(modulePath, {
requires: {
'@overleaf/metrics': {
timeAsyncMethod: sinon.stub(),
},
'@overleaf/settings': this.settings,
requestretry: this.request,
'@overleaf/fetch-utils': {

3
services/web/test/unit/src/Project/ProjectGetterTests.js
View file

@ -53,9 +53,6 @@ describe('ProjectGetter', function () {
this.ProjectGetter = SandboxedModule.require(modulePath, {
requires: {
'../../infrastructure/mongodb': { db: this.db, ObjectId },
'@overleaf/metrics': {
timeAsyncMethod: sinon.stub(),
},
'../../models/Project': {
Project: this.Project,
},

1
services/web/test/unit/src/Spelling/LearnedWordsManagerTests.js
View file

@ -21,7 +21,6 @@ describe('LearnedWordsManager', function () {
requires: {
'../../infrastructure/mongodb': { db: this.db },
'@overleaf/metrics': {
timeAsyncMethod: sinon.stub(),
inc: sinon.stub(),
},
'@overleaf/settings': {

1
services/web/test/unit/src/User/UserCreatorTests.js
View file

@ -19,7 +19,6 @@ describe('UserCreator', function () {
'../../models/User': {
User: this.UserModel,
},
'@overleaf/metrics': { timeAsyncMethod() {} },
'../../infrastructure/Features': (this.Features = {
hasFeature: sinon.stub().returns(false),
}),

3
services/web/test/unit/src/User/UserGetterTests.js
View file

@ -49,9 +49,6 @@ describe('UserGetter', function () {
requires: {
'../Helpers/Mongo': { normalizeQuery, normalizeMultiQuery },
'../../infrastructure/mongodb': this.Mongo,
'@overleaf/metrics': {
timeAsyncMethod: sinon.stub(),
},
'@overleaf/settings': (this.settings = {
reconfirmNotificationDays: 14,
}),