Actor Build Starter

fjvs0283/actor-batch-builder

No credit card required

Run builds for multiple actors in your account simultaneously. This can be useful when many actors in a given project have been updated. For example, the documentation might have been updated in 50 actors. This tool will help you trigger actor builds for all 50 at once.

.editorconfig

root = true

[*]
indent_style = space
indent_size = 4
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf

.eslintrc

{
    "extends": "@apify"
}

.gitignore

# This file tells Git which files shouldn't be added to source control

.idea
node_modules

apify_storage

Dockerfile

# First, specify the base Docker image. You can read more about
# the available images at https://sdk.apify.com/docs/guides/docker-images
# You can also use any other image from Docker Hub.
FROM apify/actor-node:16

# Second, copy just package.json and package-lock.json since it should be
# the only file that affects "npm install" in the next step, to speed up the build
COPY package*.json ./

# Install NPM packages, skip optional and development dependencies to
# keep the image small. Avoid logging too much and print the dependency
# tree for debugging
RUN npm --quiet set progress=false \
 && npm install --only=prod --no-optional \
 && echo "Installed NPM packages:" \
 && (npm list --all || true) \
 && echo "Node.js version:" \
 && node --version \
 && echo "NPM version:" \
 && npm --version

# Next, copy the remaining files and directories with the source code.
# Since we do this after NPM install, quick build will be really fast
# for most source file changes.
COPY . ./

# Optionally, specify how to launch the source code of your actor.
# By default, Apify's base Docker images define the CMD instruction
# that runs the Node.js source code using the command specified
# in the "scripts.start" section of the package.json file.
# In short, the instruction looks something like this:
#
# CMD npm start

INPUT_SCHEMA.json

{
    "title": "PuppeteerCrawler Template",
    "type": "object",
    "schemaVersion": 1,
    "properties": {
        "batchType": {
            "title": "Batch Mode",
            "description": "Choose how to identify the target actors to batch process. You can target actors that contain specific text as part of the actor name, target actors by their id, or target all actors in your account.",
            "type": "string",
            "editor": "select",
            "enum": [
                "actorNameContains",
                "actorIds",
                "all"
            ],
            "enumTitles": [
                "Actor name contains",
                "Actor IDs",
                "All actors"
            ],
            "default": "actorNameContains"
        },
        "actorNameContains": {
            "title": "Actor Name Contains",
            "type": "string",
            "description": "Text included in names of target actors.",
            "editor": "textfield",
            "prefill": "my-awesome"
        },
        "actorIds": {
            "title": "Actor IDs",
            "type": "array",
            "description": "Enter the ids of the target actors.",
            "prefill": [
                "abc123",
                "abc123"
            ],
            "editor": "json"
        }
    }
}

apify.json

{
	"name": "actor-batch-builder",
	"version": "0.0",
	"buildTag": "latest",
	"env": null,
	"template": "project_empty"
}

main.js

import Apify from 'apify';

const { utils: { log, sleep } } = Apify;

