feat(lib/runtime): Implement ext_offchain_http_request_start_version_1 host function
#1947
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,103 @@ | ||||||||
| package offchain | ||||||||
|
|
||||||||
| import ( | ||||||||
| "errors" | ||||||||
| "net/http" | ||||||||
| "sync" | ||||||||
| ) | ||||||||
|
|
||||||||
| const maxConcurrentRequests = 1000 | ||||||||
|
|
||||||||
| var ( | ||||||||
| errIntBufferEmpty = errors.New("int buffer exhausted") | ||||||||
| errIntBufferFull = errors.New("int buffer is full") | ||||||||
| errRequestIDNotAvailable = errors.New("request id not available") | ||||||||
| ) | ||||||||
|
|
||||||||
| // requestIDBuffer created to control the amount of available non-duplicated ids | ||||||||
| type requestIDBuffer chan int16 | ||||||||
|
|
||||||||
| // newIntBuffer creates the request id buffer starting from 1 till @buffSize (by default @buffSize is 1000) | ||||||||
| func newIntBuffer(buffSize int16) *requestIDBuffer { | ||||||||
| b := make(chan int16, buffSize) | ||||||||
| for i := int16(1); i <= buffSize; i++ { | ||||||||
| b <- i | ||||||||
| } | ||||||||
|
|
||||||||
| intb := requestIDBuffer(b) | ||||||||
| return &intb | ||||||||
| } | ||||||||
|
|
||||||||
| func (b *requestIDBuffer) get() (int16, error) { | ||||||||
| select { | ||||||||
| case v := <-*b: | ||||||||
| return v, nil | ||||||||
| default: | ||||||||
| return 0, errIntBufferEmpty | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| func (b *requestIDBuffer) put(i int16) error { | ||||||||
| select { | ||||||||
| case *b <- i: | ||||||||
| return nil | ||||||||
| default: | ||||||||
| return errIntBufferFull | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| // HTTPSet holds a pool of concurrent http request calls | ||||||||
| type HTTPSet struct { | ||||||||
| mtx *sync.Mutex | ||||||||
|
There was a problem hiding this comment. you can embed this, so you don't need to call
Suggested change
|
||||||||
| reqs map[int16]*http.Request | ||||||||
|
There was a problem hiding this comment. is there a chance this map will be accesses concurrently? I think potentially There was a problem hiding this comment. yes! There is mutexes locks in |
||||||||
| idBuff *requestIDBuffer | ||||||||
| } | ||||||||
|
|
||||||||
| // NewHTTPSet creates a offchain http set that can be used | ||||||||
| // by runtime as HTTP clients, the max concurrent requests is 1000 | ||||||||
| func NewHTTPSet() *HTTPSet { | ||||||||
| return &HTTPSet{ | ||||||||
| mtx: new(sync.Mutex), | ||||||||
| reqs: make(map[int16]*http.Request), | ||||||||
| idBuff: newIntBuffer(maxConcurrentRequests), | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| // StartRequest create a new request using the method and the uri, adds the request into the list | ||||||||
| // and then return the position of the request inside the list | ||||||||
| func (p *HTTPSet) StartRequest(method, uri string) (int16, error) { | ||||||||
| p.mtx.Lock() | ||||||||
| defer p.mtx.Unlock() | ||||||||
|
|
||||||||
| id, err := p.idBuff.get() | ||||||||
| if err != nil { | ||||||||
| return 0, err | ||||||||
| } | ||||||||
|
|
||||||||
| if _, ok := p.reqs[id]; ok { | ||||||||
| return 0, errRequestIDNotAvailable | ||||||||
| } | ||||||||
|
|
||||||||
| req, err := http.NewRequest(method, uri, nil) | ||||||||
| if err != nil { | ||||||||
| return 0, err | ||||||||
| } | ||||||||
|
|
||||||||
| p.reqs[id] = req | ||||||||
| return id, nil | ||||||||
| } | ||||||||
|
|
||||||||
| // Remove just remove a expecific request from reqs | ||||||||
| func (p *HTTPSet) Remove(id int16) error { | ||||||||
| p.mtx.Lock() | ||||||||
| defer p.mtx.Unlock() | ||||||||
|
|
||||||||
| delete(p.reqs, id) | ||||||||
|
|
||||||||
| return p.idBuff.put(id) | ||||||||
| } | ||||||||
|
|
||||||||
| // Get returns a request or nil if request not found | ||||||||
| func (p *HTTPSet) Get(id int16) *http.Request { | ||||||||
| return p.reqs[id] | ||||||||
| } | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package offchain | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| const defaultTestURI = "http://example.url" | ||
|
|
||
| func TestHTTPSetLimit(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| set := NewHTTPSet() | ||
| var err error | ||
| for i := 0; i < maxConcurrentRequests+1; i++ { | ||
| _, err = set.StartRequest(http.MethodGet, defaultTestURI) | ||
| } | ||
|
|
||
| require.ErrorIs(t, errIntBufferEmpty, err) | ||
| } | ||
|
|
||
| func TestHTTPSet_StartRequest_NotAvailableID(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| set := NewHTTPSet() | ||
| set.reqs[0] = &http.Request{} | ||
|
|
||
| _, err := set.StartRequest(http.MethodGet, defaultTestURI) | ||
| require.ErrorIs(t, errRequestIDNotAvailable, err) | ||
| } | ||
|
|
||
| func TestHTTPSetGet(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| set := NewHTTPSet() | ||
|
|
||
| id, err := set.StartRequest(http.MethodGet, defaultTestURI) | ||
| require.NoError(t, err) | ||
|
|
||
| req := set.Get(id) | ||
| require.NotNil(t, req) | ||
|
|
||
| require.Equal(t, http.MethodGet, req.Method) | ||
| require.Equal(t, defaultTestURI, req.URL.String()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this need to return a pointer? you can change the receiver methods below to be
(b requestIDBuffer), then you don't need to dereference it in the methodsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!