Add Event Samples

[mostekcm]

We want to add the event samples here for now until we find a more permanent location for them. The event platform beta goes out on Feb 3, 2025

[amh4r]

response will always be {} because it's being set within a step.run. Our execution model "enters" the function multiple times, with the last entrance skipping the step.run callback and immediately returning its memoized data.

Here's a simple repro of that behavior:

inngest.createFunction(
  { id: "fn-1" },
  { event: "event-1" },
  async ({ step }) => {
    let response;
    await step.run("a", async () => {
      return (response = 1);
    });

    // Always prints undefined.
    console.log(response);
  }
);

We recommend setting response to the return value of the step.run:

inngest.createFunction(
  { id: "fn-1" },
  { event: "event-1" },
  async ({ step }) => {
    const response = await step.run("a", async () => {
      return 1;
    });

    // Prints 1.
    console.log(response);
  }
);

[mostekcm]

@amh4r please take a look, I believe I have fixed this now, thanks for finding it!

[mostekcm]

🤔 is this actually pointless to use the step.run here? I originally had two steps, but now that I'm just doing one thing, it seems like extra code for now value. Should I just eliminate it?

[amh4r]

Yes, in this case there isn't a need for step.run since the whole function is the step.run

[amh4r]

This works, though will log on each attempt. Is that your desired behavior, or would you rather only log if retries are exhausted? For example, would you want to see an error log if this step.run retried twice and ultimately succeeded? There are valid reasons for either approach!

[mostekcm]

I think I would want to log each time to catch transient errors. Thanks for the thought though, I hadn't considered that.