feat: Custom Applications multiple permissions #2799

kark · 2022-09-07T10:49:17Z

https://jira.commercetools.com/browse/SHIELD-580

In preparation for the Custom Applications Multiple Permissions support.

changeset-bot · 2022-09-07T10:49:20Z

🦋 Changeset detected

Latest commit: 86ff5a8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@commercetools-frontend/application-config	Minor
@commercetools-frontend/application-shell	Minor
@commercetools-frontend/constants	Minor
@commercetools-frontend/cypress	Minor
@commercetools-frontend/mc-scripts	Minor
@commercetools-frontend/mc-dev-authentication	Minor
@commercetools-frontend/mc-html-template	Minor
@commercetools-applications/merchant-center-template-starter-typescript	Minor
@commercetools-applications/merchant-center-template-starter	Minor
@commercetools-local/playground	Minor
@commercetools-frontend/actions-global	Minor
@commercetools-frontend/application-components	Minor
@commercetools-frontend/application-shell-connectors	Minor
@commercetools-frontend/react-notifications	Minor
@commercetools-frontend/sdk	Minor
@commercetools-frontend/sentry	Minor
@commercetools-local/visual-testing-app	Minor
@commercetools-website/components-playground	Minor
@commercetools-frontend/permissions	Minor
@commercetools-frontend/i18n	Minor
@commercetools-frontend/l10n	Minor
@commercetools-backend/eslint-config-node	Minor
@commercetools-backend/express	Minor
@commercetools-backend/loggers	Minor
@commercetools-frontend/assets	Minor
@commercetools-frontend/babel-preset-mc-app	Minor
@commercetools-frontend/browser-history	Minor
@commercetools-frontend/codemod	Minor
@commercetools-frontend/create-mc-app	Minor
@commercetools-frontend/eslint-config-mc-app	Minor
@commercetools-frontend/jest-preset-mc-app	Minor
@commercetools-frontend/jest-stylelint-runner	Minor
@commercetools-frontend/notifications	Minor
@commercetools-frontend/url-utils	Minor
@commercetools-website/custom-applications	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2022-09-07T10:55:05Z

Deploy preview for merchant-center-application-kit ready!

✅ Preview
https://merchant-center-application-nc0pepxzh-commercetools.vercel.app
https://appkit-sha-9b937d63a03d0628f86af44dbdd65b6aa43c2fb6.commercetools.vercel.app
https://appkit-pr-2799.commercetools.vercel.app

Built with commit 86ff5a8.
This pull request is being automatically deployed with vercel-action

CarlosCortizasCT

This looks very promising 💪

I just left some comments with some questions/suggestions.

CarlosCortizasCT · 2022-09-09T12:00:00Z

.changeset/cuddly-chefs-burn.md

+'@commercetools-frontend/application-config': patch
+---
+
+Define new field `additionalOAuthScopes` in the Custom Application config.


Should we describe what this new field should be use for?
Or maybe add a link to the updated documentation?

packages/application-config/test/json-schema.spec.js

website/src/content/api-reference/application-config.mdx

Rhotimee

Looks good. Just some nitpicking.

Rhotimee · 2022-09-12T10:42:10Z

website/src/content/api-reference/application-config.mdx

+
+## `additionalOAuthScopes.view`
+
+A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated to the `View` permission.


Suggested change

A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated to the `View` permission.

A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the additionalOAuthScopes `View` permission.

Rhotimee · 2022-09-12T10:42:31Z

website/src/content/api-reference/application-config.mdx

+
+## `additionalOAuthScopes.manage`
+
+A list of "manage-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the `Manage` permission.


Suggested change

A list of "manage-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the `Manage` permission.

A list of "manage-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the additionalOAuthScopes `Manage` permission.

Rhotimee · 2022-09-12T10:43:57Z

website/src/content/concepts/oauth-scopes-and-user-permissions.mdx

