https://github.com/joeig/singleshot

http.RoundTripper which deduplicates similar HTTP requests
https://github.com/joeig/singleshot

go roundtripper

Last synced: 3 months ago
JSON representation

http.RoundTripper which deduplicates similar HTTP requests

• Host: GitHub
• URL: https://github.com/joeig/singleshot
• Owner: joeig
• License: mit
• Created: 2021-11-26T20:09:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T05:36:03.000Z (5 months ago)
• Last Synced: 2024-10-02T09:21:21.673Z (3 months ago)
• Topics: go, roundtripper
• Language: Go
• Homepage: https://pkg.go.dev/go.eigsys.de/singleshot
• Size: 25.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Singleshot

Singleshot provides an `http.RoundTripper` which deduplicates similar HTTP requests.

[![Go Report Card](https://goreportcard.com/badge/go.eigsys.de/singleshot)](https://goreportcard.com/report/go.eigsys.de/singleshot)

[![PkgGoDev](https://pkg.go.dev/badge/go.eigsys.de/singleshot)](https://pkg.go.dev/go.eigsys.de/singleshot)

If two similar HTTP requests are supposed to be sent concurrently, the first one will actually be sent to the server, while the second one waits until the first one was fulfilled completely.

The second request will never be sent to the server, but returns a copy of the response of the first request.

```text

Req 1 -----------------> Resp 1

             Req 2 ----> Resp 1'

                                Req 3 -------------> Resp 3

```

## Usage

```go

package main

import (

	"net/http"

	"go.eigsys.de/singleshot"

)

func main() {

	_ = http.Client{

		Transport: singleshot.NewTransport(http.DefaultTransport),

	}

}

```

## Notes

* Always apply proper timeouts or use requests with contexts, otherwise one request which is timing out may stop subsequent requests from being retried.

* Requests are considered deduplicatable, if they share the same HTTP method and request URI. Furthermore, the method has to be `GET` and the request must not be a `range` request. The body is ignored according to [RFC 2616, section 9.3](https://www.rfc-editor.org/rfc/rfc2616#section-9.3).

## Documentation

See [GoDoc](https://godoc.org/go.eigsys.de/singleshot).