[TRI-950] io.runTask return type of the callback has TypeScript error when it includes an unknown type

[ericallam]

To recreate this issue:

await io.runTask("foo", { name: "Foo" }, async () => {
  return {
    foo: "bar",
  } as unknown;
});

That is because the return type of the callback is typed as required to extend SerializedJson:

trigger.dev/packages/trigger-sdk/src/io.ts

Line 434 in fa942fc

async runTask<TResult extends SerializableJson | void = void>(

We do this so the types of the return of runTask will match what is actually returned, since we run the results of the runTask callback through a JSON stringify/parsing as task output is stored in the database as JSON. Because of Resumability, this is a requirement, unless another solution can be identified.

I'm also now realizing that this SerializedJson might be incorrectly typed as well, as it can include Date and Symbol:

trigger.dev/packages/core/src/schemas/json.ts

Line 12 in fa942fc

const SerializableSchema = z.union([

So this could cause issues when resuming a run and using the cached task output, where Date's would be symbols and the types would be wrong. It would be great to test this and possible change the required type to DeserializedJson.

_TRI-950

[ericallam]

/bounty $75

[algora-pbc]

💎 $75 bounty created by ericallam
🙋 If you'd like to work on this issue, comment below to get assigned
👉 To claim this bounty, submit a pull request that includes the text /claim #280 somewhere in its body
📝 Before proceeding, please make sure you can receive payouts in your country
💵 Payment arrives in your account 2-5 days after the bounty is rewarded
💯 You keep 100% of the bounty award
🙏 Thank you for contributing to triggerdotdev/trigger.dev!

[Akshay-Patel-dev]

/attempt #280

Options

• Cancel my attempt

[MeenuyD]

/attempt #280

Options

• Cancel my attempt

[algora-pbc]

@Akshay-Patel-dev is already attempting to complete #280 and claim the bounty. If you attempt to complete the same issue, there is a chance that @Akshay-Patel-dev will complete the issue first, and be awarded the bounty. Try discussing with @Akshay-Patel-dev and potentially collaborating on the same solution versus creating an alternate solution.

[MeenuyD]

Hello,@ericallam Can you explain a bit more

[ologbonowiwi]

I was able to reproduce the issue but it is not clear what needs to be done so far. It would be nice to get some details

/attempt #280

Options

• Cancel my attempt

[yashug]

how about we having a wrapper something like this

async function runTaskWrapper<TResult>(
  key: string | any[],
  options: RunTaskOptions,
  callback: (task: IOTask, io: IO) => Promise<TResult>
): Promise<SerializableJson> {
  const result = await io.runTask(key, options, async (task, io) => {
    const userResult = await callback(task, io);
    // Ensure that userResult is of SerializableJson type
    return userResult as SerializableJson;
  });

  return result;
}

[ologbonowiwi]

@yashug even thought this would work, it's not safety right? We would be getting a type safety at transpile/development, but on runtime the data type could be different and bring unexpected behaviors

[algora-pbc]

@Akshay-Patel-dev: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[ologbonowiwi]

@ericallam, can you take a look at #342?

I decided to take a shot, and if you test with your example

await io.runTask("foo", { name: "Foo" }, async () => {
  return {
    foo: "bar",
  } as unknown;
});

It's working now

[ologbonowiwi]

So this could cause issues when resuming a run and using the cached task output, where Date's would be symbols and the types would be wrong. It would be great to test this and possible change the required type to DeserializedJson.

Do you see a way of handling this without a breaking change?

[algora-pbc]

💡 @ologbonowiwi submitted a pull request that claims the bounty. You can visit your org dashboard to reward.
👉 @ologbonowiwi: To receive payouts, sign up on Algora, link your Github account and connect with Stripe on your dashboard.

[algora-pbc]

@MeenuyD: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc]

@ologbonowiwi: Your claim has been rewarded! 👉 Complete your Algora onboarding to collect the bounty.

[algora-pbc]

🎉🎈 @ologbonowiwi has been awarded $75! 🎈🎊

[ologbonowiwi]

Can we close this one guys? @ericallam @matt-aitken

[ologbonowiwi]

Can we close it, guys? @matt-aitken @ericallam

[matt-aitken]

Yep @ologbonowiwi, I'll close now