feat(guardian): rich consent supports authorization details #126

cgcladeraokta · 2025-02-13T12:00:41Z

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Add support to authorization_details property in the Rich Consent record.

Adds a demo to the sample app that accepts "payment_initiation" authorization details type and displays the details in the consent screen.

References

Include any links supporting this change such as a:

GitHub Issue/PR number addressed or fixed

Auth0 Community post

StackOverflow post

Support forum thread

Related pull requests/issues from other repos

If there are no references, simply delete this section.

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

This change adds test coverage for new/changed/fixed functionality

Checklist

I have added documentation for new/changed functionality in this PR or in auth0.com/docs
All active GitHub checks for tests, formatting, and security are passing
The correct base branch is being used, if not the default branch

Add support to `authorization_details` property in the Rich Consent record.

sam-muncke · 2025-02-26T15:33:47Z

README.md

+}
+```
+
+Or, if you prefer to work with typed objects, you can use the filter helper passing a Class that has been annotated with `@AuthorizationDetailsType("[type]")`.


I think we should be more forward in encouraging this as the default behaviour. See the wording that I put in the iOS README for comparison

Done in c42f8b4

sam-muncke · 2025-02-26T15:40:13Z

README.md

+}
+```
+
+Or, if you prefer to work with typed objects, you can use the filter helper passing a Class that has been annotated with `@AuthorizationDetailsType("[type]")`.


I think we probably need to make a reference to the GSON docs here. Whilst we don't explicitly expose any dependency on Gson objects in our inteface, our implementation is implicitly coupled to it and the types they define need to conform to the rules for deserialization (and can leverage things like their attributes for customization)

Agreed, added here c42f8b4

sam-muncke · 2025-02-26T16:01:20Z

app/src/main/java/com/auth0/guardian/sample/payments/PaymentInitiationDetails.java

+    }
+
+    public String getType() {
+        return "payment_initiation";


Not keen on this. I feels a bit redundant declaring this statically since we are using the annotation. I know its just an example and it ultimately will get populated to this but I think it might lead to confusion by someone using this as a reference. I'd let this be a data value like the others and let the serialization populate it.

Fixed in 67ad9c8

sam-muncke · 2025-02-26T16:08:26Z

app/src/main/java/com/auth0/guardian/sample/NotificationActivity.java


        setupUI();

+        if (notification.getTransactionLinkingId() != null) {


This is much nicer than having the separate activities with all the logic in Main. This can probably be tidied up a bit though but adding so private methods to reduce the nesting a bit. You also have 3 code paths that all ultimately call updateUI() - pretty sure you can simplify

I moved fragment initialization logic bits to private methods. About the three paths calling updateUI(), I did find a bug that caused the regular authentication fragment to always be shown before fetching the rich consent record. However, because it's "async" I didn't find an easy way to simplify it. If you've got ideas I'm all ears.

The bug has been fixed in b7f56a8

sam-muncke · 2025-02-26T16:08:47Z

app/src/main/java/com/auth0/guardian/sample/MainActivity.java

-                Log.e(TAG, "Error requesting consent details", e);
-            }
-        }
+        startActivity(NotificationActivity.getStartIntent(this, notification, enrollment));


Much better

SerhiiKobezaCapgemini · 2025-02-27T09:00:26Z

app/src/main/res/values/styles.xml


+    <style name="Label.Small" parent="Label">
+        <item name="android:textSize">12sp</item>
+    </style>


not sure it makes sense to create a style just for one TextSize attribute. Usually this approach is used when there's a need to group several elements, or when there's a design system in place. At the moment we have neither

I think now that we removed the inline text size attribute from all the views, this style makes more sense now.

SerhiiKobezaCapgemini · 2025-02-27T09:05:08Z

app/src/main/res/layout/fragment_dynamic_authorization_details.xml

+        android:layout_height="wrap_content"
+        android:layout_marginBottom="36dp"
+        android:textSize="12sp"
+        android:theme="@style/Label"


in this case the value of android:textSize attribute isn't being used because it's overridden by next element - android:theme="@style/Label" which contains textSize = 24.
Please pick just one attribute

SerhiiKobezaCapgemini · 2025-02-27T09:06:00Z

app/src/main/res/layout/fragment_dynamic_authorization_details.xml

+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:layout_marginBottom="12dp"
+        android:textSize="12sp"


in this case the value of android:textSize attribute isn't being used because it's overridden by next element - android:theme="@style/Label" which contains textSize = 24.
Please pick just one attribute

SerhiiKobezaCapgemini · 2025-02-27T09:07:10Z

app/src/main/res/layout/fragment_dynamic_authorization_details.xml

+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:text="Date"
+        android:textSize="12sp"


in this case textSize can be removed since the Label.Header is being used

SerhiiKobezaCapgemini · 2025-02-27T09:07:31Z

app/src/main/res/layout/fragment_dynamic_authorization_details.xml

+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:text="Binding Message"
+        android:textSize="12sp"


in this case textSize can be removed since the Label.Header is being used

SerhiiKobezaCapgemini · 2025-02-27T09:19:25Z

app/src/main/res/layout/fragment_consent_basic_details.xml

+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:layout_marginBottom="12dp"
+        android:textSize="12sp"


