Skip to content

fix(visitor-plugin-common): Escape special characters when emitting template literals #10482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(visitor-plugin-common): Escape special characters when emitting template literals #10482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions packages/plugins/other/visitor-plugin-common/src/client-side-base-visitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
import gqlTag from 'graphql-tag';
import { BaseVisitor, ParsedConfig, RawConfig } from './base-visitor.js';
import { LoadedFragment, ParsedImport } from './types.js';
import { buildScalarsFromConfig, unique, flatten, getConfigValue, groupBy } from './utils.js';
import { asTemplateLiteral, buildScalarsFromConfig, unique, flatten, getConfigValue, groupBy } from './utils.js';
import { FragmentImport, ImportDeclaration, generateFragmentImportStatement } from './imports.js';

gqlTag.enableExperimentalFragmentVariables();
Expand Down Expand Up @@ -350,10 +350,13 @@ export class ClientSideBaseVisitor<
const fragmentNames = this._extractFragments(node, includeNestedFragments);
const fragments = this._transformFragments(fragmentNames);

const doc = this._prepareDocument(`
${print(node).split('\\').join('\\\\') /* Re-escape escaped values in GraphQL syntax */}
${this._includeFragments(fragments)}`);
// Re-escape escaped values in GraphQL syntax.
const docLiteralContents = print(node).split('\\').join('\\\\');
const fragmentLiteralContents = this._includeFragments(fragments);

const doc = this._prepareDocument(`
${docLiteralContents}
${fragmentLiteralContents}`);
if (this.config.documentMode === DocumentMode.documentNode) {
let gqlObj = gqlTag([doc]);

Expand Down Expand Up @@ -414,8 +417,9 @@ export class ClientSideBaseVisitor<
}

if (this.config.documentMode === DocumentMode.string) {
const escapedLiteralContents = asTemplateLiteral(doc).slice(1, -1);
Copy link
Author

@gibson042 gibson042 Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd love to further extend this for honoring optimizeDocumentNode (but doing so introduces whitespace changes that break tests):

Suggested change
const escapedLiteralContents = asTemplateLiteral(doc).slice(1, -1);
const optimizedDoc = this.config.optimizeDocumentNode
? print(optimizeDocumentNode(gqlTag([doc])))
: doc;
const escapedLiteralContents = asTemplateLiteral(optimizedDoc).slice(1, -1);

if (node.kind === Kind.FRAGMENT_DEFINITION) {
return `new TypedDocumentString(\`${doc}\`, ${JSON.stringify({ fragmentName: node.name.value })})`;
return `new TypedDocumentString(\`${escapedLiteralContents}\`, ${JSON.stringify({ fragmentName: node.name.value })})`;
}

if (this._onExecutableDocumentNode && node.kind === Kind.OPERATION_DEFINITION) {
Expand All @@ -425,16 +429,21 @@ export class ClientSideBaseVisitor<
if (this._omitDefinitions === true) {
return `{${`"__meta__":${JSON.stringify(meta)},`.slice(0, -1)}}`;
}
return `new TypedDocumentString(\`${doc}\`, ${JSON.stringify(meta)})`;
return `new TypedDocumentString(\`${escapedLiteralContents}\`, ${JSON.stringify(meta)})`;
}
}

return `new TypedDocumentString(\`${doc}\`)`;
return `new TypedDocumentString(\`${escapedLiteralContents}\`)`;
}

const escapedLiteralContentsPrefix = asTemplateLiteral(docLiteralContents).slice(1, -1);
Copy link
Author

@gibson042 gibson042 Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd love to further extend this for honoring optimizeDocumentNode (but doing so introduces whitespace changes that break tests):

Suggested change
const escapedLiteralContentsPrefix = asTemplateLiteral(docLiteralContents).slice(1, -1);
const optimizedDocPrefix = this.config.optimizeDocumentNode
? print(optimizeDocumentNode(gqlTag([docLiteralContents])))
: docLiteralContents;
const escapedLiteralContentsPrefix = asTemplateLiteral(optimizedDocPrefix).slice(1, -1);

const escapedDoc = this._prepareDocument(`
${escapedLiteralContentsPrefix}
${fragmentLiteralContents}`);

const gqlImport = this._parseImport(this.config.gqlImport || 'graphql-tag');

return (gqlImport.propName || 'gql') + '`' + doc + '`';
return (gqlImport.propName || 'gql') + '`' + escapedDoc + '`';
}

protected _getGraphQLCodegenMetadata(
Expand Down
2 changes: 2 additions & 0 deletions packages/plugins/other/visitor-plugin-common/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import { parseMapper } from './mappers.js';
import { DEFAULT_SCALARS } from './scalars.js';
import { NormalizedScalarsMap, ParsedScalarsMap, ScalarsMap, FragmentDirectives, LoadedFragment } from './types.js';

export const asTemplateLiteral = str => '`' + str.replace(/[`\\]|[$][{]/g, '\\$&') + '`';

export const getConfigValue = <T = any>(value: T, defaultValue: T): T => {
if (value === null || value === undefined) {
return defaultValue;
Expand Down