feat: supports stream route API #2104

Xu-Mj · 2021-08-30T12:44:02Z

Please answer these questions before submitting a pull request, or your PR will get closed.

Why submit this pull request?

Bugfix
New feature provided
Improve performance
Backport patches

What changes will this PR take into?

supports dynamic configuration of stream-route

Related issues

fix/resolve #1986

Checklist:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

netlify · 2021-08-30T12:44:08Z

✔️ Deploy Preview for apisix-dashboard ready!

🔨 Explore the source changes: 1647f57

🔍 Inspect the deploy log: https://app.netlify.com/sites/apisix-dashboard/deploys/61385b17600b060008573d8b

😎 Browse the preview: https://deploy-preview-2104--apisix-dashboard.netlify.app

starsz

Good feature.Thank you very much.

And there are still two things that need to be done.

Add the e2e test for it.
Use JSON schema to check the stream route.

We can do it in the next PR.

starsz · 2021-08-30T14:45:03Z

api/internal/handler/stream_route/stream_route.go

+	r.POST("/apisix/admin/stream_routes", wgin.Wraps(h.Create,
+		wrapper.InputType(reflect.TypeOf(entity.StreamRoute{}))))
+	r.PUT("/apisix/admin/stream_routes", wgin.Wraps(h.Update,
+		wrapper.InputType(reflect.TypeOf(UpdateInput{}))))


I think we don't need this handler.

a little confused: how do we create a stream-route , we only support get and delete handler?

We can use POST to create a stream route. Right?

Refer: http://apisix.apache.org/docs/apisix/admin-api#stream-route

api/internal/handler/stream_route/stream_route.go

starsz · 2021-08-30T14:48:11Z

api/internal/handler/stream_route/stream_route_test.go

+	"github.com/stretchr/testify/mock"
+	"net/http"
+	"testing"
+)


starsz · 2021-08-30T14:48:33Z

api/internal/route.go

