Skip to content

Commit dfb341a

Browse files
committed
Rename DefinitionUpgrader to DefinitionRecomputer in process.ts
The class processes compute queue messages, not upgrade queue messages. Rename the class and update log messages to use 'recompute' terminology, keeping _upgradePolicy naming which correctly refers to the upgrade policy used as a guard within the compute path.
1 parent 4a70fa9 commit dfb341a

2 files changed

Lines changed: 27 additions & 27 deletions

File tree

providers/recompute/process.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class QueueHandler {
5858
}
5959
}
6060

61-
class DefinitionUpgrader implements MessageHandler {
61+
class DefinitionRecomputer implements MessageHandler {
6262
logger: Logger
6363
declare _definitionService: DefinitionService
6464
declare _upgradePolicy: UpgradeHandler
@@ -85,12 +85,12 @@ class DefinitionUpgrader implements MessageHandler {
8585
return needsCompute
8686
})
8787
if (result) {
88-
this.logger.info('Handled definition upgrade', { coordinates: coordinates.toString() })
88+
this.logger.info('Handled definition recompute', { coordinates: coordinates.toString() })
8989
} else {
90-
this.logger.debug('Skipped definition upgrade', { coordinates: coordinates.toString() })
90+
this.logger.debug('Skipped definition recompute', { coordinates: coordinates.toString() })
9191
}
9292
} catch (error) {
93-
const context = `Error handling definition upgrade for ${coordinates.toString()}`
93+
const context = `Error handling definition recompute for ${coordinates.toString()}`
9494
const originalError = error instanceof Error ? error : new Error(String(error))
9595
throw new Error(context, { cause: originalError })
9696
}
@@ -104,9 +104,9 @@ function setup(
104104
once: boolean = false,
105105
_upgradePolicy: UpgradeHandler = factory({ logger: _logger })
106106
): Promise<void> {
107-
const defUpgrader = new DefinitionUpgrader(_definitionService, _logger, _upgradePolicy)
108-
const queueHandler = new QueueHandler(_queue, _logger, defUpgrader)
107+
const defRecomputer = new DefinitionRecomputer(_definitionService, _logger, _upgradePolicy)
108+
const queueHandler = new QueueHandler(_queue, _logger, defRecomputer)
109109
return queueHandler.work(once)
110110
}
111111

112-
export { DefinitionUpgrader, QueueHandler, setup }
112+
export { DefinitionRecomputer, QueueHandler, setup }

test/providers/recompute/process.ts

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ chai.use(chaiAsPromised)
99
import { expect } from 'chai'
1010
import sinon from 'sinon'
1111
import EntityCoordinates from '../../../lib/entityCoordinates.ts'
12-
import { DefinitionUpgrader, QueueHandler } from '../../../providers/recompute/process.ts'
12+
import { DefinitionRecomputer, QueueHandler } from '../../../providers/recompute/process.ts'
1313

