Refactor context management into it's own context object

Author: mattrobenolt

src/raven.js

@@ -10,9 +10,9 @@ var _Raven = window.Raven,
     lastCapturedException,
     lastEventId,
     globalServer,
-    globalUser,
     globalKey,
     globalProject,
+    globalContext = {},
     globalOptions = {
         logger: 'javascript',
         ignoreErrors: [],
@@ -21,9 +21,7 @@ var _Raven = window.Raven,
         includePaths: [],
         crossOrigin: 'anonymous',
         collectWindowErrors: true,
-        tags: {},
-        maxMessageLength: 100,
-        extra: {}
+        maxMessageLength: 100
     },
     isRavenInstalled = false,
     objectPrototype = Object.prototype,
@@ -78,7 +76,12 @@ var Raven = {
         // merge in options
         if (options) {
             each(options, function(key, value){
-                globalOptions[key] = value;
+                // tags and extra are special and need to be put into context
+                if (key == 'tags' || key == 'extra') {
+                    globalContext[key] = value;
+                } else {
+                    globalOptions[key] = value;
+                }
             });
         }
 
@@ -292,7 +295,7 @@ var Raven = {
      * @return {Raven}
      */
     setUserContext: function(user) {
-        globalUser = user;
+        globalContext.user = user;
 
         return Raven;
     },
@@ -304,7 +307,7 @@ var Raven = {
      * @return {Raven}
      */
     setExtraContext: function(extra) {
-        globalOptions.extra = extra || {};
+        globalContext.extra = extra || {};
 
         return Raven;
     },
@@ -316,7 +319,7 @@ var Raven = {
      * @return {Raven}
      */
     setTagsContext: function(tags) {
-        globalOptions.tags = tags || {};
+        globalContext.tags = tags || {};
 
         return Raven;
     },
@@ -720,8 +723,8 @@ function send(data) {
     data = objectMerge(baseData, data);
 
     // Merge in the tags and extra separately since objectMerge doesn't handle a deep merge
-    data.tags = objectMerge(objectMerge({}, globalOptions.tags), data.tags);
-    data.extra = objectMerge(objectMerge({}, globalOptions.extra), data.extra);
+    data.tags = objectMerge(objectMerge({}, globalContext.tags), data.tags);
+    data.extra = objectMerge(objectMerge({}, globalContext.extra), data.extra);
 
     // Send along our own collected metadata with extra
     data.extra = objectMerge({
@@ -731,9 +734,9 @@ function send(data) {
     // If there are no tags/extra, strip the key from the payload alltogther.
     if (isEmptyObject(data.tags)) delete data.tags;
 
-    if (globalUser) {
+    if (globalContext.user) {
         // sentry.interfaces.User
-        data.user = globalUser;
+        data.user = globalContext.user;
     }
 
     // Include the release if it's defined in globalOptions

test/raven.test.js

@@ -4,8 +4,8 @@ function flushRavenState() {
     lastCapturedException = undefined;
     lastEventId = undefined;
     globalServer = undefined;
-    globalUser = undefined;
     globalProject = undefined;
+    globalContext = {};
     globalOptions = {
         logger: 'javascript',
         release: undefined,
@@ -15,9 +15,7 @@ function flushRavenState() {
         includePaths: [],
         crossOrigin: 'anonymous',
         collectWindowErrors: true,
-        maxMessageLength: 100,
-        tags: {},
-        extra: {}
+        maxMessageLength: 100
     },
     startTime = 0;
     ravenNotConfiguredError = undefined;
@@ -940,7 +938,7 @@ describe('globals', function() {
                 logger: 'javascript'
             };
 
-            globalUser = {name: 'Matt'};
+            globalContext.user = {name: 'Matt'};
 
             send({foo: 'bar'});
             assert.deepEqual(window.makeRequest.lastCall.args[0].data, {
@@ -972,9 +970,9 @@ describe('globals', function() {
 
             globalProject = '2';
             globalOptions = {
-                logger: 'javascript',
-                tags: {tag1: 'value1'}
+                logger: 'javascript'
             };
+            globalContext = {tags: {tag1: 'value1'}};
 
 
             send({tags: {tag2: 'value2'}});
@@ -993,7 +991,9 @@ describe('globals', function() {
                 extra: {'session:duration': 100}
             });
             assert.deepEqual(globalOptions, {
-                logger: 'javascript',
+                logger: 'javascript'
+            });
+            assert.deepEqual(globalContext, {
                 tags: {tag1: 'value1'}
             });
         });
@@ -1008,9 +1008,10 @@ describe('globals', function() {
 
             globalProject = '2';
             globalOptions = {
-                logger: 'javascript',
-                extra: {key1: 'value1'}
+                logger: 'javascript'
             };
+            globalContext = {extra: {key1: 'value1'}};
+
 
 
             send({extra: {key2: 'value2'}});
@@ -1028,7 +1029,9 @@ describe('globals', function() {
                 extra: {key1: 'value1', key2: 'value2', 'session:duration': 100}
             });
             assert.deepEqual(globalOptions, {
-                logger: 'javascript',
+                logger: 'javascript'
+            });
+            assert.deepEqual(globalContext, {
                 extra: {key1: 'value1'}
             });
         });
@@ -1045,7 +1048,7 @@ describe('globals', function() {
                 }
             };
 
-            globalUser = {name: 'Matt'};
+            globalContext.user = {name: 'Matt'};
 
             send({foo: 'bar'});
             assert.deepEqual(window.makeRequest.lastCall.args[0].data, {
@@ -1819,41 +1822,41 @@ describe('Raven (public API)', function() {
     });
 
     describe('.setUserContext', function() {
-        it('should set the globalUser object', function() {
+        it('should set the globalContext.user object', function() {
             Raven.setUserContext({name: 'Matt'});
-            assert.deepEqual(globalUser, {name: 'Matt'});
+            assert.deepEqual(globalContext.user, {name: 'Matt'});
         });
 
-        it('should clear the globalUser with no arguments', function() {
-            globalUser = {name: 'Matt'};
+        it('should clear the globalContext.user with no arguments', function() {
+            globalContext.user = {name: 'Matt'};
             Raven.setUserContext();
-            assert.isUndefined(globalUser);
+            assert.isUndefined(globalContext.user);
         });
     });
 
     describe('.setExtraContext', function() {
-        it('should set the globalOptions.extra object', function() {
+        it('should set the globalContext.extra object', function() {
             Raven.setExtraContext({name: 'Matt'});
-            assert.deepEqual(globalOptions.extra, {name: 'Matt'});
+            assert.deepEqual(globalContext.extra, {name: 'Matt'});
         });
 
-        it('should clear globalOptions.extra with no arguments', function() {
-            globalOptions = {name: 'Matt'};
+        it('should clear globalContext.extra with no arguments', function() {
+            globalOptions.extra = {name: 'Matt'};
             Raven.setExtraContext();
-            assert.deepEqual(globalOptions.extra, {});
+            assert.deepEqual(globalContext.extra, {});
         });
     });
 
     describe('.setTagsContext', function() {
-        it('should set the globalOptions.tags object', function() {
+        it('should set the globalContext.tags object', function() {
             Raven.setTagsContext({name: 'Matt'});
-            assert.deepEqual(globalOptions.tags, {name: 'Matt'});
+            assert.deepEqual(globalContext.tags, {name: 'Matt'});
         });
 
-        it('should clear globalOptions.tags with no arguments', function() {
-            globalOptions = {name: 'Matt'};
+        it('should clear globalContext.tags with no arguments', function() {
+            globalContext.tags = {name: 'Matt'};
             Raven.setTagsContext();
-            assert.deepEqual(globalOptions.tags, {});
+            assert.deepEqual(globalContext.tags, {});
         });
     });