Skip to content

test: add scanner update rate override for testing #3241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michaelhthomas wants to merge 3 commits into
base: develop
Choose a base branch
from
+69 −36
Open

test: add scanner update rate override for testing #3241

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf7de2a
test: add scanner update rate override for testing
michaelhthomas Jul 12, 2026
160f931
test: use mock timers instead of scanner test overrides
michaelhthomas Aug 16, 2026
2e98009
fix(runWithMockTimers): fail when timer guard is exhausted
michaelhthomas Aug 19, 2026
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
7 changes: 4 additions & 3 deletions server/lib/scanners/jellyfin/jellyfin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { User } from '@server/entity/User';
import type { Library } from '@server/lib/settings';
import { getSettings } from '@server/lib/settings';
import { setupTestDb } from '@server/test/db';
import { runWithMockTimers } from '@server/test/runWithMockTimers';
import assert from 'node:assert/strict';
import { beforeEach, describe, it } from 'node:test';

Expand Down Expand Up @@ -333,7 +334,7 @@ describe('Jellyfin Scanner', () => {
return [];
};

await jellyfinFullScanner.run();
await runWithMockTimers(jellyfinFullScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 5000 },
Expand Down Expand Up @@ -411,7 +412,7 @@ describe('Jellyfin Scanner', () => {
return [];
};

await jellyfinFullScanner.run();
await runWithMockTimers(jellyfinFullScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 5001 },
Expand Down Expand Up @@ -488,7 +489,7 @@ describe('Jellyfin Scanner', () => {
return [];
};

await jellyfinFullScanner.run();
await runWithMockTimers(jellyfinFullScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 5002 },
Expand Down
37 changes: 19 additions & 18 deletions server/lib/scanners/radarr/radarr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { radarrScanner } from '@server/lib/scanners/radarr';
import type { RadarrSettings } from '@server/lib/settings';
import { getSettings } from '@server/lib/settings';
import { setupTestDb } from '@server/test/db';
import { runWithMockTimers } from '@server/test/runWithMockTimers';
import assert from 'node:assert/strict';
import { beforeEach, describe, it, mock } from 'node:test';

Expand Down Expand Up @@ -93,7 +94,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ monitored: false, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 550 },
Expand All @@ -109,7 +110,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 777, monitored: false, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const media = await mediaRepository.findOne({
where: { tmdbId: 777 },
Expand All @@ -131,7 +132,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 551, monitored: true, hasFile: true }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 551 },
Expand All @@ -153,7 +154,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 552, monitored: true, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 552 },
Expand All @@ -175,7 +176,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 553, monitored: true, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 553 },
Expand All @@ -197,7 +198,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 554, monitored: false, hasFile: true }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 554 },
Expand All @@ -223,7 +224,7 @@ describe('Radarr Scanner', () => {

getMoviesImpl = async () => [];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 950 },
Expand All @@ -243,7 +244,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true }]);
getMoviesImpl = async () => [fakeRadarrMovie({ tmdbId: 1, id: 99 })];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 999 },
Expand All @@ -263,7 +264,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true }]);
getMoviesImpl = async () => [];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 888 },
Expand All @@ -285,7 +286,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 700, monitored: true, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 700 },
Expand All @@ -306,7 +307,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true }]);
getMoviesImpl = async () => [];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 800 },
Expand Down Expand Up @@ -344,7 +345,7 @@ describe('Radarr Scanner', () => {
return [fakeRadarrMovie({ tmdbId: 903, id: 11 })];
};

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updatedOrphan = await mediaRepository.findOneOrFail({
where: { tmdbId: 901 },
Expand Down Expand Up @@ -372,7 +373,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true, is4k: true }]);
getMoviesImpl = async () => [fakeRadarrMovie({ tmdbId: 1, id: 99 })];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 960 },
Expand All @@ -393,7 +394,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true, is4k: true }]);
getMoviesImpl = async () => [];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 961 },
Expand Down Expand Up @@ -436,7 +437,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true }]);
getMoviesImpl = async () => [fakeRadarrMovie({ tmdbId: 1, id: 99 })];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 1003596 },
Expand Down Expand Up @@ -484,7 +485,7 @@ describe('Radarr Scanner', () => {
fakeRadarrMovie({ tmdbId: 700, monitored: true, hasFile: false }),
];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updatedRequest = await requestRepository.findOneOrFail({
where: { id: request.id },
Expand Down Expand Up @@ -525,7 +526,7 @@ describe('Radarr Scanner', () => {
configureRadarr([{ syncEnabled: true }]);
getMoviesImpl = async () => [];

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 1234 },
Expand Down Expand Up @@ -621,7 +622,7 @@ describe('Radarr Scanner', () => {
return [fakeRadarrMovie({ tmdbId: 2, id: 88 })];
};

await radarrScanner.run();
await runWithMockTimers(radarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 1003598 },
Expand Down
32 changes: 17 additions & 15 deletions server/lib/scanners/sonarr/sonarr.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ import Media from '@server/entity/Media';
import MediaRequest from '@server/entity/MediaRequest';
import Season from '@server/entity/Season';
import { User } from '@server/entity/User';
import { sonarrScanner } from '@server/lib/scanners/sonarr';
import type { SonarrSettings } from '@server/lib/settings';
import { getSettings } from '@server/lib/settings';
import { setupTestDb } from '@server/test/db';
import { runWithMockTimers } from '@server/test/runWithMockTimers';
import assert from 'node:assert/strict';
import { beforeEach, describe, it, mock } from 'node:test';

Expand Down Expand Up @@ -103,6 +103,8 @@ Object.defineProperty(TheMovieDb.prototype, 'getTvShow', {
configurable: true,
});

import { sonarrScanner } from '@server/lib/scanners/sonarr';

@michaelhthomas michaelhthomas Aug 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sonarr was being imported before the getTvShow mock which caused it to not work. Moved it here so the mock actually applies.


mock.method(MediaRequest, 'sendNotification', async () => undefined);

setupTestDb();
Expand Down Expand Up @@ -193,7 +195,7 @@ describe('Sonarr Scanner', () => {

getSeriesImpl = async () => [];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1050 },
Expand Down Expand Up @@ -223,7 +225,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1000 },
Expand Down Expand Up @@ -253,7 +255,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1001 },
Expand Down Expand Up @@ -303,7 +305,7 @@ describe('Sonarr Scanner', () => {
getShowByTvdbIdImpl = async () => fakeTmdbShow(1);
getTvShowImpl = async () => fakeTmdbShow(1);

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1 },
Expand Down Expand Up @@ -337,7 +339,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1003 },
Expand All @@ -363,7 +365,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1004 },
Expand Down Expand Up @@ -412,7 +414,7 @@ describe('Sonarr Scanner', () => {
getShowByTvdbIdImpl = async () => fakeTmdbShow(2);
getTvShowImpl = async () => fakeTmdbShow(2);

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updatedOrphan = await mediaRepository.findOneOrFail({
where: { tmdbId: 1010 },
Expand Down Expand Up @@ -440,7 +442,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1020 },
Expand Down Expand Up @@ -471,7 +473,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true, is4k: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1030 },
Expand Down Expand Up @@ -507,7 +509,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true, is4k: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updated = await mediaRepository.findOneOrFail({
where: { tmdbId: 1031 },
Expand Down Expand Up @@ -562,7 +564,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [fakeSonarrSeries({ tvdbId: 999 })];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 2000 },
Expand Down Expand Up @@ -636,7 +638,7 @@ describe('Sonarr Scanner', () => {
getShowByTvdbIdImpl = async () => fakeTmdbShow(2001);
getTvShowImpl = async () => fakeTmdbShow(2001);

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updatedRequest = await requestRepository.findOneOrFail({
where: { id: request.id },
Expand Down Expand Up @@ -685,7 +687,7 @@ describe('Sonarr Scanner', () => {
configureSonarr([{ syncEnabled: true }]);
getSeriesImpl = async () => [];

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 2005 },
Expand Down Expand Up @@ -804,7 +806,7 @@ describe('Sonarr Scanner', () => {
tvdbId === 666 ? fakeTmdbShow(2002) : fakeTmdbShow(997);
getTvShowImpl = async ({ tvId }) => fakeTmdbShow(tvId);

await sonarrScanner.run();
await runWithMockTimers(sonarrScanner.run());

const updatedMedia = await mediaRepository.findOneOrFail({
where: { tmdbId: 2002 },
Expand Down
24 changes: 24 additions & 0 deletions server/test/runWithMockTimers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { mock } from 'node:test';

export async function runWithMockTimers<T>(
runPromise: Promise<T>,
tickMs = 4000
): Promise<T> {
Comment on lines +3 to +6

@fallenbagel fallenbagel Aug 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Takes an already-invoked Promise instead of a factory. Its fine as it is for now since setTimeout in loop() only fires after several awaits, but every call site falls back to real timers silently if that ever changes or accidentally forgets to add. runPromise: () => Promise<T>, and call it after enable()

mock.timers.enable({ apis: ['setTimeout'] });
try {
let settled = false;
runPromise
.catch(() => undefined)
.finally(() => {
settled = true;
});
let guard = 0;
while (!settled && guard++ < 100000) {
await new Promise((resolve) => setImmediate(resolve));
mock.timers.tick(tickMs);
}
return await runPromise;
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
Comment thread
michaelhthomas marked this conversation as resolved.
Outdated
} finally {
mock.timers.reset();
}
}