14-
describe('Definition Upgrade Queue Processing', () => {
14+
describe('Definition Recompute Queue Processing', () => {
1515
let logger
1616

1717
beforeEach(() => {
@@ -87,13 +87,13 @@ describe('Definition Upgrade Queue Processing', () => {
8787
})
8888
})
8989

90-
describe('DefinitionUpgrader', () => {
90+
describe('DefinitionRecomputer', () => {
9191
const coordinates = 'pypi/pypi/-/test/revision'
9292
const definition = Object.freeze({ coordinates: EntityCoordinates.fromString(coordinates) })
9393
const message = Object.freeze({ data: { coordinates: definition.coordinates } })
9494
let definitionService
9595
let upgradePolicy
96-
let upgrader
96+
let recomputer
9797

9898
beforeEach(() => {
9999
definitionService = {
@@ -103,13 +103,13 @@ describe('Definition Upgrade Queue Processing', () => {
103103
upgradePolicy = {
104104
validate: sinon.stub()
105105
}
106-
upgrader = new DefinitionUpgrader(definitionService, logger, upgradePolicy)
106+
recomputer = new DefinitionRecomputer(definitionService, logger, upgradePolicy)
107107
})
108108

109109
it('delegates to computeStoreAndCurateIf and logs when definition was recomputed', async () => {
110110
definitionService.computeStoreAndCurateIf.resolves(definition)
111111

112-
await upgrader.processMessage(message)
112+
await recomputer.processMessage(message)
113113
expect(definitionService.computeStoreAndCurateIf.calledOnce).to.be.true
114114
expect(definitionService.computeStoreAndCurateIf.getCall(0).args[0]).to.deep.eq(
115115
EntityCoordinates.fromObject(definition.coordinates)
@@ -120,23 +120,23 @@ describe('Definition Upgrade Queue Processing', () => {
120120
it('delegates to computeStoreAndCurateIf and logs debug when compute was skipped', async () => {
121121
definitionService.computeStoreAndCurateIf.resolves(undefined)
122122

123-
await upgrader.processMessage(message)
123+
await recomputer.processMessage(message)
124124
expect(definitionService.computeStoreAndCurateIf.calledOnce).to.be.true
125125
expect(logger.debug.calledOnce).to.be.true
126126
expect(logger.info.notCalled).to.be.true
127127
})
128128

129129
it('skips if there is no coordinates', async () => {
130-
await upgrader.processMessage({ data: {} })
130+
await recomputer.processMessage({ data: {} })
131131
expect(definitionService.computeStoreAndCurateIf.notCalled).to.be.true
132132
})
133133

134134
it('handles exception by rethrowing with coordinates and the original error message', async () => {
135135
definitionService.computeStoreAndCurateIf.rejects(new Error('test'))
136136

137-
await expect(upgrader.processMessage(message)).to.be.rejectedWith(
137+
await expect(recomputer.processMessage(message)).to.be.rejectedWith(
138138
Error,
139-
/Error handling definition upgrade for pypi\/pypi\/-\/test\/revision/
139+
/Error handling definition recompute for pypi\/pypi\/-\/test\/revision/
140140
)
141141
})
142142

@@ -145,7 +145,7 @@ describe('Definition Upgrade Queue Processing', () => {
145145
definitionService.computeStoreAndCurateIf.rejects(originalError)
146146

147147
try {
148-
await upgrader.processMessage(message)
148+
await recomputer.processMessage(message)
149149
expect.fail('should have thrown')
150150
} catch (error: any) {
151151
expect(error.cause).to.equal(originalError)
@@ -167,7 +167,7 @@ describe('Definition Upgrade Queue Processing', () => {
167167
it('skips compute when policy validates the definition', async () => {
168168
upgradePolicy.validate.resolves(definition) // truthy = valid → predicate returns false → skip
169169

170-
await upgrader.processMessage(message)
170+
await recomputer.processMessage(message)
171171
expect(predicateResult).to.be.false
172172
expect(definitionService.getStored.calledOnceWith(EntityCoordinates.fromObject(definition.coordinates))).to.be
173173
.true
@@ -178,7 +178,7 @@ describe('Definition Upgrade Queue Processing', () => {
178178
it('proceeds with compute when policy returns falsy', async () => {
179179
upgradePolicy.validate.resolves(undefined) // falsy = stale → predicate returns true → compute
180180

181-
await upgrader.processMessage(message)
181+
await recomputer.processMessage(message)
182182
expect(predicateResult).to.be.true
183183
expect(definitionService.getStored.calledOnceWith(EntityCoordinates.fromObject(definition.coordinates))).to.be
184184
.true
@@ -199,13 +199,13 @@ describe('Definition Upgrade Queue Processing', () => {
199199
let handler
200200
let definitionService
201201
beforeEach(() => {
202-
let definitionUpgrader
203-
;({ definitionService, definitionUpgrader } = setupDefinitionUpgrader(logger))
202+
let definitionRecomputer
203+
;({ definitionService, definitionRecomputer } = setupDefinitionRecomputer(logger))
204204
queue = {
205205
dequeueMultiple: sinon.stub().resolves([message]),
206206
delete: sinon.stub().resolves()
207207
}
208-
handler = new QueueHandler(queue, logger, definitionUpgrader)
208+
handler = new QueueHandler(queue, logger, definitionRecomputer)
209209
})
210210

211211
it('handles exception and logs the error', async () => {
@@ -216,7 +216,7 @@ describe('Definition Upgrade Queue Processing', () => {
216216
expect(queue.delete.calledOnce).to.be.true
217217
expect(logger.error.calledOnce).to.be.true
218218
expect(logger.error.args[0][0].message).to.match(
219-
/Error handling definition upgrade for pypi\/pypi\/-\/test\/revision/
219+
/Error handling definition recompute for pypi\/pypi\/-\/test\/revision/
220220
)
221221
})
222222

@@ -285,14 +285,14 @@ describe('Definition Upgrade Queue Processing', () => {
285285
})
286286
})
287287

288-
function setupDefinitionUpgrader(logger) {
288+
function setupDefinitionRecomputer(logger) {
289289
const definitionService = {
290290
getStored: sinon.stub(),
291291
computeStoreAndCurateIf: sinon.stub()
292292
}
293293
const upgradePolicy = {
294294
validate: sinon.stub()
295295
}
296-
const definitionUpgrader = new DefinitionUpgrader(definitionService as any, logger, upgradePolicy)
297-
return { definitionService, upgradePolicy, definitionUpgrader }
296+
const definitionRecomputer = new DefinitionRecomputer(definitionService as any, logger, upgradePolicy)
297+
return { definitionService, upgradePolicy, definitionRecomputer }
298298
}

0 commit comments

Comments
 (0)