feat(cli): add wait commands and enhance agentic output for builds and runs by l2ysho · Pull Request #1168 · apify/apify-cli

l2ysho · 2026-05-29T11:10:12Z

Introduces dedicated wait commands and unifies output for several build/run commands for better CI/CD integration.

…d runs Introduces dedicated `wait` commands and unifies output for several build/run commands for better CI/CD integration.

l2ysho · 2026-05-29T11:22:58Z

lets wait for #1134

The earlier change made `apify push` exit non-zero whenever the build had not reached SUCCEEDED, including non-terminal RUNNING/READY states. That broke the E2E lifecycle tests and any CI that treats a successful upload + in-progress build as a successful push. Only treat a terminal, non-SUCCEEDED status as a push failure.

…-agentic-workflows

waitForTerminalStatus overwrote a still-RUNNING job's status with a synthetic TIMED-OUT when the client-side --timeout elapsed, so an agent consuming the JSON could not tell "I gave up waiting" from "the platform job timed out" (both reported TIMED-OUT, exit 2). It now returns { job, timedOutWaiting } with the real platform status, and the wait commands map a give-up to a distinct WaitTimedOut (6) exit code, a timedOutWaiting JSON field, and give-up-specific messaging. The exit-code mapping lives in a shared exitCodeForWaitResult helper. Also drop the unused consoleActorUrl/consoleKeyValueStoreUrl exports. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

…output-for-agentic-workflows' into 1135-improve-apify-cli-buildrun-output-for-agentic-workflows

Co-authored-by: Edyta <142720610+szaganek@users.noreply.github.com>

…-agentic-workflows

…output-for-agentic-workflows' into 1135-improve-apify-cli-buildrun-output-for-agentic-workflows

…-agentic-workflows

DaveHanns

Overall great job 🚀
Few nits and suggestions tho.

DaveHanns · 2026-06-25T19:41:09Z

