mirror of
https://github.com/GopeedLab/gopeed.git
synced 2026-11-17 13:53:41 +00:00
refactor(resolve): use Fetcher.Close for preview cancellation
This commit is contained in:
1 parent
8161042b93
commit
882f0cbc84
3 files changed
+4
-71
No files matched your search
@@ -418,16 +418,6 @@ func (f *Fetcher) updateMaxConnTime(d time.Duration) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (f *Fetcher) Resolve(req *base.Request) error {
|
func (f *Fetcher) Resolve(req *base.Request) error {
|
||||||
return f.ResolveContext(context.Background(), req)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResolveContext cancels the initial request while waiting for headers. Once
|
|
||||||
// Resolve has returned, the retained response belongs to the fetcher and its
|
|
||||||
// existing Pause/Close lifecycle controls the body and prefetch.
|
|
||||||
func (f *Fetcher) ResolveContext(ctx context.Context, req *base.Request) error {
|
|
||||||
if err := ctx.Err(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := base.ParseReqExtra[fhttp.ReqExtra](req); err != nil {
|
if err := base.ParseReqExtra[fhttp.ReqExtra](req); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -439,8 +429,6 @@ func (f *Fetcher) ResolveContext(ctx context.Context, req *base.Request) error {
|
|||||||
// This allows the response to be reused for downloading (important for one-time URLs)
|
// This allows the response to be reused for downloading (important for one-time URLs)
|
||||||
// The body outlives Resolve, so the read timeout gets its own cancel func.
|
// The body outlives Resolve, so the read timeout gets its own cancel func.
|
||||||
reqCtx, reqCancel := context.WithCancel(context.Background())
|
reqCtx, reqCancel := context.WithCancel(context.Background())
|
||||||
stopCancel := context.AfterFunc(ctx, reqCancel)
|
|
||||||
defer stopCancel()
|
|
||||||
httpReq, err := f.buildRequest(reqCtx, req)
|
httpReq, err := f.buildRequest(reqCtx, req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
reqCancel()
|
reqCancel()
|
||||||
|
|||||||
@@ -563,16 +563,9 @@ func ensureResourceRequestRawURLs(parentReq *base.Request, res *base.Resource) {
|
|||||||
|
|
||||||
// resolveState owns a Fetcher until Create transfers it to a task.
|
// resolveState owns a Fetcher until Create transfers it to a task.
|
||||||
// State transitions are protected by fetcherMapLock; closeOnce serializes cleanup.
|
// State transitions are protected by fetcherMapLock; closeOnce serializes cleanup.
|
||||||
type contextResolver interface {
|
|
||||||
ResolveContext(context.Context, *base.Request) error
|
|
||||||
}
|
|
||||||
|
|
||||||
type resolveState struct {
|
type resolveState struct {
|
||||||
ctx context.Context
|
|
||||||
cancel context.CancelFunc
|
|
||||||
fetcher fetcher.Fetcher
|
fetcher fetcher.Fetcher
|
||||||
cancelled bool
|
cancelled bool
|
||||||
resolved bool
|
|
||||||
claimed bool
|
claimed bool
|
||||||
closeOnce sync.Once
|
closeOnce sync.Once
|
||||||
closeErr error
|
closeErr error
|
||||||
@@ -602,9 +595,7 @@ func (d *Downloader) ResolveWithID(id string, req *base.Request) (rr *ResolveRes
|
|||||||
if req == nil {
|
if req == nil {
|
||||||
return nil, errors.New("resolve request is required")
|
return nil, errors.New("resolve request is required")
|
||||||
}
|
}
|
||||||
resolveCtx, cancel := context.WithCancel(d.backgroundCtx)
|
state := &resolveState{}
|
||||||
defer cancel()
|
|
||||||
state := &resolveState{ctx: resolveCtx, cancel: cancel}
|
|
||||||
d.fetcherMapLock.Lock()
|
d.fetcherMapLock.Lock()
|
||||||
if d.closed.Load() {
|
if d.closed.Load() {
|
||||||
d.fetcherMapLock.Unlock()
|
d.fetcherMapLock.Unlock()
|
||||||
@@ -645,11 +636,7 @@ func (d *Downloader) ResolveWithID(id string, req *base.Request) (rr *ResolveRes
|
|||||||
if cancelled {
|
if cancelled {
|
||||||
return nil, errors.New("resource resolution cancelled")
|
return nil, errors.New("resource resolution cancelled")
|
||||||
}
|
}
|
||||||
if resolver, ok := f.(contextResolver); ok {
|
err = f.Resolve(req)
|
||||||
err = resolver.ResolveContext(state.ctx, req)
|
|
||||||
} else {
|
|
||||||
err = f.Resolve(req)
|
|
||||||
}
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -658,13 +645,13 @@ func (d *Downloader) ResolveWithID(id string, req *base.Request) (rr *ResolveRes
|
|||||||
if state.cancelled || d.closed.Load() {
|
if state.cancelled || d.closed.Load() {
|
||||||
return nil, errors.New("resource resolution cancelled")
|
return nil, errors.New("resource resolution cancelled")
|
||||||
}
|
}
|
||||||
state.resolved = true
|
|
||||||
d.fetcherCache[id] = f
|
d.fetcherCache[id] = f
|
||||||
return &ResolveResult{ID: id, Res: f.Meta().Res, SuggestedDownloadDir: d.suggestedDownloadDir(f.Meta().Res)}, nil
|
return &ResolveResult{ID: id, Res: f.Meta().Res, SuggestedDownloadDir: d.suggestedDownloadDir(f.Meta().Res)}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ReleaseResolve is idempotent. A resource already transferred to a task is
|
// ReleaseResolve is idempotent. A resource already transferred to a task is
|
||||||
// never closed by a late preview cancellation.
|
// never closed by a late preview cancellation.
|
||||||
|
// Pending resolution is interrupted according to the Fetcher's Close semantics.
|
||||||
func (d *Downloader) ReleaseResolve(id string) error {
|
func (d *Downloader) ReleaseResolve(id string) error {
|
||||||
d.fetcherMapLock.Lock()
|
d.fetcherMapLock.Lock()
|
||||||
state := d.resolveStates[id]
|
state := d.resolveStates[id]
|
||||||
@@ -673,17 +660,10 @@ func (d *Downloader) ReleaseResolve(id string) error {
|
|||||||
delete(d.resolveStates, id)
|
delete(d.resolveStates, id)
|
||||||
if state != nil {
|
if state != nil {
|
||||||
state.cancelled = true
|
state.cancelled = true
|
||||||
state.cancel()
|
|
||||||
if state.claimed {
|
if state.claimed {
|
||||||
f = nil
|
f = nil
|
||||||
} else {
|
} else {
|
||||||
f = state.fetcher
|
f = state.fetcher
|
||||||
if _, cancellable := f.(contextResolver); cancellable && !state.resolved {
|
|
||||||
// Resolve owns unpublished response/prefetch state. Its context
|
|
||||||
// cancels the request; the returning resolver closes it once
|
|
||||||
// publication has stopped, including a racing response.
|
|
||||||
f = nil
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
d.fetcherMapLock.Unlock()
|
d.fetcherMapLock.Unlock()
|
||||||
|
|||||||
@@ -3,50 +3,15 @@ package download
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/GopeedLab/gopeed/internal/fetcher"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/GopeedLab/gopeed/internal/fetcher"
|
||||||
"github.com/GopeedLab/gopeed/pkg/base"
|
"github.com/GopeedLab/gopeed/pkg/base"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestReleaseResolveCancelsPendingHTTPHeaders(t *testing.T) {
|
|
||||||
entered := make(chan struct{})
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { close(entered); <-r.Context().Done() }))
|
|
||||||
defer server.Close()
|
|
||||||
d := NewDownloader(&DownloaderConfig{Storage: NewMemStorage(), StorageDir: t.TempDir(), TempDir: t.TempDir()})
|
|
||||||
if err := d.Setup(); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
defer d.Close()
|
|
||||||
done := make(chan error, 1)
|
|
||||||
go func() {
|
|
||||||
_, err := d.ResolveWithID("pending-http", &base.Request{URL: server.URL + "/file"})
|
|
||||||
done <- err
|
|
||||||
}()
|
|
||||||
select {
|
|
||||||
case <-entered:
|
|
||||||
case <-time.After(time.Second):
|
|
||||||
t.Fatal("request did not start")
|
|
||||||
}
|
|
||||||
if err := d.ReleaseResolve("pending-http"); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("cancelled Resolve succeeded")
|
|
||||||
}
|
|
||||||
case <-time.After(300 * time.Millisecond):
|
|
||||||
server.CloseClientConnections()
|
|
||||||
t.Fatal("ReleaseResolve did not cancel the request waiting for headers")
|
|
||||||
}
|
|
||||||
if len(d.fetcherCache) != 0 || len(d.resolveStates) != 0 {
|
|
||||||
t.Fatal("cancelled operation retained resources")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
func TestReleaseResolveAfterCreateDoesNotCloseTask(t *testing.T) {
|
func TestReleaseResolveAfterCreateDoesNotCloseTask(t *testing.T) {
|
||||||
d := NewDownloader(&DownloaderConfig{Storage: NewMemStorage(), StorageDir: t.TempDir(), TempDir: t.TempDir(), FetchManagers: nil})
|
d := NewDownloader(&DownloaderConfig{Storage: NewMemStorage(), StorageDir: t.TempDir(), TempDir: t.TempDir(), FetchManagers: nil})
|
||||||
if err := d.Setup(); err != nil {
|
if err := d.Setup(); err != nil {
|
||||||
|
|||||||
Reference in new issue
Block a user