@@ -30,6 +30,37 @@ Notice here how the OAuth Scopes are grouped by the two fields `view` and `manag

 This grouping determines the **mapping and relation between OAuth Scopes and user permissions**.

+# Additional OAuth Scopes
+
+Defining `oAuthScopes` in the Custom Application config allows to use permissions limited to 1 unique pair (view/manage) specific to the Custom Application.


Suggested change

Defining `oAuthScopes` in the Custom Application config allows to use permissions limited to 1 unique pair (view/manage) specific to the Custom Application.

Defining `oAuthScopes` in the Custom Application config allows using permissions limited to 1 unique pair (view/manage) specific to the Custom Application.

Rhotimee · 2022-09-12T10:44:34Z

website/src/content/concepts/oauth-scopes-and-user-permissions.mdx

+
+Defining `oAuthScopes` in the Custom Application config allows to use permissions limited to 1 unique pair (view/manage) specific to the Custom Application.
+
+For more granular permissions, for example to allow team access to only certain parts or functionality of the Custom Application, [additional OAuth Scopes](https://docs.commercetools.com/api/scopes) can be requested as part of various permission groups. 


Suggested change

For more granular permissions, for example to allow team access to only certain parts or functionality of the Custom Application, [additional OAuth Scopes](https://docs.commercetools.com/api/scopes) can be requested as part of various permission groups.

For more granular permissions, for example, to allow the team access to only certain parts or functionality of the Custom Application, [additional OAuth Scopes](https://docs.commercetools.com/api/scopes) can be requested as part of various permission groups.

emmenko · 2022-09-12T11:08:44Z

FYI: marking this PR as draft/blocked as we shouldn't merge this yet, only when it's time to release the feature. We can use this as the base branch I suppose.

emmenko

Have you had a chance to test the OIDC flow locally?

emmenko · 2022-09-12T13:30:26Z

.changeset/cuddly-chefs-burn.md

@@ -0,0 +1,5 @@
+---
+'@commercetools-frontend/application-config': patch


Nit: new features usually should be considered a minor version

.changeset/fresh-coins-shout.md

emmenko · 2022-09-15T08:10:04Z

website/src/content/api-reference/application-config.mdx

@@ -327,7 +327,7 @@ You can have "view-only" or "manage-only" OAuth Scopes and leave the other list

 ## `oAuthScopes.view`

-A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated to the `View` permission.
+A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the `View` permission.


I would prefer the documentation changes to be defined in a separate PR. Main reason being that merging this PR will publish the docs changes but the packages are not being released yet.

So the docs changes can be merged separately once the packages have been released.

Can you extract these docs changes into a separate PR? Thanks 🙂

packages/application-config/src/validations.ts

CarlosCortizasCT

Awesome job 🚀

* feat(config): include additional permissions when using config-sync * refactor(cli): validate additional oathScope * refactor(cli): implement getPermissions function, update tests * refactor(cli): move getPermission function to transformer.ts * refactor(cli): add validation for additional permission name * refactor(cli): show duplicated permission name in error thrown

emmenko

🚀

github-actions bot deployed to Preview September 7, 2022 10:53 View deployment

kark force-pushed the SHIELD-580-additionalOAuthScopes-field branch from 66c0e0f to 3caad79 Compare September 9, 2022 08:46

github-actions bot deployed to Preview September 9, 2022 08:51 View deployment

kark marked this pull request as ready for review September 9, 2022 11:36

kark requested a review from a team September 9, 2022 11:36

CarlosCortizasCT reviewed Sep 9, 2022

View reviewed changes

github-actions bot deployed to Preview September 12, 2022 09:53 View deployment

Rhotimee approved these changes Sep 12, 2022

View reviewed changes

emmenko added the 🛑 Status: blocked label Sep 12, 2022

emmenko marked this pull request as draft September 12, 2022 11:08

github-actions bot deployed to Preview September 12, 2022 11:40 View deployment

github-actions bot requested a deployment to Preview September 15, 2022 07:09 In progress

emmenko reviewed Sep 15, 2022

View reviewed changes

kark force-pushed the SHIELD-580-additionalOAuthScopes-field branch from 5e11208 to 564f59a Compare September 15, 2022 11:53

kark changed the title ~~refactor(config): define new field additionalOAuthScopes in the Custom Application config~~ feat: Custom Applications multiple permissions Sep 15, 2022

github-actions bot deployed to Preview September 15, 2022 12:08 View deployment

emmenko added the 🚀 Type: New Feature Something new label Nov 8, 2022

kark force-pushed the SHIELD-580-additionalOAuthScopes-field branch 2 times, most recently from 2e06827 to 55b0790 Compare November 22, 2022 07:50

github-actions bot deployed to Preview November 22, 2022 07:55 View deployment

github-actions bot deployed to Preview November 22, 2022 07:59 View deployment

github-actions bot deployed to Preview November 22, 2022 08:07 View deployment

github-actions bot deployed to Preview November 23, 2022 13:14 View deployment

kark marked this pull request as ready for review November 24, 2022 07:59

github-actions bot deployed to Preview November 24, 2022 08:21 View deployment

CarlosCortizasCT reviewed Nov 24, 2022

View reviewed changes

packages/application-config/src/validations.ts Show resolved Hide resolved

github-actions bot deployed to Preview November 25, 2022 09:11 View deployment

github-actions bot deployed to Preview November 25, 2022 09:15 View deployment

CarlosCortizasCT approved these changes Nov 25, 2022

View reviewed changes

emmenko mentioned this pull request Nov 30, 2022

docs: Custom Applications multiple permissions #2806

Merged

kark and others added 12 commits December 9, 2022 10:35

refactor(config): define new field additionalOAuthScopes in app config

16db486

docs: improvements

dcc9798

docs: code review improvements

61ea935

refactor(config): include additional oauth scopes in oidc flow (#2801)

c43a469

refactor: make a separate PR with docs changes

fb9e6a9

refactor: update permission group name regex

e00e2a0

test: fix snapshots

c74b706

chore: alphabetic not alphanumeric

b0fef42

chore: update changeset

28bdfb9

refactor: at least one additional oauth scope defined

0b30015

test: typo

86ff5a8

emmenko force-pushed the SHIELD-580-additionalOAuthScopes-field branch from 9a01d41 to 86ff5a8 Compare December 9, 2022 09:35

github-actions bot deployed to Preview December 9, 2022 09:46 View deployment

emmenko removed the 🛑 Status: blocked label Dec 9, 2022

emmenko approved these changes Dec 9, 2022

View reviewed changes

emmenko merged commit 033d95e into main Dec 9, 2022

emmenko deleted the SHIELD-580-additionalOAuthScopes-field branch December 9, 2022 10:19

ghost mentioned this pull request Dec 9, 2022

Version Packages #2909

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Custom Applications multiple permissions #2799

feat: Custom Applications multiple permissions #2799

kark commented Sep 7, 2022

changeset-bot bot commented Sep 7, 2022 •

edited

Loading

github-actions bot commented Sep 7, 2022 •

edited

Loading

CarlosCortizasCT left a comment

CarlosCortizasCT Sep 9, 2022

Rhotimee left a comment

Rhotimee Sep 12, 2022

Rhotimee Sep 12, 2022

Rhotimee Sep 12, 2022

Rhotimee Sep 12, 2022

emmenko commented Sep 12, 2022

emmenko left a comment

emmenko Sep 12, 2022

emmenko Sep 15, 2022

CarlosCortizasCT left a comment

emmenko left a comment


		## `additionalOAuthScopes.view`

		A list of "view-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated to the `View` permission.


		## `additionalOAuthScopes.manage`

		A list of "manage-only" [OAuth Scopes](https://docs.commercetools.com/api/scopes) required by the Custom Application and associated with the `Manage` permission.

	Defining `oAuthScopes` in the Custom Application config allows to use permissions limited to 1 unique pair (view/manage) specific to the Custom Application.
	Defining `oAuthScopes` in the Custom Application config allows using permissions limited to 1 unique pair (view/manage) specific to the Custom Application.


		Defining `oAuthScopes` in the Custom Application config allows to use permissions limited to 1 unique pair (view/manage) specific to the Custom Application.

		For more granular permissions, for example to allow team access to only certain parts or functionality of the Custom Application, [additional OAuth Scopes](https://docs.commercetools.com/api/scopes) can be requested as part of various permission groups.

		@@ -0,0 +1,5 @@
		---
		'@commercetools-frontend/application-config': patch

feat: Custom Applications multiple permissions #2799

feat: Custom Applications multiple permissions #2799

Conversation

kark commented Sep 7, 2022

changeset-bot bot commented Sep 7, 2022 • edited Loading

🦋 Changeset detected

github-actions bot commented Sep 7, 2022 • edited Loading

CarlosCortizasCT left a comment

Choose a reason for hiding this comment

CarlosCortizasCT Sep 9, 2022

Choose a reason for hiding this comment

Rhotimee left a comment

Choose a reason for hiding this comment

Rhotimee Sep 12, 2022

Choose a reason for hiding this comment

Rhotimee Sep 12, 2022

Choose a reason for hiding this comment

Rhotimee Sep 12, 2022

Choose a reason for hiding this comment

Rhotimee Sep 12, 2022

Choose a reason for hiding this comment

emmenko commented Sep 12, 2022

emmenko left a comment

Choose a reason for hiding this comment

emmenko Sep 12, 2022

Choose a reason for hiding this comment

emmenko Sep 15, 2022

Choose a reason for hiding this comment

CarlosCortizasCT left a comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Sep 7, 2022 •

edited

Loading

github-actions bot commented Sep 7, 2022 •

edited

Loading