Merge pull request #21 from FireTail-io/dev

Make default batch callback no-op if FIRETAIL_API_TOKEN is unset

Author: rileyfiretail

logsapi/client.go

@@ -18,7 +18,10 @@ type Client struct {
 
 func NewClient(options Options) (*Client, error) {
 	options.setDefaults()
-	options.loadEnvVars()
+	err := options.loadEnvVars()
+	if err != nil {
+		return nil, err
+	}
 
 	client := &Client{
 		recordsChannel:    make(chan firetail.Record, options.recordsBufferSize),
@@ -29,7 +32,7 @@ func NewClient(options Options) (*Client, error) {
 		batchCallback:     options.BatchCallback,
 	}
 
-	err := subscribeToLogsApi(options.awsLambdaRuntimeAPI, options.ExtensionID)
+	err = subscribeToLogsApi(options.awsLambdaRuntimeAPI, options.ExtensionID)
 	if err != nil {
 		return nil, err
 	}

logsapi/options.go

@@ -29,7 +29,7 @@ type Options struct {
 	awsLambdaRuntimeAPI string // The URL of the Lambda Runtime API
 	maxBatchSize        int    // The maximum size of a batch to provide to the BatchCallback
 	recordsBufferSize   int    // The size of the records channel buffer
-	firetailApiUrl      string // The URL of the Firetail Logging API used by the default BatchCallback
+	firetailApiUrl      string // The URL of the Firetail Logging API used by the default BatchCallback. If it is the empty string, the default BatchCallback is noop
 	firetailApiToken    string // The API token for the Firetail Logging API used by the default BatchCallback
 }
 
@@ -64,12 +64,7 @@ func (o *Options) loadEnvVars() error {
 		o.maxBatchSize = maxBatchSize
 	}
 
-	firetailApiToken := os.Getenv("FIRETAIL_API_TOKEN")
-	if firetailApiToken == "" {
-		return errors.New("FIRETAIL_API_TOKEN not set")
-	}
-	o.firetailApiToken = firetailApiToken
-
+	o.firetailApiToken = os.Getenv("FIRETAIL_API_TOKEN")
 	firetailApiUrl := os.Getenv("FIRETAIL_API_URL")
 	if firetailApiUrl == "" {
 		firetailApiUrl = DefaultFiretailApiUrl
@@ -82,6 +77,10 @@ func (o *Options) loadEnvVars() error {
 func (o *Options) setDefaults() {
 	if o.BatchCallback == nil {
 		o.BatchCallback = func(batch []firetail.Record) error {
+			// If there's no token set, then there's nothing to do - the default is noop
+			if o.firetailApiToken == "" {
+				return nil
+			}
 			// Try to send the batch to Firetail
 			log.Printf("Attempting to send batch of %d record(s) to Firetail...", len(batch))
 			recordsSent, err := firetail.SendRecordsToSaaS(batch, o.firetailApiUrl, o.firetailApiToken)

logsapi/options_test.go

@@ -78,18 +78,11 @@ func TestLoadEnvVarsNegativeIntegers(t *testing.T) {
 	}
 }
 
-func TestLoadEnvVarsNoApiToken(t *testing.T) {
-	testOptions := Options{}
-	err := testOptions.loadEnvVars()
-	require.NotNil(t, err)
-	assert.Equal(t, "FIRETAIL_API_TOKEN not set", err.Error())
-}
-
 func TestLoadEnvVarsDefaults(t *testing.T) {
-	t.Setenv("FIRETAIL_API_TOKEN", "TEST_TOKEN")
 	testOptions := Options{}
 	err := testOptions.loadEnvVars()
 	require.Nil(t, err)
+	assert.Equal(t, "", testOptions.firetailApiToken)
 	assert.Equal(t, DefaultRecordsBufferSize, testOptions.recordsBufferSize)
 	assert.Equal(t, DefaultMaxBatchSize, testOptions.maxBatchSize)
 	assert.Equal(t, DefaultFiretailApiUrl, testOptions.firetailApiUrl)
@@ -125,7 +118,8 @@ func TestDefaultBatchCallback(t *testing.T) {
 	defer testServer.Close()
 
 	testOptions := &Options{
-		firetailApiUrl: testServer.URL,
+		firetailApiToken: "TEST_TOKEN",
+		firetailApiUrl:   testServer.URL,
 	}
 	testOptions.setDefaults()
 
@@ -146,7 +140,8 @@ func TestDefaultBatchCallback(t *testing.T) {
 
 func TestDefaultBatchCallbackFail(t *testing.T) {
 	testOptions := &Options{
-		firetailApiUrl: "\n",
+		firetailApiToken: "TEST_TOKEN",
+		firetailApiUrl:   "\n",
 	}
 	testOptions.setDefaults()