Removes honeybadger.SetContext and Client.SetContext

Calling honeybadger.SetContext applies to all Go routines that use
honeybadger.Notify or DefaultClient which means that setting values from
one request could end up being reported in the error from a request on a
different Go routine / thread. This API works fine in languages like
Ruby which have thread local storage but I think it is too easily
misunderstood and will likely cause problems so I've decided to remove
it.

Author: gaffneyc

CHANGELOG.md

@@ -5,6 +5,9 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+### Changed
+- Removed honeybadger.SetContext and client.SetContext (#35) -@gaffneyc
+
 ## [0.5.0] - 2019-10-17
 ### Added
 - Added Sync mode

README.md

@@ -156,25 +156,6 @@ honeybadger.Notify(err, honeybadger.Tags{"timeout", "http"})
 
 ---
 
-
-### `honeybadger.SetContext()`: Set metadata to be sent if an error occurs
-
-This method lets you set context data that will be sent if an error should occur.
-
-For example, it's often useful to record the current user's ID when an error occurs in a web app. To do that, just use `SetContext` to set the user id on each request. If an error occurs, the id will be reported with it.
-
-**Note**: This method is currently shared across goroutines, and therefore may not be optimal for use in highly concurrent use cases, such as HTTP requests. See [issue #35](https://github.com/honeybadger-io/honeybadger-go/issues/35).
-
-#### Examples:
-
-```go
-honeybadger.SetContext(honeybadger.Context{
-  "user_id": 1,
-})
-```
-
----
-
 ### ``defer honeybadger.Monitor()``: Automatically report panics from your functions
 
 To automatically report panics in your functions or methods, add

client.go

@@ -23,7 +23,6 @@ type noticeHandler func(*Notice) error
 // the configuration and implements the public API.
 type Client struct {
 	Config               *Configuration
-	context              *contextSync
 	worker               worker
 	beforeNotifyHandlers []noticeHandler
 }
@@ -33,11 +32,6 @@ func (client *Client) Configure(config Configuration) {
 	client.Config.update(&config)
 }
 
-// SetContext updates the client context with supplied context.
-func (client *Client) SetContext(context Context) {
-	client.context.Update(context)
-}
-
 // Flush blocks until the worker has processed its queue.
 func (client *Client) Flush() {
 	client.worker.Flush()
@@ -52,7 +46,6 @@ func (client *Client) BeforeNotify(handler func(notice *Notice) error) {
 
 // Notify reports the error err to the Honeybadger service.
 func (client *Client) Notify(err interface{}, extra ...interface{}) (string, error) {
-	extra = append([]interface{}{client.context.internal}, extra...)
 	notice := newNotice(client.Config, newError(err, 2), extra...)
 	for _, handler := range client.beforeNotifyHandlers {
 		if err := handler(notice); err != nil {
@@ -113,9 +106,8 @@ func New(c Configuration) *Client {
 	worker := newBufferedWorker(config)
 
 	client := Client{
-		Config:  config,
-		worker:  worker,
-		context: newContextSync(),
+		Config: config,
+		worker: worker,
 	}
 
 	return &client

client_test.go

@@ -1,7 +1,6 @@
 package honeybadger
 
 import (
-	"sync"
 	"testing"
 )
 
@@ -29,48 +28,6 @@ func TestConfigureClientEndpoint(t *testing.T) {
 	}
 }
 
-func TestClientContext(t *testing.T) {
-	client := New(Configuration{})
-
-	client.SetContext(Context{"foo": "bar"})
-	client.SetContext(Context{"bar": "baz"})
-
-	context := client.context.internal
-
-	if context["foo"] != "bar" {
-		t.Errorf("Expected client to merge global context. expected=%#v actual=%#v", "bar", context["foo"])
-	}
-
-	if context["bar"] != "baz" {
-		t.Errorf("Expected client to merge global context. expected=%#v actual=%#v", "baz", context["bar"])
-	}
-}
-
-func TestClientConcurrentContext(t *testing.T) {
-	var wg sync.WaitGroup
-
-	client := New(Configuration{})
-	newContext := Context{"foo": "bar"}
-
-	wg.Add(2)
-
-	go updateContext(&wg, client, newContext)
-	go updateContext(&wg, client, newContext)
-
-	wg.Wait()
-
-	context := client.context.internal
-
-	if context["foo"] != "bar" {
-		t.Errorf("Expected context value. expected=%#v result=%#v", "bar", context["foo"])
-	}
-}
-
-func updateContext(wg *sync.WaitGroup, client *Client, context Context) {
-	client.SetContext(context)
-	wg.Done()
-}
-
 func TestNotifyPushesTheEnvelope(t *testing.T) {
 	client, worker, _ := mockClient(Configuration{})
 
@@ -121,9 +78,8 @@ func mockClient(c Configuration) (Client, *mockWorker, *mockBackend) {
 	backendConfig.update(&c)
 
 	client := Client{
-		Config:  newConfig(*backendConfig),
-		worker:  worker,
-		context: newContextSync(),
+		Config: newConfig(*backendConfig),
+		worker: worker,
 	}
 
 	return client, worker, backend

context_sync.go

@@ -54,11 +54,6 @@ func Configure(c Configuration) {
 	DefaultClient.Configure(c)
 }
 
-// SetContext merges c Context into the Context of the global client.
-func SetContext(c Context) {
-	DefaultClient.SetContext(c)
-}
-
 // Notify reports the error err to the Honeybadger service.
 //
 // The first argument err may be an error, a string, or any other type in which