Apify.main(async () => {

    const client = Apify.newClient();
    const { items: actors } = await client.actors().list();
    const { batchType, actorNameContains, actorIds } = await Apify.getInput();

    let batchTypeDescription = "";
    let targetActors = [];
    let actorCount = 0;
    let totalBuildsFinished = 0;
    let requestsCount = 0;

    let results = {
        "builds": [],
        "stats": {
            "total": 0,
            "failed": 0,
            "succeeded": 0,
            "requests": 0
        }
    };


    async function prepTargetActors() {
        for (const item in actors) {
            if (batchType == "actorNameContains" && actors[item].name.includes(actorNameContains)) {
                targetActors.push(actors[item]);
                batchTypeDescription = "matching part of the actor name.";
            }
            else if (batchType == "actorIds" && actorIds.includes(actors[item].id)) {
                targetActors.push(actors[item]);
                batchTypeDescription = "matching selected actor ids.";
            }
            else if (batchType == "all") {
                targetActors.push(actors[item]);
                batchTypeDescription = "for all actors in the account.";
            }
        }
        log.info(`Starting builds ${batchTypeDescription}`);
        log.info('–––––––––––––––––––––––––––––––––––––––––');
    }


    async function buildActors(targetActors) {
        let actorsInProgress = [];
        for (const item in targetActors) {
            actorCount++;
            await sleep(1000);
            const { id: actorId, name: actorName } = targetActors[item];
            const actor = client.actor(actorId);

            try {
                const startBuild = await actor.build('0.0');
                requestsCount++;

                log.info(`${actorCount}.`);
                log.info(`actor name: ${actorName}`);
                log.info(`build id:   ${startBuild.id}`);
                log.info(`started at: ${startBuild.startedAt}`);
                log.info(`status:     ${startBuild.status}`);
                log.info('–––––––––––––––––––––––––––––––––––––––––');

                actorsInProgress.push(targetActors[item]);

            } catch (error) {
                actorCount--;

                log.warning(`skipping actor ${actorName} due to ${error.type}.`);
                log.warning(`actor id: ${actorId}`);
                log.info('–––––––––––––––––––––––––––––––––––––––––');
            }
        }
        log.info(`builds started for ${actorCount} actors.`);
        log.info('waiting for builds to finish...');
        log.info('–––––––––––––––––––––––––––––––––––––––––');

        return actorsInProgress;
    };


    async function checkBuilds(targetActor) {
        const actor = client.actor(targetActor.id);
        const { id: actorId, name: actorName, buildtag: actorBuildTag } = await actor.get();
        requestsCount++;

        let buildFinshed = false;
        while (!buildFinshed) {
            await sleep(delay);
            requestsCount++;
            const { items: actorBuilds } = await actor.builds().list({ 'desc': true });
            const buildInProgress = actorBuilds[0];

            let result = { ...buildInProgress, actorId, actorName, actorBuildTag };

            if (buildInProgress.status == 'RUNNING') {
                buildFinshed = false;

            } else if (buildInProgress.status == 'SUCCEEDED') {
                results.stats.total++;
                results.stats.succeeded++;

                buildFinshed = true;
                totalBuildsFinished++;
                results.builds.push(result);

                log.info(`${totalBuildsFinished} of ${actorCount}`);
                log.info(`actor name:  ${actorName}`);
                log.info(`finished at: ${buildInProgress.finishedAt}`);
                log.info(`status:      ${buildInProgress.status}`);
                log.info('–––––––––––––––––––––––––––––––––––––––––');

            } else if (buildInProgress.status == 'FAILED') {
                results.stats.total++;
                results.stats.failed++;

                buildFinshed = true;
                totalBuildsFinished++;
                results.builds.push(result);

                log.info(`${totalBuildsFinished} of ${actorCount}`);
                log.error(`actor name:  ${actorName}`);
                log.error(`finished at: ${buildInProgress.finishedAt}`);
                log.error(`status:      ${buildInProgress.status}`);
                log.info('–––––––––––––––––––––––––––––––––––––––––');
            }
        }
    }

    async function startChecks(actorsInProgress) {
        for (const item in actorsInProgress) {
            checkBuilds(actorsInProgress[item]);
        }
        while (totalBuildsFinished != actorsInProgress.length) {
            await sleep(delay);
        }
        results.stats.requests = requestsCount;
    }


    await prepTargetActors();
    let actorsInProgress = await buildActors(targetActors.slice(0));
    let delay = (actorCount > 0) ? 10000 : 0;
    await sleep(delay);
    await startChecks(actorsInProgress);

    log.info('Done.');
    log.info(`total builds requested:  ${results.stats.total}`);
    log.info(`total builds successful: ${results.stats.succeeded}`);
    log.info(`total builds failed:     ${results.stats.failed}`);
    log.info(`total API calls:         ${results.stats.requests}`);

    const store = await Apify.openKeyValueStore();
    await store.setValue('STATS', results.stats);
    await Apify.pushData(results.builds);
});

package.json

{
	"name": "actor-batch-builder",
	"version": "0.0.1",
	"type": "module",
	"description": "This is a boilerplate of an Apify actor.",
	"dependencies": {
		"apify": "^2.0.7"
	},
	"devDependencies": {
		"@apify/eslint-config": "^0.1.3",
		"eslint": "^7.0.0"
	},
	"scripts": {
		"start": "node main.js",
		"lint": "./node_modules/.bin/eslint ./src --ext .js,.jsx",
		"lint:fix": "./node_modules/.bin/eslint ./src --ext .js,.jsx --fix",
		"test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
	},
	"author": "It's not you it's me",
	"license": "ISC"
}