Skip to content

feat(actors): enables standby mode via actor.json #991

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
l2ysho merged 10 commits into from
Jan 28, 2026
Merged

feat(actors): enables standby mode via actor.json #991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bcb8702
feat(actors): enables standby mode via actor.json
l2ysho Jan 13, 2026
98e9f79
chore(actors): fix tests and remove unused type
l2ysho Jan 13, 2026
ffbf2f9
chore(tests): fix path in tests
l2ysho Jan 13, 2026
dd47acb
Ffx(actors): corrects standby mode behavior
l2ysho Jan 15, 2026
3b686b1
refactor: remove defaults for standBy
l2ysho Jan 27, 2026
b1ac83e
Merge branch 'master' into 913-actorjson-option-usesstandbymode-does-…
l2ysho Jan 27, 2026
f97a2e4
chore: updates apify-client to v2.22.0
l2ysho Jan 27, 2026
62da62e
Merge branch 'master' into 913-actorjson-option-usesstandbymode-does-…
l2ysho Jan 27, 2026
46c4310
Merge branch 'master' into 913-actorjson-option-usesstandbymode-does-…
l2ysho Jan 28, 2026
dcc824d
Chore: updates apify-client dependency
l2ysho Jan 28, 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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"@skyra/jaro-winkler": "^1.1.1",
"adm-zip": "~0.5.15",
"ajv": "~8.17.1",
"apify-client": "~2.22.0",
"apify-client": "^2.22.0",
"archiver": "~7.0.1",
"axios": "^1.11.0",
"chalk": "~5.6.0",
Expand Down
6 changes: 6 additions & 0 deletions src/commands/actors/push.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,12 @@ export class ActorsPushCommand extends ApifyCommand<typeof ActorsPushCommand> {
},
],
};

// Enable standby mode if configured in actor.json
if (actorConfig!.usesStandbyMode) {
newActor.actorStandby = { isEnabled: true };
}
Comment on lines +202 to +205
Copy link
Member

@vladfrangu vladfrangu Jan 27, 2026

Choose a reason for hiding this comment

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

Just calling out, not blocking: This will only enable standby on new actors, and it will NOT propagate to existing ones (say if you migrate from ??? -> standby, or vice versa)

Maybe this is something we want to do? @B4nan Or should it be a different command, like actors edit?

Copy link
Member

@B4nan B4nan Jan 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Hmm, good point, no strong opinions, I wouldn't add a new command for that (we don't have actors edit, or do we?)

(I wouldn't block the PR on that, it can happen in a future one, or even never if nobody really asks for it)

Copy link
Contributor

@janbuchar janbuchar Jan 27, 2026

Choose a reason for hiding this comment

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

I mean, there are other cases already where changing something in the actor.json file for an existing Actor doesn't change the "platform-side version" of the Actor, so... Ostrich algorithm?

Copy link
Member

@B4nan B4nan Jan 27, 2026

Choose a reason for hiding this comment

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

Yeah agreed, lets leave that for later never.


actor = await apifyClient.actors().create(newActor);
actorId = actor.id;
isActorCreatedNow = true;
Expand Down
73 changes: 72 additions & 1 deletion test/api/commands/push.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,6 @@ describe('[api] apify push', () => {
await testRunCommand(ActorsPushCommand, { args_actorId: testActor.id, flags_noPrompt: true });

testActor = (await testActorClient.get())!;

if (testActor) await testActorClient.delete();

// Title and description should be preserved from the original actor
Expand All @@ -372,6 +371,78 @@ describe('[api] apify push', () => {
TEST_TIMEOUT,
);

it(
'should enable standby mode when usesStandbyMode is true in actor.json',
async () => {
const actorJson = JSON.parse(readFileSync(joinPath(LOCAL_CONFIG_PATH), 'utf8'));

actorJson.name = `${actorJson.name}-standBy-test`;
actorJson.usesStandbyMode = true;

writeFileSync(joinPath(LOCAL_CONFIG_PATH), JSON.stringify(actorJson, null, '\t'), { flag: 'w' });

await testRunCommand(ActorsPushCommand, { flags_noPrompt: true, flags_force: true });

const userInfo = await getLocalUserInfo();
const actorId = `${userInfo.username}/${actorJson.name}`;
actorsForCleanup.add(actorId);
const createdActorClient = testUserClient.actor(actorId);
const createdActor = await createdActorClient.get();

// Verify all standby options are set to default values
expect(createdActor?.actorStandby).to.be.eql({
isEnabled: true,
disableStandbyFieldsOverride: false,
maxRequestsPerActorRun: 4,
desiredRequestsPerActorRun: 3,
idleTimeoutSecs: 300,
build: 'latest',
memoryMbytes: 1024,
shouldPassActorInput: false,
});

if (createdActor) await createdActorClient.delete();
},
TEST_TIMEOUT,
);

it(
'should not enable standby mode on existing actor when usesStandbyMode is true in actor.json',
async () => {
// Create an actor without standby mode first
const testActorWithTitleDesc = {
...TEST_ACTOR,
name: `${TEST_ACTOR.name}-standBy-rewrite-test`,
};
const testActor = await testUserClient.actors().create(testActorWithTitleDesc);
actorsForCleanup.add(testActor.id);
const testActorClient = testUserClient.actor(testActor.id);

// Verify standby is not enabled initially
const initialActor = await testActorClient.get();
expect(initialActor?.actorStandby?.isEnabled).to.not.be.eql(true);

// Enable standby
const actorJson = JSON.parse(readFileSync(joinPath(LOCAL_CONFIG_PATH), 'utf8'));
actorJson.usesStandbyMode = true;
writeFileSync(joinPath(LOCAL_CONFIG_PATH), JSON.stringify(actorJson, null, '\t'), { flag: 'w' });

// Push to existing actor - this should update standby mode
await testRunCommand(ActorsPushCommand, {
args_actorId: testActor.id,
flags_noPrompt: true,
flags_force: true,
});

const updatedActor = await testActorClient.get();

// Verify standby is not enabled after push
expect(updatedActor?.actorStandby?.isEnabled).to.not.be.eql(true);
if (updatedActor) await testActorClient.delete();
},
TEST_TIMEOUT,
);

it(
'should not push Actor when there are no files to push',
async () => {
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2300,7 +2300,7 @@ __metadata:
adm-zip: "npm:~0.5.15"
ajv: "npm:~8.17.1"
apify: "npm:^3.2.4"
apify-client: "npm:~2.22.0"
apify-client: "npm:^2.22.0"
archiver: "npm:~7.0.1"
axios: "npm:^1.11.0"
chalk: "npm:~5.6.0"
Expand Down Expand Up @@ -2368,7 +2368,7 @@ __metadata:
languageName: node
linkType: hard

"apify-client@npm:~2.22.0":
"apify-client@npm:^2.22.0":
version: 2.22.0
resolution: "apify-client@npm:2.22.0"
dependencies:
Expand Down