add generateId option to graphql-mini-transforms

Author: dsanders11

packages/graphql-mini-transforms/src/document.ts

@@ -14,9 +14,26 @@ import {
 const IMPORT_REGEX = /^#import\s+['"]([^'"]*)['"];?[\s\n]*/gm;
 const DEFAULT_NAME = 'Operation';
 
+function defaultGenerateId(normalizedSource: string) {
+  // This ID is a hash of the full file contents that are part of the document,
+  // including other documents that are injected in, but excluding any unused
+  // fragments. This is useful for things like persisted queries.
+  return createHash('sha256')
+    .update(minifySource(normalizedSource))
+    .digest('hex');
+}
+
+export interface CleanDocumentOptions {
+  removeUnused?: boolean;
+  generateId?: (normalizedSource: string) => string;
+}
+
 export function cleanDocument(
   document: DocumentNode,
-  {removeUnused = true} = {},
+  {
+    removeUnused = true,
+    generateId = defaultGenerateId,
+  }: CleanDocumentOptions = {},
 ) {
   if (removeUnused) {
     removeUnusedDefinitions(document);
@@ -33,12 +50,7 @@ export function cleanDocument(
     stripLoc(definition);
   }
 
-  // This ID is a hash of the full file contents that are part of the document,
-  // including other documents that are injected in, but excluding any unused
-  // fragments. This is useful for things like persisted queries.
-  const id = createHash('sha256')
-    .update(normalizedSource)
-    .digest('hex');
+  const id = generateId(print(document));
 
   Reflect.defineProperty(normalizedDocument, 'id', {
     value: id,

packages/graphql-mini-transforms/src/webpack.ts

@@ -3,14 +3,22 @@ import {dirname} from 'path';
 import {loader} from 'webpack';
 import {parse, DocumentNode} from 'graphql';
 
-import {cleanDocument, extractImports} from './document';
+import {cleanDocument, extractImports, CleanDocumentOptions} from './document';
 
 export default async function graphQLLoader(
   this: loader.LoaderContext,
   source: string | Buffer,
 ) {
   this.cacheable();
 
+  const options = this.query;
+
+  if (options && typeof options !== 'object') {
+    throw new Error(
+      '@shopify/graphql-mini-transforms only supports options as an object',
+    );
+  }
+
   const done = this.async();
 
   if (done == null) {
@@ -20,8 +28,19 @@ export default async function graphQLLoader(
   }
 
   try {
+    const cleanDocumentOptions = {} as CleanDocumentOptions;
+
+    if (options) {
+      cleanDocumentOptions.generateId = options.generateId;
+    }
+
     const document = await loadDocument(source, this.context, this);
-    done(null, `export default ${JSON.stringify(cleanDocument(document))};`);
+    done(
+      null,
+      `export default ${JSON.stringify(
+        cleanDocument(document, cleanDocumentOptions),
+      )};`,
+    );
   } catch (error) {
     done(error);
   }

packages/graphql-mini-transforms/tests/webpack.test.ts

@@ -72,6 +72,14 @@ describe('graphql-mini-transforms/webpack', () => {
     );
   });
 
+  it('has option for custom ID generate function', async () => {
+    const result = await extractDocumentExport(
+      `query Shop { shop { id } }`,
+      createLoaderContext({loaderOptions: {generateId: () => 'foo'}}),
+    );
+    expect(result).toHaveProperty('id', 'foo');
+  });
+
   describe('import', () => {
     it('adds the resolved import as a dependency', async () => {
       const context = '/app/';
@@ -208,6 +216,7 @@ interface Options {
   context?: string;
   resolve?(context: string, imported: string): string | Error;
   readFile?(file: string): string | Error;
+  loaderOptions?: object;
 }
 
 // This is a limited subset of the loader API that we actually use in our
@@ -216,6 +225,7 @@ function createLoaderContext({
   context = __dirname,
   readFile = () => '',
   resolve = (context, imported) => path.resolve(context, imported),
+  loaderOptions = undefined,
 }: Options = {}): loader.LoaderContext {
   return {
     context,
@@ -251,6 +261,7 @@ function createLoaderContext({
       }
     },
     addDependency() {},
+    query: loaderOptions,
   } as any;
 }