[client-preset] Make persisted docs default hashing algorithm sha256, and follow recommended format (#10652)

* Update default hash to be sha256 for persisted documents

* Add changeset

* chore(dependencies): updated changesets for modified dependencies

* Update tests

* chore(dependencies): updated changesets for modified dependencies

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: eddeee888

.changeset/sad-rules-sell.md

@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/client-preset': major
+---
+
+BREAKING CHANGES: The default hashing algorithm is now sha256 instead of sha1. Generated sha256 format also follows the standard outlined in https://github.com/graphql/graphql-over-http/blob/52d56fb36d51c17e08a920510a23bdc2f6a720be/spec/Appendix%20A%20--%20Persisted%20Documents.md#sha256-hex-document-identifier

examples/persisted-documents-string-mode/src/gql/graphql.ts

@@ -33,5 +33,5 @@ export const HelloQueryDocument = new TypedDocumentString(
   hello
 }
     `,
-  { hash: '86f01e23de1c770cabbc35b2d87f2e5fd7557b6f' }
+  { hash: 'sha256:4c3f5d98b02279859b4c0c4efdba9553ac7acf89b9b0785eb24be68d5a67e6e8' }
 ) as unknown as TypedDocumentString<HelloQueryQuery, HelloQueryQueryVariables>;

examples/persisted-documents-string-mode/src/gql/persisted-documents.json

@@ -1,3 +1,3 @@
 {
-  "86f01e23de1c770cabbc35b2d87f2e5fd7557b6f": "query HelloQuery { hello }"
+  "sha256:4c3f5d98b02279859b4c0c4efdba9553ac7acf89b9b0785eb24be68d5a67e6e8": "query HelloQuery { hello }"
 }

examples/persisted-documents/src/gql/graphql.ts

@@ -9,7 +9,7 @@ export type HelloQueryQueryVariables = Exact<{ [key: string]: never }>;
 export type HelloQueryQuery = { hello: string };
 
 export const HelloQueryDocument = {
-  __meta__: { hash: '86f01e23de1c770cabbc35b2d87f2e5fd7557b6f' },
+  __meta__: { hash: 'sha256:4c3f5d98b02279859b4c0c4efdba9553ac7acf89b9b0785eb24be68d5a67e6e8' },
   kind: 'Document',
   definitions: [
     {

examples/persisted-documents/src/gql/persisted-documents.json

@@ -1,3 +1,3 @@
 {
-  "86f01e23de1c770cabbc35b2d87f2e5fd7557b6f": "query HelloQuery { hello }"
+  "sha256:4c3f5d98b02279859b4c0c4efdba9553ac7acf89b9b0785eb24be68d5a67e6e8": "query HelloQuery { hello }"
 }

packages/presets/client/src/index.ts

@@ -90,7 +90,7 @@ export type ClientPresetConfig = {
          * The algorithm parameter is typed with known algorithms and as a string rather than a union because it solely depends on Crypto's algorithms supported
          * by the version of OpenSSL on the platform.
          *
-         * @default `sha1`
+         * @default `sha256`
          */
         hashAlgorithm?: 'sha1' | 'sha256' | (string & {}) | ((operation: string) => string);
       };
@@ -164,7 +164,7 @@ export const preset: Types.OutputPreset<ClientPresetConfig> = {
           hashAlgorithm:
             (typeof options.presetConfig.persistedDocuments === 'object' &&
               options.presetConfig.persistedDocuments.hashAlgorithm) ||
-            'sha1',
+            'sha256',
         }
       : null;
 

packages/presets/client/src/persisted-documents.ts

@@ -7,6 +7,8 @@ const CONNECTION_DIRECTIVE_NAME = 'connection';
 
 /**
  * This function generates a hash from a document node.
+ * When `sha256` algorithm is used, the hash should be prefixed with `sha256:`
+ * https://github.com/graphql/graphql-over-http/blob/52d56fb36d51c17e08a920510a23bdc2f6a720be/spec/Appendix%20A%20--%20Persisted%20Documents.md#sha256-hex-document-identifier
  */
 export function generateDocumentHash(
   operation: string,
@@ -17,7 +19,10 @@ export function generateDocumentHash(
   }
   const shasum = crypto.createHash(algorithm);
   shasum.update(operation);
-  return shasum.digest('hex');
+
+  const algorithmPrefix = algorithm === 'sha256' ? 'sha256:' : '';
+
+  return algorithmPrefix + shasum.digest('hex');
 }
 
 /**

packages/presets/client/tests/client-preset.spec.ts

@@ -496,7 +496,7 @@ console.log(await response.json())
 
 ### Hashing algorithm
 
-To override the default hash algorithm of sha1 set `persistedDocuments.hashAlgorithm`
+To override the default hash algorithm of sha256 set `persistedDocuments.hashAlgorithm`
 
 ```ts filename="codegen.ts" {10-12}
 import { type CodegenConfig } from '@graphql-codegen/cli'
@@ -509,7 +509,7 @@ const config: CodegenConfig = {
       preset: 'client',
       presetConfig: {
         persistedDocuments: {
-          hashAlgorithm: 'sha256'
+          hashAlgorithm: 'sha1'
         }
       }
     }