Merge pull request #294 from Meteor-Community-Packages/setUserRoles-a…

…nyScope Allow setUserRoles() to replace the roles of all scopes
Meteor-Community-Packages · Nov 14, 2019 · 1f17f56 · 1f17f56
2 parents d916aeb + ad88577
commit 1f17f56
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 2 deletions.
diff --git a/roles/roles_common.js b/roles/roles_common.js
@@ -401,6 +401,7 @@ Object.assign(Roles, {
    * @param {Array|String} roles Name(s) of roles to add users to. Roles have to exist.
    * @param {Object|String} [options] Options:
    *   - `scope`: name of the scope, or `null` for the global role
+   *   - `anyScope`: if `true`, remove all roles the user has, of any scope, if `false`, only the one in the same scope
    *   - `ifExists`: if `true`, do not throw an exception if the role does not exist
    *
    * Alternatively, it can be a scope name string.
@@ -421,7 +422,8 @@ Object.assign(Roles, {
     Roles._checkScopeName(options.scope)
 
     options = Object.assign({
-      ifExists: false
+      ifExists: false,
+      anyScope: false
     }, options)
 
     users.forEach(function (user) {
@@ -431,7 +433,12 @@ Object.assign(Roles, {
         id = user
       }
       // we first clear all roles for the user
-      Meteor.roleAssignment.remove({ 'user._id': id, scope: options.scope })
+      const selector = { 'user._id': id }
+      if (!options.anyScope) {
+        selector.scope = options.scope
+      }
+
+      Meteor.roleAssignment.remove(selector)
 
       // and then add all
       roles.forEach(function (role) {

diff --git a/roles/tests/server.js b/roles/tests/server.js
@@ -743,6 +743,33 @@ describe('roles', function () {
     testUser('eve', ['editor'])
   })
 
+  it('can set user roles by scope and anyScope', function () {
+    Roles.createRole('admin')
+    Roles.createRole('editor')
+
+    var eve = Meteor.users.findOne({ _id: users.eve })
+
+    assert.sameDeepMembers(Roles.getRolesForUser(users.eve, { anyScope: true, fullObjects: true }).map(obj => { delete obj._id; return obj }), [])
+
+    Roles.addUsersToRoles(eve, 'admin')
+
+    assert.sameDeepMembers(Roles.getRolesForUser(users.eve, { anyScope: true, fullObjects: true }).map(obj => { delete obj._id; return obj }), [{
+      role: { _id: 'admin' },
+      scope: null,
+      user: { _id: users.eve },
+      inheritedRoles: [{ _id: 'admin' }]
+    }])
+
+    Roles.setUserRoles(eve, 'editor', { anyScope: true, scope: 'scope2' })
+
+    assert.sameDeepMembers(Roles.getRolesForUser(users.eve, { anyScope: true, fullObjects: true }).map(obj => { delete obj._id; return obj }), [{
+      role: { _id: 'editor' },
+      scope: 'scope2',
+      user: { _id: users.eve },
+      inheritedRoles: [{ _id: 'editor' }]
+    }])
+  })
+
   it('can get all roles', function () {
     roles.forEach(function (role) {
       Roles.createRole(role)