Identify instance with user id instead of username

Resolves #230

Author: pixtron

CHANGELOG.md

@@ -28,6 +28,7 @@
 * Use Buffer.from() instead of deprecated new Buffer() #238
 * Replace call to deprecated function setTemplateImage #236
 * Cancel upload if file has been changed or deleted #140
+* Identify instance with user id instead of username #230
 
 
 ## 1.2.1

app/lib/auth/controller.js

@@ -477,13 +477,14 @@ module.exports = function(env, clientConfig) {
 
       logger.info('verifying new user credentials with whoami call', {category: 'auth', authMethod: config.authMethod, username: config.username});
 
-      whoami(config).then(username => {
+      whoami(config).then(user => {
         var url = clientConfig.get('blnUrl');
         var context = clientConfig.get('context');
 
-        instance.link(username, url, context, clientConfig).then(newInstance => {
-          //only change username after instance has been loaded, otherwise we might change the username in an old instance
-          clientConfig.set('username', username);
+        instance.link(user.username, user.id, url, context, clientConfig).then(newInstance => {
+          // only change user after instance has been loaded, otherwise we might change the user in an old instance
+          clientConfig.set('username', user.username);
+          clientConfig.set('userid', user.id);
           clientConfig.set('loggedin', true);
           resolve(newInstance);
         }).catch(err => {
@@ -504,17 +505,17 @@ module.exports = function(env, clientConfig) {
 
       var sync = fullSyncFactory(config, logger);
 
-      sync.blnApi.whoami(function(error, username) {
+      sync.blnApi.whoami(function(error, user) {
         if(error) {
-          logger.info('whoami failed', {category: 'auth', error, username});
+          logger.info('whoami failed', {category: 'auth', error});
 
           error = _checkForNetworkAndServerErrors(error);
 
           reject(error);
         } else {
-          logger.info('whoami successfull', {category: 'auth', username});
+          logger.info('whoami successfull', {category: 'auth', username: user.usernmae, userid: user.id});
 
-          resolve(username);
+          resolve(user);
         }
       });
     });

app/lib/instance.js

@@ -17,8 +17,6 @@ function initialize() {
     instances = {};
   } else {
     instances = JSON.parse(fs.readFileSync(instancesFile, 'utf8'));
-    //require() does caching?
-    //instances = require(instancesFile);
   }
 }
 
@@ -33,6 +31,19 @@ function persist() {
 module.exports = function() {
   initialize();
 
+  /**
+   * Checks if the user in the given instance is the same as the user who logged in
+   **/
+  function isInstanceUser(instance, userid, username) {
+    // TODO pixtron - deprecated check for username can be removed in version 2.0.0 (see #230)
+    if(instance.userid) {
+      return instance.userid === userid;
+    } else {
+      logger.warning('Identifying instance with username', {category: 'instance', instance});
+      return instance.username === username;
+    }
+  }
+
   function archiveDataDir(clientConfig) {
     return new Promise(function(resolve, reject) {
       var instance = instances.lastActive;
@@ -132,9 +143,12 @@ module.exports = function() {
     }
   }
 
-  function loadInstance(name, clientConfig) {
+  function loadInstance(name, userid, clientConfig) {
+    // TODO pixtron - deprecated userid can be removed again in version 2.0.0 (see #230)
+    // Currently it is only here to migrate the instances
     var switchInstance = function() {
       instances.active = name;
+      instances.instances[name].userid = userid;
       instances.instances[name].balloonDir = undefined;
       instances.instances[name].balloonDirIno = undefined;
       persist();
@@ -163,14 +177,13 @@ module.exports = function() {
     });
   }
 
-  function setNewInstance(username, server, context, clientConfig) {
+  function setNewInstance(username, userid, server, context, clientConfig) {
     if(!instances.instances) {
       instances.instances = {};
     }
 
     var name = getNewInstanceName();
-
-    instances.instances[name] = { username, server, context };
+    instances.instances[name] = { username, userid, server, context };
     instances.active = name;
     persist();
     clientConfig.initialize();
@@ -193,13 +206,14 @@ module.exports = function() {
 
       return instances.instances[name];
     },
-    getInstance: function(username, url, context) {
+    // TODO pixtron - deprecated username can be removed in version 2.0.0 (see #230)
+    getInstance: function(username, url, context, userid) {
       if(instances.instances) {
         for(instance in instances.instances) {
           if(
             instances.instances[instance].server === url
             &&
-            instances.instances[instance].username === username
+            isInstanceUser(instances.instances[instance], userid, username)
             &&
             instances.instances[instance].context === context
           ) {
@@ -210,34 +224,34 @@ module.exports = function() {
 
       return null;
     },
-    link: function(username, url, context, clientConfig) {
+    link: function(username, userid, url, context, clientConfig) {
       return new Promise((resolve, reject) => {
         var activeInstance = this.getActiveInstance();
 
         if(activeInstance) {
           var activeInstanceCfg = instances[activeInstance];
-          if(activeInstanceCfg && activeInstanceCfg.username === username) {
+          if(activeInstanceCfg && isInstanceUser(activeInstanceCfg, userid, username)) {
             return resolve(false);
           } else {
-            // if username changed, we need to unlink the active instance
+            // if user changed, we need to unlink the active instance
             this.unlink(clientConfig);
           }
         }
 
-        var instanceName = this.getInstance(username, url, context);
+        var instanceName = this.getInstance(username, url, context, userid);
 
         if(instanceName === this.getLastActiveInstance()) {
-          loadInstance(instanceName, clientConfig).then(() => {
+          loadInstance(instanceName, userid, clientConfig).then(() => {
             resolve(false);
           }).catch(reject);
         } else {
           archiveDataDir(clientConfig).then(() => {
             if(instanceName === null) {
-              setNewInstance(username, url, context, clientConfig).then(() => {
+              setNewInstance(username, userid, url, context, clientConfig).then(() => {
                 resolve(true);
               }).catch(reject);
             } else {
-              loadInstance(instanceName, clientConfig).then(() => {
+              loadInstance(instanceName, userid, clientConfig).then(() => {
                 resolve(false);
               }).catch(reject);
             }

app/ui/startup/controller.js

@@ -114,7 +114,7 @@ module.exports = function(env, clientConfig) {
         ||
         !clientConfig.isActiveInstance()
         ||
-        instance.getInstance(clientConfig.get('username'), clientConfig.get('blnUrl'), clientConfig.get('context')) === null
+        instance.getInstance(clientConfig.get('username'), clientConfig.get('blnUrl'), clientConfig.get('context'), clientConfig.get('userid')) === null
     );
   }
 

package-lock.json

@@ -93,7 +93,7 @@
     "minimist": "~1.2.0"
   },
   "dependencies": {
-    "@gyselroth/balloon-node-sync": "0.6.5",
+    "@gyselroth/balloon-node-sync": "0.6.6",
     "@gyselroth/icon-collection": "^1.0.13",
     "@gyselroth/node-advanced-desktop": "^1.0.5",
     "@openid/appauth": "^1.2.6",