make instance names case-insensitive

Author: djih

README.md

@@ -79,7 +79,7 @@ If you want to log events to multiple Amplitude apps, you will need to have sepa
 
 You need to assign a name to each Amplitude app / instance, and use that name consistently when fetching that instance to call functions. **IMPORTANT: Once you have chosen a name for that instance you cannot change it.** Every instance's data and settings are tied to its name, and you will need to continue using that instance name for all future versions of your app to maintain data continuity, so chose your instance names wisely. Note these names do not need to be the names of your apps in the Amplitude dashboards, but they need to remain consistent throughout your code. You also need to be sure that each instance is initialized with the correct apiKey.
 
-Instance names must be nonnull and nonempty strings. You can fetch each instance by name by calling `amplitude.getInstance('INSTANCE_NAME')`.
+Instance names must be nonnull and nonempty strings. Names are case-insensitive. You can fetch each instance by name by calling `amplitude.getInstance('INSTANCE_NAME')`.
 
 As mentioned before, each new instance created will have its own apiKey, userId, deviceId, and settings. **You will have to reconfigure all the settings for each instance.** This gives you the freedom to have different settings for each instance.
 

amplitude.js

@@ -115,15 +115,19 @@ var utils = require('./utils');
 var version = require('./version');
 var DEFAULT_OPTIONS = require('./options');
 
