Add onFidesEvent method for an alternative way to subscribe to Fides events #5297
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
fides
|
||||||||||||||||||||||||||||||
| Project |
fides
|
| Branch Review |
refs/pull/5297/merge
|
| Run status |
|
| Run duration | 00m 38s |
| Commit |
|
| Committer | Guntars Ašmanis-Graham |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
4
|
Upgrade your plan to view test results. | |
| View all changes introduced in this branch ↗︎ | |
NevilleS
reviewed
Sep 18, 2024
|
Btw, there's an issue with |
eastandwestwind
approved these changes
Sep 23, 2024
There was a problem hiding this comment.
Small change request but nothing blocking. Manually tested this and was able to get the event details surfaced using the new onFidesEvent method.
Thanks @guncha !
eastandwestwind
approved these changes
Sep 23, 2024
fides
|
||||||||||||||||||||||||||||||
| Project |
fides
|
| Branch Review |
main
|
| Run status |
|
| Run duration | 00m 37s |
| Commit |
|
| Committer | Guntars Ašmanis-Graham |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
Failures
|
0
|
|
Flaky
|
0
|
|
Pending
|
0
|
|
Skipped
|
0
|
|
Passing
|
4
|
Upgrade your plan to view test results. | |
| View all changes introduced in this branch ↗︎ | |
Vagoasdf
pushed a commit
that referenced
this pull request
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description Of Changes
This PR adds an
onFidesEventmethod to the globalFidesobject that subscribes the callback to Fides events. This is equivalent to callingwindow.addEventListener(...)yourself, except that the callback receives theFidesEventDetailobject instead of aCustomEvent. This is needed for the Google Tag Manager template integration as it doesn't allow usage of APIs likeaddEventListenerand also doesn't supportCustomEventor, really, any other non-primitive type.See this Slack thread for the rationale.
Code Changes
onFidesEventmethod tofides.tsandfides-tcf.tsSteps to Confirm
fides.jsversion on a pageFides.onFidesEventis availableconsole.log), trigger the event and verify that the handler was calledPre-Merge Checklist
CHANGELOG.md