made stuff more package private

Author: myleshorton

src/github.com/getlantern/flashlight/config/config.go

@@ -9,47 +9,11 @@ import (
 
 	"github.com/getlantern/flashlight/client"
 	"github.com/getlantern/flashlight/proxied"
-	"github.com/getlantern/golog"
 	"github.com/getlantern/rot13"
 	"github.com/getlantern/tarfs"
 	"github.com/getlantern/yaml"
 )
 
-var (
-	log = golog.LoggerFor("flashlight.config")
-
-	// GlobalURLs are the chained and fronted URLs for fetching the global config.
-	GlobalURLs = &ChainedFrontedURLs{
-		Chained: "https://globalconfig.flashlightproxy.com/global.yaml.gz",
-		Fronted: "https://d24ykmup0867cj.cloudfront.net/global.yaml.gz",
-	}
-
-	// GlobalStagingURLs are the chained and fronted URLs for fetching the global
-	// config in a staging environment.
-	GlobalStagingURLs = &ChainedFrontedURLs{
-		Chained: "https://globalconfig.flashlightproxy.com/global.yaml.gz",
-		Fronted: "https://d24ykmup0867cj.cloudfront.net/global.yaml.gz",
-	}
-
-	// The following are over HTTP because proxies do not forward X-Forwarded-For
-	// with HTTPS and because we only support falling back to direct domain
-	// fronting through the local proxy for HTTP.
-
-	// ProxiesURLs are the chained and fronted URLs for fetching the per user
-	// proxy config.
-	ProxiesURLs = &ChainedFrontedURLs{
-		Chained: "http://config.getiantem.org/proxies.yaml.gz",
-		Fronted: "http://d2wi0vwulmtn99.cloudfront.net/proxies.yaml.gz",
-	}
-
-	// ProxiesStagingURLs are the chained and fronted URLs for fetching the per user
-	// proxy config in a staging environment.
-	ProxiesStagingURLs = &ChainedFrontedURLs{
-		Chained: "http://config-staging.getiantem.org/proxies.yaml.gz",
-		Fronted: "http://d33pfmbpauhmvd.cloudfront.net/proxies.yaml.gz",
-	}
-)
-
 // Config is an interface for getting proxy data saved locally, embedded
 // in the binary, or fetched over the network.
 type Config interface {
@@ -62,7 +26,7 @@ type Config interface {
 
 	// Poll polls for new configs from a remote server and saves them to disk for
 	// future runs.
-	poll(UserConfig, chan interface{}, *ChainedFrontedURLs, time.Duration)
+	poll(UserConfig, chan interface{}, *chainedFrontedURLs, time.Duration)
 }
 
 type config struct {
@@ -72,79 +36,79 @@ type config struct {
 	factory   func() interface{}
 }
 
-// ChainedFrontedURLs contains a chained and a fronted URL for fetching a config.
-type ChainedFrontedURLs struct {
-	Chained string
-	Fronted string
+// chainedFrontedURLs contains a chained and a fronted URL for fetching a config.
+type chainedFrontedURLs struct {
+	chained string
+	fronted string
 }
 
-// Options specifies the options to use for piping config data back to the
+// options specifies the options to use for piping config data back to the
 // dispatch processor function.
-type Options struct {
+type options struct {
 
-	// SaveDir is the directory where we should save new configs and also look
+	// saveDir is the directory where we should save new configs and also look
 	// for existing saved configs.
-	SaveDir string
+	saveDir string
 
-	// Obfuscate specifies whether or not to obfuscate the config on disk.
-	Obfuscate bool
+	// obfuscate specifies whether or not to obfuscate the config on disk.
+	obfuscate bool
 
-	// Name specifies the name of the config file both on disk and in the
+	// name specifies the name of the config file both on disk and in the
 	// embedded config that uses tarfs (the same in the interest of using
 	// configuration by convention).
-	Name string
+	name string
 
-	// URLs are the chaines and fronted URLs to use for fetching this config.
-	URLs *ChainedFrontedURLs
+	// urls are the chaines and fronted URLs to use for fetching this config.
+	urls *chainedFrontedURLs
 
-	// UserConfig contains data for communicating the user details to upstream
+	// userConfig contains data for communicating the user details to upstream
 	// servers in HTTP headers, such as the pro token.
-	UserConfig UserConfig
+	userConfig UserConfig
 
-	// YAMLTemplater is a factory method for generating structs that will be used
+	// yamlTemplater is a factory method for generating structs that will be used
 	// when unmarshalling yaml data.
-	YAMLTemplater func() interface{}
+	yamlTemplater func() interface{}
 
-	// Dispatch is essentially a callback function for processing retrieved
+	// dispatch is essentially a callback function for processing retrieved
 	// yaml configs.
-	Dispatch func(cfg interface{})
+	dispatch func(cfg interface{})
 
-	// EmbeddedData is the data for embedded configs, using tarfs.
-	EmbeddedData []byte
+	// embeddedData is the data for embedded configs, using tarfs.
+	embeddedData []byte
 
-	// Sleep the time to sleep between config fetches.
-	Sleep time.Duration
+	// sleep the time to sleep between config fetches.
+	sleep time.Duration
 }
 
-// PipeConfig creates a new config pipeline for reading a specified type of
+// pipeConfig creates a new config pipeline for reading a specified type of
 // config onto a channel for processing by a dispatch function. This will read
 // configs in the following order:
 //
 // 1. Configs saved on disk, if any
 // 2. Configs embedded in the binary according to the specified name, if any.
 // 3. Configs fetched remotely, and those will be piped back over and over
 //   again as the remote configs change (but only if they change).
-func PipeConfig(opts *Options) {
+func pipeConfig(opts *options) {
 
 	configChan := make(chan interface{})
 
 	go func() {
 		for {
 			cfg := <-configChan
-			opts.Dispatch(cfg)
+			opts.dispatch(cfg)
 		}
 	}()
-	configPath, err := client.InConfigDir(opts.SaveDir, opts.Name)
+	configPath, err := client.InConfigDir(opts.saveDir, opts.name)
 	if err != nil {
 		log.Errorf("Could not get config path? %v", err)
 	}
 
-	log.Tracef("Obfuscating %v", opts.Obfuscate)
-	conf := newConfig(configPath, opts.Obfuscate, opts.YAMLTemplater)
+	log.Tracef("Obfuscating %v", opts.obfuscate)
+	conf := newConfig(configPath, opts.obfuscate, opts.yamlTemplater)
 
 	if saved, proxyErr := conf.saved(); proxyErr != nil {
 		log.Debugf("Could not load stored config %v", proxyErr)
-		if embedded, errr := conf.embedded(opts.EmbeddedData, opts.Name); errr != nil {
+		if embedded, errr := conf.embedded(opts.embeddedData, opts.name); errr != nil {
 			log.Errorf("Could not load embedded config %v", errr)
 		} else {
 			log.Debugf("Sending embedded config for %v", name)
@@ -157,23 +121,23 @@ func PipeConfig(opts *Options) {
 
 	// Now continually poll for new configs and pipe them back to the dispatch
 	// function.
-	go conf.poll(opts.UserConfig, configChan, opts.URLs, opts.Sleep)
+	go conf.poll(opts.userConfig, configChan, opts.urls, opts.sleep)
 }
 
 // newConfig create a new ProxyConfig instance that saves and looks for
 // saved data at the specified path.
 func newConfig(filePath string, obfuscate bool,
 	factory func() interface{}) Config {
-	pc := &config{
+	cfg := &config{
 		filePath:  filePath,
 		obfuscate: obfuscate,
 		saveChan:  make(chan interface{}),
 		factory:   factory,
 	}
 
 	// Start separate go routine that saves newly fetched proxies to disk.
-	go pc.save()
-	return pc
+	go cfg.save()
+	return cfg
 }
 
 func (conf *config) saved() (interface{}, error) {
@@ -217,7 +181,7 @@ func (conf *config) embedded(data []byte, fileName string) (interface{}, error)
 }
 
 func (conf *config) poll(uc UserConfig,
-	configChan chan interface{}, urls *ChainedFrontedURLs, sleep time.Duration) {
+	configChan chan interface{}, urls *chainedFrontedURLs, sleep time.Duration) {
 	fetcher := newFetcher(uc, proxied.ParallelPreferChained(), urls)
 
 	for {
@@ -233,8 +197,9 @@ func (conf *config) poll(uc UserConfig,
 
 			// Push these to channels to avoid race conditions that might occur if
 			// we did these on go routines, for example.
-			configChan <- cfg
 			conf.saveChan <- cfg
+			log.Debugf("Sent to save chan")
+			configChan <- cfg
 		}
 		time.Sleep(sleep)
 	}
@@ -280,25 +245,3 @@ func (conf *config) saveOne(in interface{}) error {
 	log.Debugf("Wrote file at %v", conf.filePath)
 	return nil
 }
-
-// GetProxyURLs returns the proxy URLs to use depending on whether or not we're in
-// staging.
-func GetProxyURLs(staging bool) *ChainedFrontedURLs {
-	if staging {
-		log.Debug("Configuring for staging")
-		return ProxiesStagingURLs
-	}
-	log.Debugf("Not configuring for staging.")
-	return ProxiesURLs
-}
-
-// GetGlobalURLs returns the global URLs to use depending on whether or not we're in
-// staging.
-func GetGlobalURLs(staging bool) *ChainedFrontedURLs {
-	if staging {
-		log.Debug("Configuring for staging")
-		return GlobalStagingURLs
-	}
-	log.Debugf("Not configuring for staging.")
-	return GlobalURLs
-}

src/github.com/getlantern/flashlight/config/config_test.go

@@ -57,7 +57,7 @@ func TestEmbedded(t *testing.T) {
 	}
 }
 
-func TestPoll(t *testing.T) {
+func TestPollProxies(t *testing.T) {
 	fronted.ConfigureForTest(t)
 	proxyChan := make(chan interface{})
 	file := "./fetched-proxies.yaml"
@@ -68,11 +68,10 @@ func TestPoll(t *testing.T) {
 	fi, err := os.Stat(file)
 	assert.Nil(t, err)
 	mtime := fi.ModTime()
+	tempName := fi.Name() + ".stored"
+	os.Rename(fi.Name(), tempName)
 
-	flags := make(map[string]interface{})
-	flags["staging"] = false
-
-	urls := ProxiesURLs
+	urls := proxiesURLs
 	go cfg.poll(&userConfig{}, proxyChan, urls, 1*time.Hour)
 	proxies := (<-proxyChan).(map[string]*client.ChainedServerInfo)
 
@@ -82,17 +81,27 @@ func TestPoll(t *testing.T) {
 		assert.True(t, len(val.Addr) > 6)
 	}
 
-	for i := 1; i <= 20; i++ {
+	for i := 1; i <= 400; i++ {
 		fi, err = os.Stat(file)
-		if fi.ModTime().After(mtime) {
+		if err == nil && fi != nil && fi.ModTime().After(mtime) {
+			log.Debugf("Got newer mod time?")
 			break
 		}
 		time.Sleep(50 * time.Millisecond)
 	}
 
 	fi, err = os.Stat(file)
+	if err != nil {
+		log.Debugf("Got error: %v", err)
+	}
+
+	assert.NotNil(t, fi)
 	assert.Nil(t, err)
+
 	assert.True(t, fi.ModTime().After(mtime))
+
+	// Just restore the original file.
+	os.Rename(tempName, fi.Name())
 }
 
 func TestPollGlobal(t *testing.T) {
@@ -106,13 +115,16 @@ func TestPollGlobal(t *testing.T) {
 	fi, err := os.Stat(file)
 	assert.Nil(t, err)
 	mtime := fi.ModTime()
+	tempName := fi.Name() + ".stored"
+	os.Rename(fi.Name(), tempName)
 
-	go cfg.poll(&userConfig{}, configChan, GlobalURLs, 1*time.Hour)
+	go cfg.poll(&userConfig{}, configChan, globalURLs, 1*time.Hour)
 
 	var fetched *Global
 	select {
 	case fetchedConfig := <-configChan:
 		fetched = fetchedConfig.(*Global)
+		log.Debug("Got config from chan")
 	case <-time.After(20 * time.Second):
 		break
 	}
@@ -121,15 +133,24 @@ func TestPollGlobal(t *testing.T) {
 
 	assert.True(t, len(fetched.Client.MasqueradeSets) > 1)
 
-	for i := 1; i <= 200; i++ {
+	for i := 1; i <= 400; i++ {
+		log.Debugf("Stating file at " + file)
 		fi, err = os.Stat(file)
-		if fi.ModTime().After(mtime) {
+		if err == nil && fi != nil && fi.ModTime().After(mtime) {
+			log.Debugf("Got newer mod time?")
 			break
 		}
-		time.Sleep(100 * time.Millisecond)
+		time.Sleep(50 * time.Millisecond)
 	}
 
 	fi, err = os.Stat(file)
+	if err != nil {
+		log.Debugf("Got error: %v", err)
+	}
 	assert.Nil(t, err)
+	assert.NotNil(t, fi)
 	assert.True(t, fi.ModTime().After(mtime), "Incorrect modification times")
+
+	// Just restore the original file.
+	os.Rename(tempName, fi.Name())
 }

src/github.com/getlantern/flashlight/config/fetcher.go

@@ -45,11 +45,11 @@ type UserConfig interface {
 // newFetcher creates a new configuration fetcher with the specified
 // interface for obtaining the user ID and token if those are populated.
 func newFetcher(conf UserConfig, rt http.RoundTripper,
-	urls *ChainedFrontedURLs) Fetcher {
-	log.Debugf("Will poll for config at %v (%v)", urls.Chained, urls.Fronted)
+	urls *chainedFrontedURLs) Fetcher {
+	log.Debugf("Will poll for config at %v (%v)", urls.chained, urls.fronted)
 
 	// Force detour to whitelist chained domain
-	u, err := url.Parse(urls.Chained)
+	u, err := url.Parse(urls.chained)
 	if err != nil {
 		log.Fatalf("Unable to parse chained cloud config URL: %v", err)
 	}
@@ -59,8 +59,8 @@ func newFetcher(conf UserConfig, rt http.RoundTripper,
 		lastCloudConfigETag: map[string]string{},
 		user:                conf,
 		rt:                  rt,
-		chainedURL:          urls.Chained,
-		frontedURL:          urls.Fronted,
+		chainedURL:          urls.chained,
+		frontedURL:          urls.fronted,
 	}
 }