From 7478aa8f096310467a8a93d39cd4600d2adbe82a Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:25:46 -0400 Subject: [PATCH 1/6] feature(capabilities): add base collection ability class --- addons/api/addon/abilities/collection.js | 36 ++++++++++++++++++ addons/api/app/abilities/collection.js | 1 + .../tests/unit/abilities/collection-test.js | 38 +++++++++++++++++++ 3 files changed, 75 insertions(+) create mode 100644 addons/api/addon/abilities/collection.js create mode 100644 addons/api/app/abilities/collection.js create mode 100644 addons/api/tests/unit/abilities/collection-test.js diff --git a/addons/api/addon/abilities/collection.js b/addons/api/addon/abilities/collection.js new file mode 100644 index 000000000..8cb3ca2d7 --- /dev/null +++ b/addons/api/addon/abilities/collection.js @@ -0,0 +1,36 @@ +import { Ability } from 'ember-can'; + +/** + * Generic ability provides abilities common to all models in the API. + */ +export default class ModelAbility extends Ability { + // =permissions + + /** + * @type {boolean} + */ + get canList() { + return this.hasAuthorizedCollectionAction('list'); + } + + /** + * @type {boolean} + */ + get canCreate() { + return this.hasAuthorizedCollectionAction('create'); + } + + // =methods + + /** + * Returns true if the given action is contained in the ability model's + * `authorized_collection_actions` array. + * @param {string} action + * @return {boolean} + */ + hasAuthorizedCollectionAction(action) { + const { authorized_collection_actions } = this.model; + const collection = this.collection || {}; + return authorized_collection_actions[collection]?.includes(action); + } +} diff --git a/addons/api/app/abilities/collection.js b/addons/api/app/abilities/collection.js new file mode 100644 index 000000000..041825d2d --- /dev/null +++ b/addons/api/app/abilities/collection.js @@ -0,0 +1 @@ +export { default } from 'api/abilities/collection'; diff --git a/addons/api/tests/unit/abilities/collection-test.js b/addons/api/tests/unit/abilities/collection-test.js new file mode 100644 index 000000000..dd9037ee6 --- /dev/null +++ b/addons/api/tests/unit/abilities/collection-test.js @@ -0,0 +1,38 @@ +import { module, test } from 'qunit'; +import { setupTest } from 'ember-qunit'; + +module('Unit | Abilities | Model', function (hooks) { + setupTest(hooks); + + test('it reflects when a resource may be listed based on authorized_collection_actions', function (assert) { + assert.expect(2); + const service = this.owner.lookup('service:can'); + const model = { + authorized_collection_actions: { + foobars: ['list'], + }, + }; + assert.ok(service.can('list collection', model, { collection: 'foobars' })); + model.authorized_collection_actions = []; + assert.notOk( + service.can('list collection', model, { collection: 'foobars' }) + ); + }); + + test('it reflects when a resource may be created based on authorized_collection_actions', function (assert) { + assert.expect(2); + const service = this.owner.lookup('service:can'); + const model = { + authorized_collection_actions: { + foobars: ['create'], + }, + }; + assert.ok( + service.can('create collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions = []; + assert.notOk( + service.can('create collection', model, { collection: 'foobars' }) + ); + }); +}); From 7fd7613c300281e1aa361f73dd1aebb1f38f0755 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:33:52 -0400 Subject: [PATCH 2/6] test: correct collection test --- addons/api/tests/unit/abilities/collection-test.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/addons/api/tests/unit/abilities/collection-test.js b/addons/api/tests/unit/abilities/collection-test.js index dd9037ee6..b810e6939 100644 --- a/addons/api/tests/unit/abilities/collection-test.js +++ b/addons/api/tests/unit/abilities/collection-test.js @@ -1,7 +1,7 @@ import { module, test } from 'qunit'; import { setupTest } from 'ember-qunit'; -module('Unit | Abilities | Model', function (hooks) { +module('Unit | Abilities | Collection', function (hooks) { setupTest(hooks); test('it reflects when a resource may be listed based on authorized_collection_actions', function (assert) { @@ -13,7 +13,7 @@ module('Unit | Abilities | Model', function (hooks) { }, }; assert.ok(service.can('list collection', model, { collection: 'foobars' })); - model.authorized_collection_actions = []; + model.authorized_collection_actions.foobars = []; assert.notOk( service.can('list collection', model, { collection: 'foobars' }) ); @@ -30,7 +30,7 @@ module('Unit | Abilities | Model', function (hooks) { assert.ok( service.can('create collection', model, { collection: 'foobars' }) ); - model.authorized_collection_actions = []; + model.authorized_collection_actions.foobars = []; assert.notOk( service.can('create collection', model, { collection: 'foobars' }) ); From 4659b54e9e33905dbdb9d3e6c988767585e534c6 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:52:27 -0400 Subject: [PATCH 3/6] =?UTF-8?q?feat:=20=F0=9F=8E=B8=20add=20ui-level=20nav?= =?UTF-8?q?igation=20ability?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ui/admin/app/abilities/collection.js | 30 +++++++++++++++++++ .../tests/unit/abilities/collection-test.js | 29 ++++++++++++++++++ ui/desktop/app/abilities/collection.js | 30 +++++++++++++++++++ .../tests/unit/abilities/collection-test.js | 29 ++++++++++++++++++ 4 files changed, 118 insertions(+) create mode 100644 ui/admin/app/abilities/collection.js create mode 100644 ui/admin/tests/unit/abilities/collection-test.js create mode 100644 ui/desktop/app/abilities/collection.js create mode 100644 ui/desktop/tests/unit/abilities/collection-test.js diff --git a/ui/admin/app/abilities/collection.js b/ui/admin/app/abilities/collection.js new file mode 100644 index 000000000..c40786021 --- /dev/null +++ b/ui/admin/app/abilities/collection.js @@ -0,0 +1,30 @@ +import CollectionAbility from 'api/abilities/collection'; +import { inject as service } from '@ember/service'; + +export default class OverrideModelAbility extends CollectionAbility { + // =services + + @service features; + + // =permissions + + /** + * Navigating to a resource is allowed if either list or create grants + * are present. + * @type {boolean} + */ + get canNavigate() { + return this.canList || this.canCreate; + } + + // =methods + + /** + * If the capabilities feature flag is disabled, actions are always + * authorized. This mimics pre-capabilities behavior. + */ + hasAuthorizedCollectionAction() { + if (!this.features.isEnabled('capabilities')) return true; + return super.hasAuthorizedCollectionAction(...arguments); + } +} diff --git a/ui/admin/tests/unit/abilities/collection-test.js b/ui/admin/tests/unit/abilities/collection-test.js new file mode 100644 index 000000000..586eb52b4 --- /dev/null +++ b/ui/admin/tests/unit/abilities/collection-test.js @@ -0,0 +1,29 @@ +import { module, test } from 'qunit'; +import { setupTest } from 'ember-qunit'; + +module('Unit | Abilities | Collection', function (hooks) { + setupTest(hooks); + + test('it reflects when a resource may be navigated to based on list and create actions', function (assert) { + assert.expect(4); + const service = this.owner.lookup('service:can'); + const model = { + authorized_collection_actions: { foobars: [] }, + }; + assert.notOk( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['list']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['create']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['list', 'create']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + }); +}); diff --git a/ui/desktop/app/abilities/collection.js b/ui/desktop/app/abilities/collection.js new file mode 100644 index 000000000..c40786021 --- /dev/null +++ b/ui/desktop/app/abilities/collection.js @@ -0,0 +1,30 @@ +import CollectionAbility from 'api/abilities/collection'; +import { inject as service } from '@ember/service'; + +export default class OverrideModelAbility extends CollectionAbility { + // =services + + @service features; + + // =permissions + + /** + * Navigating to a resource is allowed if either list or create grants + * are present. + * @type {boolean} + */ + get canNavigate() { + return this.canList || this.canCreate; + } + + // =methods + + /** + * If the capabilities feature flag is disabled, actions are always + * authorized. This mimics pre-capabilities behavior. + */ + hasAuthorizedCollectionAction() { + if (!this.features.isEnabled('capabilities')) return true; + return super.hasAuthorizedCollectionAction(...arguments); + } +} diff --git a/ui/desktop/tests/unit/abilities/collection-test.js b/ui/desktop/tests/unit/abilities/collection-test.js new file mode 100644 index 000000000..586eb52b4 --- /dev/null +++ b/ui/desktop/tests/unit/abilities/collection-test.js @@ -0,0 +1,29 @@ +import { module, test } from 'qunit'; +import { setupTest } from 'ember-qunit'; + +module('Unit | Abilities | Collection', function (hooks) { + setupTest(hooks); + + test('it reflects when a resource may be navigated to based on list and create actions', function (assert) { + assert.expect(4); + const service = this.owner.lookup('service:can'); + const model = { + authorized_collection_actions: { foobars: [] }, + }; + assert.notOk( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['list']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['create']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + model.authorized_collection_actions.foobars = ['list', 'create']; + assert.ok( + service.can('navigate collection', model, { collection: 'foobars' }) + ); + }); +}); From 6cbde9c982e20307ccc02ab7bf78be175a10610e Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:54:12 -0400 Subject: [PATCH 4/6] Update collection.js --- addons/api/addon/abilities/collection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/addons/api/addon/abilities/collection.js b/addons/api/addon/abilities/collection.js index 8cb3ca2d7..ad52afd18 100644 --- a/addons/api/addon/abilities/collection.js +++ b/addons/api/addon/abilities/collection.js @@ -3,7 +3,7 @@ import { Ability } from 'ember-can'; /** * Generic ability provides abilities common to all models in the API. */ -export default class ModelAbility extends Ability { +export default class CollectionAbility extends Ability { // =permissions /** From 4256c7e552b8bbe8cd7843e75df05c1b0a13a9cb Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:54:35 -0400 Subject: [PATCH 5/6] Update collection.js --- ui/desktop/app/abilities/collection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/desktop/app/abilities/collection.js b/ui/desktop/app/abilities/collection.js index c40786021..1da414d43 100644 --- a/ui/desktop/app/abilities/collection.js +++ b/ui/desktop/app/abilities/collection.js @@ -1,7 +1,7 @@ import CollectionAbility from 'api/abilities/collection'; import { inject as service } from '@ember/service'; -export default class OverrideModelAbility extends CollectionAbility { +export default class OverrideCollectionAbility extends CollectionAbility { // =services @service features; From 3c83375d84c3986abbd8ad06f3d20f7f7fcff0b9 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 19 Aug 2021 17:55:05 -0400 Subject: [PATCH 6/6] Update collection.js --- ui/admin/app/abilities/collection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/admin/app/abilities/collection.js b/ui/admin/app/abilities/collection.js index c40786021..1da414d43 100644 --- a/ui/admin/app/abilities/collection.js +++ b/ui/admin/app/abilities/collection.js @@ -1,7 +1,7 @@ import CollectionAbility from 'api/abilities/collection'; import { inject as service } from '@ember/service'; -export default class OverrideModelAbility extends CollectionAbility { +export default class OverrideCollectionAbility extends CollectionAbility { // =services @service features;