Feature: Golang Http Tcp Bridge #36667

duxin40 · 2024-10-17T08:12:07Z

As mentioned in the proposal: #35749 , this PR is to support using Golang to extend TCP upstream proxy, to make changes to connections and data messages in the http2tcp situation of envoy.
(this PR does)

Here is my thought about Golang extension function points:

Support encoding message processing for upstream TCP requests (route and cluster have been determined, and targeted message processing can be performed for route and cluster)
Support the handling of conn connection status during the encoding stage of upstream TCP requests (for example, by setting end_stream=false to avoid envoy semi connected status)
Support decoding message processing and aggregation for upstream TCP response in onUpstreamData.(for example, by setting end_stream=true to indicate that the message is encapsulated and can be passed to downstream)
Aggregate the tcp messages received multiple times by onUpstreamData of tcp response.
Support obtaining route and cluster information, which can be referenced for targeted processing in the above stages.

What we can do with this Golang extension:

With this golang extension, developers can quickly get started with envoy and use golang to implement http2tcp such as http2dubbo、http2rpc.

Commit Message: support Golang TCP Upstream Extension for http2tcp on Envoy
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

Signed-off-by: duxin40 <duxin40@gamil.com>

support golang tcp extension for http2tcp

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only · 2024-10-17T08:12:13Z

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #36667 was opened by duxin40.

see: more, trace.

Signed-off-by: duxin40 <duxin40@gamil.com>

duxin40 · 2024-10-17T09:25:41Z

I will add unit tests for these codes and fix errors related to unit tests.

duxin40 · 2024-10-17T09:27:46Z

@doujiang24 could you take a look and check if the direction looks good? thanks!

tyxia · 2024-10-18T16:04:21Z

/assign @doujiang24

Per discussion in #35749

repokitteh-read-only · 2024-10-18T16:04:27Z

@duxin40 cannot be assigned to this issue.

🐱

Caused by: a #36667 (comment) was created by @tyxia.

see: more, trace.

doujiang24

Better add a simple example that use Golang to implement http => TCP protocol, to show how it could be for users for easier understanding.
It do not need to be runable, just a demo.

source/common/router/router.cc

api/contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha/BUILD

duxin40 · 2024-10-21T07:02:08Z

Better add a simple example that use Golang to implement http => TCP protocol, to show how it could be for users for easier understanding. It do not need to be runable, just a demo.

Done. in the dir: contrib/upstreams/http/tcp/test_data/http2dubbo-examples

Signed-off-by: duxin40 <duxin40@gamil.com>

contrib/golang/upstreams/http/tcp/source/upstream_request.cc

doujiang24 · 2024-10-27T14:07:09Z

contrib/golang/upstreams/http/tcp/source/upstream_request.cc

