Generate CRUD by default for SDL and Services to mitigate issues in GraphQL used in cells

[dthyresson]

Fixes issue: #4766

As noted in the above issue:

When generating first the SDL for a model, and then a Cell for the same model you'll get an error printed to the console, and the generated code will be wrong.

The issue is that the SDL generator doesn't generate the userExample query that the Cell needs. You can "fix"/work around that by running the SDL generator with the --crud flag. The SDL generator by default only generates the "find many" query. I think it should generate the "find unique" query too. The "write prisma model" -> "generate sdl" -> "generate cell" workflow is something we should support by default, without any extra flags.

This PR updates the sdl and service generator to always create CRUD artifacts.

Note:

• Docs need update to reflect new default (todo)
• Will tutorial need change in example code output (@cannikin)

[netlify]

✅ Deploy Preview for redwoodjs-docs ready!

🔨 Explore the source changes: ba13525

🔍 Inspect the deploy log: https://app.netlify.com/sites/redwoodjs-docs/deploys/6234f3a9865e7a0009d7eb26

😎 Browse the preview: https://deploy-preview-4785--redwoodjs-docs.netlify.app

[dthyresson]

Oh @jtoar I just realized I can now update the docs in this same repo -- and part of this PR! Amazing.

[cannikin]

To stay consistent (not passing the flag is the same as true) we may want to update the scenarios generator to also not pass the flag when it generates the SDL portion.

[dthyresson]

To stay consistent (not passing the flag is the same as true) we may want to update the scenarios generator to also not pass the flag when it generates the SDL portion.

@cannikin

I don't think there is a dedicated scenarios option on the api side.

On the web side there are tests and stories.

But, on the api side, the tests use scenarios so I think it's all or nothing.

I'll check again (but that was my impression when making the change).

[cannikin]

I was just thinking remove these two lines since crud is default true now:

https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L161
https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L167

[dthyresson]

I was just thinking remove these two lines since crud is default true now:

https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L161 https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L167

Oh, I see in scaffold. Ok that makes sense. Thanks!

[dthyresson]

I was just thinking remove these two lines since crud is default true now:
https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L161 https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L167

Oh, I see in scaffold. Ok that makes sense. Thanks!

I updated https://github.com/redwoodjs/redwood/blob/main/packages/cli/src/commands/generate/scaffold/scaffold.js#L161 for the SDL default in scaffold.

But - the one in services since it passes along in ...rest I didn't want to mess with the logic there ... removing it causes tests to fail. Figured not worth risk to change the rules there for moment,

[Tobbe]

I prefer the --no-crud syntax. I think it's easier to read (and shorter to type) than --crud=false. A quick search through the docs shows we use both variants for other commands, but the --no- version is more common.

[dthyresson]

I prefer the --no-crud syntax. I think it's easier to read (and shorter to type) than --crud=false. A quick search through the docs shows we use both variants for other commands, but the --no- version is more common.

Thanks! I had forgotten about the “—no” option. That’s much better.

[thedavidprice]

@cannikin I'll get this in when CI passes. Will the tutorial need updating?

[cannikin]

Yep: https://redwoodjs.com/docs/tutorial/saving-data#create-an-sdl--service I actually make a point of saying we're NOT using the --crud flag so that we can teach you how to do it manually first.

[thedavidprice]

Understood. Will you still keep that flow then and just start with --no-crud?

[cannikin]

Maybe...I tend to want to teach the plain, basic forms of commands and then mention specialty flags in a little callout... I can reword, it's fine. Just makes it look like Redwood does even more stuff for you!