LogDog: enable services to fetch project configs

server/internal/logdog/service/config/config.go

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package config
 
 import (
+        "errors"
+        "fmt"
         "time"
 
         "github.com/golang/protobuf/proto"
         "github.com/luci/luci-go/common/clock"
         "github.com/luci/luci-go/common/config"
         log "github.com/luci/luci-go/common/logging"
         "github.com/luci/luci-go/common/proto/logdog/svcconfig"
+        "github.com/luci/luci-go/server/proccache"
         "golang.org/x/net/context"
 )
 
 // Options is the set of options used to set up a Manager.
 //
 // The configuration is loaded from a svcconfig.Config protobuf.
 type Options struct {
         // Config is the configuration service to load from.
         Config config.Interface
 
+        // ProjectID is the project's application ID. This is used to load
+        // project-specific configurations.
+        //
+        // If empty, project-specific configurations cannot be loaded.
+        ProjectID string

[nodir, 2016/05/18 16:25:51]

Better call it AppID so it is unambiguous. Luci config actually uses term
"project id", not "project name"

[dnj (Google), 2016/05/18 16:50:31]

I'm using the term, "project ID", here, which is consistent with LUCI-config
(projects/<project-id>). AppID == ProjectID, I feel, is a GAE implementation
detail that I don't need to propagate outside of GAE code.

[nodir, 2016/05/18 17:02:19]

I don't understand. This is app id, see how is it used

+
         // ConfigSet is the name of the ConfigSet to load.
         ConfigSet string
         // ServiceConfigPath is the name of the LogDog service config within the
         // ConfigSet.
         ServiceConfigPath string
 
+        // ProjectConfigCacheDuration is the amount of time to cache a project's
+        // configuration. If this is <= 0, the project config will be fetched each
+        // time it's requested.
+        ProjectConfigCacheDuration time.Duration
+
         // KillCheckInterval, if >0, starts a goroutine that polls every interval to
         // see if the configuration has changed. If it has, KillFunc will be invoked.
         KillCheckInterval time.Duration
         // KillFunc is the function that will be called if a configuration hash change
         // has been observed.
         KillFunc func()
 }
 
 func (o *Options) getConfig(hashOnly bool) (*config.Config, error) {
         return o.Config.GetConfig(o.ConfigSet, o.ServiceConfigPath, hashOnly)
@@ skipping 43 matching lines @@
 // It can also periodically refresh that configuration and invoke a shutdown
 // function if its content changes.
 type Manager struct {
         o *Options
 
         // cfg is the initial configuration.
         cfg svcconfig.Config
         // cfgHash is the hash string of the original config.
         cfgHash string
 
+        // projectConfigCache is a cache of project-specific configs. They will
+        // eventually timeout and get refreshed according to options.
+        projectConfigCache proccache.Cache
+
         // configChangedC will contain the result of the most recent configuration
         // change poll operation. The configuration change poller will block until
         // that result is consumed.
         configChangedC chan struct{}
         // changePollerCancelFunc is the cancel function to call to stop the
         // configuration poller.
         changePollerCancelFunc func()
 }
 
 // NewManager generates a new Manager and loads the initial configuration.
@@ skipping 19 matching lines @@
         }
 
         return &m, nil
 }
 
 // Config returns the service configuration instance.
 func (m *Manager) Config() *svcconfig.Config {
         return &m.cfg
 }
 
+// ProjectConfig returns the project configuration.
+func (m *Manager) ProjectConfig(c context.Context, project config.ProjectName) (*svcconfig.ProjectConfig, error) {
+        projectID := m.o.ProjectID

[nodir, 2016/05/18 16:25:51]

This is app id

[dnj (Google), 2016/05/18 16:50:31]

Acknowledged.

+        if projectID == "" {
+                return nil, errors.New("no app ID specified")
+        }
+
+        v, err := proccache.GetOrMake(c, project, func() (interface{}, time.Duration, error) {
+                configSet := fmt.Sprintf("projects/%s", project)
+                configPath := fmt.Sprintf("%s.cfg", projectID)
+                cfg, err := m.o.Config.GetConfig(configSet, configPath, false)
+                if err != nil {
+                        log.Fields{
+                                log.ErrorKey: err,
+                                "project":    project,
+                        }.Errorf(c, "Failed to load config.")
+                        return nil, 0, err
+                }
+
+                var pcfg svcconfig.ProjectConfig
+                if err := proto.UnmarshalText(cfg.Content, &pcfg); err != nil {
+                        log.Fields{
+                                log.ErrorKey: err,
+                                "project":    project,
+                                "hash":       cfg.ContentHash,
+                                "configSet":  configSet,
+                                "path":       configPath,

[nodir, 2016/05/18 16:25:51]

Sort?

[dnj (Google), 2016/05/18 16:50:31]

I don't think you need to pay so much attention to the order of map keys. I'm
fine with this being not specifically ordered.

+                        }.Errorf(c, "Failed to unmarshal project config.")
+                }
+
+                log.Fields{
+                        "cacheDuration": m.o.ProjectConfigCacheDuration,
+                        "project":       project,
+                        "hash":          cfg.ContentHash,
+                        "configSet":     configSet,
+                        "path":          configPath,

[nodir, 2016/05/18 16:25:51]

Sort?

[dnj (Google), 2016/05/18 16:50:31]

Acknowledged.

+                }.Infof(c, "Refreshed project configuration.")
+                return &pcfg, m.o.ProjectConfigCacheDuration, nil
+        })
+        if err != nil {
+                return nil, err
+        }
+        return v.(*svcconfig.ProjectConfig), nil
+}
+
 // Close terminates the config change poller and blocks until it has finished.
 //
 // Close must be called in order to ensure that Go scheduler properly schedules
 // the goroutine.
 func (m *Manager) Close() {
         // If our config change poller is running, cancel and reap it.
         if m.changePollerCancelFunc != nil {
                 m.changePollerCancelFunc()
                 <-m.configChangedC
         }
 }
 
 func (m *Manager) reloadConfig(c context.Context) error {
         cfg, err := m.o.getConfig(false)
         if err != nil {
                 return err
         }
 
         if err := proto.UnmarshalText(cfg.Content, &m.cfg); err != nil {
                 log.Fields{
                         log.ErrorKey: err,
                         "hash":       cfg.ContentHash,
                 }.Errorf(c, "Failed to unmarshal configuration.")
                 return err
         }
         m.cfgHash = cfg.ContentHash
         return nil
 }