replace ApiKey with SdkKey (FF-2390) (#43)

* replace ApiKey with SdkKey (FF-2390)

* adjust panic messages

Author: leoromanovsky

README.md

@@ -22,14 +22,14 @@ In your `go.mod`, add the SDK package as a dependency:
 
 ```
 require (
-    github.com/Eppo-exp/golang-sdk/v2
+    github.com/Eppo-exp/golang-sdk/v3
 )
 ```
 
 Or you can install the SDK from the command line with:
 
 ```
-go get github.com/Eppo-exp/golang-sdk/v2
+go get github.com/Eppo-exp/golang-sdk/v3
 ```
 
 ## Quick start
@@ -40,7 +40,7 @@ Begin by initializing a singleton instance of Eppo's client. Once initialized, t
 
 ```go
 import (
-    "github.com/Eppo-exp/golang-sdk/v2/eppoclient"
+    "github.com/Eppo-exp/golang-sdk/v3/eppoclient"
 )
 
 var eppoClient = &eppoclient.EppoClient{}
@@ -49,7 +49,7 @@ func main() {
     assignmentLogger := NewExampleAssignmentLogger()
 
     eppoClient = eppoclient.InitClient(eppoclient.Config{
-        ApiKey:           "<your_sdk_key>",
+        SdkKey:           "<your_sdk_key>",
         AssignmentLogger: assignmentLogger,
     })
 }
@@ -60,7 +60,7 @@ func main() {
 
 ```go
 import (
-    "github.com/Eppo-exp/golang-sdk/v2/eppoclient"
+    "github.com/Eppo-exp/golang-sdk/v3/eppoclient"
 )
 
 var eppoClient = &eppoclient.EppoClient{}
@@ -133,4 +133,4 @@ func main() {
 
 ## Philosophy
 
-Eppo's SDKs are built for simplicity, speed and reliability. Flag configurations are compressed and distributed over a global CDN (Fastly), typically reaching your servers in under 15ms. Server SDKs continue polling Eppo’s API at 30-second intervals. Configurations are then cached locally, ensuring that each assignment is made instantly. Evaluation logic within each SDK consists of a few lines of simple numeric and string comparisons. The typed functions listed above are all developers need to understand, abstracting away the complexity of the Eppo's underlying (and expanding) feature set.
+Eppo's SDKs are built for simplicity, speed and reliability. Flag configurations are compressed and distributed over a global CDN (Fastly), typically reaching your servers in under 15ms. Server SDKs continue polling Eppo’s API at 10-second intervals. Configurations are then cached locally, ensuring that each assignment is made instantly. Evaluation logic within each SDK consists of a few lines of simple numeric and string comparisons. The typed functions listed above are all developers need to understand, abstracting away the complexity of the Eppo's underlying (and expanding) feature set.

eppoclient/config.go

@@ -6,14 +6,14 @@ const default_base_url = "https://fscdn.eppo.cloud/api"
 
 type Config struct {
 	BaseUrl          string
-	ApiKey           string
+	SdkKey           string
 	AssignmentLogger IAssignmentLogger
 	PollerInterval   time.Duration
 }
 
 func (cfg *Config) validate() {
-	if cfg.ApiKey == "" {
-		panic("api key not set")
+	if cfg.SdkKey == "" {
+		panic("sdk key not set")
 	}
 
 	if cfg.BaseUrl == "" {

eppoclient/config_test.go

@@ -9,7 +9,7 @@ import (
 
 func Test_config_defaultPollerInterval(t *testing.T) {
 	cfg := Config{
-		ApiKey: "blah",
+		SdkKey: "blah",
 	}
 
 	cfg.validate()

eppoclient/configurationrequestor.go

@@ -27,7 +27,7 @@ func newConfigurationRequestor(httpClient httpClient, configStore *configuration
 func (ecr *configurationRequestor) GetConfiguration(experimentKey string) (flagConfiguration, error) {
 	if ecr.httpClient.isUnauthorized {
 		// should we panic here or return an error?
-		panic("Unauthorized: please check your API key")
+		panic("Unauthorized: please check your SDK key")
 	}
 
 	result, err := ecr.configStore.GetConfiguration(experimentKey)

eppoclient/doc.go

@@ -12,7 +12,7 @@
 
 	func main() {
 		eppoClient = eppoclient.InitClient(eppoclient.Config{
-			ApiKey:           "<your_api_key>",
+			SdkKey:           "<your_sdk_key>",
 			AssignmentLogger: eppoclient.AssignmentLogger{},
 		})
 	}

eppoclient/eppoclient_e2e_test.go

@@ -36,7 +36,7 @@ func Test_e2e(t *testing.T) {
 
 	mockLogger := new(mockLogger)
 	mockLogger.Mock.On("LogAssignment", mock.Anything).Return()
-	client := InitClient(Config{BaseUrl: serverUrl, ApiKey: "dummy", AssignmentLogger: mockLogger})
+	client := InitClient(Config{BaseUrl: serverUrl, SdkKey: "dummy", AssignmentLogger: mockLogger})
 
 	// give client the time to "fetch" the mock config
 	time.Sleep(2 * time.Second)

eppoclient/httpclient.go

@@ -18,7 +18,7 @@ type httpClient struct {
 }
 
 type SDKParams struct {
-	apiKey     string
+	sdkKey     string
 	sdkName    string
 	sdkVersion string
 }
@@ -43,7 +43,8 @@ func (hc *httpClient) get(resource string) (string, error) {
 	req.Header.Set("Content-Type", "application/json; charset=UTF-8")
 
 	q := req.URL.Query()
-	q.Add("apiKey", hc.sdkParams.apiKey)
+	// todo: migrate to bearer token authorization header
+	q.Add("apiKey", hc.sdkParams.sdkKey) // origin server uses apiKey
 	q.Add("sdkName", hc.sdkParams.sdkName)
 	q.Add("sdkVersion", hc.sdkParams.sdkVersion)
 	req.URL.RawQuery = q.Encode()

eppoclient/httpclient_test.go

@@ -30,7 +30,7 @@ func TestHttpClientGet(t *testing.T) {
 
 	client := &http.Client{}
 	hc := newHttpClient(server.URL, client, SDKParams{
-		apiKey:     "testApiKey",
+		sdkKey:     "testSdkKey",
 		sdkName:    "testSdkName",
 		sdkVersion: "testSdkVersion",
 	})

eppoclient/initclient.go

@@ -10,7 +10,7 @@ var __version__ = "3.0.0"
 // an instance of EppoClient, which could be used to get assignments information.
 func InitClient(config Config) *EppoClient {
 	config.validate()
-	sdkParams := SDKParams{apiKey: config.ApiKey, sdkName: "go", sdkVersion: __version__}
+	sdkParams := SDKParams{sdkKey: config.SdkKey, sdkName: "go", sdkVersion: __version__}
 
 	httpClient := newHttpClient(config.BaseUrl, &http.Client{Timeout: REQUEST_TIMEOUT_SECONDS}, sdkParams)
 	configStore := newConfigurationStore()