feat: disable tracing through headers (#1189)

wundergraph · Sep 19, 2024 · c23fd77 · c23fd77
1 parent 180c714
commit c23fd77
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 5 deletions.
diff --git a/playground/src/components/playground/index.tsx b/playground/src/components/playground/index.tsx
@@ -404,6 +404,7 @@ export const Playground = (input: {
   }, [schema, clientValidationEnabled]);
 
   const [debouncedQuery] = useDebounce(query, 300);
+  const [debouncedHeaders] = useDebounce(headers, 300);
 
   useEffect(() => {
     const getPlan = async () => {
@@ -418,10 +419,13 @@ export const Playground = (input: {
           return;
         }
 
+        const existingHeaders = JSON.parse(debouncedHeaders || '{}');
+        delete existingHeaders['X-WG-TRACE'];
         const requestHeaders: Record<string, string> = {
-          ...JSON.parse(headers),
+          ...existingHeaders,
           'X-WG-Include-Query-Plan': 'true',
           'X-WG-Skip-Loader': 'true',
+          'X-WG-DISABLE-TRACING': 'true',
         };
 
         validateHeaders(requestHeaders);
@@ -448,7 +452,7 @@ export const Playground = (input: {
     };
 
     getPlan();
-  }, [debouncedQuery, headers, url, schema]);
+  }, [debouncedQuery, debouncedHeaders, url, schema]);
 
   return (
     <TooltipProvider>

diff --git a/router/core/router.go b/router/core/router.go
@@ -335,6 +335,7 @@ func NewRouter(opts ...Option) (*Router, error) {
 		"apollographql-client-version",
 		// Required for WunderGraph ART
 		"x-wg-trace",
+		"x-wg-disable-tracing",
 		"x-wg-token",
 		"x-wg-skip-loader",
 		"x-wg-include-query-plan",

diff --git a/router/internal/graphiql/graphiql.html b/router/internal/graphiql/graphiql.html
diff --git a/router/pkg/config/config.schema.json b/router/pkg/config/config.schema.json
@@ -699,6 +699,7 @@
             "Apollo-Graphql-Client-Name",
             "Apollo-Graphql-Client-Version",
             "x-wg-trace",
+            "x-wg-disable-tracing",
             "x-wg-token",
             "x-wg-include-query-plan",
             "x-wg-skip-loader",

diff --git a/router/pkg/trace/utils.go b/router/pkg/trace/utils.go
@@ -46,6 +46,10 @@ func CommonRequestFilter(r *http.Request) bool {
 	if r.Method == "GET" && r.Header.Get("Upgrade") != "" {
 		return false
 	}
+	// Ignore if client disables tracing through header
+	if r.Header.Get("X-WG-DISABLE-TRACING") == "true" {
+		return false
+	}
 	return true
 }
 

diff --git a/studio/src/pages/[organizationSlug]/[namespace]/graph/[slug]/playground.tsx b/studio/src/pages/[organizationSlug]/[namespace]/graph/[slug]/playground.tsx
@@ -817,6 +817,7 @@ const PlaygroundPage: NextPageWithLayout = () => {
   ]);
 
   const [debouncedQuery] = useDebounce(query, 300);
+  const [debouncedHeaders] = useDebounce(headers, 300);
 
   useEffect(() => {
     const getPlan = async () => {
@@ -836,11 +837,14 @@ const PlaygroundPage: NextPageWithLayout = () => {
           return;
         }
 
+        const existingHeaders = JSON.parse(debouncedHeaders || "{}");
+        delete existingHeaders["X-WG-TRACE"];
         const requestHeaders: Record<string, string> = {
-          ...JSON.parse(headers),
+          ...existingHeaders,
           "X-WG-Token": graphContext.graphRequestToken,
           "X-WG-Include-Query-Plan": "true",
           "X-WG-Skip-Loader": "true",
+          "X-WG-DISABLE-TRACING": "true",
         };
 
         validateHeaders(requestHeaders);
@@ -879,9 +883,9 @@ const PlaygroundPage: NextPageWithLayout = () => {
     getPlan();
   }, [
     debouncedQuery,
+    debouncedHeaders,
     graphContext?.featureFlagsInLatestValidComposition,
     graphContext?.graphRequestToken,
-    headers,
     loadSchemaGraphId,
     routingUrl,
     schema,