Updated MCWS persistence to scrub the returned user ID of invalid characters to support full name returns from identity service

Author: Peter Di Pasquale

src/persistence/BaseMCWSPersistenceProvider.js

@@ -106,7 +106,7 @@ export default class BaseMCWSPersistenceProvider {
 
         const user = await this.openmct.user.getCurrentUser();
         const containedNamespaces = await this.getNamespacesFromMCWS(namespaceDefinition);
-        const userNamespace = interpolateUsername(namespaceTemplate, user.id);
+        const userNamespace = interpolateUsername(namespaceTemplate, user.name, user.id);
         const existingUserNamespace = containedNamespaces.find(namespace => namespace.url === userNamespace.url);
 
         if (existingUserNamespace) {
@@ -118,7 +118,7 @@ export default class BaseMCWSPersistenceProvider {
 
         containedNamespaces.unshift(userNamespace);
 
-        await this.createIfMissing(userNamespace, user.id);
+        await this.createIfMissing(userNamespace, user.id, user.name);
 
         return containedNamespaces;
     }
@@ -137,7 +137,7 @@ export default class BaseMCWSPersistenceProvider {
         const templateObject = namespaceDefinition.childTemplate;
         const userNamespaces = namespaces.map((namespace) => {
             const username = USERNAME_FROM_PATH_REGEX.exec(namespace.subject)[1]
-            const userNamespaceDefinition = interpolateUsername(templateObject, username);
+            const userNamespaceDefinition = interpolateUsername(templateObject, username, username);
 
             userNamespaceDefinition.location = namespaceDefinition.id;
 
@@ -156,7 +156,7 @@ export default class BaseMCWSPersistenceProvider {
     */
     async getRootNamespaces() {
         const user = await this.openmct.user.getCurrentUser();
-        let rootNamespaces = await Promise.all(this.roots.map((rootNamespace) => this.createIfMissing(rootNamespace, user.id)));
+        let rootNamespaces = await Promise.all(this.roots.map((rootNamespace) => this.createIfMissing(rootNamespace, user.id, user.name)));
         rootNamespaces = rootNamespaces.filter(Boolean);
 
         return this.filterNamespacesByPath(rootNamespaces);
@@ -172,7 +172,7 @@ export default class BaseMCWSPersistenceProvider {
      * @param {NamespaceDefinition} namespaceDefinition
      * @returns {Promise.<NamespaceDefinition>|Promise.<undefined>}
      */
-    async createIfMissing(namespaceDefinition, userId) {
+    async createIfMissing(namespaceDefinition, userId, userName) {
         const namespace = mcws.namespace(namespaceDefinition.url);
 
         try {

src/persistence/test/MCWSNamespaceServiceSpec.js

@@ -104,10 +104,10 @@ describe('MCWSNamespaceService', () => {
             url: '/some/personal/namespace',
             containsNamespaces: true,
             childTemplate: {
-                id: 'personal-${USER}:root',
-                key: 'personal-${USER}',
-                name: '${USER}',
-                url: '/some/personal/namespace/${USER}'
+                id: 'personal-${USERID}:root',
+                key: 'personal-${USERID}',
+                name: '${USERNAME}',
+                url: '/some/personal/namespace/${USERID}'
             }
         };
         inaccessibleContainerRootDefinition = {
@@ -117,10 +117,10 @@ describe('MCWSNamespaceService', () => {
             url: '/inaccessible/personal/namespace',
             containsNamespaces: true,
             childTemplate: {
-                id: 'inaccessible-personal-${USER}:root',
-                key: 'inaccessible-personal-${USER}',
-                name: '${USER}',
-                url: '/inaccessible/personal/namespace/${USER}'
+                id: 'inaccessible-personal-${USERID}:root',
+                key: 'inaccessible-personal-${USERID}',
+                name: '${USERNAME}',
+                url: '/inaccessible/personal/namespace/${USERID}'
             }
         };
         missingContainerRootDefinition = {
@@ -130,10 +130,10 @@ describe('MCWSNamespaceService', () => {
             url: '/missing/personal/namespace',
             containsNamespaces: true,
             childTemplate: {
-                id: 'missing-personal-${USER}:root',
-                key: 'missing-personal-${USER}',
-                name: '${USER}',
-                url: '/missing/personal/namespace/${USER}'
+                id: 'missing-personal-${USERID}:root',
+                key: 'missing-personal-${USERID}',
+                name: '${USERNAME}',
+                url: '/missing/personal/namespace/${USERID}'
             }
         };
 

src/persistence/utils.js

@@ -36,10 +36,10 @@ export function createNamespace(namespace) {
             url: namespace.url,
             containsNamespaces: true,
             childTemplate: {
-                id: namespace.key + '-${USER}:root',
-                key: namespace.key + '-${USER}',
-                name: '${USER}',
-                url: namespace.url + '/${USER}'
+                id: namespace.key + '-${USERID}:root',
+                key: namespace.key + '-${USERID}',
+                name: '${USERNAME}',
+                url: namespace.url + '/${USERID}'
             }
         };
     } else {
@@ -54,18 +54,19 @@ export function createNamespace(namespace) {
 
 /**
  * Interpolate a username with all values in a supplied object, replacing
- * '${USER}' with the supplied username.
+ * '${USERNAME}' with the supplied username and '${USERID} with the
+ *  supplied user ID.
  *
  * @private
  * @param {NamespaceTemplate} templateObject namespace template object.
  * @param {string} username a username.
  * @returns {NamespaceDefinition} a namespace definition object.
  */
-export function interpolateUsername(templateObject, username) {
+export function interpolateUsername(templateObject, username, userid) {
     const namespaceDefinition = {};
 
     Object.keys(templateObject).forEach(key => {
-        namespaceDefinition[key] = templateObject[key].replace('${USER}', username);
+        namespaceDefinition[key] = templateObject[key].replace('${USERNAME}', username).replace('${USERID}', userid);
     });
 
     return namespaceDefinition;

src/services/identity/createMCWSUser.js

@@ -9,7 +9,7 @@ export default function createMCWSUser(UserClass) {
          * @param {MCWSUserInfo} userInfo
          */
         constructor(name) {
-            super(name, name); // no id is returned, so we use name twice
+            super(String(name).replace(/[^a-zA-Z0-9]/g, ''), name); // no id is returned, so we use name twice
         }
     };
 }