[TT-10909]: fix issue with missing upstream headers in graphql proxy only

[kofoworola]

User description

Description

This PR fixes an issue where the requests from the client were not sent upstream. This was due to an edge case cause by the open telemetry context modification

TT-10909

This PR also fixes a situation where the requested content-encoding by the client is ignored

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

• I ensured that the documentation is up to date
• I explained why this PR updates go.mod in detail with reasoning why it's required
• I would like a code coverage CI quality gate exception and have explained why

---

Type

bug_fix, enhancement

---

Description

• Added a new test to ensure headers are correctly passed to the upstream when OpenTelemetry is enabled.
• Introduced a new context management strategy for GraphQL proxy-only mode to correctly forward headers.
• Updated various components within the internal GraphQL engine to utilize the new context structure for header forwarding.

---

Changes walkthrough

	Relevant files
Tests	reverse_proxy_test.go Add Test for GraphQL Proxy with OpenTelemetry                        gateway/reverse_proxy_test.go Added a new test TestGraphQL_ProxyOnlyPassHeadersWithOTel to ensure headers are passed upstream when OpenTelemetry is enabled. +38/-0
Enhancement	context.go Manage GraphQL Proxy Context for Headers Forwarding            internal/graphengine/context.go Introduced GraphQLProxyOnlyContextValues struct to store request and response details. Added functions SetProxyOnlyContextValue and GetProxyOnlyContextValue for managing GraphQL proxy context. +31/-0    engine_v2.go Integrate New Context Management in Engine V2                        internal/graphengine/engine_v2.go Modified to use SetProxyOnlyContextValue for setting proxy context. Updated to retrieve proxy context using GetProxyOnlyContextValue. +2/-2      graphql_go_tools_v1.go Update Error Handling with New Context Structure                  internal/graphengine/graphql_go_tools_v1.go Updated returnErrorsFromUpstream to use GraphQLProxyOnlyContextValues. +1/-1      transport.go Refactor Transport Logic for GraphQL Proxy                              internal/graphengine/transport.go Refactored to use GraphQLProxyOnlyContextValues for handling proxy-only requests. Adjusted header forwarding logic to accommodate new context structure. +10/-10

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

API Changes

no api changes detected

[github-actions]

PR Description updated to latest commit (8b994c8)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR involves changes across multiple files with the introduction of a new context management mechanism for GraphQL proxy requests. Understanding the context flow and ensuring it doesn't introduce regressions requires a thorough review.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: The implementation of SetProxyOnlyContextValue and GetProxyOnlyContextValue relies on a single instance of contextKey. If multiple requests are processed concurrently, this could lead to race conditions or incorrect context values being retrieved.
🔒 Security concerns	No

Code feedback:

---

relevant file	internal/graphengine/context.go
suggestion	Consider using a more unique context key or ensure that the context management mechanism is safe for concurrent use. This could prevent potential issues with context value retrieval in a concurrent environment. [important]
relevant line	var graphqlProxyContextInfo = contextKey{}

---

relevant file	internal/graphengine/engine_v2.go
suggestion	Ensure that GetProxyOnlyContextValue always returns a valid value or handle the case where it might return nil to avoid potential nil pointer dereferences. [important]
relevant line	proxyOnlyCtx := GetProxyOnlyContextValue(reqCtx)

---

