Wasp•2y ago

Jobs - Output type error following the example in docs

Hey guys! I'm following the docs on how to create a job (https://wasp-lang.dev/docs/advanced/jobs#job-definition-and-usage). Unfortunately, I'm having some type errors. I'm using openSaas template.

export const foo: MySpecialJob<Input, Output> = async ({ name }, context) => {
  console.log(`Hello ${name}!`);
  const tasks = await context.entities.Task.findMany({});
  return { tasks };
};

export const foo: MySpecialJob<Input, Output> = async ({ name }, context) => {
  console.log(`Hello ${name}!`);
  const tasks = await context.entities.Task.findMany({});
  return { tasks };
};

export const foo: MySpecialJob<Input, Output> = async ({ name }, context) => {
  console.log(`Hello ${name}!`);
  const tasks = await context.entities.Task.findMany({});
  return { tasks };
};

export const foo: MySpecialJob<Input, Output> = async ({ name }, context) => {
  console.log(`Hello ${name}!`);
  const tasks = await context.entities.Task.findMany({});
  return { tasks };
};

Error:

Type 'Output' does not satisfy the constraint 'void | JSONValue'.
  Type 'Output' is not assignable to type 'JSONObject'.
    Property 'tasks' is incompatible with index signature.
      Type '(GetResult<{ id: string; description: string; time: string; isDone: boolean; userId: number; createdAt: Date; }, unknown> & {})[]' is not assignable to type 'JSONValue'.ts(2344)

Type 'Output' does not satisfy the constraint 'void | JSONValue'.
  Type 'Output' is not assignable to type 'JSONObject'.
    Property 'tasks' is incompatible with index signature.
      Type '(GetResult<{ id: string; description: string; time: string; isDone: boolean; userId: number; createdAt: Date; }, unknown> & {})[]' is not assignable to type 'JSONValue'.ts(2344)

Type 'Output' does not satisfy the constraint 'void | JSONValue'.
  Type 'Output' is not assignable to type 'JSONObject'.
    Property 'tasks' is incompatible with index signature.
      Type '(GetResult<{ id: string; description: string; time: string; isDone: boolean; userId: number; createdAt: Date; }, unknown> & {})[]' is not assignable to type 'JSONValue'.ts(2344)

Type 'Output' does not satisfy the constraint 'void | JSONValue'.
  Type 'Output' is not assignable to type 'JSONObject'.
    Property 'tasks' is incompatible with index signature.
      Type '(GetResult<{ id: string; description: string; time: string; isDone: boolean; userId: number; createdAt: Date; }, unknown> & {})[]' is not assignable to type 'JSONValue'.ts(2344)

Is there some issue with the example that I missed?

Thank you for your help!

Recurring Jobs | Wasp

In most web apps, users send requests to the server and receive responses with some data. When the server responds quickly, the app feels responsive and smooth.

miho•2/15/24, 8:32 AM

Hey

Have you tried mapping the tasks array into an array of objects with properties you need? If you could be so kind to try this.

I'm not sure if the issue is that Prisma's objects are not serializable or we actually have bug.

kancurOP•2/15/24, 5:03 PM

Hey @miho ! I tried mocking the output completely, with a valid output, but it still complains.

kancurOP•2/15/24, 5:05 PM

If I set the output type as string, it doesn't complain anymore

kancurOP•2/15/24, 5:07 PM

type Output = Task[]; // ❌ doesnt work
type Output = Task; // ❌ doesnt work
type Output = { foo: string }; // ✅ works
type Output = string; // ✅ works

type FakeTask = { id: string; name: string; done: boolean };
type Output = { tasks: FakeTask[] }; // ✅ works

type Output = Task[]; // ❌ doesnt work
type Output = Task; // ❌ doesnt work
type Output = { foo: string }; // ✅ works
type Output = string; // ✅ works

type FakeTask = { id: string; name: string; done: boolean };
type Output = { tasks: FakeTask[] }; // ✅ works

MEE6•2/15/24, 5:07 PM

Wohooo @kancur, you just became a Waspeteer level 1!

kancurOP•2/15/24, 5:08 PM

So there's something about the TaskTask type, that doesn't work

kancurOP•2/15/24, 5:08 PM

kancurOP•2/15/24, 5:14 PM

So as a workaround, I can create a custom type and return that instead of prismas type directly, I guess.

kancurOP•2/15/24, 5:18 PM

It seems the createdAtcreatedAt field is an issue - when I omit it, it works.

kancurOP•2/15/24, 6:10 PM

nope, it doesn't actually work, I no longer see the error in vscode, but it doesn't compile

miho•2/15/24, 6:51 PM

Hmmmm that's weird. I guess the issue is that the TaskTask is a class with methods and stuff, have you maybe tried what you said, creating new objects with only the fields you need? e.g.

return {
  tasks: tasks.map(task => ({ id: task.id, description: task.description })),
};

return {
  tasks: tasks.map(task => ({ id: task.id, description: task.description })),
};

kancurOP•2/15/24, 7:48 PM

tried it, doesn't help

kancurOP•2/15/24, 7:48 PM

kancurOP•2/15/24, 7:49 PM

kancurOP•2/15/24, 7:49 PM

full error for reference (above)

kancurOP•2/15/24, 7:50 PM

Property 'createdAt' is incompatible with index signature.
                Type 'Date' is not assignable to type 'JSONValue'.
                  Type 'Date' is not assignable to type 'JSONObject'.
                    Index signature for type 'string' is missing in type 'Date'.

Property 'createdAt' is incompatible with index signature.
                Type 'Date' is not assignable to type 'JSONValue'.
                  Type 'Date' is not assignable to type 'JSONObject'.
                    Index signature for type 'string' is missing in type 'Date'.

kancurOP•2/15/24, 7:51 PM

Here's my task model:

kancurOP•2/15/24, 7:51 PM

It's basically the OpenSaasOpenSaas template + copy pasting that jobs code from the docs

kancurOP•2/15/24, 7:53 PM

Okay, I now know why it worked in docs

The Task entity is much simpler there, and doesn't contain date

MEE6•2/15/24, 7:53 PM

Wohooo @kancur, you just became a Waspeteer level 2!

kancurOP•2/15/24, 7:53 PM

if it contained value typed Date, it would throw typescript error like mine I think

miho•2/15/24, 7:54 PM

Gotcha! Okay, so what's going on here:

We are using PgBoss for our async jobs processing
PgBoss saves the output of a job in a Postgres database (using a JSON field FYI)
PgBoss expects from us to save job outputs as plain objects (DateDate is a class, not a primitive value like
```
string
```
```
string
```
) which means you can't save really any object you want
Ideally, you would save to the database only objects with primitive values, but values you can use to reference the actual task like e.g. Task.idTask.id

What I would recommend, make the OutputOutput more primitive e.g. { id: 5 }{ id: 5 } and then when you need the tasks, fetch them using the saved IDs

kancurOP•2/15/24, 7:57 PM

Okay, I see now!

Thanks for your help & tips @miho !

miho•2/15/24, 7:58 PM

Thank you for the patience and making us figure this out!

miho•2/15/24, 7:58 PM

We could improve our jobs output serialization e.g. use Superjson which can handle dates, which would make your experience smoother. Good thing for us to note.

Jobs - Output type error following the example in docs

Similar Threads

Similar Threads

Similar Threads