Skip to content

fix(controlplane): fallback CAS downloads from invalid backends #3255

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

Open
waveywaves wants to merge 1 commit into
base: main
Choose a base branch
from
+82 −9
Open

fix(controlplane): fallback CAS downloads from invalid backends #3255

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
2 changes: 1 addition & 1 deletion app/controlplane/cmd/wire_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion app/controlplane/internal/service/cascredential.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,10 @@ func (s *CASCredentialsService) Get(ctx context.Context, req *pb.CASCredentialsS
}

if mapping != nil {
backend = mapping.CASBackend
backend, err = s.casBackendUC.FindDownloadBackend(ctx, mapping.CASBackend)
if err != nil {
return nil, handleUseCaseErr(err, s.log)
}
} else {
// fallback to default backend if the user or the token is allowed to
if ok, err := s.authzUC.Enforce(ctx, currentAuthzSubject, authz.PolicyDefaultBackendArtifactRead); err != nil {
Expand Down
14 changes: 7 additions & 7 deletions app/controlplane/internal/service/casredirect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,11 @@ type CASRedirectService struct {

casMappingUC *biz.CASMappingUseCase
casCredsUseCase *biz.CASCredentialsUseCase
casBackendUC *biz.CASBackendUseCase
casServerConf *conf.Bootstrap_CASServer
}

func NewCASRedirectService(casmUC *biz.CASMappingUseCase, casCredsUC *biz.CASCredentialsUseCase, conf *conf.Bootstrap_CASServer, opts ...NewOpt) (*CASRedirectService, error) {
func NewCASRedirectService(casmUC *biz.CASMappingUseCase, casCredsUC *biz.CASCredentialsUseCase, casBackendUC *biz.CASBackendUseCase, conf *conf.Bootstrap_CASServer, opts ...NewOpt) (*CASRedirectService, error) {
if conf == nil || conf.GetDownloadUrl() == "" {
return nil, errors.New("CASServer.downloadURL configuration is missing")
}
Expand All @@ -61,6 +62,7 @@ func NewCASRedirectService(casmUC *biz.CASMappingUseCase, casCredsUC *biz.CASCre
service: newService(opts...),
casMappingUC: casmUC,
casCredsUseCase: casCredsUC,
casBackendUC: casBackendUC,
casServerConf: conf,
}, nil
}
Expand Down Expand Up @@ -103,18 +105,16 @@ func (s *CASRedirectService) GetDownloadURL(ctx context.Context, req *pb.GetDown
return nil, handleUseCaseErr(err, s.log)
}

backend := mapping.CASBackend
backend, err := s.casBackendUC.FindDownloadBackend(ctx, mapping.CASBackend)
if err != nil {
return nil, handleUseCaseErr(err, s.log)
}

// inline backends don't have a download URL
if backend.Inline {
return nil, kerrors.NotFound("not found", "CAS backend is inline")
}

// check if the backend is on a valid state, if not return an error
if backend.ValidationStatus != biz.CASBackendValidationOK {
return nil, pb.ErrorCasBackendErrorReasonInvalid("CAS Storage is in an invalid state and can't download artifacts, please fix it before attempting it again")
}

// Create an URL to download the artifact from the CAS backend
downloadBase, err := url.Parse(s.casServerConf.GetDownloadUrl())
if err != nil {
Expand Down
14 changes: 14 additions & 0 deletions app/controlplane/pkg/biz/casbackend.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,20 @@ func (uc *CASBackendUseCase) FindDefaultOrFallbackBackend(ctx context.Context, o
return fallbackBackend, nil
}

// FindDownloadBackend returns the mapped backend, or the org default/fallback when the mapped backend is invalid.
func (uc *CASBackendUseCase) FindDownloadBackend(ctx context.Context, mapped *CASBackend) (*CASBackend, error) {

@migmartri migmartri Jul 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this meethod is correct since it checks default, not just fallback, do we want to also check default?

if mapped == nil {
return nil, NewErrNotFound("CAS Backend")
}

if mapped.ValidationStatus == CASBackendValidationOK {
return mapped, nil
}

uc.logger.Infow("msg", "mapped CAS backend validation failed, attempting default/fallback", "backend", mapped.Name, "status", mapped.ValidationStatus, "orgID", mapped.OrganizationID)
return uc.FindDefaultOrFallbackBackend(ctx, mapped.OrganizationID.String())
}

func (uc *CASBackendUseCase) CreateInlineBackend(ctx context.Context, orgID string) (*CASBackend, error) {
ctx, span := otelx.Start(ctx, casBackendTracer, "CASBackendUseCase.CreateInlineBackend")
defer span.End()
Expand Down
56 changes: 56 additions & 0 deletions app/controlplane/pkg/biz/casbackend_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,62 @@ func (s *casBackendTestSuite) TestFindDefaultBackendFound() {
assert.Equal(backend, wantBackend)
}

func (s *casBackendTestSuite) TestFindDownloadBackend() {
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
ctx := context.Background()
mapped := &biz.CASBackend{ID: uuid.New(), OrganizationID: s.validUUID, ValidationStatus: biz.CASBackendValidationOK}

got, err := s.useCase.FindDownloadBackend(ctx, mapped)
s.Require().NoError(err)
s.Same(mapped, got)

s.resetMock()
mapped.ValidationStatus = biz.CASBackendValidationFailed
defaultBackend := &biz.CASBackend{ID: uuid.New(), ValidationStatus: biz.CASBackendValidationOK}
s.repo.On("FindDefaultBackend", mock.Anything, s.validUUID).Return(defaultBackend, nil).Once()

got, err = s.useCase.FindDownloadBackend(ctx, mapped)
s.Require().NoError(err)
s.Same(defaultBackend, got)

s.resetMock()
defaultBackend.ValidationStatus = biz.CASBackendValidationFailed
fallbackBackend := &biz.CASBackend{ID: uuid.New(), ValidationStatus: biz.CASBackendValidationOK}
s.repo.On("FindDefaultBackend", mock.Anything, s.validUUID).Return(defaultBackend, nil).Once()
s.repo.On("FindFallbackBackend", mock.Anything, s.validUUID).Return(fallbackBackend, nil).Once()

got, err = s.useCase.FindDownloadBackend(ctx, mapped)
s.Require().NoError(err)
s.Same(fallbackBackend, got)

got, err = s.useCase.FindDownloadBackend(ctx, nil)
s.Nil(got)
s.True(biz.IsNotFound(err))

s.resetMock()
s.repo.On("FindDefaultBackend", mock.Anything, s.validUUID).Return(nil, nil).Once()

got, err = s.useCase.FindDownloadBackend(ctx, mapped)
s.Nil(got)
s.True(biz.IsNotFound(err))

s.resetMock()
s.repo.On("FindDefaultBackend", mock.Anything, s.validUUID).Return(defaultBackend, nil).Once()
s.repo.On("FindFallbackBackend", mock.Anything, s.validUUID).Return(nil, nil).Once()

got, err = s.useCase.FindDownloadBackend(ctx, mapped)
s.Nil(got)
s.True(biz.IsNotFound(err))

s.resetMock()
fallbackBackend.ValidationStatus = biz.CASBackendValidationFailed
s.repo.On("FindDefaultBackend", mock.Anything, s.validUUID).Return(defaultBackend, nil).Once()
s.repo.On("FindFallbackBackend", mock.Anything, s.validUUID).Return(fallbackBackend, nil).Once()

got, err = s.useCase.FindDownloadBackend(ctx, mapped)
s.Nil(got)
s.True(biz.IsErrValidation(err))
}

func (s *casBackendTestSuite) TestSaveInvalidUUID() {
repo, err := s.useCase.CreateOrUpdate(context.Background(), s.invalidUUID, "", "", "", backendType, true)
assert.True(s.T(), biz.IsErrInvalidUUID(err))
Expand Down
Loading