fix(cli-utils): Add missing deduplication and normalization to `gener…

…ate persisted` output (#275)

.changeset/slimy-boxes-try.md

@@ -0,0 +1,5 @@
+---
+"@gql.tada/cli-utils": patch
+---
+
+Add missing fragment deduplication to `generate persisted` command's output and add document normalization, which can be disabled using the `--disable-normalization` argument.

packages/cli-utils/src/commands/generate-output/runner.ts

@@ -20,7 +20,7 @@ export interface OutputOptions {
   forceTSFormat?: boolean;
   /** Whether to disable the optimized output format for `.d.ts` files.
    * @defaultValue `false` */
-  disablePreprocessing: boolean;
+  disablePreprocessing?: boolean;
   /** The filename to write the cache file to.
    * @defaultValue The `tadaTurboLocation` configuration option */
   output: string | undefined;

packages/cli-utils/src/commands/generate-persisted/index.ts

@@ -11,6 +11,10 @@ export class GeneratePersisted extends Command {
     description: 'Specify the `tsconfig.json` used to read, unless `--output` is passed.',
   });
 
+  disableNormalization = Option.Boolean('--disable-normalization', false, {
+    description: 'Disables normalizing of GraphQL documents (parsing then printing documents)',
+  });
+
   failOnWarn = Option.Boolean('--fail-on-warn', false, {
     description: 'Triggers an error and a non-zero exit code if any warnings have been reported',
   });
@@ -25,6 +29,7 @@ export class GeneratePersisted extends Command {
     const tty = initTTY();
     const result = await tty.start(
       run(tty, {
+        disableNormalization: this.disableNormalization,
         failOnWarn: this.failOnWarn,
         output: this.output,
         tsconfig: this.tsconfig,

packages/cli-utils/src/commands/generate-persisted/runner.ts

@@ -10,6 +10,13 @@ import type { PersistedDocument } from './types';
 import * as logger from './logger';
 
 export interface PersistedOptions {
+  /** Whether to disable normalization of GraphQL documents in the output.
+   * @defaultValue `false`
+   * @remarks
+   * Normalizing a GraphQL document means to parse then print them, which
+   * removes comments and normalizes formatting.
+   */
+  disableNormalization?: boolean;
   /** The `tsconfig.json` to use for configurations and the TypeScript program.
    * @defaultValue A `tsconfig.json` in the current or any parent directory. */
   tsconfig: string | undefined;
@@ -35,6 +42,7 @@ export async function* run(tty: TTY, opts: PersistedOptions): AsyncIterable<Comp
   if (tty.isInteractive) yield logger.runningPersisted();
 
   const generator = runPersisted({
+    disableNormalization: !!opts.disableNormalization,
     rootPath: configResult.rootPath,
     configPath: configResult.configPath,
     pluginConfig,

packages/cli-utils/src/commands/generate-persisted/thread.ts

@@ -1,5 +1,5 @@
 import ts from 'typescript';
-import { print } from '@0no-co/graphql.web';
+import { parse, print } from '@0no-co/graphql.web';
 
 import type { FragmentDefinitionNode } from '@0no-co/graphql.web';
 import type { GraphQLSPConfig } from '@gql.tada/internal';
@@ -18,6 +18,7 @@ import { expose } from '../../threads';
 import type { PersistedSignal, PersistedWarning, PersistedDocument } from './types';
 
 export interface PersistedParams {
+  disableNormalization: boolean;
   rootPath: string;
   configPath: string;
   pluginConfig: GraphQLSPConfig;
@@ -139,18 +140,44 @@ async function* _runPersisted(params: PersistedParams): AsyncIterableIterator<Pe
         continue;
       }
 
-      const fragments: FragmentDefinitionNode[] = [];
+      const fragmentDefs: FragmentDefinitionNode[] = [];
       const operation = foundNode.arguments[0].getText().slice(1, -1);
       if (foundNode.arguments[1] && ts.isArrayLiteralExpression(foundNode.arguments[1])) {
         unrollTadaFragments(
           foundNode.arguments[1],
-          fragments,
+          fragmentDefs,
           container.buildPluginInfo(params.pluginConfig)
         );
       }
 
-      let document = operation;
-      for (const fragment of fragments) document += '\n\n' + print(fragment);
+      const seen = new Set<string>();
+      let document: string;
+      if (params.disableNormalization) {
+        document = operation;
+      } else {
+        try {
+          document = print(parse(operation));
+        } catch (_error) {
+          warnings.push({
+            message:
+              `The referenced document of "${referencingNode.getText()}" could not be parsed.\n` +
+              'Run `check` to see specific validation errors.',
+            file: position.fileName,
+            line: position.line,
+            col: position.col,
+          });
+          continue;
+        }
+      }
+
+      // NOTE: Update graphqlsp not to pre-parse fragments, which also swallows errors
+      for (const fragmentDef of fragmentDefs) {
+        const printedFragmentDef = print(fragmentDef);
+        if (!seen.has(printedFragmentDef)) {
+          document += '\n\n' + print(fragmentDef);
+          seen.add(printedFragmentDef);
+        }
+      }
 
       documents.push({
         schemaName: call.schema,

website/reference/gql-tada-cli.md

@@ -123,6 +123,7 @@ When this command is run inside a GitHub Action, [workflow commands](https://doc
 
 | Option              | Description                                                                                      |
 | ------------------- | ------------------------------------------------------------------------------------------------ |
+| `--disable-normalization`     | Whether to disable normalizing the GraphQL document. (Default: false) |
 | `--tsconfig,-c`     | Optionally, a `tsconfig.json` file to use instead of an automatically discovered one.            |
 | `--fail-on-warn,-w` | Triggers an error and a non-zero exit code if any warnings have been reported.                   |
 | `--output,-o`       | Specify where to output the file to. (Default: The `tadaPersistedLocation` configuration option) |
@@ -172,6 +173,7 @@ await generateOutput({
 
 |                     | Description                                                                                                           |
 | ------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `disableNormalization`     | Disables normalizing the GraphQL document |
 | `output` option     | The filename to write the persisted JSON manifest file to (Default: the `tadaPersistedLocation` configuration option) |
 | `tsconfig` option   | The `tsconfig.json` to use instead of an automatically discovered one.                                                |
 | `failOnWarn` option | Whether to throw an error instead of logging warnings.                                                                |