Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add feature and entity flagging into checkPermission #1187

Merged
merged 3 commits into from
Aug 25, 2023

Conversation

dbouwman
Copy link
Member

  1. Description:

checkPermission now incorporates context.featureFlags, and entity.features into it's logic.

Also updated the checkPermission tests to use fake policies, tied to real permissions. This ensures our tests don't need to change as business rules change over time.

Flag Rules:

  • entity.features["hub:some:permission"]: false will disable that for the entity
    • ^^ only applies if the hub:some:permission policy has .entityConfigurable: true
    • returns disabled-by-entity-flag "response"
  • context.featureFlags["hub:some:permission"]: false will cause that permission to not be granted for all calls
    • returns disabled-by-feature-flag "response"
  • context.featureFlags["hub:some:permission"]: true will override the availability, environment checks, as well as an entity flag set to false

Next step is to add query param parsing into apps, and pass flags into context when it's created

  1. Instructions for testing:
  • run tests
  1. Almost closes Issues: #7552

  2. Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide

  3. used semantic commit messages

  4. PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)

  5. updated peerDependencies as needed. CRITICAL our automated release system can not be counted on to update peerDependencies so we must do it manually in our PRs when needed. See the updating peerDependencies section of the release instructions for more details.

@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Merging #1187 (f863766) into master (7ed63d9) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #1187   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          733       732    -1     
  Lines        13061     13077   +16     
  Branches      2230      2233    +3     
=========================================
+ Hits         13061     13077   +16     
Files Changed Coverage Δ
...on/src/permissions/_internal/checkEntityFeature.ts 100.00% <ø> (ø)
...src/permissions/_internal/getPolicyResponseCode.ts 100.00% <ø> (ø)
...mon/src/projects/_internal/ProjectBusinessRules.ts 100.00% <ø> (ø)
packages/common/src/ArcGISContext.ts 100.00% <100.00%> (ø)
packages/common/src/ArcGISContextManager.ts 100.00% <100.00%> (ø)
...n/src/permissions/_internal/checkAuthentication.ts 100.00% <100.00%> (ø)
...s/common/src/permissions/_internal/checkLicense.ts 100.00% <100.00%> (ø)
...ommon/src/permissions/_internal/checkPrivileges.ts 100.00% <100.00%> (ø)
packages/common/src/permissions/checkPermission.ts 100.00% <100.00%> (ø)

@dbouwman dbouwman force-pushed the f/7552-feature-flag-integration branch from deac8f7 to f863766 Compare August 25, 2023 14:53
@dbouwman dbouwman merged commit b040283 into master Aug 25, 2023
7 checks passed
@dbouwman dbouwman deleted the f/7552-feature-flag-integration branch August 25, 2023 15:07
github-actions bot pushed a commit that referenced this pull request Aug 25, 2023
# @esri/hub-common [14.3.0](https://github.com/Esri/hub.js/compare/@esri/hub-common@14.2.0...@esri/hub-common@14.3.0) (2023-08-25)

### Features

