Skip to content
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.

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

Refactor: a new httpclient #1073

Merged
merged 5 commits into from
Dec 1, 2021
Merged

Conversation

breezewish
Copy link
Member

@breezewish breezewish commented Nov 29, 2021

This PR provides a new design of the HTTP client, pretty much close to resty.

Primary advantages:

  • No need to call Close(), just like resty.
  • No need to process error multiple times during the calling, just like resty, one chained call for all.
  • Unlike resty, No need to call and pair SetDoNotParseResponse() + .RawResponse in order to do streaming, just call PipeBody().
  • Unlike resty, No need to call and pair SetResult(&Foo{}) + .Result().(*Foo) in order to unmarshal, just call ReadBodyAsJSON(&foo).

Sample usages below :

Get response body in bytes:

bytes, _, err := httpclient.New(httpclient.Config{}).LR().
    Get(....).
    ReadBodyAsBytes(&data)
if err != nil {
    // error handling
}

Unmarshal JSON:

var data FooResponse
_, err := httpclient.New(httpclient.Config{}).LR().
    Get(....).
    ReadBodyAsJSON(&data)
if err != nil {
    // error handling
}

Streaming:

writtenBytes, _, err := httpclient.New(httpclient.Config{}).LR().
    Get(....).
    PipeBody(someWriter)
if err != nil {
    // error handling
}

Set Headers:

var data FooResponse
_, err := httpclient.New(httpclient.Config{}).LR().
    SetHeader("x-requested-with", "foo").
    Get(....).
    ReadBodyAsJSON(&data)
if err != nil {
    // error handling
}

Reuse clients:

client := httpclient.New(httpclient.Config{})
_, _, _ = client.LR().Get(...).ReadBodyAsString()
_, _, _ = client.LR().Get(...).ReadBodyAsString()

Read response headers:

bytes, rawResp, err := httpclient.New(httpclient.Config{}).LR().
    Get(....).
    ReadBodyAsBytes(&data)
if err != nil {
    // error handling
}
fmt.Println(rawResp.Header.Get("x-header"))

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Nov 29, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • shhdgit

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.


// +build race

// Package israce reports if the Go race detector is enabled.
Copy link
Member

Choose a reason for hiding this comment

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

knowledge++++

if err != nil {
return "", nil, err
}
return strings.TrimSpace(string(bytes)), resp, nil
Copy link
Member

Choose a reason for hiding this comment

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

Maybe it's too surprising to have TrimSpace, as a common http client.

Copy link
Member Author

Choose a reason for hiding this comment

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

This behavior is taken from resty:

// String method returns the body of the server response as String.
func (r *Response) String() string {
	if r.body == nil {
		return ""
	}
	return strings.TrimSpace(string(r.body))
}

@breezewish
Copy link
Member Author

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 1c9f041

@ti-chi-bot ti-chi-bot merged commit e9cb103 into master Dec 1, 2021
@ti-chi-bot ti-chi-bot deleted the refactor/move_httpclient/1_impl branch December 1, 2021 07:55
baurine pushed a commit to baurine/tidb-dashboard that referenced this pull request Dec 30, 2021
baurine added a commit that referenced this pull request Dec 30, 2021
* Revert "Release v2021.12.06.1 (#1084)"

This reverts commit bcc43a0.

* Compitable with different TiDB versions for conprof and non-root-login features (#1047)

* make conprof independent

* check feature enable

* add check feature enable middleware

* hide menu if feature is not enabled

* refactor non root login switch by new design

* i18n

* yarn fmt

* renaming

* adjust fe code

* refine

* remove unused log

* build(deps): bump ws from 5.2.2 to 5.2.3 in /ui (#1055)

* CICD: Update the release pipeline for recent PD format policies (#1054)

* fix i18n wording (#1056)

* Refactor: Change util module to util package (#1052)

* Refactor: Fix godot incorrectly add dot suffix to annotations (#1059)

* lint: Add goheader for copyright lints (#1062)

* Refactor: Migrate to use the `rest` package in util/ (#1060)

* fix(*): globally delete/update data by GORM (#1065)

* ui: bump dependencies (#1066)

* refactor: Switch to use ziputil, netutil, reflectutil and fileswap (#1067)

* Fix request header being pinned after pd profiling (#1069)

* Integrate speedscope (#1064)

* fix potential panic when GetPDInstances (#1075)

Signed-off-by: crazycs <chen.two.cs@gmail.com>

* Refactor: a new httpclient (#1073)

* Refactor: Switch to use util/distro in all places (#1078)

* chore: support import relative file URL (#1082)

* Refactor: Move tools into a standalone module (#1079)

* Fix script to embed the ui (#1088)

* Fix script to embed the ui

* Hack write_strings

* Refactor feature flag to support more modules (#1057)

* Drop sysutil dependency (#1093)

* chore: add graph generation (#1085)

* Refactor: Add TopologyProvider (#1098)

* esbuild: i18n + dep (#1101)

* script: Add a script to generate version matrix (#1104)

* distro: support dynamic config (#1094)

* chore: support multiple profiling types (#1095)

* fix(distro): check distro_strings.json fmt by prettier (#1106)

* script: fix generate assets (#1107)

* Add integration test (#1083)

* debug_api: Switch to use the new util (#1103)

* refactor(ui): auto refresh button (#1105)

* refactor(ui): auto refresh button

* chore: update translation

* fix: remain seconds

* refine: refresh button

* fix: onRefresh

* fix: auto refresh

* fix: continue tick

* chore: add some comments

* tweak: remaining refresh seconds

* chore: clean code

Co-authored-by: Wenxuan <breezewish@pingcap.com>

* ui: refine conprof (#1102)

* update wording

* not check prom any more

* replace time range component

* i18n

* support view profile by diffrent ways

* extract ActionsButton

* change download data format

* refine

* comments

* Revert "comments"

This reverts commit 3b03fdb.

* fix view cpu profile fail

* update state

* hide action button if disable

* address feedback

* update release-version

* sync with master

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Wenxuan <breezewish@pingcap.com>
Co-authored-by: Suhaha <jklopsdfw@gmail.com>
Co-authored-by: Yini Xu <34967660+YiniXu9506@users.noreply.github.com>
Co-authored-by: crazycs <crazycs520@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants