Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion providers/queue_provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,25 @@ export default class QueueProvider {
})
}

/**
* A warmed up app never gets started and its providers are never shut
* down. Therefore, we must not resolve the queue manager (and open the
* adapter connections) in this mode.
*/
#isWarmingUp() {
return this.app.getMode() === 'warmup'
}

async boot() {
if (this.#isWarmingUp()) {
return
}

await this.app.container.make('queue.manager')
}

async start() {
if (this.app.getEnvironment() === 'console') {
if (this.app.getEnvironment() === 'console' || this.#isWarmingUp()) {
return
}

Expand Down
9 changes: 7 additions & 2 deletions tests/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import { getActiveTest } from '@japa/runner'
import { IgnitorFactory } from '@adonisjs/core/factories'
import type { AppEnvironments } from '@adonisjs/core/types/app'
import type { AppEnvironments, ApplicationModes } from '@adonisjs/core/types/app'
import type { DatabaseConfig } from '@adonisjs/lucid/types/database'

import { defineConfig, drivers } from '../index.js'
Expand All @@ -21,7 +21,8 @@ export async function setupApp(
config: {
queue?: ReturnType<typeof defineConfig>
database?: DatabaseConfig
} = {}
} = {},
mode?: ApplicationModes
) {
const ignitor = new IgnitorFactory()
.withCoreProviders()
Expand Down Expand Up @@ -56,6 +57,10 @@ export async function setupApp(
})

const app = ignitor.createApp(env || 'web')
if (mode) {
app.setMode(mode)
}

await app.init().then(() => app.boot())

getActiveTest()?.cleanup(() => app.terminate())
Expand Down
62 changes: 62 additions & 0 deletions tests/provider.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

import { test } from '@japa/runner'
import { fileURLToPath } from 'node:url'
import { configProvider } from '@adonisjs/core'
import { Locator } from '@boringnode/queue'
import { sync } from '@boringnode/queue/drivers/sync_adapter'

Expand Down Expand Up @@ -272,4 +273,65 @@ test.group('Provider', (group) => {
Worker.prototype.start = originalStart
}
})

test('should not resolve the queue manager when warming up the app', async ({ assert, fs }) => {
await fs.create(
'app/jobs/provider_warmup_job.ts',
`
import { Job } from '@boringnode/queue'

export default class ProviderWarmupJob extends Job {
async execute() {}
}
`
)

/**
* Adapters like redis acquire their connection when resolved. Resolving
* them while warming up the app leaves open sockets behind, since the
* providers of a warmed up app are never shut down
*/
let resolvedAdapters = 0
const app = await setupApp(
'web',
{
queue: defineConfig({
default: 'sync',
adapters: {
sync: configProvider.create(async () => {
resolvedAdapters++
return sync()
}),
},
locations: [`${fs.basePath}/app/jobs/provider_warmup_job.ts`],
}),
},
'warmup'
)

assert.equal(resolvedAdapters, 0)

await app.warmUp()

assert.equal(app.getState(), 'warmed')
assert.equal(resolvedAdapters, 0)
assert.isUndefined(Locator.get('ProviderWarmupJob'))
})

test('should resolve the queue manager when booting the app', async ({ assert }) => {
let resolvedAdapters = 0
await setupApp('web', {
queue: defineConfig({
default: 'sync',
adapters: {
sync: configProvider.create(async () => {
resolvedAdapters++
return sync()
}),
},
}),
})

assert.equal(resolvedAdapters, 1)
})
})
Loading