codegen graphql schema

[Tobbe]

Use codegen instead of programmatically calling the CLI.

This sets us up to better handle #4762
If/when #4849 goes in we could add a link to that when printing the error message

Easiest way to test this PR is to use the Gitpod link and then paste the Book and Shelf models below into schema.prisma

model Book {
  id      Int    @id @default(autoincrement())
  title   String @unique
  Shelf   Shelf? @relation(fields: [shelfId], references: [id])
  shelfId Int?
}

model Shelf {
  id    Int    @id @default(autoincrement())
  name  String @unique
  books Book[]
}

After that just run yarn rw g sdl Book and you'll see an error message printed

[netlify]

✅ Deploy Preview for redwoodjs-docs canceled.

Name	Link
🔨 Latest commit	bc6a052
🔍 Latest deploy log	https://app.netlify.com/sites/redwoodjs-docs/deploys/62703b5b756fbb0008ffca23

[orta]

Note that this conflicts pretty heavily with #5216 which right now needs to evaluate code before running

[Tobbe]

@orta This PR mainly touches graphqlSchema.ts and yours is mainly in graphqlCodeGen.ts. Can you please help me understand how they conflict? Thanks!

[orta]

oh good point - it doesn't!

[dthyresson]

@Tobbe I added some language from the docs to help resolve the SDL generator type issue.

I think similar language there and a link to the docs when published can be helpful.

[Tobbe]

This is what it looks like now. I think I'll add a couple of newlines

[Tobbe]

This is what it looks like now, and I'm happy with that.

In my own terminal the link looks better

[dthyresson]

This is what it looks like now, and I'm happy with that.

In my own terminal the link looks better

This is great @Tobbe . Leaving to @jtoar to finalize language.

[jtoar]

@Tobbe Awesome! This is gonna save us a ton of Discord threads. 😄

I have two suggestions:

First, I'm worried the Maybe you need to generate SDL or scaffolding for Book first part may make users think that they need to start over (by git cleaning, etc), generate the other model (here, Book), only to find another error message saying Maybe you need to generate SDL or scaffolding for Shelf first.

So I propose we change it to:

It looks like you have a Shelf model in your Prisma schema.
If it's part of a relation, you may have to generate SDL or scaffolding for Shelf too.
If you haven't done so yet, ignore the error message here and do so now.

My reasoning is that you have to generate one before the other, so don't tell them to start over, just tell them to generate the other one. You could comment out the relation fields, generate the SDLs/scaffolds, comment the relations fields back in, and force generate the SDLs/scaffolds, but that's a few too many steps for me when all I need to do is run the other SDL/scaffold generator. But thoughts?

Second, I feel like the message should stand out more. Maybe we could style it a bit to make it more eye catching?

This is the code I added (along with a chalk import—it's already a dependency of this package) to get that message; happy to commit it if you agree:

        console.error(
          [
            `  ${chalk.bgYellow(` ${chalk.black.bold('Heads up')} `)}`,
            '',
            chalk.yellow(
              `  It looks like you have a ${name} model in your Prisma schema.`
            ),
            chalk.yellow(
              `  If it's part of a relation, you may have to generate SDL or scaffolding for ${name} too.`
            ),
            chalk.yellow(
              `  If you haven't done so yet, ignore the error message here and do so now.`
            ),
            '',
            chalk.yellow(
              `  See the ${terminalLink(
                'Troubleshooting Generators',
                'https://redwoodjs.com/docs/schema-relations#troubleshooting-generators'
              )} section in our docs for more help.`
            ),
            '',
          ].join('\n')
        )

[Tobbe]

Yes! I ❤️ this Dom! This is so much better than what I had.

What terminal/shell do you have? Why don't you get the nice looking link I get? (iTerm2 + zsh)

To keep iterating on the text a little bit, what do you think of

It looks like you have a Shelf model in your Prisma schema.
If Book and Shelf form a relation, you may have to generate SDL or scaffolding for Shelf too.
So, if you haven't done that yet, ignore this error message and run that generator now.

[jtoar]

What terminal/shell do you have? Why don't you get the nice looking link I get? (iTerm2 + zsh)

I use the default mac terminal and fish shell. I think the mac terminal is unsupported. It's ok!

I like the copy! If I could suggest one more thing, I'd change If Book and Shelf form a relation to If Book and Shelf have a relation.

I'll add the commit now. There's one thing I don't know how to do yet: how do you get "Book"?

[jnhooper]

Hi! sorry to but into this conversation, this all looks great and i think it'll solve an issue i was butting my head against. I was trying to look through this pr to see what your solution looked like but i couldn't find the successful test fixture, so i was hoping someone here could take a quick peek/ this could be illuminating for anyone else coming across this pr like me before this gets released.

model Item {
  id          Int       @id @default(autoincrement())
  name        String
  quantity    Int
    
  createdBy   User      @relation("createdItems", fields: [createdByUserId], references: [id])
  pickedUpBy  User?     @relation("pickedUpItems", fields: [pickedUpById], references: [id])
  

  createdByUserId Int
  pickedUpById    Int

}

model User {
  id                  Int       @id @default(autoincrement())
  email               String    @unique
  name                String
  itemsCreated      Item[]      @relation("createdItems")
  itemsPickedUp     Item[]      @relation("pickedUpItems")
}

then when scaffolding these i run into the problem Unknown type User and Unknown type Item in the respective sdl files. I solved this by just manually copying the types into each other's sdl files

//item.sdl
export const schema = gql`
# had to copy the below manually
  type User {
    id: Int!
    email: String!
    name: String!
    itemsCreated: [Item]!
    itemsPickedUp: [Item]!
  }

# this was auto generated
  type Item {
    id: Int!
    name: String!
    quantity: Int!
    createdBy: User!
    pickedUpBy: User
    createdByUserId: Int!
    pickedUpById: Int!
  }
`

this works but seems... not ideal. is it possible to import the types from one file into another?
Thanks so much for the guidance, i'm really impressed by everything so far

[dotansimha]

LGTM. It's better to run codegen from core when you have all the info already, instead of using the cli. You can also control how it's being executed and break the dependency to fs (and reduce a lot of dependencies you might not need...)

[jtoar]

@jnhooper you shouldn't have to import types into files, just run the sdl or scaffold generator for one model after the other while expecting the first model that to have type errors. Does that make sense? So it'd be:

yarn rw g scaffold users
# Will report type errors, but still scaffold ok
yarn rw g scaffold items
# No errors