Pause, Resume, and Rerun a Workflow

export default defineComponent({
  async run({ $ }) {
    const { resume_url, cancel_url } = $.flow.suspend();
    $.send.email({
      subject: "Please approve this important workflow",
      text: `Click here to approve the workflow: ${resume_url}, and cancel here: ${cancel_url}`,
    });
    // Pipedream suspends your workflow at the end of the step
  },
});

export default defineComponent({
  async run({ $ }) {
    // 7 days
    const TIMEOUT = 1000 * 60 * 60 * 24 * 7;
    $.flow.suspend(TIMEOUT);
  },
});

import { axios } from "@pipedream/platform";
 
export default defineComponent({
  props: {
    openai: {
      type: "app",
      app: "openai",
    },
  },
  async run({ steps, $ }) {
    try {
      return await axios($, {
        url: `https://api.openai.com/v1/completions`,
        method: "post",
        headers: {
          Authorization: `Bearer ${this.openai.$auth.api_key}`,
        },
        data: {
          model: "text-davinci-003",
          prompt: "Say this is a test",
          max_tokens: 7,
          temperature: 0,
        },
      });
    } catch (error) {
      const MAX_RETRIES = 3;
      const DELAY = 1000 * 30;
 
      // Retry the request every 30 seconds, for up to 3 times
      $.flow.rerun(DELAY, null, MAX_RETRIES);
    }
  },
});

import axios from "axios";
 
export default defineComponent({
  async run({ $ }) {
    const MAX_RETRIES = 3;
    // 10 seconds
    const DELAY = 1000 * 10;
    const { run } = $.context;
    // $.context.run.runs starts at 1 and increments when the step is rerun
    if (run.runs === 1) {
      // $.flow.rerun(delay, context (discussed below), max retries)
      $.flow.rerun(DELAY, null, MAX_RETRIES);
    } else if (run.runs === MAX_RETRIES + 1) {
      throw new Error("Max retries exceeded");
    } else {
      // Poll external API for status
      const { data } = await axios({
        method: "GET",
        url: "https://example.com/status",
      });
      // If we're done, continue with the rest of the workflow
      if (data.status === "DONE") return data;
 
      // Else retry later
      $.flow.rerun(DELAY, null, MAX_RETRIES);
    }
  },
});

$.flow.rerun(
  delay, // The number of milliseconds until the step will be rerun
  context, // JSON-serializable data you need to pass between runs
  maxRetries // The total number of times the step will rerun. Defaults to 10
);

import axios from "axios";
 
export default defineComponent({
  async run({ steps, $ }) {
    const TIMEOUT = 86400 * 1000;
    const { run } = $.context;
    // $.context.run.runs starts at 1 and increments when the step is rerun
    if (run.runs === 1) {
      const { cancel_url, resume_url } = $.flow.rerun(TIMEOUT, null, 1);
 
      // Send resume_url to external service
      await axios({
        method: "POST",
        url: "your callback URL",
        data: {
          resume_url,
          cancel_url,
        },
      });
    }
 
    // When the external service calls back into the resume_url, you have access to
    // the callback data within $.context.run.callback_request
    else if (run.callback_request) {
      return run.callback_request;
    }
  },
});

$.flow.rerun(1000, { hello: "world" });

export default defineComponent({
  async run({ $ }) {
    const MAX_RETRIES = 3;
    const { run } = $.context;
    if (run.runs === 1) {
      $.flow.rerun(1000, null, MAX_RETRIES);
    } else if (run.runs === MAX_RETRIES + 1) {
      throw new Error("Max retries exceeded");
    }
  },
});