Adds async identity collection to the audit UI #191

jwrosewell · 2022-06-15T16:21:23Z

Controller for the audit UI component now supports the AuditHandler interface.
Audit viewer is now added to the advert div element via the AuditHandler interface in the demo. Note the demo has been amended to "fake" an auditable response to demonstrate the UI. More work is needed on system integration to align the different components of the project. See issue Prebid "bidWon" event does not contain PAF object #181.
Identity information when provided adds an email icon with a pre-populated email and a link to the privacy policy.
All class for identity data are performed asynchronously.
Common elements of the CMP concerning localisation have been moved to the core.
This PR along with Adding initial version of audit log v2 html pattern library #180 are dependencies for the update to the V2 UI.

…d with the transmission. Enabled the contact DPO, and privacy policy URL icons when identity information is returned. Handled the situation where identity information can not be returned. Modified the data model and fields to support promise resolution to update the UI. Moved the tick and cross icons into the component HTML.

…t-log-async # Conflicts: # paf-mvp-audit/src/controller.ts

…be shared across the CMP and the Audit modules.

…e rather than a folder. Uses the shared core loader and locale features.

…at the audit handler can extract them if the users wants to check the log.

…ansfer the audit log data.

… into feature/audit-log-async

…t-log-async

OlivierChirouze

I'm fine with this PR, but would like to have @RomainLofaso to check the integration with seeds paf-lib.ts

OlivierChirouze · 2022-06-23T14:14:08Z

paf-mvp-audit/src/model.ts

