import apify from "../../apify.app.mjs";
import { parseObject } from "../../common/utils.mjs";
import { WEBHOOK_EVENT_TYPES } from "@apify/consts";
export default {
key: "apify-run-actor",
name: "Run Actor",
description: "Performs an execution of a selected Actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)",
version: "0.0.6",
annotations: {
destructiveHint: false,
openWorldHint: true,
readOnlyHint: false,
},
type: "action",
props: {
apify,
actorSource: {
type: "string",
label: "Search Actors from",
description: "Where to search for Actors. Valid options are Store and Recently used Actors.",
options: [
{
label: "Apify Store Actors",
value: "store",
},
{
label: "Recently used Actors",
value: "recently-used",
},
],
reloadProps: true,
default: "recently-used",
},
actorId: {
propDefinition: [
apify,
"actorId",
(c) => ({
actorSource: c.actorSource,
}),
],
reloadProps: true,
},
buildTag: {
propDefinition: [
apify,
"buildTag",
(c) => ({
actorId: c.actorId,
}),
],
reloadProps: true,
optional: true,
},
runAsynchronously: {
type: "boolean",
label: "Run Asynchronously",
description: "Set to `true` to run the Actor asynchronously",
reloadProps: true,
default: true,
},
timeout: {
type: "string",
label: "Timeout (seconds)",
description: "Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.",
optional: true,
},
memory: {
type: "string",
label: "Memory (MB)",
description: "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.",
optional: true,
},
maxItems: {
type: "string",
label: "Max Items",
description: "The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.",
optional: true,
},
maxTotalChargeUsd: {
type: "string",
label: "Max Total Charge USD",
description: "Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.",
optional: true,
},
webhook: {
type: "string",
label: "Webhook URL",
description: "Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.",
optional: true,
reloadProps: true,
},
},
methods: {
getType(type) {
return [
"string",
"object",
"integer",
"boolean",
].includes(type)
? type
: "string[]";
},
async getSchema(actorId, buildTag) {
const build = await this.apify.getBuild(actorId, buildTag);
if (!build) {
throw new Error(`No build found for actor ${actorId}`);
}
if (build.actorDefinition && build.actorDefinition.input) {
return build.actorDefinition.input;
}
if (build.inputSchema) {
try {
return typeof build.inputSchema === "string"
? JSON.parse(build.inputSchema)
: build.inputSchema;
} catch (err) {
throw new Error(
`Failed to parse inputSchema for actor ${actorId}: ${err.message}`,
);
}
}
throw new Error(
`No input schema found for actor ${actorId}. Has it been built successfully?`,
);
},
async prepareData(data) {
const newData = {};
const { properties } = await this.getSchema(this.actorId, this.buildTag);
for (const [
key,
value,
] of Object.entries(data)) {
const editor = properties[key]?.editor || "hidden";
newData[key] = Array.isArray(value)
? value.map((item) => this.setValue(editor, item))
: value;
}
return newData;
},
prepareOptions(value) {
if (value.enum && value.enumTitles) {
return value.enum.map((val, i) => ({
value: val,
label: value.enumTitles[i],
}));
}
},
setValue(editor, item) {
switch (editor) {
case "requestListSources":
return {
url: item,
};
case "pseudoUrls":
return {
purl: item,
};
case "globs":
return {
glob: item,
};
default:
return item;
}
},
},
async additionalProps() {
const props = {};
try {
const schema = await this.getSchema(this.actorId, this.buildTag);
const {
properties, required: requiredProps = [],
} = schema;
for (const [
key,
value,
] of Object.entries(properties)) {
if (value.editor === "hidden") continue;
props[key] = {
type: this.getType(value.type),
label: value.title,
description: value.description,
optional: !requiredProps.includes(key),
};
if (props[key].type === "string" && value.isSecret) {
props[key].secret = value.isSecret;
} else if (props[key].type === "integer") {
props[key].min = value.minimum;
props[key].max = value.maximum;
if (value.unit) {
props[key].description += ` Unit: ${value.unit}.`;
}
} else if (props[key].type === "boolean") {
props[key].default = false;
}
const options = this.prepareOptions(value);
if (options) props[key].options = options;
const defaultValue = value.prefill ?? value.default;
if (defaultValue !== undefined) {
if (props[key].type !== "object") {
props[key].default = defaultValue;
if (props[key].type === "string[]" && value.editor === "requestListSources") {
props[key].default = defaultValue.map((request) => request.url);
}
}
props[key].description += ` Default: \`${JSON.stringify(defaultValue)}\``;
}
}
} catch (e) {
props.properties = {
type: "object",
label: "Properties",
description: e.message || "Schema not available, showing fallback.",
};
}
if (!this.runAsynchronously) {
props.outputRecordKey = {
type: "string",
label: "Output Record Key",
description:
"Key of the record from the run's default key-value store to return. Default is `OUTPUT`.",
optional: true,
default: "OUTPUT",
};
}
if (this.webhook) {
props.eventTypes = {
type: "string[]",
label: "Event Types",
description: "The types of events to send to the webhook",
options: Object.values(WEBHOOK_EVENT_TYPES),
};
}
return props;
},
async run({ $ }) {
const {
apify,
actorId,
buildTag,
runAsynchronously,
outputRecordKey,
timeout,
memory,
maxItems,
maxTotalChargeUsd,
webhook,
eventTypes,
...data
} = this;
const actorDetails = await apify.getActor({
actorId,
});
if (!actorDetails) {
throw new Error(`Actor with ID "${actorId}" does not exist.`);
}
if (!actorDetails.stats?.totalBuilds || actorDetails.stats.totalBuilds === 0) {
throw new Error(
`Actor "${actorDetails.title || actorDetails.name}" has no builds. Please build it first before running.`,
);
}
if (buildTag) {
const taggedBuilds = actorDetails.taggedBuilds || {};
if (!taggedBuilds[buildTag]) {
throw new Error(
`Build with tag "${buildTag}" was not found for actor "${actorDetails.title || actorDetails.name}".`,
);
}
}
const rawInput = this.properties
? parseObject(this.properties)
: data;
const input = await this.prepareData(rawInput);
const params = {
...(buildTag && {
build: buildTag,
}),
...(timeout && {
timeout: Number(timeout),
}),
...(memory && {
memory: Number(memory),
}),
...(maxItems && {
maxItems: Number(maxItems),
}),
...(maxTotalChargeUsd && {
maxTotalChargeUsd: Number(maxTotalChargeUsd),
}),
...(webhook && {
webhooks: [
{
eventTypes,
requestUrl: webhook,
},
],
}),
};
let run;
if (runAsynchronously) {
run = await apify.runActorAsynchronously({
actorId,
data: input,
params,
});
$.export("$summary", `Successfully started Actor run with ID: ${run.id}`);
return run;
} else {
run = await apify.runActor({
actorId,
input,
options: params,
});
let output;
if (run.defaultKeyValueStoreId) {
const record = await apify
._client()
.keyValueStore(run.defaultKeyValueStoreId)
.getRecord(outputRecordKey);
output = record?.value;
}
$.export(
"$summary",
`The run of an Actor with ID: ${actorId} has finished with status "${run.status}".`,
);
return {
run,
output,
};
}
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.
