Skip to content

refactor: unify build orchestration flows and fix runBuilds dry-run output #126

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
ruocco-l merged 4 commits into from
Aug 24, 2026
Merged

refactor: unify build orchestration flows and fix runBuilds dry-run output #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd1af05
refactor runBuilds and runBuildsFromLocal
ruocco-l Aug 21, 2026
0a0de5c
clean import of source types and actor version
ruocco-l Aug 21, 2026
e05ee76
rename version number constants
ruocco-l Aug 24, 2026
2e96360
inline startActorBuild and startActorBuildFromLocal
ruocco-l Aug 24, 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
35 changes: 13 additions & 22 deletions bin/build-from-local.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ import fs from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';

import type { ActorVersionSourceFile } from 'apify-client';
import type { ActorVersion, ActorVersionSourceFile } from 'apify-client';
import { ActorSourceType } from 'apify-client';

import { ApifyBuilder, waitAndSummarizeBuilds } from './build.js';
import { dryRunBuildData, LOCAL_SOURCE_VERSION_NUMBER, runAndSummarizeBuilds } from './build.js';
import { buildDockerIgnoreMatcher } from './dockerignore.js';
import { isPathWithinScope } from './path-utils.js';
import type { ActorConfig, BuildData } from './types.js';
Expand Down Expand Up @@ -197,26 +198,16 @@ export const runBuildsFromLocal = async ({
for (const { actorFullName, folder } of actorConfigs) {
console.error(` ${actorFullName} (${folder})`);
}
return actorConfigs.map(({ actorFullName }) => ({
buildId: 'dry-run',
actorRawId: 'dry-run',
buildNumber: '0.98.0',
actorFullName,
}));
return actorConfigs.map(({ actorFullName }) => dryRunBuildData(actorFullName, LOCAL_SOURCE_VERSION_NUMBER));
}

console.error('=========================================');
console.error('STARTED LOCAL BUILDS:');
const buildersByActorFullName = new Map<string, ApifyBuilder>(
actorConfigs.map((actorConfig) => [actorConfig.actorFullName, ApifyBuilder.fromActorConfig(actorConfig)]),
);
const startedBuilds = await Promise.all(
actorConfigs.map(async ({ actorFullName, folder }) => {
const builder = buildersByActorFullName.get(actorFullName)!;
const sourceFiles = await collectSourceFiles(actorFullName, folder);
return builder.startActorBuildFromSourceFiles(sourceFiles);
}),
);

return waitAndSummarizeBuilds(startedBuilds, buildersByActorFullName, 'LOCAL BUILDS');
return runAndSummarizeBuilds(actorConfigs, 'LOCAL BUILDS', async (actorConfig, builder) => {
const sourceFiles = await collectSourceFiles(actorConfig.actorFullName, actorConfig.folder);
const actorVersion: ActorVersion = {
versionNumber: LOCAL_SOURCE_VERSION_NUMBER,
sourceFiles,
sourceType: ActorSourceType.SourceFiles,
};
return builder.createVersionAndBuild(LOCAL_SOURCE_VERSION_NUMBER, actorVersion, false);
});
};
136 changes: 66 additions & 70 deletions bin/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import type { ActorVersionSourceFile, Build } from 'apify-client';
import { ApifyClient } from 'apify-client';

import { ACTOR_SOURCE_TYPES } from '@apify/consts';
import type { ActorVersion, Build } from 'apify-client';
import { ActorSourceType, ApifyClient } from 'apify-client';

import type { ActorConfig, BuildData } from './types.js';

Expand All @@ -12,6 +10,11 @@ type BuildPrActorOptions = {
actorConfig: ActorConfig;
useDockerCache: boolean;
};

// Fixed version number used to build from local source files, since there is no real version to track.
export const LOCAL_SOURCE_VERSION_NUMBER = '0.98';
const DEFAULT_TEST_VERSION_NUMBER = '0.99';

@metalwarrior665 metalwarrior665 Aug 22, 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.

Since we are hoisting the version here, I would also move the 0.99 as TESTING_VERSION_NUM

