harbor/src/lib/response_buffer.go
chlins 7eed9db404 feat(manifest): introduce cache layer for manifest (#16459)
Implement cache layer for resource manifest, it will read manifest
from cache instead of proxying to distribution if enabled.

Signed-off-by: chlins <chenyuzh@vmware.com>
2022-05-19 10:25:50 +08:00

114 lines
2.8 KiB
Go

// Copyright Project Harbor Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package lib
import (
"bytes"
"errors"
"net/http"
)
// ResponseBuffer is a wrapper for the http.ResponseWriter to buffer the response data
type ResponseBuffer struct {
w http.ResponseWriter
code int
header http.Header
buffer bytes.Buffer
wroteHeader bool
flushed bool
}
// NewResponseBuffer creates a ResponseBuffer object
func NewResponseBuffer(w http.ResponseWriter) *ResponseBuffer {
return &ResponseBuffer{
w: w,
header: http.Header{},
buffer: bytes.Buffer{},
}
}
// WriteHeader writes the status code into the buffer without writing to the underlying response writer
func (r *ResponseBuffer) WriteHeader(statusCode int) {
if r.wroteHeader {
return
}
r.wroteHeader = true
r.code = statusCode
}
// Write writes the data into the buffer without writing to the underlying response writer
func (r *ResponseBuffer) Write(data []byte) (int, error) {
if !r.wroteHeader {
r.WriteHeader(http.StatusOK)
}
return r.buffer.Write(data)
}
// Header returns the header of the buffer
func (r *ResponseBuffer) Header() http.Header {
return r.header
}
// Buffer returns the buffer of ResponseBuffer
func (r *ResponseBuffer) Buffer() []byte {
return r.buffer.Bytes()
}
// Flush the status code, header and data into the underlying response writer
func (r *ResponseBuffer) Flush() (int, error) {
r.flushed = true
header := r.w.Header()
for k, vs := range r.header {
for _, v := range vs {
header.Add(k, v)
}
}
if r.code > 0 {
r.w.WriteHeader(r.code)
}
return r.w.Write(r.buffer.Bytes())
}
// Success checks whether the status code is >= 200 & <= 399
func (r *ResponseBuffer) Success() bool {
code := r.StatusCode()
return code >= http.StatusOK && code < http.StatusBadRequest
}
// Reset reset the response buffer
func (r *ResponseBuffer) Reset() error {
if r.flushed {
return errors.New("response flushed")
}
r.code = 0
r.wroteHeader = false
r.header = http.Header{}
r.buffer = bytes.Buffer{}
return nil
}
// StatusCode returns the status code
func (r *ResponseBuffer) StatusCode() int {
if r.code == 0 {
// NOTE: r.code is zero means that `WriteHeader` not called by the http handler,
// so process it as http.StatusOK
return http.StatusOK
}
return r.code
}