Skip to content

[registry-facade] Properly retry fetching mainfests/config as well #20880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2025
Merged

[registry-facade] Properly retry fetching mainfests/config as well #20880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 125 additions & 80 deletions components/registry-facade/pkg/registry/manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"github.com/opentracing/opentracing-go"
"github.com/pkg/errors"
"golang.org/x/xerrors"
"k8s.io/apimachinery/pkg/util/wait"

"github.com/gitpod-io/gitpod/common-go/log"
"github.com/gitpod-io/gitpod/common-go/tracing"
Expand Down Expand Up @@ -96,6 +97,15 @@ func (reg *Registry) handleManifest(ctx context.Context, r *http.Request) http.H
return res
}

// fetcherBackoffParams defines the backoff parameters for blob retrieval.
// Aiming at ~10 seconds total time for retries
var fetcherBackoffParams = wait.Backoff{
Duration: 1 * time.Second,
Factor: 1.2,
Jitter: 0.2,
Steps: 5,
}

type manifestHandler struct {
Context context.Context

Expand Down Expand Up @@ -278,39 +288,51 @@ func DownloadConfig(ctx context.Context, fetch FetcherFunc, ref string, desc oci

return nil, xerrors.Errorf("unsupported media type: %s", desc.MediaType)
}
log := log.WithField("desc", desc)

var opts manifestDownloadOptions
for _, o := range options {
o(&opts)
}

var rc io.ReadCloser
if opts.Store != nil {
r, err := opts.Store.ReaderAt(ctx, desc)
if errors.Is(err, errdefs.ErrNotFound) {
// not cached yet
} else if err != nil {
log.WithError(err).WithField("desc", desc).Warn("cannot read config from store - fetching again")
} else {
defer r.Close()
rc = io.NopCloser(content.NewReader(r))
var buf []byte
err = wait.ExponentialBackoffWithContext(ctx, fetcherBackoffParams, func(ctx context.Context) (done bool, err error) {
var rc io.ReadCloser
if opts.Store != nil {
r, err := opts.Store.ReaderAt(ctx, desc)
if errors.Is(err, errdefs.ErrNotFound) {
// not cached yet
} else if err != nil {
log.WithError(err).Warn("cannot read config from store - fetching again")
} else {
defer r.Close()
rc = io.NopCloser(content.NewReader(r))
}
}
}
if rc == nil {
fetcher, err := fetch()
if err != nil {
return nil, err
if rc == nil {
fetcher, err := fetch()
if err != nil {
log.WithError(err).Warn("cannot create fetcher")
return false, nil // retry
}
rc, err = fetcher.Fetch(ctx, desc)
if err != nil {
log.WithError(err).Warn("cannot fetch config")
return false, nil // retry
}
defer rc.Close()
}
rc, err = fetcher.Fetch(ctx, desc)

buf, err = io.ReadAll(rc)
if err != nil {
return nil, xerrors.Errorf("cannot download config: %w", err)
log.WithError(err).Warn("cannot read config")
return false, nil // retry
}
defer rc.Close()
}

buf, err := io.ReadAll(rc)
return true, nil
})
if err != nil {
return nil, xerrors.Errorf("cannot read config: %w", err)
return nil, xerrors.Errorf("failed to fetch config: %w", err)
}

var res ociv1.Image
Expand Down Expand Up @@ -387,68 +409,80 @@ func AsFetcherFunc(f remotes.Fetcher) FetcherFunc {
// DownloadManifest downloads and unmarshals the manifest of the given desc. If the desc points to manifest list
// we choose the first manifest in that list.
func DownloadManifest(ctx context.Context, fetch FetcherFunc, desc ociv1.Descriptor, options ...ManifestDownloadOption) (cfg *ociv1.Manifest, rdesc *ociv1.Descriptor, err error) {
log := log.WithField("desc", desc)

var opts manifestDownloadOptions
for _, o := range options {
o(&opts)
}

var (
placeInStore bool
rc io.ReadCloser
mediaType = desc.MediaType
inpt []byte
)
if opts.Store != nil {
func() {
nfo, err := opts.Store.Info(ctx, desc.Digest)
if errors.Is(err, errdefs.ErrNotFound) {
// not in store yet
return
}
err = wait.ExponentialBackoffWithContext(ctx, fetcherBackoffParams, func(ctx context.Context) (done bool, err error) {
var rc io.ReadCloser
if opts.Store != nil {
func() {
nfo, err := opts.Store.Info(ctx, desc.Digest)
if errors.Is(err, errdefs.ErrNotFound) {
// not in store yet
return
}
if err != nil {
log.WithError(err).Warn("cannot get manifest from store")
return
}
if nfo.Labels["Content-Type"] == "" {
// we have broken data in the store - ignore it and overwrite
return
}

r, err := opts.Store.ReaderAt(ctx, desc)
if errors.Is(err, errdefs.ErrNotFound) {
// not in store yet
return
}
if err != nil {
log.WithError(err).Warn("cannot get manifest from store")
return
}

mediaType, rc = nfo.Labels["Content-Type"], &reader{ReaderAt: r}
}()
}
if rc == nil {
// did not find in store, or there was no store. Either way, let's fetch this
// thing from the remote.
placeInStore = true

var fetcher remotes.Fetcher
fetcher, err = fetch()
if err != nil {
log.WithError(err).WithField("desc", desc).Warn("cannot get manifest from store")
return
}
if nfo.Labels["Content-Type"] == "" {
// we have broken data in the store - ignore it and overwrite
return
log.WithError(err).Warn("cannot create fetcher")
return false, nil // retry
}

r, err := opts.Store.ReaderAt(ctx, desc)
if errors.Is(err, errdefs.ErrNotFound) {
// not in store yet
return
}
rc, err = fetcher.Fetch(ctx, desc)
if err != nil {
log.WithError(err).WithField("desc", desc).Warn("cannot get manifest from store")
return
log.WithError(err).Warn("cannot fetch manifest")
return false, nil // retry
}

mediaType, rc = nfo.Labels["Content-Type"], &reader{ReaderAt: r}
}()
}
if rc == nil {
// did not find in store, or there was no store. Either way, let's fetch this
// thing from the remote.
placeInStore = true

var fetcher remotes.Fetcher
fetcher, err = fetch()
if err != nil {
return
mediaType = desc.MediaType
}

rc, err = fetcher.Fetch(ctx, desc)
inpt, err = io.ReadAll(rc)
rc.Close()
if err != nil {
err = xerrors.Errorf("cannot fetch manifest: %w", err)
return
log.WithError(err).Warn("cannot read manifest")
return false, nil // retry
}
mediaType = desc.MediaType
}

inpt, err := io.ReadAll(rc)
rc.Close()
return true, nil
})
if err != nil {
err = xerrors.Errorf("cannot download manifest: %w", err)
err = xerrors.Errorf("failed to fetch manifest: %w", err)
return
}

Expand All @@ -457,7 +491,8 @@ func DownloadManifest(ctx context.Context, fetch FetcherFunc, desc ociv1.Descrip

switch rdesc.MediaType {
case images.MediaTypeDockerSchema2ManifestList, ociv1.MediaTypeImageIndex:
log.WithField("desc", rdesc).Debug("resolving image index")
log := log.WithField("desc", rdesc)
log.Debug("resolving image index")

// we received a manifest list which means we'll pick the default platform
// and fetch that manifest
Expand All @@ -472,24 +507,34 @@ func DownloadManifest(ctx context.Context, fetch FetcherFunc, desc ociv1.Descrip
return
}

var fetcher remotes.Fetcher
fetcher, err = fetch()
if err != nil {
return
}
err = wait.ExponentialBackoffWithContext(ctx, fetcherBackoffParams, func(ctx context.Context) (done bool, err error) {
var fetcher remotes.Fetcher
fetcher, err = fetch()
if err != nil {
log.WithError(err).Warn("cannot create fetcher")
return false, nil // retry
}

// TODO(cw): choose by platform, not just the first manifest
md := list.Manifests[0]
rc, err = fetcher.Fetch(ctx, md)
if err != nil {
err = xerrors.Errorf("cannot download config: %w", err)
return
}
rdesc = &md
inpt, err = io.ReadAll(rc)
rc.Close()
// TODO(cw): choose by platform, not just the first manifest
var rc io.ReadCloser
md := list.Manifests[0]
rc, err = fetcher.Fetch(ctx, md)
if err != nil {
log.WithError(err).Warn("cannot download config")
return false, nil // retry
}
rdesc = &md
inpt, err = io.ReadAll(rc)
rc.Close()
if err != nil {
log.WithError(err).Warn("cannot download manifest")
return false, nil // retry
}

return true, nil
})
if err != nil {
err = xerrors.Errorf("cannot download manifest: %w", err)
err = xerrors.Errorf("failed to download config: %w", err)
return
}
}
Expand Down
Loading
Loading