export class ApifyBuilder {
private constructor(
private readonly apifyClient: ApifyClient,
Expand Down Expand Up @@ -57,12 +60,11 @@ export class ApifyBuilder {
return { defaultBuildNumber, defaultVersionNumber, defaultBuildTag };
};

startActorBuild = async ({
buildTag,
versionNumber,
gitRepoUrl,
useDockerCache,
}: BuildPrActorOptions): Promise<BuildData> => {
createVersionAndBuild = async (
versionNumber: string,
actorVersion: ActorVersion,
useCache: boolean,
): Promise<BuildData> => {
const actorClient = this.apifyClient.actor(this.actorFullName);
const actorInfo = await actorClient.get();
if (!actorInfo) {
Expand All @@ -73,17 +75,6 @@ export class ApifyBuilder {
);
}

// NOTE: I couldn't find this type, so I had to extract it :(
type ActorVersion = Parameters<ReturnType<typeof actorClient.version>['update']>[0];
const actorVersion: ActorVersion = {
buildTag,
versionNumber,
gitRepoUrl,
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore: coudn't find this type either :(
sourceType: ACTOR_SOURCE_TYPES.GIT_REPO,
};

// Prepare version
const versionExists = !actorInfo.versions.find((version) => version.versionNumber === versionNumber);
if (versionExists) {
Expand All @@ -95,45 +86,12 @@ export class ApifyBuilder {
}

// We also get back actId so the testing actor can both match by actor ID and name
const { id, actId, buildNumber } = await actorClient.build(versionNumber, { useCache: useDockerCache });
const { id, actId, buildNumber } = await actorClient.build(versionNumber, { useCache });

console.error(`[${this.actorFullName}]: ${id} (${buildNumber})`);
return { buildId: id, actorRawId: actId, buildNumber, actorFullName: this.actorFullName };
};

startActorBuildFromSourceFiles = async (sourceFiles: ActorVersionSourceFile[]): Promise<BuildData> => {
const ZIP_VERSION = '0.98';
const actorClient = this.apifyClient.actor(this.actorFullName);
const actorInfo = await actorClient.get();
if (!actorInfo) {
throw new Error(
`No actor named '${this.actorFullName}' was found on the platform. If this` +
' is unexpected, make sure the actor you are targeting is spelled the' +
' same as the folder in the repository.',
);
}

type ActorVersion = Parameters<ReturnType<typeof actorClient.version>['update']>[0];
const actorVersion: ActorVersion = {
versionNumber: ZIP_VERSION,
sourceFiles,
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore: couldn't find this type :(
sourceType: ACTOR_SOURCE_TYPES.SOURCE_FILES,
};

const versionExists = !actorInfo.versions.find((v) => v.versionNumber === ZIP_VERSION);
if (versionExists) {
await actorClient.versions().create(actorVersion);
} else {
await actorClient.version(ZIP_VERSION).update(actorVersion);
}

const { id, actId, buildNumber } = await actorClient.build(ZIP_VERSION, { useCache: false });
console.error(`[${this.actorFullName}]: ${id} (${buildNumber})`);
return { buildId: id, actorRawId: actId, buildNumber, actorFullName: this.actorFullName };
};

waitForBuildToFinish = async (buildId: string): Promise<Build> => {
const build = await this.apifyClient.build(buildId).waitForFinish();
const versionNumber = build.buildNumber;
Expand Down Expand Up @@ -281,6 +239,33 @@ export const waitAndSummarizeBuilds = async (
return startedBuilds;
};

export const runAndSummarizeBuilds = async (
actorConfigs: ActorConfig[],
label: string,
buildOneActor: (actorConfig: ActorConfig, builder: ApifyBuilder) => Promise<BuildData>,
): Promise<BuildData[]> => {
const buildersByActorFullName = new Map<string, ApifyBuilder>(
actorConfigs.map((actorConfig) => [actorConfig.actorFullName, ApifyBuilder.fromActorConfig(actorConfig)]),
);
console.error('=========================================');
console.error(`STARTED ${label}:`);
const startedBuilds = await Promise.all(
actorConfigs.map(async (actorConfig) =>
buildOneActor(actorConfig, buildersByActorFullName.get(actorConfig.actorFullName)!),
),
);

return waitAndSummarizeBuilds(startedBuilds, buildersByActorFullName, label);
};

// Placeholder BuildData for dry runs, since no real build was triggered.
export const dryRunBuildData = (actorFullName: string, versionNumber: string): BuildData => ({
buildId: 'dry-run',
actorRawId: 'dry-run',
buildNumber: versionNumber,
actorFullName,
});

type RunBuildsOptions = {
actorConfigs: ActorConfig[];
isLatest?: boolean;
Expand All @@ -297,7 +282,7 @@ export const runBuilds = async ({
isLatest = false,
dryRun,
useDockerCache,
}: RunBuildsOptions) => {
}: RunBuildsOptions): Promise<BuildData[]> => {
const buildConfigs: BuildPrActorOptions[] = [];

for (const actorConfig of actorConfigs) {
Expand All @@ -310,7 +295,7 @@ export const runBuilds = async ({
versionNumber = defaultVersionNumber;
buildTag = defaultBuildTag;
} else {
versionNumber = '0.99';
versionNumber = DEFAULT_TEST_VERSION_NUMBER;
}

// Depending on if these are miniactors or standaloneActors
Expand All @@ -322,23 +307,34 @@ export const runBuilds = async ({
}

if (dryRun) {
return buildConfigs;
console.error('[DRY RUN] Would build:');
for (const { actorConfig, versionNumber } of buildConfigs) {
console.error(` ${actorConfig.actorFullName} (${versionNumber})`);
}
return buildConfigs.map(({ actorConfig, versionNumber }) =>
dryRunBuildData(actorConfig.actorFullName, versionNumber),
);
}

const buildersByActorFullName = new Map<string, ApifyBuilder>(
actorConfigs.map((actorConfig) => [actorConfig.actorFullName, ApifyBuilder.fromActorConfig(actorConfig)]),
);
console.error('=========================================');
console.error('STARTED BUILDS:');
const startedBuilds = await Promise.all(
buildConfigs.map(async (buildConfig) => {
const builder = buildersByActorFullName.get(buildConfig.actorConfig.actorFullName)!;
const buildData = await builder.startActorBuild(buildConfig);
return buildData;
}),
const buildConfigsByActorFullName = new Map(
buildConfigs.map((buildConfig) => [buildConfig.actorConfig.actorFullName, buildConfig]),
);

return waitAndSummarizeBuilds(startedBuilds, buildersByActorFullName, 'BUILDS');
return runAndSummarizeBuilds(actorConfigs, 'BUILDS', async (actorConfig, builder) => {
const {
buildTag,
versionNumber,
gitRepoUrl,
useDockerCache: useCache,
} = buildConfigsByActorFullName.get(actorConfig.actorFullName)!;
const actorVersion: ActorVersion = {
buildTag,
versionNumber,
gitRepoUrl,
sourceType: ActorSourceType.GitRepo,
};
return builder.createVersionAndBuild(versionNumber, actorVersion, useCache);
});
};

export const deleteOldBuilds = async (actorConfigs: ActorConfig[]) => {
Expand Down
Loading