Skip to content

feat: add default 1 hour test run timeout #79

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

Merged
Patai5 merged 2 commits into from
Apr 15, 2026
Merged

feat: add default 1 hour test run timeout #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cd0d47
feat: add default 1 hour test run timeout
Patai5 Apr 14, 2026
6eca8c6
refactor: improve constant duration time readability
Patai5 Apr 15, 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
5 changes: 5 additions & 0 deletions lib/consts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,8 @@ export const TO_FINISH_WITH_OPTIONS: ToFinishWithOptionsWithDefaults = {
maxRetriesPerRequest: null,
forbiddenLogs: ['ReferenceError', 'TypeError'],
};

/**
* Both the test runs and the vitest test specs should finish in this time - 1 hour
*/
export const DEFAULT_TEST_RUN_DURATION_MS = 60 * 60 * 1000; // 1 hour
7 changes: 5 additions & 2 deletions lib/lib.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { ApifyClient } from 'apify-client';
import type { SuiteFactory, TestContext, TestFunction } from 'vitest';
import { describe as vitestDescribe, ExpectStatic, test as vitestTest } from 'vitest';

import { DEFAULT_TEST_RUN_DURATION_MS } from './consts.js';
import { extendExpect } from './extend-expect.js';
import { RunTestResult } from './run-test-result.js';
import type { ActorBuild, ActorTestOptions, RunOptions } from './types.js';
Expand Down Expand Up @@ -37,7 +38,7 @@ const DEFAULT_TEST_OPTIONS: ActorTestOptions = {
// we want to run tests concurrently
concurrent: true,
// test should finish within 1 hour
timeout: 60_000 * 60,
timeout: DEFAULT_TEST_RUN_DURATION_MS,
};

export const describe = (name: string, fn?: SuiteFactory<object>, options: ActorTestOptions = DEFAULT_TEST_OPTIONS) => {
Expand All @@ -46,6 +47,8 @@ export const describe = (name: string, fn?: SuiteFactory<object>, options: Actor

const DEFAULT_TEST_ACTOR_OPTIONS: ActorTestOptions = {
retry: 1,
// prevent orphaned runs
timeout: DEFAULT_TEST_RUN_DURATION_MS,
};

export const testActor = <T>(
Expand Down Expand Up @@ -124,7 +127,7 @@ export const testTestActor = <T>(
expect: extendExpect(expect),
// @ts-expect-error: this just to test custom matchers
// eslint-disable-next-line @typescript-eslint/no-empty-function
run: () => { },
run: () => {},
...rest,
});
});
Expand Down
9 changes: 8 additions & 1 deletion lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ export interface ActorMatchers<R = unknown> {
hard: <T>(actual: T, message?: string) => Assertion;
}

export type ActorTestOptions = Omit<TestOptions, 'retry'> & {
export type ActorTestOptions = Omit<TestOptions, 'retry' | 'timeout'> & {
/**
* Times to retry the test if fails. Useful for making flaky tests more stable.
* When retries is up, the last test error will be thrown.
Expand All @@ -137,6 +137,13 @@ export type ActorTestOptions = Omit<TestOptions, 'retry'> & {
*/
// we are just extending the docs here to replace the default value, otherwise it's the exact same
retry?: TestOptions['retry'];
/**
* Timeout for the actor run in milliseconds. Zero value means there is no timeout.
* - If `undefined`, the run uses timeout of the default Actor run configuration.
*
* @default 60 * 60 * 1000 // 1 hour
*/
timeout?: ActorCallOptions['timeout'];
};

declare module 'vitest' {
Expand Down
Loading