@@ -18,6 +18,7 @@ package internal

 import (
 	"fmt"
+	"github.com/apisix/manager-api/internal/handler/stream_route"


Xu-Mj · 2021-08-30T14:55:54Z

Good feature.Thank you very much.

And there are still two things that need to be done.

Add the e2e test for it.

Use JSON schema to check the stream route.

We can do it in the next PR.

OK，got it！

nic-chen · 2021-08-31T10:42:30Z

@Xu-Mj
My suggestion is to update the schema and struct first and then submit the APIs (including test cases) in two to three times.

liuxiran · 2021-08-31T23:22:42Z

@Xu-Mj
My suggestion is to update the schema and struct first and then submit the APIs (including test cases) in two to three times.

Agree with @nic-chen , and we plan to update the schema to latest APISIX 2.9 this week in other pr by @bzp2010 , @Xu-Mj can focus on improve code and test cases, unit test and e2e test，thanks a lot

Xu-Mj · 2021-09-01T12:17:06Z

@Xu-Mj
My suggestion is to update the schema and struct first and then submit the APIs (including test cases) in two to three times.

ok，got it

Xu-Mj · 2021-09-01T12:17:41Z

@Xu-Mj
My suggestion is to update the schema and struct first and then submit the APIs (including test cases) in two to three times.

Agree with @nic-chen , and we plan to update the schema to latest APISIX 2.9 this week in other pr by @bzp2010 , @Xu-Mj can focus on improve code and test cases, unit test and e2e test，thanks a lot

ok

starsz · 2021-09-02T03:45:08Z

@Xu-Mj
My suggestion is to update the schema and struct first and then submit the APIs (including test cases) in two to three times.

Agree with @nic-chen , and we plan to update the schema to latest APISIX 2.9 this week in other pr by @bzp2010 , @Xu-Mj can focus on improve code and test cases, unit test and e2e test，thanks a lot

Got it. 👍

liuxiran · 2021-09-06T07:03:40Z

Hi @Xu-Mj our schema has already updated, see: #2117

and you can merge master to go on your test cases, any question can comment here, thanks a lot

codecov-commenter · 2021-09-07T09:43:39Z

Codecov Report

Attention: Patch coverage is 72.47706% with 30 lines in your changes missing coverage. Please review.

Project coverage is 69.39%. Comparing base (9f17637) to head (6cdc584).
Report is 189 commits behind head on master.

Files with missing lines	Patch %	Lines
api/internal/handler/stream_route/stream_route.go	67.53%	16 Missing and 9 partials ⚠️
api/internal/handler/upstream/upstream.go	80.00%	2 Missing and 1 partial ⚠️
api/internal/core/store/storehub.go	87.50%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2104      +/-   ##
==========================================
- Coverage   69.52%   69.39%   -0.14%     
==========================================
  Files         189      190       +1     
  Lines        7275     7381     +106     
  Branches      823      824       +1     
==========================================
+ Hits         5058     5122      +64     
- Misses       1921     1952      +31     
- Partials      296      307      +11

Flag	Coverage Δ
backend-e2e-test	`45.69% <31.19%> (-0.52%)`	⬇️
backend-e2e-test-ginkgo	`50.16% <68.80%> (+0.41%)`	⬆️
backend-unit-test	`49.13% <10.18%> (-1.26%)`	⬇️
frontend-e2e-test	`68.13% <ø> (-0.08%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

api/test/e2e/stream_route_test.go

Xu-Mj · 2021-09-16T02:09:48Z

Hi @Xu-Mj our schema has already updated, see: #2117

and you can merge master to go on your test cases, any question can comment here, thanks a lot

Hi，@liuxiran i followed your suggestion,and completed test module. is there still any problem? and how to validate a stream route in apisix?

bzp2010 · 2021-09-20T15:09:20Z

Hi, @nic-chen @LiteSun. Do we need to actually test the stream route created in the dashboard and how we should do it? Do you have any suggestions?

api/internal/handler/stream_route/stream_route_test.go

api/test/e2enew/base/base.go

api/internal/core/entity/entity.go

starsz · 2021-10-20T12:58:54Z

api/internal/handler/stream_route/stream_route.go

+	r.POST("/apisix/admin/stream_routes", wgin.Wraps(h.Create,
+		wrapper.InputType(reflect.TypeOf(entity.StreamRoute{}))))
+	r.PUT("/apisix/admin/stream_routes", wgin.Wraps(h.Update,
+		wrapper.InputType(reflect.TypeOf(UpdateInput{}))))


We can use POST to create a stream route. Right?

Refer: http://apisix.apache.org/docs/apisix/admin-api#stream-route

api/internal/handler/stream_route/stream_route.go

api/test/e2enew/base/base.go

bzp2010 · 2021-10-21T06:46:11Z

Hi, @nic-chen @starsz.

We can use POST to create a stream route. Right?

Yes, we can use it.

Better to add it. It's important.

TCP and UDP test case added.

api/test/e2enew/stream_route/stream_route_test.go

caibirdme · 2023-04-13T04:17:04Z

Which version support this feature? I don't see any place to config stream_route in v3.0

Xu-Mj added 4 commits August 27, 2021 12:06

feat: add stream route module

22a8b1f

feat: add stream route test cases

d825953

fix: change error handling

68199b0

feat: add license for stream route

47078cd

starsz reviewed Aug 30, 2021

View reviewed changes

starsz requested a review from nic-chen August 30, 2021 14:50

liuxiran mentioned this pull request Aug 30, 2021

feat: supports dynamic configuration of stream-route #1986

Closed

liuxiran requested a review from bzp2010 August 31, 2021 01:31

fix: format imports

b28a045

Xu-Mj added 4 commits September 7, 2021 16:24

fix: add stream route to schema check queue

0d49fea

feat: add e2e test

de766a4

feat: add desc and plugins parameters

b2f28ad

Merge branch 'master' into stream_route

51937a3

liuxiran reviewed Sep 8, 2021

View reviewed changes

api/test/e2e/stream_route_test.go Outdated Show resolved Hide resolved

Xu-Mj added 4 commits September 8, 2021 14:39

feat: add e2e test

c4e2d9f

feat: add license for e2e test

1647f57

fix: fix e2e test case body error

4029a5b

fix: delete trailing whitespace at stream_route_test.go 45 line

95ac83a

Merge branch 'master' into stream_route

4b88275

bzp2010 added 7 commits October 18, 2021 22:48

test: remove old E2E implementation

fd97fa2

test: fix typo

a60c504

feat: add upstream usage check

30cd147

test: add stream route E2E with upstream

be74488

test: fix unit test

1ecd33b

test: update E2E case

2e1d987

test: update E2E environment configure

df2dac8

bzp2010 changed the title ~~feat: supports dynamic configuration of stream-route~~ feat: supports stream route API Oct 19, 2021

nic-chen reviewed Oct 19, 2021

View reviewed changes

api/internal/handler/stream_route/stream_route_test.go Show resolved Hide resolved

nic-chen reviewed Oct 19, 2021

View reviewed changes

api/test/e2enew/base/base.go Show resolved Hide resolved

bzp2010 added 3 commits October 19, 2021 16:51

test: add condition list unit test

8f0d27c

Merge branch 'master' into stream_route

7813825

test: add TLS with SNI DP E2E test

4506f43

bzp2010 requested review from nic-chen, starsz and liuxiran October 20, 2021 01:24

starsz reviewed Oct 20, 2021

View reviewed changes

bzp2010 added 2 commits October 21, 2021 11:14

chore: rename Sni to SNI

01e6d0e

test: add TCP and UDP E2E test

55476e6

test: fix TCP read

6cdc584

bzp2010 requested a review from starsz October 25, 2021 02:20

nic-chen reviewed Oct 25, 2021

View reviewed changes

api/test/e2enew/stream_route/stream_route_test.go Show resolved Hide resolved

iamayushdas approved these changes Oct 25, 2021

View reviewed changes

starsz approved these changes Nov 3, 2021

View reviewed changes

nic-chen approved these changes Nov 4, 2021

View reviewed changes

bzp2010 self-assigned this Nov 4, 2021

bzp2010 approved these changes Nov 4, 2021

View reviewed changes

bzp2010 merged commit e53a607 into apache:master Nov 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: supports stream route API #2104

feat: supports stream route API #2104

Xu-Mj commented Aug 30, 2021

netlify bot commented Aug 30, 2021 •

edited

Loading

starsz left a comment •

edited

Loading

starsz Aug 30, 2021

Xu-Mj Aug 31, 2021

starsz Oct 20, 2021

starsz Aug 30, 2021

starsz Aug 30, 2021

Xu-Mj commented Aug 30, 2021

nic-chen commented Aug 31, 2021

liuxiran commented Aug 31, 2021

Xu-Mj commented Sep 1, 2021

Xu-Mj commented Sep 1, 2021

starsz commented Sep 2, 2021

liuxiran commented Sep 6, 2021

codecov-commenter commented Sep 7, 2021 •

edited

Loading

Xu-Mj commented Sep 16, 2021 •

edited

Loading

bzp2010 commented Sep 20, 2021

starsz Oct 20, 2021

bzp2010 commented Oct 21, 2021

caibirdme commented Apr 13, 2023

feat: supports stream route API #2104

feat: supports stream route API #2104

Conversation

Xu-Mj commented Aug 30, 2021

netlify bot commented Aug 30, 2021 • edited Loading

starsz left a comment • edited Loading

Choose a reason for hiding this comment

starsz Aug 30, 2021

Choose a reason for hiding this comment

Xu-Mj Aug 31, 2021

Choose a reason for hiding this comment

starsz Oct 20, 2021

Choose a reason for hiding this comment

starsz Aug 30, 2021

Choose a reason for hiding this comment

starsz Aug 30, 2021

Choose a reason for hiding this comment

Xu-Mj commented Aug 30, 2021

nic-chen commented Aug 31, 2021

liuxiran commented Aug 31, 2021

Xu-Mj commented Sep 1, 2021

Xu-Mj commented Sep 1, 2021

starsz commented Sep 2, 2021

liuxiran commented Sep 6, 2021

codecov-commenter commented Sep 7, 2021 • edited Loading

Codecov Report

Xu-Mj commented Sep 16, 2021 • edited Loading

bzp2010 commented Sep 20, 2021

starsz Oct 20, 2021

Choose a reason for hiding this comment

bzp2010 commented Oct 21, 2021

caibirdme commented Apr 13, 2023

netlify bot commented Aug 30, 2021 •

edited

Loading

starsz left a comment •

edited

Loading

codecov-commenter commented Sep 7, 2021 •

edited

Loading

Xu-Mj commented Sep 16, 2021 •

edited

Loading