Compare Arrays with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Helper Functions, Pipedream and 1400+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Compare Arrays with the Helper Functions API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream trigger and Helper Functions action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Compare Arrays action
1. Connect your Helper Functions account
2. Configure Array 1
3. Configure Array 2
4. Select a Compare Action
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

Enter the API key from your Pipedream Account Settings

About Pipedream#

Integration platform for developers

Action#

Compare Arrays on Helper Functions

Description:Get the difference, intersection, union, or symetric difference of two arrays/sets.

Version:0.0.1

Key:helper_functions-compare-arrays

View on GitHub

Helper Functions Overview#

Pipedream provides a set of helper functions that make it easy to manipulate
and work with data in your workflow. You can use these helper functions to:

Perform mathematical operations on data
Format data
Extract data from arrays and objects
Convert data from one format to another
Manipulate dates and times
Generate random data

Here are some examples of what you can build using the Helper Functions API:

A calculator that performs mathematical operations on data
A formatter that formats data
An extractor that extracts data from arrays and objects
A converter that converts data from one format to another
A date and time manipulator
A random data generator

Action Code#

import helperFunctions from "../../helper_functions.app.mjs";

export default {
  key: "helper_functions-compare-arrays",
  name: "Compare Arrays",
  description: "Get the difference, intersection, union, or symetric difference of two arrays/sets.",
  version: "0.0.1",
  type: "action",
  props: {
    helperFunctions,
    array1: {
      type: "string[]",
      label: "Array 1",
      description: "Array to compare to second array",
      default: [],
    },
    array2: {
      type: "string[]",
      label: "Array 2",
      description: "Array to be compared with first array",
      default: [],
    },
    actionType: {
      type: "string",
      label: "Compare Action",
      description: "Type of action to perform on the arrays",
      options: [
        "difference",
        "union",
        "intersection",
        "symmetric difference",
      ],
    },
  },
  methods: {
    getDifference(set1, set2) {
      return new Set([
        ...set1,
      ].filter((x) => !set2.has(x)));
    },
    getIntersection(set1, set2) {
      return new Set([
        ...set1,
      ].filter((x) => set2.has(x)));
    },
    getUnion(set1, set2) {
      for (const elem of set2) {
        set1.add(elem);
      }
      return set1;
    },
    getSymmetricDifference(set1, set2) {
      for (const elem of set2) {
        if (set1.has(elem)) {
          set1.delete(elem);
        } else {
          set1.add(elem);
        }
      }
      return set1;
    },
  },
  run() {
    const set1 = new Set(this.array1);
    const set2 = new Set(this.array2);

    let results;

    switch (this.actionType) {
    case "difference": {
      results = this.getDifference(set1, set2);
      break;
    }
    case "union": {
      results = this.getUnion(set1, set2);
      break;
    }
    case "intersection": {
      results = this.getIntersection(set1, set2);
      break;
    }
    case "symmetric difference": {
      results = this.getSymmetricDifference(set1, set2);
      break;
    }
    default:
      throw new Error(`Unknown action type: ${this.actionType}`);
    }

    return Array.from(results);
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Helper Functions	`helperFunctions`	`app`	This component uses the Helper Functions app.
Array 1	`array1`	`string[]`	Array to compare to second array
Array 2	`array2`	`string[]`	Array to be compared with first array
Compare Action	`actionType`	`string`	Select a value from the drop down menu:`differenceunionintersectionsymmetric difference`

Action Authentication#

The Helper Functions API does not require authentication.

About Helper Functions#

Helper functions and functional utilities to use within your Pipedream workflows

More Ways to Connect Helper Functions + Pipedream#

Other Popular Integrations#

Base64 Decode String with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream + Helper Functions

Try it

Convert Currency via exchangerate.host with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream + Helper Functions

Try it

Convert HTML to Slack mrkdwn format with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream + Helper Functions

Try it

Convert JavaScript Object to JSON String with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream + Helper Functions

Try it

Delay by N milliseconds with Helper Functions API on New Scheduled Tasks from Pipedream API

Pipedream + Helper Functions

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it