relevant file	gateway/reverse_proxy_test.go
suggestion	Add more test cases to cover scenarios where the OpenTelemetry context might be modified in unexpected ways, ensuring the headers are still correctly passed upstream. [medium]
relevant line	func TestGraphQL_ProxyOnlyPassHeadersWithOTel(t *testing.T) {

---

relevant file	internal/graphengine/transport.go
suggestion	Validate the response from g.originalTransport.RoundTrip(request) before accessing its properties to prevent potential nil pointer dereferences. [medium]
relevant line	response, err := g.originalTransport.RoundTrip(request)

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, require_can_be_split_review, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

Category	Suggestions
Enhancement	Convert the test to a table-driven format for better maintainability. Consider using a table-driven test approach for TestGraphQL_ProxyOnlyPassHeadersWithOTel to handle multiple test cases more efficiently and to improve code maintainability. gateway/reverse_proxy_test.go [1000-1036] func TestGraphQL_ProxyOnlyPassHeadersWithOTel(t *testing.T) { - ... + testCases := []struct { + name string + headers map[string]string + want string + }{ + { + name: "Test with custom-client-header", + headers: map[string]string{ + "custom-client-header": "custom-value", + }, + want: "custom-value", + }, + // Add more test cases here + } + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + // Test logic here + }) + } }
	Log or handle ignored headers for better error tracking. Consider logging or handling the case where ignoreForwardedHeaders contains a header that is not present in the forwardedRequest.Header, to improve debugging and error tracking. internal/graphengine/transport.go [74-75] -if proxyOnlyValues.ignoreForwardedHeaders[forwardedHeaderKey] { +if _, ok := proxyOnlyValues.ignoreForwardedHeaders[forwardedHeaderKey]; ok { + log.Printf("Ignoring header: %s", forwardedHeaderKey) continue }
Best practice	Use a custom type for context keys to avoid potential collisions. Use context.WithValue with caution and define a type for your context key to avoid collisions. It's recommended to use a custom type rather than a basic type like struct{} for the context key. internal/graphengine/context.go [17-19] -type contextKey struct{} -var graphqlProxyContextInfo = contextKey{} +type contextKeyType string +var graphqlProxyContextInfo = contextKeyType("graphqlProxyContextInfo")
	Validate the request method before setting it in handleProxyOnly. When modifying the request method in handleProxyOnly, ensure that the method is valid and supported by the server to avoid unexpected behavior. internal/graphengine/transport.go [40] -request.Method = proxyOnlyValues.forwardedRequest.Method +if validMethod(proxyOnlyValues.forwardedRequest.Method) { + request.Method = proxyOnlyValues.forwardedRequest.Method +} else { + // Handle invalid method +}
Possible issue	Add error handling when setting the proxy-only context value. Ensure error handling is performed when setting the proxy-only context value to handle any potential errors that might occur during the process. internal/graphengine/engine_v2.go [265] -reqCtx = SetProxyOnlyContextValue(reqCtx, outreq) +reqCtx, err := SetProxyOnlyContextValue(reqCtx, outreq) +if err != nil { + // Handle error +}

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[github-actions]

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

[github-actions]

💥 CI tests failed 🙈

git-state

diff --git a/internal/graphengine/engine_v2.go b/internal/graphengine/engine_v2.go
index 8c53b66..12857ac 100644
--- a/internal/graphengine/engine_v2.go
+++ b/internal/graphengine/engine_v2.go
@@ -3,10 +3,11 @@ package graphengine
 import (
 	"context"
 	"errors"
-	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/httpclient"
 	"net/http"
 	"strings"
 
+	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/httpclient"
+
 	"github.com/jensneuse/abstractlogger"
 	"github.com/sirupsen/logrus"
 

Please look at the run or in the Checks tab.

[github-actions]

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

[github-actions]

💥 CI tests failed 🙈

git-state

diff --git a/gateway/handler_success_test.go b/gateway/handler_success_test.go
index 488fb3a..485a319 100644
--- a/gateway/handler_success_test.go
+++ b/gateway/handler_success_test.go
@@ -2,10 +2,11 @@ package gateway
 
 import (
 	"context"
-	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/httpclient"
 	"net/http"
 	"testing"
 
+	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/httpclient"
+
 	"github.com/TykTechnologies/graphql-go-tools/pkg/graphql"
 	"github.com/TykTechnologies/tyk-pump/analytics"
 	"github.com/TykTechnologies/tyk/test"

Please look at the run or in the Checks tab.

[sonarcloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[kofoworola]

/release to release-5.2

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@kofoworola Succesfully merged PR

[kofoworola]

/release to release5-lts

[tykbot]

@kofoworola Release branch not found

[kofoworola]

/release to release-5-lts

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@kofoworola Succesfully merged PR

[kofoworola]

/release to release-5.3

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@kofoworola Succesfully merged PR

[kofoworola]

/release to release-5.3

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@kofoworola Seems like there is conflict and it require manual merge.

[kofoworola]

/release to release-5.3.0

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@kofoworola Succesfully merged PR