+}
+
+void TcpUpstream::encodeTrailers(const Envoy::Http::RequestTrailerMap&) {
+  Buffer::OwnedImpl data;


ditto, we'd better golang convert trailers to data buffer, but we can just add a TODO for it now, it's not a common use case.

got it, will finish it in the near future.

contrib/golang/upstreams/http/tcp/test/test_data/http2dubbo-example/README.md

contrib/golang/upstreams/http/tcp/source/upstream_request.cc

…om response header in envoyGoOnUpstreamData Signed-off-by: duxin40 <duxin40@gamil.com>

doujiang24

Sorry for the late, it's good enough to add more tests, including integration tests.

contrib/golang/upstreams/http/tcp/source/upstream_request.cc

contrib/golang/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp/shim.go

contrib/golang/upstreams/http/tcp/source/processor_state.cc

Signed-off-by: duxin40 <duxin40@gamil.com>

.github/dependabot.yml

doujiang24

Nice work, we are closer

contrib/golang/upstreams/http/tcp/source/processor_state.cc

contrib/golang/upstreams/http/tcp/source/upstream_request.cc

contrib/golang/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp/shim.go

doujiang24 · 2025-01-11T04:39:15Z

contrib/golang/upstreams/http/tcp/source/go/pkg/upstreams/http/tcp/shim.go

+}
+
+func (f *requestMap) GetReq(key *C.httpRequest) *httpRequest {
+	if v, ok := f.requests.Load(key); ok {


Can we introduce the worker_id as #31987? it could be much better performance when there are large envoy workers.

it also could be marked as TODO, since this PR is big enough.

okay, let's mark it as a TODO, and i will optimize it in the near future~

docs/root/configuration/http/tcp_bridge/golang.rst

Signed-off-by: duxin40 <duxin40@gamil.com>

doujiang24 · 2025-01-18T16:03:50Z

/docs

repokitteh-read-only · 2025-01-18T16:03:55Z

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/36667/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: a #36667 (comment) was created by @doujiang24.

see: more, trace.

doujiang24

@duxin40 Thank you so much for your hard work and patience.

Please run the tests in the asan mode, in your local dev, here is the command from my side:

ENVOY_DOCKER_BUILD_DIR=/path/to/envoy-bazel-cache \
GOPROXY='https://goproxy.cn' \
    bash -x ci/run_envoy_docker.sh 'bash -x ci/do_ci.sh asan'

It's so good enough to merge from my side.

@mattklein123 @wbpcode could you please take another look at this PR.
It is a bit large, but it's also a very important feature to extend HTTP <-> RPC.

doujiang24 · 2025-01-18T16:08:54Z

docs/root/configuration/http/tcp_bridge/golang.rst

+.. literalinclude:: /_configs/go/golang-http-tcp-bridge-with-config.yaml
+   :language: yaml
+   :linenos:
+   :lines: 38-50


seems the line number is incorrect? see: https://storage.googleapis.com/envoy-pr/a4ef3f6/docs/configuration/http/tcp_bridge/golang.html

Signed-off-by: duxin40 <33946910+duxin40@users.noreply.github.com>

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only · 2025-01-19T02:27:20Z

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/36667/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: a #36667 (comment) was created by @duxin40.

see: more, trace.

duxin40 and others added 4 commits October 17, 2024 11:24

support golang tcp extension for http2tcp

01813c1

Signed-off-by: duxin40 <duxin40@gamil.com>

Merge pull request #8 from duxin40/main-merge

ed300bb

support golang tcp extension for http2tcp

merge code of opensource main

1386488

Signed-off-by: duxin40 <duxin40@gamil.com>

rollback go package version to follow opensource code

6946c93

Signed-off-by: duxin40 <duxin40@gamil.com>

duxin40 marked this pull request as ready for review October 17, 2024 08:12

duxin40 added 2 commits October 17, 2024 16:20

fix error for tests

7ae6768

Signed-off-by: duxin40 <duxin40@gamil.com>

fix error for tests

a60f4fa

Signed-off-by: duxin40 <duxin40@gamil.com>

tyxia assigned doujiang24 Oct 18, 2024

doujiang24 reviewed Oct 20, 2024

View reviewed changes

source/common/router/router.cc Outdated Show resolved Hide resolved

api/contrib/envoy/extensions/upstreams/http/tcp/golang/v3alpha/BUILD Outdated Show resolved Hide resolved

duxin40 added 3 commits October 21, 2024 15:18

add example for http2dubbo by golang extension on envoy

e8234db

Signed-off-by: duxin40 <duxin40@gamil.com>

delete unused code

17bc4a4

Signed-off-by: duxin40 <duxin40@gamil.com>

add new blank line

4b5880c

Signed-off-by: duxin40 <duxin40@gamil.com>

duxin40 force-pushed the main branch from f071f5d to 4b5880c Compare October 21, 2024 07:19

duxin40 added 3 commits October 21, 2024 21:05

Optimize http2dubbo example

4abfe0a

Signed-off-by: duxin40 <duxin40@gamil.com>

format example code

da41130

Signed-off-by: duxin40 <duxin40@gamil.com>

format example code

1c35411

Signed-off-by: duxin40 <duxin40@gamil.com>

mattklein123 self-assigned this Oct 21, 2024

mattklein123 added the waiting label Oct 21, 2024

support EncodeHeaders for goalng tcp upstream extension

98e1589

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Oct 22, 2024

mattklein123 added the waiting label Oct 22, 2024

doujiang24 reviewed Oct 27, 2024

View reviewed changes

1.support set buffer for writing upstream data 2.support specify cust…

9bb967c

…om response header in envoyGoOnUpstreamData Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Oct 30, 2024

doujiang24 reviewed Dec 29, 2024

View reviewed changes

remove lock since the plugin is sync-data-flow between c and go

ac75587

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Dec 31, 2024

mattklein123 added the waiting label Jan 3, 2025

optimize code about panic

4595abd

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Jan 4, 2025

terminate the stream when get panic

ad43324

Signed-off-by: duxin40 <duxin40@gamil.com>

mattklein123 added the waiting label Jan 6, 2025

add integration test for golang-http-tcp-bridge

e314824

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Jan 8, 2025

duxin40 added 3 commits January 9, 2025 12:41

fix ci problem

0dc67d0

Signed-off-by: duxin40 <duxin40@gamil.com>

optimize doc

3869b18

Signed-off-by: duxin40 <duxin40@gamil.com>

format code

1fbe401

Signed-off-by: duxin40 <duxin40@gamil.com>

duxin40 changed the title ~~feature: Http1-Tcp Bridge via Golang plugin~~ Feature: Golang Http Tcp Bridge Jan 9, 2025

doujiang24 reviewed Jan 10, 2025

View reviewed changes

.github/dependabot.yml Show resolved Hide resolved

doujiang24 reviewed Jan 11, 2025

View reviewed changes

mattklein123 added the waiting label Jan 11, 2025

optimize annotation and merge multiple test go mods into a single one

248045f

Signed-off-by: duxin40 <duxin40@gamil.com>

repokitteh-read-only bot removed the waiting label Jan 13, 2025

duxin40 added 3 commits January 13, 2025 14:00

add go.mod for test_data

c8942ba

Signed-off-by: duxin40 <duxin40@gamil.com>

add a test for add_data

e12539d

Signed-off-by: duxin40 <duxin40@gamil.com>

format code

a4ef3f6

Signed-off-by: duxin40 <duxin40@gamil.com>

mattklein123 added the waiting label Jan 15, 2025

doujiang24 reviewed Jan 18, 2025

View reviewed changes

Merge branch 'main' into main

914297e

Signed-off-by: duxin40 <33946910+duxin40@users.noreply.github.com>

repokitteh-read-only bot removed the waiting label Jan 19, 2025

format code and doc

8adb4d8

Signed-off-by: duxin40 <duxin40@gamil.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Golang Http Tcp Bridge #36667

Feature: Golang Http Tcp Bridge #36667

duxin40 commented Oct 17, 2024

repokitteh-read-only bot commented Oct 17, 2024

duxin40 commented Oct 17, 2024

duxin40 commented Oct 17, 2024

tyxia commented Oct 18, 2024 •

edited

Loading

repokitteh-read-only bot commented Oct 18, 2024

doujiang24 left a comment

duxin40 commented Oct 21, 2024

doujiang24 Oct 27, 2024

duxin40 Oct 30, 2024

doujiang24 left a comment

doujiang24 left a comment

doujiang24 Jan 11, 2025

doujiang24 Jan 11, 2025

duxin40 Jan 13, 2025 •

edited

Loading

doujiang24 commented Jan 18, 2025

repokitteh-read-only bot commented Jan 18, 2025

doujiang24 left a comment

doujiang24 Jan 18, 2025

repokitteh-read-only bot commented Jan 19, 2025

Feature: Golang Http Tcp Bridge #36667

Are you sure you want to change the base?

Feature: Golang Http Tcp Bridge #36667

Conversation

duxin40 commented Oct 17, 2024

Here is my thought about Golang extension function points:

What we can do with this Golang extension:

repokitteh-read-only bot commented Oct 17, 2024

duxin40 commented Oct 17, 2024

duxin40 commented Oct 17, 2024

tyxia commented Oct 18, 2024 • edited Loading

repokitteh-read-only bot commented Oct 18, 2024

doujiang24 left a comment

Choose a reason for hiding this comment

duxin40 commented Oct 21, 2024

doujiang24 Oct 27, 2024

Choose a reason for hiding this comment

duxin40 Oct 30, 2024

Choose a reason for hiding this comment

doujiang24 left a comment

Choose a reason for hiding this comment

doujiang24 left a comment

Choose a reason for hiding this comment

doujiang24 Jan 11, 2025

Choose a reason for hiding this comment

doujiang24 Jan 11, 2025

Choose a reason for hiding this comment

duxin40 Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

doujiang24 commented Jan 18, 2025

repokitteh-read-only bot commented Jan 18, 2025

doujiang24 left a comment

Choose a reason for hiding this comment

doujiang24 Jan 18, 2025

Choose a reason for hiding this comment

repokitteh-read-only bot commented Jan 19, 2025

tyxia commented Oct 18, 2024 •

edited

Loading

duxin40 Jan 13, 2025 •

edited

Loading