in this case the value of android:textSize attribute isn't being used because it's overridden by next element - android:theme="@style/Label" which contains textSize = 24.
Please pick just one attribute

SerhiiKobezaCapgemini · 2025-02-27T09:33:03Z

...in/java/com/auth0/guardian/sample/fragments/consent/DynamicAuthorizationDetailsFragment.java

+
+        layout = view.findViewById(R.id.dynamicAuthorizationDetailsLayout);
+        bindingMessageText = view.findViewById(R.id.bindingMessage);
+        dateText = view.findViewById(R.id.dateText);


for better readability it could be moved into a separate function named setupUI

SerhiiKobezaCapgemini · 2025-02-27T09:33:47Z

.../main/java/com/auth0/guardian/sample/fragments/consent/ConsentPaymentInitiationFragment.java

+        remittanceInfoText = view.findViewById(R.id.paymentRemittanceInformationText);
+        creditorAccountText = view.findViewById(R.id.paymentAccountText);
+        amountCurrencyText = view.findViewById(R.id.paymentAmountCurrencyText);
+        amountText = view.findViewById(R.id.paymentAmountText);


for better readability it could be moved into a separate function named setupUI

SerhiiKobezaCapgemini · 2025-02-27T09:34:08Z

app/src/main/java/com/auth0/guardian/sample/fragments/consent/ConsentBasicDetailsFragment.java

+
+        bindingMessageText = (TextView) view.findViewById(R.id.bindingMessage);
+        scopeText = (TextView) view.findViewById(R.id.scope);
+        dateText = (TextView) view.findViewById(R.id.dateText);


for better readability it could be moved into a separate function named setupUI

SerhiiKobezaCapgemini · 2025-02-27T09:34:36Z

app/src/main/java/com/auth0/guardian/sample/fragments/AuthenticationRequestDetailsFragment.java

+        browserText = view.findViewById(R.id.browserText);
+        osText = view.findViewById(R.id.osText);
+        locationText = view.findViewById(R.id.locationText);
+        dateText = view.findViewById(R.id.dateText);


for better readability it could be moved into a separate function named setupUI

cgcladeraokta · 2025-02-27T12:23:53Z

@SerhiiKobezaCapgemini I fixed all your requested changes. Thank you for your feedback.

cgcladeraokta added 5 commits February 13, 2025 11:25

feat(rich-consents): support authorization details

4f6a4eb

Add support to `authorization_details` property in the Rich Consent record.

feat(rich-consents): authz details typed overload

2fc99c1

fix(rich-consents): get authz details by type

247bc97

feat(app): consent fragments

2643cba

feat(app): payment initiation consent

9c9ed49

cgcladeraokta changed the title ~~feat(rich-consents): support authorization details~~ feat(guardian): rich consents supports authorization details Feb 18, 2025

cgcladeraokta changed the title ~~feat(guardian): rich consents supports authorization details~~ feat(guardian): rich consent supports authorization details Feb 18, 2025

cgcladeraokta marked this pull request as ready for review February 18, 2025 12:45

cgcladeraokta added 5 commits February 18, 2025 15:18

doc: document rich consent authorizadion details

60f9395

refactor(guardian): guardian rich consent static gson

110432e

fix: return empty list instead of null

19f8c22

refactor: avoid serializing/deserializing using JsonObject

b5f0dca

refactor(guardian): authorization details type annotation

3fa7fb6

ionutmanolache-okta previously approved these changes Feb 26, 2025

View reviewed changes

refactor: filter authorization details by type

a2ce1a9

cgcladeraokta dismissed ionutmanolache-okta’s stale review via a2ce1a9 February 26, 2025 14:08

feat: payment initiation actions and locations

e7642d8

sam-muncke reviewed Feb 26, 2025

View reviewed changes

cgcladeraokta added 5 commits February 26, 2025 18:03

feat: render dynamic authorization details item

0010268

refactor: improve code

75655b3

doc: improve authz details docs in README

c42f8b4

refactor: fix payment details object definition

67ad9c8

fix: do not render regular authentication consent if linkingid

b7f56a8

SerhiiKobezaCapgemini suggested changes Feb 27, 2025

View reviewed changes

cgcladeraokta added 2 commits February 27, 2025 13:09

fix: improve resources organization

1f877c5

refactor: improve code readability

a7a1651

fix: invalid display theme

d37cb1c

SerhiiKobezaCapgemini approved these changes Feb 27, 2025

View reviewed changes

cgcladeraokta requested a review from sam-muncke March 6, 2025 13:01

sam-muncke approved these changes Mar 6, 2025

View reviewed changes

ionutmanolache-okta merged commit 8e83c0f into auth0:master Mar 12, 2025
3 checks passed


		setupUI();

		if (notification.getTransactionLinkingId() != null) {

feat(guardian): rich consent supports authorization details #126

feat(guardian): rich consent supports authorization details #126

Uh oh!

Conversation

cgcladeraokta commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

References

Testing

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sam-muncke Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sam-muncke Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cgcladeraokta commented Feb 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cgcladeraokta commented Feb 13, 2025 •

edited

Loading

sam-muncke Feb 26, 2025 •

edited

Loading

sam-muncke Feb 26, 2025 •

edited

Loading