feat: Adds Setup CLI Command to Configure GraphQL Trusted Documents

docs/docs/cli-commands.md

@@ -1999,11 +1999,55 @@ We perform a simple compatibility check in an attempt to make you aware of poten
 
 It's the author of the npm package's responsibility to specify the correct compatibility range, so **you should always research the packages you use with this command**. Especially since they will be executing code on your machine!
 
+### setup graphql
+
+This command creates the necessary files to support GraphQL features like trusted documents.
+
+#### Usage
+
+Run `yarn rw setup graphql <feature>`
+
+
+#### setup graphql trusted-docs
+
+This command creates the necessary configuratiion to start using [GraphQL Trusted Documents](./graphql/trusted-documents.md).
+
+
+```
+yarn redwood setup graphql trusted-documents
+```
+
+| Arguments & Options | Description              |
+| :------------------ | :----------------------- |
+| `--force, -f`       | Forgo compatibility checks |
+
+#### Usage
+
+Run `yarn rw graphql trusted-documents`
+
+#### Example
+
+```bash
+~/redwood-app$ yarn rw graphql trusted-documents
+✔ Update Redwood Project Configuration to enable GraphQL Trusted Documents ...
+✔ Generating Trusted Documents store ...
+✔ Configuring the GraphQL Handler to use a Trusted Documents store ...
+```
+
+
+If you have not setup the RedwoodJS server file, it will be setup:
+
+```bash
+✔ Adding the experimental server file...
+✔ Adding config to redwood.toml...
+✔ Adding required api packages...
+```
+
+
 ### setup realtime
 
 This command creates the necessary files, installs the required packages, and provides examples to setup RedwoodJS Realtime from GraphQL live queries and subscriptions. See the Realtime docs for more information.
 
-
 ```
 yarn redwood setup realtime
 ```

docs/docs/graphql/trusted-documents.md

@@ -93,6 +93,11 @@ Thus preventing unwanted queries or GraphQl traversal attacks,
 
 ## Configure Trusted Documents
 
