Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cli/api/http_client.go at trunk · cli/cli · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
cli
/
cli
Public
Notifications
You must be signed in to change notification settings
Fork
9k
Star
46.3k
Code
Issues
1k
Pull requests
62
Discussions
Actions
Projects
Security and quality
13
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Files
Expand file tree
trunk
Breadcrumbs
cli
/
api
/
http_client.go
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
240 lines (206 loc) · 7.03 KB
trunk
Breadcrumbs
cli
/
api
/
http_client.go
Copy path
Top
File metadata and controls
Code
Blame
240 lines (206 loc) · 7.03 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
package
api
import
(
"fmt"
"io"
"net/http"
"net/url"
"strings"
"time"
"github.com/cli/cli/v2/internal/gh/ghtelemetry"
"github.com/cli/cli/v2/utils"
ghAPI
"github.com/cli/go-gh/v2/pkg/api"
ghauth
"github.com/cli/go-gh/v2/pkg/auth"
)
type
config
interface
{
ActiveToken
(
string
) (
string
,
string
)
HostForAPIHost
(
string
) (
string
,
bool
)
}
type
HTTPClientOptions
struct
{
AppVersion
string
InvokingAgent
string
CacheTTL
time.
Duration
Config
config
EnableCache
bool
Log
io.
Writer
LogColorize
bool
LogVerboseHTTP
bool
SkipDefaultHeaders
bool
TelemetryDisabler
ghtelemetry.
Disabler
}
func
NewHTTPClient
(
opts
HTTPClientOptions
) (
*
http.
Client
,
error
) {
// Provide invalid host, and token values so gh.HTTPClient will not automatically resolve them.
// The real host and token are inserted at request time.
clientOpts
:=
ghAPI.
ClientOptions
{
Host
:
"none"
,
AuthToken
:
"none"
,
LogIgnoreEnv
:
true
,
SkipDefaultHeaders
:
opts
.
SkipDefaultHeaders
,
}
debugEnabled
,
debugValue
:=
utils
.
IsDebugEnabled
()
if
strings
.
Contains
(
debugValue
,
"api"
) {
opts
.
LogVerboseHTTP
=
true
}
if
opts
.
LogVerboseHTTP
||
debugEnabled
{
clientOpts
.
Log
=
opts
.
Log
clientOpts
.
LogColorize
=
opts
.
LogColorize
clientOpts
.
LogVerboseHTTP
=
opts
.
LogVerboseHTTP
}
ua
:=
fmt
.
Sprintf
(
"GitHub CLI %s"
,
opts
.
AppVersion
)
if
opts
.
InvokingAgent
!=
""
{
ua
=
fmt
.
Sprintf
(
"%s Agent/%s"
,
ua
,
opts
.
InvokingAgent
)
}
headers
:=
map
[
string
]
string
{
userAgent
:
ua
,
apiVersion
:
apiVersionValue
,
}
clientOpts
.
Headers
=
headers
if
opts
.
EnableCache
{
clientOpts
.
EnableCache
=
opts
.
EnableCache
clientOpts
.
CacheTTL
=
opts
.
CacheTTL
}
client
,
err
:=
ghAPI
.
NewHTTPClient
(
clientOpts
)
if
err
!=
nil
{
return
nil
,
err
}
if
opts
.
Config
!=
nil
{
client
.
Transport
=
AddAuthTokenHeader
(
client
.
Transport
,
opts
.
Config
)
}
if
opts
.
TelemetryDisabler
!=
nil
{
client
.
Transport
=
telemetryDisablerTransport
{
wrappedTransport
:
client
.
Transport
,
telemetryDisabler
:
opts
.
TelemetryDisabler
,
}
}
return
client
,
nil
}
// ExternalHTTPClientOptions holds options for creating an external HTTP client.
type
ExternalHTTPClientOptions
struct
{
AppVersion
string
Log
io.
Writer
LogColorize
bool
Transport
http.
RoundTripper
}
// NewExternalHTTPClient creates an HTTP client for talking to non-GitHub hosts.
// It includes debug logging and a User-Agent header but does not attach any
// authentication tokens or GitHub-specific headers.
func
NewExternalHTTPClient
(
opts
ExternalHTTPClientOptions
) (
*
http.
Client
,
error
) {
clientOpts
:=
ghAPI.
ClientOptions
{
Host
:
"none"
,
AuthToken
:
"none"
,
LogIgnoreEnv
:
true
,
SkipDefaultHeaders
:
true
,
Transport
:
opts
.
Transport
,
}
debugEnabled
,
debugValue
:=
utils
.
IsDebugEnabled
()
logVerboseHTTP
:=
false
if
strings
.
Contains
(
debugValue
,
"api"
) {
logVerboseHTTP
=
true
}
if
logVerboseHTTP
||
debugEnabled
{
clientOpts
.
Log
=
opts
.
Log
clientOpts
.
LogColorize
=
opts
.
LogColorize
clientOpts
.
LogVerboseHTTP
=
logVerboseHTTP
}
clientOpts
.
Headers
=
map
[
string
]
string
{
userAgent
:
fmt
.
Sprintf
(
"GitHub CLI %s"
,
opts
.
AppVersion
),
}
client
,
err
:=
ghAPI
.
NewHTTPClient
(
clientOpts
)
if
err
!=
nil
{
return
nil
,
err
}
return
client
,
nil
}
func
NewCachedHTTPClient
(
httpClient
*
http.
Client
,
ttl
time.
Duration
)
*
http.
Client
{
newClient
:=
*
httpClient
newClient
.
Transport
=
AddCacheTTLHeader
(
httpClient
.
Transport
,
ttl
)
return
&
newClient
}
// AddCacheTTLHeader adds a header to the request telling the cache that the request
// should be cached for a specified amount of time.
func
AddCacheTTLHeader
(
rt
http.
RoundTripper
,
ttl
time.
Duration
) http.
RoundTripper
{
return
&
funcTripper
{
roundTrip
:
func
(
req
*
http.
Request
) (
*
http.
Response
,
error
) {
// If the header is already set in the request, don't overwrite it.
if
req
.
Header
.
Get
(
cacheTTL
)
==
""
{
req
.
Header
.
Set
(
cacheTTL
,
ttl
.
String
())
}
return
rt
.
RoundTrip
(
req
)
}}
}
// AddAuthTokenHeader adds an authentication token header for the host specified by the request.
func
AddAuthTokenHeader
(
rt
http.
RoundTripper
,
cfg
config
) http.
RoundTripper
{
return
&
funcTripper
{
roundTrip
:
func
(
req
*
http.
Request
) (
*
http.
Response
,
error
) {
// If the header is already set in the request, don't overwrite it.
if
req
.
Header
.
Get
(
authorization
)
!=
""
{
return
rt
.
RoundTrip
(
req
)
}
var
redirectHostnameChange
bool
if
req
.
Response
!=
nil
&&
req
.
Response
.
Request
!=
nil
{
redirectHostnameChange
=
getHostname
(
req
)
!=
getHostname
(
req
.
Response
.
Request
)
}
// Only set header if an initial request or redirect request to the same host as the initial request.
// If the host has changed during a redirect do not add the authentication token header.
if
redirectHostnameChange
{
return
rt
.
RoundTrip
(
req
)
}
hostnameInRequest
:=
ghauth
.
NormalizeHostname
(
getHostname
(
req
))
token
,
_
:=
cfg
.
ActiveToken
(
hostnameInRequest
)
if
token
==
""
{
// The request may be aimed at a host's api_host, which gh is
// not logged in to and so has no token of its own. Fall back
// to the token of the host it stands in for. This only ever
// adds a token where there would have been none, so hosts we
// already authenticate keep resolving exactly as before.
if
canonicalHost
,
ok
:=
cfg
.
HostForAPIHost
(
hostnameInRequest
);
ok
{
token
,
_
=
cfg
.
ActiveToken
(
canonicalHost
)
}
}
if
token
!=
""
{
req
.
Header
.
Set
(
authorization
,
fmt
.
Sprintf
(
"token %s"
,
token
))
}
return
rt
.
RoundTrip
(
req
)
}}
}
// ExtractHeader extracts a named header from any response received by this client and,
// if non-blank, saves it to dest.
func
ExtractHeader
(
name
string
,
dest
*
string
)
func
(http.
RoundTripper
) http.
RoundTripper
{
return
func
(
tr
http.
RoundTripper
) http.
RoundTripper
{
return
&
funcTripper
{
roundTrip
:
func
(
req
*
http.
Request
) (
*
http.
Response
,
error
) {
res
,
err
:=
tr
.
RoundTrip
(
req
)
if
err
==
nil
{
if
value
:=
res
.
Header
.
Get
(
name
);
value
!=
""
{
*
dest
=
value
}
}
return
res
,
err
}}
}
}
type
funcTripper
struct
{
roundTrip
func
(
*
http.
Request
) (
*
http.
Response
,
error
)
}
func
(
tr
funcTripper
)
RoundTrip
(
req
*
http.
Request
) (
*
http.
Response
,
error
) {
return
tr
.
roundTrip
(
req
)
}
// getHostname returns the hostname the request is addressed to, preferring an
// explicit Host override and falling back to the URL host. Any port in the host
// is stripped, so callers compare on the hostname alone.
func
getHostname
(
r
*
http.
Request
)
string
{
host
:=
r
.
Host
if
host
==
""
{
host
=
r
.
URL
.
Host
}
return
(
&
url.
URL
{
Host
:
host
}).
Hostname
()
}
type
telemetryDisablerTransport
struct
{
wrappedTransport
http.
RoundTripper
telemetryDisabler
ghtelemetry.
Disabler
}
func
(
t
telemetryDisablerTransport
)
RoundTrip
(
req
*
http.
Request
) (
*
http.
Response
,
error
) {
// If the request is aimed at an enterprise host, disable telemetry.
// Currently, requests that are sent to configured api_hosts will be treated as enterprise hosts,
// even though they may be GHEC with Data Residency.
if
ghauth
.
IsEnterprise
(
getHostname
(
req
)) {
t
.
telemetryDisabler
.
Disable
()
}
return
t
.
wrappedTransport
.
RoundTrip
(
req
)
}
You can’t perform that action at this time.