Version 4

[StorytellerCZ]

• BREAKING: Synchronous functions are now available only on client side
• BREAKING: Migration functions for past versions are no longer available
• Removed deprecated publication of legacy role assignments
• UI Helpers now use console.debug for debugging messages
• RolesCollection and RoleAssignmentsCollection can now be exported in addition to being accessed via Meteor.roles and Meteor.roleAssignment
• Support for Meteor 3

[jankapunkt]

@StorytellerCZ is there anything that isn't already implemented by the latest release that contains the async counterparts?

[StorytellerCZ]

Not 100% sure, but I think we have everything. I will remove the sync MongoDB calls in this branch. Or maybe for the client we can leave the sync methods? Thoughts?

[tchax]

@StorytellerCZ I think it would make sense to leave sync methods for the client. This is consistent with other packages like Accounts isn't it ? Thanks

[dallman2]

Synchronous Mongo calls on the client side are alright in Meteor 3.0, IIRC. When is this PR expected to be merged in and published? I would love to test this in my application.

[StorytellerCZ]

Once this is merged:
#344

I will release a beta.

[dallman2]

I would suggest updating the userIsInRole function on like 658 of roles_common.js to:

  userIsInRole: async function (user, roles, options) {
    let id
    options = Roles._normalizeOptions(options)

    // ensure array to simplify code
    if (!Array.isArray(roles)) roles = [roles]

    roles = roles.filter(r => r != null)

    if (!roles.length) return false

    Roles._checkScopeName(options.scope)

    options = Object.assign({
      anyScope: false
    }, options)

    if (user && typeof user === 'object') {
      id = user._id
    } else {
      id = user
    }

    if (!id) return false
    if (typeof id !== 'string') return false

    const selector = { 'user._id': id }

    if (!options.anyScope) {
      selector.scope = { $in: [options.scope, null] }
    }

    const promises = roles.map((roleName) => {
      selector['inheritedRoles._id'] = roleName

      return Meteor.roleAssignment.find(selector, { limit: 1 }).countAsync() > 0
    })
    await Promise.all(promises)
    return promises.some(p => p)
  },

For obvious reasons, the method needs to become async to be able to count how many records are in the collection.

[StorytellerCZ]

@dallman2 PRs welcome.

[jankapunkt]

This is breaking all our tests:

1. If we directly replace Meteor.Roles it will not apply this internal collection. We also can no longer check if a role is created using Meteor.roles.countDocuments
2. If we use hwillston:stub-collections we can only test for integration and not manully stub specific methods for unit tests. This was possible when Meteor.roles was used.

[StorytellerCZ]

The Meteor.roles is still applied and unchanged, but you can now import he RolesCollection as well from the package. See roles_common_async.js.

[StorytellerCZ]

@jankapunkt please give this a look in the latest push, I have reverted to using the Meteor object for collection access.

[StorytellerCZ]

@jankapunkt @harryadel can I get a check on this from you, so that we can do the release? Many thanks!

[StorytellerCZ]

Anything else for release? @jankapunkt @harryadel

[harryadel]

Very few nitpicks, feel free to disregard if you don't agree.