-
Notifications
You must be signed in to change notification settings - Fork 205
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
Add Browser UserAction Event #1941
base: main
Are you sure you want to change the base?
Add Browser UserAction Event #1941
Conversation
requirement_level: recommended | ||
examples: ["//*[@id='testBtn']"] | ||
- id: user_action_type | ||
type: enum |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
need to confirm the user_action_type
enum. Currently, I am using the definitions from https://github.com/microsoft/ApplicationInsights-JS/blob/main/extensions/applicationinsights-clickanalytics-js/src/Enums.ts
name: browser.user_action | ||
brief: > | ||
This event describes actions performed by the user such as click, scroll, zoom, resize, etc. | ||
body: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to see a comment here to clarify that this is temporary or that this will actually be an attribute. That way readers do not expect to find content in the actual body.
- id: element | ||
type: string | ||
stability: development | ||
brief: Target element tag name and it is obtained via event.target.tagName. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
brief: Target element tag name and it is obtained via event.target.tagName. | |
brief: Target element tag name and it is obtained via `event.target.tagName`. |
- id: click_coordinates | ||
type: string | ||
stability: development | ||
brief: Click coordinates captured as a string in the format {x}X{y}. | ||
requirement_level: recommended | ||
examples: ["345X23"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this specific enough? Should this also specify if the coordinates are relative to the element or the page or the window or ???
- id: event.browser.user_action | ||
stability: development | ||
type: event | ||
name: browser.user_action |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we think there's an opportunity to use another prefix/namespace other than browser
? It seems like this is something that mobile (ios/android) could certainly also benefit from as well. If we can't make it broader to support multiple clients, then I fear we will encounter duplication later. I also undertand if the answer is "no, it doesn't make sense because browser already has all this stuff (eg. element xpath below, etc)"...but I think we should at least consider it.
Possible alternative namespaces: client.user_action
, app.user_action
, ux.action
...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is good, especially as a first pass "development" event, thanks! I left some comments and think there is room for improvement and possibly sharing/broadening, but I don't want those to block. Thanks for making this bite-sized!
Fixes #
Changes
Please provide a brief description of the changes here.
Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.
Merge requirement checklist
[chore]