+   * and the other identity information over multiple requests to the same endpoint.
+   * @returns promise that when resolved will provide the identity associated with the transmission result or an error.
+   */
+  public getIdentity() {


NIT: return type

Thanks. There are quite a few changes coming in the next PR. I'm considering changing this one to draft and then adding the next set of changes to it. Could @RomainLofaso hold off reviewing until we've updated?

Would you mind keeping it separate instead?
This way it would be easier to review: in the current review I think there are only a couple of files that "need" to be reviewed by Romain, the rest is mostly about translation, identity and pattern library.
I'm wondering if adding "quite a few changes" to this review would not make it complicated to review.

The async model had to change a lot when the V2 UI layer was finally complete and the two combined. I'm reviewing this today. Therefore some of the elements of this PR are no longer present and it would merely waste review time. I don't think there's a way to get away from the additional features of the V2 layer being a large addition (not change) to the project. Perhaps the review could include a virtual F2F to go through the approach if the concern is about the size of the PR?

… into feature/audit-log-v2-complete # Conflicts: # paf-mvp-demo-express/public/assets/.gitignore # paf-mvp-demo-express/src/views/publisher/index.hbs # tsconfig.test.json

…f-mvp-implementation into feature/audit-log-v2-complete

…to fix a bug in the choosen project.

… the audit viewer to support build of crypto components for browser.

…t come from OpenRTB to be able to demonstrate the mock audit log.

jwrosewell · 2022-07-01T12:04:57Z

There were a number of issues related to the integration of the V2 changes which make this PR unavoidably large. I suggest the following approach to review.

There have been changes to the core to support the need for promises to be returned to support browser crypto features. It is these areas where the risk of breaking changes to existing functionality exists. These are grouped in this commit.
There are minor changes to the CMP to support the Marketing class becoming a core component as it is shared across audit and CMP. These are contained in this commit.
The audit log V2 is in this commit. As this is new functionality and won’t break existing features this could be given a light touch review to expedite getting this PR into the demo. There are a few changes to be added including progress spinners for fields that have not resolved verification, and the modal form to capture “pause this ad” reasons.

The other commits after these are minor and relate to fixing missing NPM packages or the demo code.

Note that the workflow tests needed to change to include getting the submodule as a dependency. At the time of writing this these tests are queued but not complete.

…an hour.

…me element.

Added sub module clone to build-test script after confirming worked resolve missing module on cypress.

Removed async/await syntax from jest test as might be the cause of intermittent failure of audit tests that require promises. Updated the audit log mocks from the refreshed tests.

jwrosewell · 2022-07-01T16:58:19Z

@OlivierChirouze This is now ready for review. I know it is a large PR but the main areas to review are the core changes related to making crypto async. See this commit.

jwrosewell · 2022-07-01T17:04:55Z

Mobile

Tablet

Desktop

The example data is now copied before the mock audit log is created to avoid the order of test execution impacting the test outcomes. (cherry picked from commit ada897d4b80bcb1aa8e2ffde4c69bf20b3343c91)

…Node.

…dle explicitly.

…n a form that will fail validation. This commit resigns the data until it passes validation.

…being a Promise.

…not provided.

jwrosewell added 16 commits June 8, 2022 09:03

Merge branch 'feature/audit-log-v2-pattern-library' into feature/audi…

4d48cf0

…t-log-async # Conflicts: # paf-mvp-audit/src/controller.ts

Removed the CMP folder.

c62be72

Move the locale and loader capabilities to the core so that they can …

49a1115

…be shared across the CMP and the Audit modules.

The output from the CMP module now has "cmp" in the resource file nam…

d4e7a2f

…e rather than a folder. Uses the shared core loader and locale features.

Contoller now supports the AuditHandler interface.

6b679f5

Modified the gitignore to ignore all the OK-UI assets.

b198c27

Updated the marketing template to use the new CMP file.

156e58e

Added the audit log string to the attributes of the div element so th…

9722d27

…at the audit handler can extract them if the users wants to check the log.

Updated the comment in PAF lib to make it clearer on the method to tr…

9af0bde

…ansfer the audit log data.

Completed the download functionality.

79cf56b

Modified the demo and PAF lib to fake an audit log input to the PAF lib.

bd54cf2

Updated the audit button to the single icon.

b848863

Added the close icon to the language file.

1f08ae0

Merge branch 'main' of https://github.com/prebid/paf-mvp-implementation…

ddf878e

… into feature/audit-log-async

Merge branch 'feature/audit-log-v2-pattern-library' into feature/audi…

1f46a92

…t-log-async

jwrosewell requested a review from a team as a code owner June 15, 2022 16:21

johnnorris and others added 5 commits June 16, 2022 08:49

Pattern library (Audit log v2) fix broken link in documentation

6d34b18

Initial update of UI HTML and CSS.

db673a9

Pattern library (Audit log v2) specify Node v16

f96ce89

Pattern library (Audit log v2) ensure popup is fixed from top

a57492d

Pattern library (Audit log v2) update README on Storybook

8f4799c

OlivierChirouze reviewed Jun 23, 2022

View reviewed changes

jwrosewell marked this pull request as draft June 23, 2022 15:40

jwrosewell added 6 commits June 24, 2022 09:32

WIP

7906bfb

Merge branch 'main' of https://github.com/prebid/paf-mvp-implementation…

b6cde58

… into feature/audit-log-v2-complete # Conflicts: # paf-mvp-demo-express/public/assets/.gitignore # paf-mvp-demo-express/src/views/publisher/index.hbs # tsconfig.test.json

WIP

117a055

Merge branch 'feature/cmp-initial' of https://github.com/51Degrees/pa…

d7dd657

…f-mvp-implementation into feature/audit-log-v2-complete

Added a sub module for the verification of signatures in the browser …

f5e997d

…to fix a bug in the choosen project.

WIP

a9bb9af

jwrosewell added 5 commits July 1, 2022 12:31

Removed references to ecdsa-secp256r1 for NPM. Submodule is now used.

4d4036d

rollup-plugin-node-globals and rollup-plugin-node-polyfills added for…

fb45390

… the audit viewer to support build of crypto components for browser.

Updated the demo to place the OneKey icon under an image that does no…

7751e45

…t come from OpenRTB to be able to demonstrate the mock audit log.

Fix name change for CMP.

fd33781

Added dependency to clone the sub modules when running tests.

659086f

jwrosewell marked this pull request as ready for review July 1, 2022 12:05

jwrosewell added 9 commits July 1, 2022 14:30

Changed sub module run command as Git shows the test has stalled for …

27067ac

…an hour.

Improve the setting of the advert content width.

00ca100

Removed pause this Ad UI component.

86d471c

Added missing data-action for settings.

698a52a

Addressed potential bug where multiple listenners are added to the sa…

aa223c5

…me element.

Fixed wrong URL being used in the preload.

5fa28b9

Moved the git submodule clone to what seems to be the right place.

679dc06

Fixed upper case L in log that prevented tests passing on Ubuntu.

2a7c38a

Added sub module clone to build-test script after confirming worked resolve missing module on cypress.

Fixed bug in test where the overall property does not need await.

d5ec0a5

Removed async/await syntax from jest test as might be the cause of intermittent failure of audit tests that require promises. Updated the audit log mocks from the refreshed tests.

jwrosewell added 12 commits July 4, 2022 12:25

Fixed test defect where the test was not running. Now uses async await.

6924b12

The example data is now copied before the mock audit log is created to avoid the order of test execution impacting the test outcomes. (cherry picked from commit ada897d4b80bcb1aa8e2ffde4c69bf20b3343c91)

Removed Promise from generateKey because this is only ever called in …

bd82cf6

…Node.

Check if the return type from verify and fromJWK is a promise and han…

96e98f0

…dle explicitly.

Removed unneeded await in the test.

6f76f25

Found cause of random test failure. The signature is being returned i…

58dc0b2

…n a form that will fail validation. This commit resigns the data until it passes validation.

Improved the performance of the resolver when no delay is specified.

d1a0922

Fixed comment.

62a7144

Removed console log messages.

f8b2da7

Updated mock audit log data.

301b757

Addess GitHub warning due to duplicate package names in tests.

740383b

Cast the verify check to boolean to avoid any possible issue with it …

804cae7

…being a Promise.

Added a check for the verify method to handle situations where it is …

9cc4c37

…not provided.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adds async identity collection to the audit UI #191

Adds async identity collection to the audit UI #191

Uh oh!

jwrosewell commented Jun 15, 2022

Uh oh!

OlivierChirouze left a comment

Uh oh!

OlivierChirouze Jun 23, 2022

Uh oh!

jwrosewell Jun 23, 2022

Uh oh!

OlivierChirouze Jun 24, 2022

Uh oh!

jwrosewell Jun 24, 2022

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Adds async identity collection to the audit UI #191

Are you sure you want to change the base?

Adds async identity collection to the audit UI #191

Uh oh!

Conversation

jwrosewell commented Jun 15, 2022

Uh oh!

OlivierChirouze left a comment

Choose a reason for hiding this comment

Uh oh!

OlivierChirouze Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

jwrosewell Jun 23, 2022

Choose a reason for hiding this comment

Uh oh!

OlivierChirouze Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

jwrosewell Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

jwrosewell commented Jul 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants