Update persisted-queries.md

[damikun]

Adds persisted-queries documenattion

Related converetr pull-req repo: ChilliCream/hotchocolate-examples#31

[tobias-tengler]

Thanks for chiming in and documenting persisted queries! ❤️
I've left some feedback for you below.

[michaelstaib]

@damikun sorry for the wait. I have put that on my stack now :)

[damikun]

Any plans on this or points that I can rewrite? :)

[michaelstaib]

@damikun just looked at it yesterday and merge main back in so that it is technically mergeable.

[michaelstaib]

Let's add another section here to show how to add the security aspect and limit the server to only allow persisted queries. I will post you some code examples.

[benmccallum]

Are you able to throw in an example @michaelstaib ? Thre's a TODO spot just lower. Then I think we can merge this. It'll be helpful for us at AutoGuru too, as this is next on our list for persisted queries now that we've got them all setup for the perf side of things.

[tobias-tengler]

I'm also going to take a look!

[michaelstaib]

@tobias-tengler yes and no :D

we should handle it, further we should be able to handle multiple of them. So if multiple are in the folder we should handle them as well. Lets create an issue for that and work details out on there.

[damikun]

Good rewrite Tobias... You are good in understanding and writing Doc it will be better if you finish it..

[tobias-tengler]

Any reason why this was retargeted to develop, while being added to the 11.3 milestone? There aren't any preview features being documented here. I think it can go straight into main...

[michaelstaib]

This is more complex than this ... you actually need to copy the full pipeline and hook into a specific place of the chain. While in your case you would still get the execution the regular request was already executed at this point.
This is why I moved this to develop so that we can introduce a new option that handles this.

[michaelstaib]

I have most of it implemented...I will revisit it later today

[tobias-tengler]

Ah I see, works for me :)

[tobias-tengler]

@michaelstaib what's the status of this? Should we track it as an issue?
I would like to get these docs in for the v11 guys: is there a good (albeit probably verbose) way to restrict execution to only persisted queries without the proposed option? If there is, I'd like to document it here and then merge it. We can then revisit the documentation, once the proposed option has been implemented in >= v12.

[tobias-tengler]

@michaelstaib I extracted this as an issue so we do not loose track of it: #3943

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[benmccallum]

Notes for StrawberryShake setup with persisted queries

1. In your .graphqlrc.json, add under extensions > strawberryShake a property called requestStrategy with a value of `"PersistedQuery".
2. Optionally set the hashAlgorithm property (by default it is "md5")
3. Configure the output directory were the queries should be written to by adding a property to your csproj called StrawberryShake_PersistedQueryDirectory.
   1. This needs to be an absolute path
   2. Without the MSBuild property, the client generation will fallback to the default request strategy. This can be leveraged to conditionally opt-in/out of persisted queries during local development by adding a condition to the property to it is only defined when desired.
   3. Be careful not to output your persisted queries into a path picked up by your GraphQL config file's documents setting, else Strawberry Shake will consider them new queries to generate code for which will obviously conflict with the original ones.

3.3 caused me issues. GraphQLConfig isn't setup to support an array of globs, so I couldn't do an opt-in and an opt-out setup. So I tried to do a separate subfolder for my defined queries, e.g. Operations/**/*.graphql and then output to PersistedQueries, but the build was passing but not producing any generated code. 🤷🏻 I checked DotNet.Glob docs, not sure whether it's me or what, but there's probably some limitations with the current implementation of graphql config.

@tobias-tengler , not sure if you have started this anywhere, but here's my scribbles from my investigations today.

[tobias-tengler]

@benmccallum I won't cover this in this PR, but I derived an issue from your comment.
If you feel like it, you could also start a PR for the StrawberryShake documentation! :)

[michaelstaib]

I will merge this one an we can refine in follow-up prs.