-var DEFAULT_INSTANCE = '$defaultInstance';
+var DEFAULT_INSTANCE = '$default_instance';
 
 var Amplitude = function() {
   this.options = object.merge({}, DEFAULT_OPTIONS); // maintain a copy for backwards compatibilty
   this._instances = {}; // mapping of instance names to instances
 };
 
 Amplitude.prototype.getInstance = function(instance) {
-  instance = utils.isEmptyString(instance) ? DEFAULT_INSTANCE : instance;
+  if (utils.isEmptyString(instance)) {
+    instance = DEFAULT_INSTANCE;
+  }
+  instance = instance.toLowerCase();
+
   var client = this._instances[instance];
   if (client === undefined) {
     client = new AmplitudeClient(instance);
@@ -265,7 +269,7 @@ var log = function(s) {
   console.log('[Amplitude] ' + s);
 };
 
-var DEFAULT_INSTANCE = '$defaultInstance';
+var DEFAULT_INSTANCE = '$default_instance';
 var IDENTIFY_EVENT = '$identify';
 var API_VERSION = 2;
 var MAX_STRING_LENGTH = 1024;
@@ -287,7 +291,10 @@ var LocalStorageKeys = {
  * AmplitudeClient API
  */
 var AmplitudeClient = function(instanceName) {
-  this._instanceName = utils.isEmptyString(instanceName) ? DEFAULT_INSTANCE : instanceName;
+  if (utils.isEmptyString(instanceName)) {
+    instanceName = DEFAULT_INSTANCE;
+  }
+  this._instanceName = instanceName.toLowerCase();
   this._storageSuffix = this._instanceName === DEFAULT_INSTANCE ? '' : '_' + this._instanceName;
   this._unsentEvents = [];
   this._unsentIdentifys = [];

amplitude.min.js

@@ -17,7 +17,7 @@ var log = function(s) {
   console.log('[Amplitude] ' + s);
 };
 
-var DEFAULT_INSTANCE = '$defaultInstance';
+var DEFAULT_INSTANCE = '$default_instance';
 var IDENTIFY_EVENT = '$identify';
 var API_VERSION = 2;
 var MAX_STRING_LENGTH = 1024;
@@ -39,7 +39,10 @@ var LocalStorageKeys = {
  * AmplitudeClient API
  */
 var AmplitudeClient = function(instanceName) {
-  this._instanceName = utils.isEmptyString(instanceName) ? DEFAULT_INSTANCE : instanceName;
+  if (utils.isEmptyString(instanceName)) {
+    instanceName = DEFAULT_INSTANCE;
+  }
+  this._instanceName = instanceName.toLowerCase();
   this._storageSuffix = this._instanceName === DEFAULT_INSTANCE ? '' : '_' + this._instanceName;
   this._unsentEvents = [];
   this._unsentIdentifys = [];

src/amplitude-client.js

@@ -6,15 +6,19 @@ var utils = require('./utils');
 var version = require('./version');
 var DEFAULT_OPTIONS = require('./options');
 
-var DEFAULT_INSTANCE = '$defaultInstance';
+var DEFAULT_INSTANCE = '$default_instance';
 
 var Amplitude = function() {
   this.options = object.merge({}, DEFAULT_OPTIONS); // maintain a copy for backwards compatibilty
   this._instances = {}; // mapping of instance names to instances
 };
 
 Amplitude.prototype.getInstance = function(instance) {
-  instance = utils.isEmptyString(instance) ? DEFAULT_INSTANCE : instance;
+  if (utils.isEmptyString(instance)) {
+    instance = DEFAULT_INSTANCE;
+  }
+  instance = instance.toLowerCase();
+
   var client = this._instances[instance];
   if (client === undefined) {
     client = new AmplitudeClient(instance);

src/amplitude.js

@@ -45,6 +45,11 @@ describe('AmplitudeClient', function() {
       reset();
     });
 
+    it('should make instanceName case-sensitive', function() {
+      assert.equal(new AmplitudeClient('APP3')._instanceName, 'app3');
+      assert.equal(new AmplitudeClient('$DEFAULT_INSTANCE')._instanceName, '$default_instance');
+    });
+
     it('should accept userId', function() {
       amplitude.init(apiKey, userId);
       assert.equal(amplitude.options.userId, userId);
@@ -335,7 +340,7 @@ describe('AmplitudeClient', function() {
       localStorage.setItem('amplitude_unsent', existingEvent);
       localStorage.setItem('amplitude_unsent_identify', existingIdentify);
 
-      var amplitude2 = new AmplitudeClient('$defaultInstance');
+      var amplitude2 = new AmplitudeClient('$default_Instance');
       amplitude2.init(apiKey, null, {batchEvents: true});
 
       // check event loaded into memory

test/amplitude-client.js

@@ -51,9 +51,12 @@ describe('Amplitude', function() {
       amplitude.init(apiKey);
       assert.equal(amplitude.getInstance().options.apiKey, apiKey);
       assert.equal(amplitude.options, amplitude.getInstance().options);
-      assert.equal(amplitude.getInstance('$defaultInstance').options.apiKey, apiKey);
-      assert.equal(amplitude.getInstance(), amplitude.getInstance('$defaultInstance'));
+      assert.equal(amplitude.getInstance('$default_instance').options.apiKey, apiKey);
+      assert.equal(amplitude.getInstance(), amplitude.getInstance('$default_instance'));
 
+      // test for case insensitivity
+      assert.equal(amplitude.getInstance(), amplitude.getInstance('$DEFAULT_INSTANCE'));
+      assert.equal(amplitude.getInstance(), amplitude.getInstance('$DEFAULT_instance'));
       assert.equal(amplitude.options.deviceId, amplitude.getInstance().options.deviceId);
     });
 
@@ -66,6 +69,15 @@ describe('Amplitude', function() {
       assert.notEqual(app1, app2);
       assert.equal(app1.options.apiKey, 1);
       assert.equal(app2.options.apiKey, 2);
+
+      assert.equal(app1, amplitude.getInstance('app1'));
+      assert.equal(app1, amplitude.getInstance('APP1'));
+      assert.equal(app1, amplitude.getInstance('aPp1'));
+      assert.equal(app2, amplitude.getInstance('app2'));
+      assert.equal(app2, amplitude.getInstance('APP2'));
+      assert.equal(app2, amplitude.getInstance('aPp2'));
+
+      assert.equal(amplitude.getInstance('APP3')._instanceName, 'app3');
     });
 
     it('should return same instance for same key', function() {