+Below are instructions to manually configure Trusted Documents in your redwoodJS project.
+
+Alternatively, you can use the `yarn redwood setup graphql trusted-documents` [CLI setup command](../cli-commands.md#setup-graphql-trusted-docs).
+
+
 ### Configure redwood.toml
 
 Setting `trustedDocuments` to true will

packages/cli/src/commands/setup/graphql/features/trusted-docs.ts

@@ -0,0 +1,179 @@
+import fs from 'fs'
+import path from 'path'
+
+import execa from 'execa'
+import { Listr } from 'listr2'
+import { format } from 'prettier'
+import { Project, SyntaxKind, type PropertyAssignment } from 'ts-morph'
+
+import {
+  recordTelemetryAttributes,
+  prettierOptions,
+} from '@redwoodjs/cli-helpers'
+import { getConfigPath } from '@redwoodjs/project-config'
+
+import { getPaths } from '../../../../lib'
+import c from '../../../../lib/colors'
+
+export const command = 'trusted-docs'
+export const description = 'Set up Trusted Documents for GraphQL'
+
+export function builder(yargs: any) {
+  yargs.option('force', {
+    alias: 'f',
+    default: false,
+    description: 'Overwrite existing configuration',
+    type: 'boolean',
+  })
+}
+
+function configureGraphQLHandlerWithStore() {
+  return {
+    title:
+      'Configuring the GraphQL Handler to use a Trusted Documents store ...',
+    task: async () => {
+      // locate "api/functions/graphql.[js|ts]"
+      let graphQlSourcePath: string | undefined
+      const functionsDir = getPaths().api.functions
+      if (fs.existsSync(path.join(functionsDir, 'graphql.ts'))) {
+        graphQlSourcePath = path.join(functionsDir, 'graphql.ts')
+      } else if (fs.existsSync(path.join(functionsDir, 'graphql.js'))) {
+        graphQlSourcePath = path.join(functionsDir, 'graphql.js')
+      }
+
+      if (!graphQlSourcePath) {
+        console.warn(
+          c.warning(
+            `Unable to find the GraphQL Handler source file: ${path.join(
+              functionsDir,
+              'graphql.(js|ts)'
+            )}`
+          )
+        )
+        return
+      }
+
+      // add import
+      const project = new Project()
+      const graphQlSourceFile =
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        project.addSourceFileAtPathIfExists(graphQlSourcePath)!
+      let graphQlSourceFileChanged = false
+      let identified = false
+
+      const imports = graphQlSourceFile.getImportDeclarations()
+      if (
+        !imports.some(
+          (i) => i.getModuleSpecifierValue() === 'src/lib/trustedDocumentsStore'
+        )
+      ) {
+        graphQlSourceFile.addImportDeclaration({
+          moduleSpecifier: 'src/lib/trustedDocumentsStore',
+          namedImports: ['store'],
+        })
+        graphQlSourceFileChanged = true
+      }
+
+      // add "trustedDocuments" option to `createGraphQLHandler` call
+      graphQlSourceFile
+        .getDescendantsOfKind(SyntaxKind.CallExpression)
+        .forEach((expr) => {
+          if (identified) {
+            return
+          }
+
+          if (
+            expr.getExpression().asKind(SyntaxKind.Identifier)?.getText() ===
+            'createGraphQLHandler'
+          ) {
+            const arg = expr
+              .getArguments()[0]
+              ?.asKind(SyntaxKind.ObjectLiteralExpression)
+            if (arg) {
+              identified = true
+              const props = arg.getProperties()
+              const trustedDocsProp = props.find(
+                (p): p is PropertyAssignment =>
+                  p.asKind(SyntaxKind.PropertyAssignment)?.getName() ===
+                  'trustedDocuments'
+              )
+              if (!trustedDocsProp) {
+                arg.addPropertyAssignment({
+                  name: 'trustedDocuments',
+                  initializer: '{ store }',
+                })
+                graphQlSourceFileChanged = true
+              }
+            }
+          }
+        })
+
+      if (!identified) {
+        console.warn(
+          c.warning(
+            'Unable to determine how to setup Trusted Documents in the GraphQL Handler. Please add it manually following https://docs.redwoodjs.com/docs/graphql/trusted-documents#configure-graphql-handler'
+          )
+        )
+      }
+
+      if (graphQlSourceFileChanged) {
+        await project.save()
+        const updatedHandler = fs.readFileSync(graphQlSourcePath, 'utf-8')
+        const prettifiedHandler = format(updatedHandler, {
+          ...prettierOptions(),
+          parser: 'babel-ts',
+        })
+        fs.writeFileSync(graphQlSourcePath, prettifiedHandler, 'utf-8')
+      }
+    },
+  }
+}
+
+export async function handler({
+  force,
+  install,
+}: {
+  force: boolean
+  install: boolean
+}) {
+  recordTelemetryAttributes({
+    command: 'setup graphql trusted-docs',
+    force,
+    install,
+  })
+
+  const tasks = new Listr(
+    [
+      {
+        title:
+          'Update Redwood Project Configuration to enable GraphQL Trusted Documents ...',
+        skip: () => false,
+        task: () => {
+          const redwoodTomlPath = getConfigPath()
+          const originalTomlContent = fs.readFileSync(redwoodTomlPath, 'utf-8')
+
+          const tomlToAppend = `[graphql]\n  trustedDocuments = true`
+
+          const newConfig = originalTomlContent + '\n' + tomlToAppend
+
+          fs.writeFileSync(redwoodTomlPath, newConfig, 'utf-8')
+        },
+      },
+      {
+        title: 'Generating Trusted Documents store ...',
+        task: () => {
+          execa.commandSync('yarn redwood generate types', { stdio: 'ignore' })
+        },
+      },
+      configureGraphQLHandlerWithStore(),
+    ],
+    { rendererOptions: { collapseSubtasks: false } }
+  )
+
+  try {
+    await tasks.run()
+  } catch (e: any) {
+    console.error(c.error(e.message))
+    process.exit(e?.exitCode || 1)
+  }
+}

packages/cli/src/commands/setup/graphql/graphql.js

@@ -0,0 +1,14 @@
+import terminalLink from 'terminal-link'
+
+export const command = 'graphql <feature>'
+export const description = 'Set up GraphQL feature support'
+export const builder = (yargs) =>
+  yargs
+    .commandDir('./features')
+    .demandCommand()
+    .epilogue(
+      `Also see the ${terminalLink(
+        'Redwood CLI Reference',
+        'https://redwoodjs.com/docs/cli-commands#setup-graphql'
+      )}`
+    )