+	timedOutWaiting: boolean;
+}
+
+export async function waitForTerminalStatus(options: WaitForJobOptions): Promise<WaitForJobResult> {


Nit: this would deserve unit test.

Addressed in 5f7a180

DaveHanns · 2026-06-25T19:41:09Z

+	return !!status && TERMINAL_STATUSES.has(status);
+}
+
+export function exitCodeForJobStatus(status: string | undefined, kind: 'build' | 'run'): number {


Suggestion: instead of hardcoding status string literals ('TIMED-OUT', 'ABORTING', …), the ACTOR_JOB_STATUSES should be used, e.g.: ACTOR_JOB_STATUSES.TIMED_OUT, ...

Addressed in 3124ca0

DaveHanns · 2026-06-25T19:41:09Z

+
+export interface ResultSummaryOptions {
+	resultLabel: string; // e.g. "Apify push result"
+	overallStatus: 'SUCCEEDED' | 'FAILED' | 'ABORTED' | 'TIMED-OUT' | 'RUNNING';


Suggestion: These should not be hardcoded, but derived from @apify/consts.

Besides that having the overallStatus as subset of all possible job statuses is not really much effective here as all its callers cast the job.status as never to fit even if they do not fit. For instance, overallStatus: run.status as never, in runs/wait.ts where

(property) ActorRunListItem.status: "READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "ABORTING" | "ABORTED" | "TIMING-OUT" | "TIMED-OUT"

Addressed in 0dbdf53

DaveHanns · 2026-06-25T20:27:54Z

+
+const TERMINAL_STATUSES = new Set<string>(ACTOR_JOB_TERMINAL_STATUSES as readonly string[]);
+
+export function isTerminalStatus(status: string | undefined): status is TerminalStatus {


Nit: this feels like over-optimization. For a 4-element array, the dedicated TERMINAL_STATUSES Set (and the as readonly string[] cast) isn't worth it. ACTOR_JOB_TERMINAL_STATUSES.includes(...) should be good enough.

Addressed in f21d0ab

DaveHanns · 2026-06-25T20:27:55Z

+	return !!status && TERMINAL_STATUSES.has(status);
+}
+
+export function exitCodeForJobStatus(status: string | undefined, kind: 'build' | 'run'): number {


Here and through the rest of the file, status: string and kind: 'build' | 'run' are stringly-typed. Suggest deriving two named types and using them throughout instead:

type JobStatus = (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES]; type JobType = (typeof ACTOR_JOB_TYPES)[keyof typeof ACTOR_JOB_TYPES];

then use JobStatus for the status parameters and JobType for kind across exitCodeForJobStatus, isTerminalStatus, etc.

Addressed in a71de07

DaveHanns · 2026-06-25T20:29:51Z

+	}
+}
+
+export async function fetchLogTail(apifyClient: ApifyClient, jobId: string, maxLines = 20): Promise<string[]> {


Suggestion: fetchLogTail is generally useful and overlaps with the output improvements in the sibling agentic-output PRs (e.g. #1198). Once these land, this should be the single shared implementation they all import, rather than each PR re-implementing it.

Addressed in 28f73f0

DaveHanns · 2026-06-25T20:35:37Z

+		const refreshedBuild = await apifyClient.build(build.id).get();
+		if (!refreshedBuild) {
+			error({ message: `Could not fetch build with ID "${build.id}" after deployment.` });
+			process.exitCode = CommandExitCodes.BuildFailed;
+			return;
+		}
+		build = refreshedBuild;


Nit: the intermediate refreshedBuild isn't needed, since the !refreshedBuild branch returns, you can null-check and assign to build directly without the extra variable.

Suggested change

const refreshedBuild = await apifyClient.build(build.id).get();

if (!refreshedBuild) {

error({ message: `Could not fetch build with ID "${build.id}" after deployment.` });

process.exitCode = CommandExitCodes.BuildFailed;

return;

}

build = refreshedBuild;

build = await apifyClient.build(build.id).get();

if (!build) {

error({ message: `Could not fetch build with ID "${build.id}" after deployment.` });

process.exitCode = CommandExitCodes.BuildFailed;

return;

}

Addressed in 2e31e4d

DaveHanns · 2026-06-25T20:39:02Z

+			const refreshed = await client.build(build.id).get();
+			if (!refreshed) {
+				error({ message: `Could not refresh build status for build "${build.id}".` });
+				process.exitCode = 1;
+				return;
+			}
+			build = refreshed;


Nit: same as the refreshedBuild case in push.ts, the intermediate refreshed isn't needed; since the !refreshed branch returns, null-check and assign to build directly.

Suggested change

const refreshed = await client.build(build.id).get();

if (!refreshed) {

error({ message: `Could not refresh build status for build "${build.id}".` });

process.exitCode = 1;

return;

}

build = refreshed;

build = await client.build(build.id).get();

if (!build) {

error({ message: `Could not refresh build status for build "${build.id}".` });

process.exitCode = 1;

return;

}

The refreshed intermediate no longer exists on master — this block was replaced by waitForTerminalStatus in a later revision of the PR.

DaveHanns · 2026-06-26T06:03:26Z

+				? ((await apifyClient.build(jobId).get()) as Build | undefined)
+				: ((await apifyClient.run(jobId).get()) as ActorRun | undefined);


Suggestion: the casting on both of these lines is unnecessary. The get already returns correct type.

In general, I have noticed that Claude loves to solve every tiny TS issue with casting. We could probably fight that with stricter linting 🤔

Addressed in 3664c00

…d runs (#1168) Introduces dedicated `wait` commands and unifies output for several build/run commands for better CI/CD integration. closes #1140 --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: Edyta <142720610+szaganek@users.noreply.github.com>

The review asked that --silent gate the --json branch in call. That is already handled by finalizeRun (silent returns before json), but the existing silent test used json: false. Add a case with both set to lock that silent wins over json and nothing is printed. Ref: #1168 (comment)

These are missing findings from #1168. Releasing as chore to skip release notes and changelog.

Resolves #1168 (comment)

fetchRunLogTail keeps its succeeded-run guard and 10-line tail but delegates the fetch/split/slice to the shared fetchLogTail, which now also trims trailing whitespace. Resolves #1168 (comment)

Resolves #1168 (comment)

Add consoleActorUrl and consoleKeyValueStoreUrl, use the builders in start/call/run-result/runs info/builds info instead of inlined URLs, and standardize build URLs on the /builds/ path format. Resolves #1168 (comment)

Add a generic overload mapping kind to Build/ActorRun so callers no longer cast the returned job. Resolves #1168 (comment) Resolves #1168 (comment) Resolves #1168 (comment)

Resolves #1168 (comment)

feat(cli): add wait commands and enhance agentic output for builds an…

10f311b

…d runs Introduces dedicated `wait` commands and unifies output for several build/run commands for better CI/CD integration.

l2ysho self-assigned this May 29, 2026

l2ysho added the t-builders Issues owned by the Builders team. label May 29, 2026

l2ysho linked an issue May 29, 2026 that may be closed by this pull request

Improve Apify CLI build/run output for agentic workflows #1135

Open

github-actions Bot added this to the 141st sprint - Tooling team milestone May 29, 2026

DaveHanns removed a link to an issue Jun 10, 2026

Improve Apify CLI build/run output for agentic workflows #1135

Open

l2ysho and others added 3 commits June 10, 2026 16:07

Merge branch 'master' into 1135-improve-apify-cli-buildrun-output-for…

d2d7038

…-agentic-workflows

Merge remote-tracking branch 'origin/1135-improve-apify-cli-buildrun-…

3e0ce2d

…output-for-agentic-workflows' into 1135-improve-apify-cli-buildrun-output-for-agentic-workflows

l2ysho marked this pull request as ready for review June 15, 2026 12:15

l2ysho requested review from szaganek and vladfrangu as code owners June 15, 2026 12:15

l2ysho requested review from DaveHanns and patrikbraborec June 15, 2026 12:15

l2ysho modified the milestones: 141st sprint - Tooling team, 143rd sprint - DX team Jun 16, 2026

szaganek approved these changes Jun 16, 2026

View reviewed changes

Comment thread src/commands/builds/wait.ts Outdated

Comment thread src/commands/builds/wait.ts Outdated

Comment thread docs/reference.md Outdated

l2ysho and others added 8 commits June 22, 2026 13:16

Update src/commands/builds/wait.ts

ff41d46

Co-authored-by: Edyta <142720610+szaganek@users.noreply.github.com>

Update src/commands/builds/wait.ts

be2eaa1

Co-authored-by: Edyta <142720610+szaganek@users.noreply.github.com>

Merge branch 'master' into 1135-improve-apify-cli-buildrun-output-for…

828bcd2

…-agentic-workflows

style(docs): add period to json flag descriptions

90d1756

Merge remote-tracking branch 'origin/1135-improve-apify-cli-buildrun-…

fd3b4fa

…output-for-agentic-workflows' into 1135-improve-apify-cli-buildrun-output-for-agentic-workflows

Merge branch 'master' into 1135-improve-apify-cli-buildrun-output-for…

3aede70

…-agentic-workflows

fix tests

8c87837

fix order

5d57004

l2ysho mentioned this pull request Jun 25, 2026

feat(call): emit explicit final run status and JSON output (#1139) #1198

Merged

DaveHanns reviewed Jun 25, 2026

View reviewed changes

Comment thread src/lib/consts.ts

Merge branch 'master' into 1135-improve-apify-cli-buildrun-output-for…

a56dba6

…-agentic-workflows

l2ysho merged commit d3c3e5b into master Jun 25, 2026
24 checks passed

l2ysho deleted the 1135-improve-apify-cli-buildrun-output-for-agentic-workflows branch June 25, 2026 18:40

DaveHanns reviewed Jun 25, 2026

View reviewed changes

DaveHanns reviewed Jun 26, 2026

View reviewed changes

l2ysho mentioned this pull request Jun 30, 2026

1140 followup review fixes #1241

Merged

l2ysho added a commit that referenced this pull request Jul 1, 2026

chore: address missed reviews

d68fbe8

These are missing findings from #1168. Releasing as chore to skip release notes and changelog.

l2ysho added a commit that referenced this pull request Jul 8, 2026

refactor(cli): drop redundant casts on build/run get results

3664c00

Resolves #1168 (comment)

l2ysho added a commit that referenced this pull request Jul 8, 2026

refactor(cli): widen overallStatus to JobStatus, drop as-never casts

0dbdf53

Resolves #1168 (comment)

l2ysho added a commit that referenced this pull request Jul 8, 2026

refactor(cli): drop refreshedBuild intermediate in actors push

2e31e4d

Resolves #1168 (comment)

l2ysho mentioned this pull request Jul 8, 2026

1140 followup review fixes 2 #1268

Open


		const TERMINAL_STATUSES = new Set<string>(ACTOR_JOB_TERMINAL_STATUSES as readonly string[]);

		export function isTerminalStatus(status: string \| undefined): status is TerminalStatus {

		? ((await apifyClient.build(jobId).get()) as Build \| undefined)
		: ((await apifyClient.run(jobId).get()) as ActorRun \| undefined);

Uh oh!

Conversation

l2ysho commented May 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

l2ysho commented May 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaveHanns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

l2ysho commented May 29, 2026 •

edited

Loading