| // Licensed to the Apache Software Foundation (ASF) under one or more |
| // contributor license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright ownership. |
| // The ASF licenses this file to You under the Apache License, Version 2.0 |
| // (the "License"); you may not use this file except in compliance with |
| // the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package bufmodulecache |
| |
| import ( |
| "context" |
| "fmt" |
| ) |
| |
| import ( |
| "go.uber.org/zap" |
| ) |
| |
| import ( |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule" |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule/bufmoduleref" |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/manifest" |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/storage" |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/verbose" |
| ) |
| |
| type casModuleReader struct { |
| // required parameters |
| delegate bufmodule.ModuleReader |
| repositoryClientFactory RepositoryServiceClientFactory |
| logger *zap.Logger |
| verbosePrinter verbose.Printer |
| // initialized in newCASModuleReader |
| cache *casModuleCacher |
| stats *cacheStats |
| } |
| |
| var _ bufmodule.ModuleReader = (*casModuleReader)(nil) |
| |
| func newCASModuleReader( |
| bucket storage.ReadWriteBucket, |
| delegate bufmodule.ModuleReader, |
| repositoryClientFactory RepositoryServiceClientFactory, |
| logger *zap.Logger, |
| verbosePrinter verbose.Printer, |
| ) *casModuleReader { |
| return &casModuleReader{ |
| delegate: delegate, |
| repositoryClientFactory: repositoryClientFactory, |
| logger: logger, |
| verbosePrinter: verbosePrinter, |
| cache: &casModuleCacher{ |
| logger: logger, |
| bucket: bucket, |
| }, |
| stats: &cacheStats{}, |
| } |
| } |
| |
| func (c *casModuleReader) GetModule( |
| ctx context.Context, |
| modulePin bufmoduleref.ModulePin, |
| ) (bufmodule.Module, error) { |
| var modulePinDigest *manifest.Digest |
| if digest := modulePin.Digest(); digest != "" { |
| var err error |
| modulePinDigest, err = manifest.NewDigestFromString(digest) |
| // Fail fast if the buf.lock file contains a malformed digest |
| if err != nil { |
| return nil, fmt.Errorf("malformed module digest %q: %w", digest, err) |
| } |
| } |
| cachedModule, err := c.cache.GetModule(ctx, modulePin) |
| if err == nil { |
| c.stats.MarkHit() |
| return cachedModule, nil |
| } |
| c.logger.Sugar().Debug("module cache miss", zap.Error(err)) |
| c.stats.MarkMiss() |
| remoteModule, err := c.delegate.GetModule(ctx, modulePin) |
| if err != nil { |
| return nil, err |
| } |
| // Manifest and BlobSet should always be set. |
| if remoteModule.Manifest() == nil || remoteModule.BlobSet() == nil { |
| return nil, fmt.Errorf("required manifest/blobSet not set on module") |
| } |
| if modulePinDigest != nil { |
| manifestBlob, err := remoteModule.Manifest().Blob() |
| if err != nil { |
| return nil, err |
| } |
| manifestDigest := manifestBlob.Digest() |
| if !modulePinDigest.Equal(*manifestDigest) { |
| // buf.lock module digest and BSR module don't match - fail without overwriting cache |
| return nil, fmt.Errorf("module digest mismatch - expected: %q, found: %q", modulePinDigest, manifestDigest) |
| } |
| } |
| if err := c.cache.PutModule(ctx, modulePin, remoteModule); err != nil { |
| return nil, err |
| } |
| if err := warnIfDeprecated(ctx, c.repositoryClientFactory, modulePin, c.logger); err != nil { |
| return nil, err |
| } |
| return remoteModule, nil |
| } |