Merge pull request hayes#787 from TLadd/trl/docs-for-auth-relay-ordering

docs: add context to scope-auth plugin ordering relative to relay
moonflare · Feb 8, 2023 · 326bd04 · 326bd04
2 parents 42814c3 + 5464754
commit 326bd04
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 12 deletions.
diff --git a/packages/deno/packages/migration/mod.ts b/packages/deno/packages/migration/mod.ts
diff --git a/packages/deno/packages/plugin-add-graphql/mod.ts b/packages/deno/packages/plugin-add-graphql/mod.ts
diff --git a/packages/deno/packages/plugin-scope-auth/README.md b/packages/deno/packages/plugin-scope-auth/README.md
@@ -13,8 +13,11 @@ yarn add @pothos/plugin-scope-auth
 
 #### IMPORTANT
 
-When using `scope-auth` with other plugins, make sure that the `scope-auth` plugin is listed first
-to ensure that other plugins that wrap resolvers do not execute first.
+When using `scope-auth` with other plugins, the `scope-auth` plugin should generally be listed first
+to ensure that other plugins that wrap resolvers do not execute before the `scope-auth` logic.
+However, exceptions do exist where it is desirable for a plugin to run before `scope-auth`. For
+instance, putting the [relay plugin](https://pothos-graphql.dev/docs/plugins/relay) before the
+`scope-auth` plugin results in the `authScopes` function correctly receiving parsed `globalID`s.
 
 ### Setup
 

diff --git a/packages/plugin-scope-auth/README.md b/packages/plugin-scope-auth/README.md
@@ -13,8 +13,11 @@ yarn add @pothos/plugin-scope-auth
 
 #### IMPORTANT
 
-When using `scope-auth` with other plugins, make sure that the `scope-auth` plugin is listed first
-to ensure that other plugins that wrap resolvers do not execute first.
+When using `scope-auth` with other plugins, the `scope-auth` plugin should generally be listed first
+to ensure that other plugins that wrap resolvers do not execute before the `scope-auth` logic.
+However, exceptions do exist where it is desirable for a plugin to run before `scope-auth`. For
+instance, putting the [relay plugin](https://pothos-graphql.dev/docs/plugins/relay) before the
+`scope-auth` plugin results in the `authScopes` function correctly receiving parsed `globalID`s.
 
 ### Setup
 

diff --git a/website/pages/docs/plugins/scope-auth.mdx b/website/pages/docs/plugins/scope-auth.mdx
@@ -27,8 +27,11 @@ yarn add @pothos/plugin-scope-auth
 
 #### IMPORTANT
 
-When using `scope-auth` with other plugins, make sure that the `scope-auth` plugin is listed first
-to ensure that other plugins that wrap resolvers do not execute first.
+When using `scope-auth` with other plugins, the `scope-auth` plugin should generally be listed first
+to ensure that other plugins that wrap resolvers do not execute before the `scope-auth` logic.
+However, exceptions do exist where it is desirable for a plugin to run before `scope-auth`. For
+instance, putting the [relay plugin](https://pothos-graphql.dev/docs/plugins/relay) before the
+`scope-auth` plugin results in the `authScopes` function correctly receiving parsed `globalID`s.
 
 ### Setup