*  add feature and entity flagging into checkPermission ([#1187](#1187)) ([b040283](b040283))
github-actions bot pushed a commit that referenced this pull request Aug 28, 2023
## [14.0.1](https://github.com/Esri/hub.js/compare/@esri/hub-sites@14.0.0...@esri/hub-sites@14.0.1) (2023-08-28)

### Bug Fixes

* rollback stat migration ([#1193](#1193)) ([8465e15](8465e15))

### Features

*  add feature and entity flagging into checkPermission ([#1187](#1187)) ([b040283](b040283))
* site's followers pane permissions ([#1186](#1186)) ([90feec7](90feec7))
* ungate dashboard from projects ([#1188](#1188)) ([658b936](658b936))
* **hub-common:** add icon for Discussion content type ([#1185](#1185)) ([7ae927a](7ae927a))
github-actions bot pushed a commit that referenced this pull request Oct 8, 2023
# [14.1.0](https://github.com/Esri/hub.js/compare/@esri/hub-search@14.0.0...@esri/hub-search@14.1.0) (2023-10-08)

### Bug Fixes

* update groups link from teams to groups ([#1262](#1262)) ([26dd47a](26dd47a))
* **hub-discussions:** add author and editor to isearchchannels ([#1257](#1257)) ([5d22e8b](5d22e8b))
* account for index values that are 0 in card view models ([#1196](#1196)) ([bbc1928](bbc1928))
* add featured content to initiatives edit ([#1208](#1208)) ([a3f0361](a3f0361))
* add Project to wellKnownColletions ([#1254](#1254)) ([82eb6a1](82eb6a1))
* add shareContent group permission and minor hub group clean up ([#1194](#1194)) ([9a90b6d](9a90b6d))
* added default empty quotes for computeProps ([#1204](#1204)) ([3c83e4a](3c83e4a))
* auto-populating groups in project creation ([#1225](#1225)) ([0b9465f](0b9465f))
* checkPermission and checkPrivileges first check isAuthenticated ([#1227](#1227)) ([b292131](b292131))
* ensure featured content catalogs are returned as an array ([#1207](#1207)) ([d28b56f](d28b56f))
* properly deserialize trustedOrgs from context ([#1256](#1256)) ([760b4ff](760b4ff))
* **hub-common:** content location should be of type extent, not polygon ([#1228](#1228)) ([c5539f4](c5539f4))
* **hub-common:** fix fetchHubContent does not support slugs ([#1216](#1216)) ([d3a4eba](d3a4eba))
* **hub-common:** re-adds the discussion permissions to validPermissions array ([#1223](#1223)) ([9db7245](9db7245))
* **hub-common:** workspace route for content is /workspace/content/:id not /workspace/contents/:id ([#1250](#1250)) ([f2c6679](f2c6679))
* rollback stat migration ([#1193](#1193)) ([8465e15](8465e15))
* shouldClearEmptyFields now accounts for licenseInfo ([#1198](#1198)) ([3f4eb47](3f4eb47))
* uiSchema translation keys ([#1224](#1224)) ([a55292f](a55292f))
* **hub-discussions:** user can read channel if group is non-discussable ([#1201](#1201)) ([28d61f3](28d61f3))

### Features

* **hub-common:** adds followers group discussion settings on site wo… ([#1251](#1251)) ([e0beb59](e0beb59))
*  add feature and entity flagging into checkPermission ([#1187](#1187)) ([b040283](b040283))
* Add Initiative and Project Associations ([#1213](#1213)) ([7cb0298](7cb0298))
* add invite users to hub group ([#1197](#1197)) ([014b2bd](014b2bd))
* add links hash for project, initiative, and group entities ([#1226](#1226)) ([aba8f7b](aba8f7b))
* add member role badges to user card model ([#1195](#1195)) ([e09608d](e09608d))
* add new polling util ([#1265](#1265)) ([e36c142](e36c142))
* add option to enrich an entity  ([#1220](#1220)) ([0b57ff5](0b57ff5))
* add supporting groups to sites property map ([#1205](#1205)) ([2d473d6](2d473d6))
* add workspaceRelative to enrichGroupSearchResult ([#1206](#1206)) ([f6d2016](f6d2016))
* addGroupMembers ([#1230](#1230)) ([3a7c900](3a7c900))
* adding license picker to content workspace ([#1192](#1192)) ([312b333](312b333))
* adds entity discussion settings ([#1221](#1221)) ([5e25a43](5e25a43))
* adds getChannelUsersQuery method, bumps to @esri/arcgis-rest-port… ([#1210](#1210)) ([320d6d8](320d6d8))
* collaborator pane for content workspace ([#1259](#1259)) ([e00e624](e00e624))
* initiative template entity ([#1229](#1229)) ([f5a995a](f5a995a))
* initiative template workspace ([#1246](#1246)) ([cb385e5](cb385e5))
* scaffold solution template entity ([#1253](#1253)) ([54d1fe6](54d1fe6))
* **hub-common:** add application type content edit link ([#1217](#1217)) ([82ceec4](82ceec4))
* **hub-common:** add blocked as a possible PostStatus ([#1222](#1222)) ([11c8a58](11c8a58))
* **hub-common:** add content settings schemas and derive props from server definitions ([#1209](#1209)) ([1721285](1721285))
* **hub-common:** add getResultSiteRelativeLink so Hub Page results can have slugs in siteRelative l ([#1200](#1200)) ([27e0740](27e0740))
* **hub-common:** add hub:[entity]:manage permission for all entities ([#1202](#1202)) ([71191b7](71191b7))
* **hub-common:** add icon for Discussion content type ([#1185](#1185)) ([7ae927a](7ae927a))
* **hub-discussions:** adding ability to update the groups of a channel ([#1218](#1218)) ([7bc2117](7bc2117))
* followers settings schema and behavior ([#1211](#1211)) ([a8be73b](a8be73b))
* item extent now selectable, savable, and reflects in old and new view ([#1212](#1212)) ([5dbe3bb](5dbe3bb))
* partnered orgs added to context ([#1214](#1214)) ([7979571](7979571))
* refactor entity schema implementation ([#1203](#1203)) ([88cdd2b](88cdd2b))
* **hub-common:** add unified "links" hash as an optional property for all entities ([#1199](#1199)) ([ba14502](ba14502))
* site's followers pane permissions ([#1186](#1186)) ([90feec7](90feec7))
* ungate dashboard from projects ([#1188](#1188)) ([658b936](658b936))
github-actions bot pushed a commit that referenced this pull request Oct 8, 2023
# [14.1.0](https://github.com/Esri/hub.js/compare/@esri/hub-teams@14.0.0...@esri/hub-teams@14.1.0) (2023-10-08)

### Bug Fixes

* update groups link from teams to groups ([#1262](#1262)) ([26dd47a](26dd47a))
* **hub-discussions:** add author and editor to isearchchannels ([#1257](#1257)) ([5d22e8b](5d22e8b))
* account for index values that are 0 in card view models ([#1196](#1196)) ([bbc1928](bbc1928))
* add featured content to initiatives edit ([#1208](#1208)) ([a3f0361](a3f0361))
* add Project to wellKnownColletions ([#1254](#1254)) ([82eb6a1](82eb6a1))
* add shareContent group permission and minor hub group clean up ([#1194](#1194)) ([9a90b6d](9a90b6d))
* added default empty quotes for computeProps ([#1204](#1204)) ([3c83e4a](3c83e4a))
* auto-populating groups in project creation ([#1225](#1225)) ([0b9465f](0b9465f))
* checkPermission and checkPrivileges first check isAuthenticated ([#1227](#1227)) ([b292131](b292131))
* ensure featured content catalogs are returned as an array ([#1207](#1207)) ([d28b56f](d28b56f))
* properly deserialize trustedOrgs from context ([#1256](#1256)) ([760b4ff](760b4ff))
* **hub-common:** content location should be of type extent, not polygon ([#1228](#1228)) ([c5539f4](c5539f4))
* **hub-common:** fix fetchHubContent does not support slugs ([#1216](#1216)) ([d3a4eba](d3a4eba))
* **hub-common:** re-adds the discussion permissions to validPermissions array ([#1223](#1223)) ([9db7245](9db7245))
* **hub-common:** workspace route for content is /workspace/content/:id not /workspace/contents/:id ([#1250](#1250)) ([f2c6679](f2c6679))
* rollback stat migration ([#1193](#1193)) ([8465e15](8465e15))
* shouldClearEmptyFields now accounts for licenseInfo ([#1198](#1198)) ([3f4eb47](3f4eb47))
* uiSchema translation keys ([#1224](#1224)) ([a55292f](a55292f))
* **hub-discussions:** user can read channel if group is non-discussable ([#1201](#1201)) ([28d61f3](28d61f3))

### Features

* **hub-common:** adds followers group discussion settings on site wo… ([#1251](#1251)) ([e0beb59](e0beb59))
*  add feature and entity flagging into checkPermission ([#1187](#1187)) ([b040283](b040283))
* Add Initiative and Project Associations ([#1213](#1213)) ([7cb0298](7cb0298))
* add invite users to hub group ([#1197](#1197)) ([014b2bd](014b2bd))
* add links hash for project, initiative, and group entities ([#1226](#1226)) ([aba8f7b](aba8f7b))
* add member role badges to user card model ([#1195](#1195)) ([e09608d](e09608d))
* add new polling util ([#1265](#1265)) ([e36c142](e36c142))
* add option to enrich an entity  ([#1220](#1220)) ([0b57ff5](0b57ff5))
* add supporting groups to sites property map ([#1205](#1205)) ([2d473d6](2d473d6))
* add workspaceRelative to enrichGroupSearchResult ([#1206](#1206)) ([f6d2016](f6d2016))
* addGroupMembers ([#1230](#1230)) ([3a7c900](3a7c900))
* adding license picker to content workspace ([#1192](#1192)) ([312b333](312b333))
* adds entity discussion settings ([#1221](#1221)) ([5e25a43](5e25a43))
* adds getChannelUsersQuery method, bumps to @esri/arcgis-rest-port… ([#1210](#1210)) ([320d6d8](320d6d8))
* collaborator pane for content workspace ([#1259](#1259)) ([e00e624](e00e624))
* initiative template entity ([#1229](#1229)) ([f5a995a](f5a995a))
* initiative template workspace ([#1246](#1246)) ([cb385e5](cb385e5))
* scaffold solution template entity ([#1253](#1253)) ([54d1fe6](54d1fe6))
* **hub-common:** add application type content edit link ([#1217](#1217)) ([82ceec4](82ceec4))
* **hub-common:** add blocked as a possible PostStatus ([#1222](#1222)) ([11c8a58](11c8a58))
* **hub-common:** add content settings schemas and derive props from server definitions ([#1209](#1209)) ([1721285](1721285))
* **hub-common:** add getResultSiteRelativeLink so Hub Page results can have slugs in siteRelative l ([#1200](#1200)) ([27e0740](27e0740))
* **hub-common:** add hub:[entity]:manage permission for all entities ([#1202](#1202)) ([71191b7](71191b7))
* **hub-common:** add icon for Discussion content type ([#1185](#1185)) ([7ae927a](7ae927a))
* **hub-discussions:** adding ability to update the groups of a channel ([#1218](#1218)) ([7bc2117](7bc2117))
* followers settings schema and behavior ([#1211](#1211)) ([a8be73b](a8be73b))
* item extent now selectable, savable, and reflects in old and new view ([#1212](#1212)) ([5dbe3bb](5dbe3bb))
* partnered orgs added to context ([#1214](#1214)) ([7979571](7979571))
* refactor entity schema implementation ([#1203](#1203)) ([88cdd2b](88cdd2b))
* **hub-common:** add unified "links" hash as an optional property for all entities ([#1199](#1199)) ([ba14502](ba14502))
* site's followers pane permissions ([#1186](#1186)) ([90feec7](90feec7))
* ungate dashboard from projects ([#1188](#1188)) ([658b936](658b936))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants