Documentation
¶
Overview ¶
Package httputil provides shared HTTP helper utilities used across multiple HTTP-facing packages (server, proxy, etc.).
Index ¶
- Constants
- func ApplyGitHubAPIHeaders(req *http.Request, authHeader string)
- func IsTransientHTTPError(statusCode int) bool
- func ParseRateLimitResetHeader(value string) time.Time
- func WriteErrorResponse(w http.ResponseWriter, statusCode int, code, message string)
- func WriteJSONResponse(w http.ResponseWriter, statusCode int, body interface{})
- type BaseResponseWriter
Constants ¶
const GitHubUserAgent = "awmg/1.0"
GitHubUserAgent is the User-Agent header value sent on all GitHub API requests.
Variables ¶
This section is empty.
Functions ¶
func ApplyGitHubAPIHeaders ¶ added in v0.3.1
ApplyGitHubAPIHeaders sets the standard GitHub API request headers on req. authHeader should be the full Authorization header value (e.g. "token xyz" or "Bearer xyz"). When authHeader is empty no Authorization header is set, which is appropriate when the caller has already decided that no auth is available.
func IsTransientHTTPError ¶ added in v0.2.25
IsTransientHTTPError returns true for status codes that indicate a temporary server-side condition (rate-limiting or transient failure) worth retrying.
func ParseRateLimitResetHeader ¶ added in v0.2.20
ParseRateLimitResetHeader parses the Unix-timestamp value of the X-RateLimit-Reset HTTP header into a time.Time. Returns zero time when the header value is absent or malformed.
func WriteErrorResponse ¶ added in v0.3.2
func WriteErrorResponse(w http.ResponseWriter, statusCode int, code, message string)
WriteErrorResponse writes a JSON error response with a consistent {"error": code, "message": message} shape. Both the server and proxy packages should use this helper so that API consumers always receive the same error shape.
func WriteJSONResponse ¶
func WriteJSONResponse(w http.ResponseWriter, statusCode int, body interface{})
WriteJSONResponse sets the Content-Type header, writes the status code, and encodes body as JSON. It centralises the three-line pattern used across HTTP handlers.
Types ¶
type BaseResponseWriter ¶ added in v0.3.14
type BaseResponseWriter struct {
http.ResponseWriter
// StatusCode holds the captured HTTP status code. It is set by WriteHeader
// and, if still zero when Write is first called, defaults to http.StatusOK.
// Only the first call to WriteHeader or Write sets StatusCode, matching
// net/http semantics where only the first status sent is effective.
StatusCode int
// contains filtered or unexported fields
}
BaseResponseWriter wraps http.ResponseWriter and captures the HTTP response status code. It implements Write (with implicit-200 capture), WriteHeader, and Unwrap so that http.ResponseController callers can access optional interfaces (e.g. http.Flusher, http.Hijacker) on the underlying writer.
Embed BaseResponseWriter in package-specific types to avoid duplicating this status-capture boilerplate.
func (*BaseResponseWriter) Unwrap ¶ added in v0.3.14
func (w *BaseResponseWriter) Unwrap() http.ResponseWriter
Unwrap returns the underlying http.ResponseWriter so that callers using http.ResponseController can discover optional interfaces such as http.Flusher or http.Hijacker on the real writer.
func (*BaseResponseWriter) Write ¶ added in v0.3.14
func (w *BaseResponseWriter) Write(b []byte) (int, error)
Write captures an implicit 200 status on first call when no prior WriteHeader was issued, then delegates to the underlying writer.
func (*BaseResponseWriter) WriteHeader ¶ added in v0.3.14
func (w *BaseResponseWriter) WriteHeader(code int)
WriteHeader captures the status code on first call and forwards it to the underlying writer. Subsequent calls are forwarded but do not update StatusCode, matching net/http semantics where only the first WriteHeader is effective.
Source Files