go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/auth_service/internal/configs/srvcfg/permissionscfg/config.go (about)

     1  // Copyright 2023 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package permissionscfg
    16  
    17  import (
    18  	"context"
    19  
    20  	"go.chromium.org/luci/config"
    21  	"go.chromium.org/luci/config/server/cfgcache"
    22  
    23  	"go.chromium.org/luci/auth_service/api/configspb"
    24  )
    25  
    26  var cachedPermissionsCfg = cfgcache.Register(&cfgcache.Entry{
    27  	Path: "permissions.cfg",
    28  	Type: (*configspb.PermissionsConfig)(nil),
    29  })
    30  
    31  // Get returns the config stored in context.
    32  func Get(ctx context.Context) (*configspb.PermissionsConfig, error) {
    33  	cfg, err := cachedPermissionsCfg.Get(ctx, nil)
    34  	return cfg.(*configspb.PermissionsConfig), err
    35  }
    36  
    37  // GetWithMetadata returns the config and its metadata stored in context.
    38  func GetWithMetadata(ctx context.Context) (*configspb.PermissionsConfig, *config.Meta, error) {
    39  	meta := &config.Meta{}
    40  	cfg, err := cachedPermissionsCfg.Get(ctx, meta)
    41  	return cfg.(*configspb.PermissionsConfig), meta, err
    42  }
    43  
    44  // SetConfig installs the cfg with empty metadata into the context ctx.
    45  func SetConfig(ctx context.Context, cfg *configspb.PermissionsConfig) error {
    46  	return cachedPermissionsCfg.Set(ctx, cfg, &config.Meta{})
    47  }
    48  
    49  // SetConfigWithMetadata installs the cfg with the given metadata into the context ctx.
    50  func SetConfigWithMetadata(ctx context.Context, cfg *configspb.PermissionsConfig, meta *config.Meta) error {
    51  	return cachedPermissionsCfg.Set(ctx, cfg, meta)
    52  }
    53  
    54  // Update fetches the config and puts it into the datastore.
    55  //
    56  // It is then used by all requests that go through Middleware.
    57  func Update(ctx context.Context) error {
    58  	_, err := cachedPermissionsCfg.Update(ctx, nil)
    59  	return err
    60  }