✨ [RUMF-945] allow users to customize the attribute used to define the action name #919

bcaudan · 2021-06-30T09:16:14Z

Motivation

It can be useful to reuse existing tagging in the html to retrieve the action name rather than forcing customer to duplicate their tagging for every third party that need to retrieve this info.

take over of #903

Changes

Introduce new actionNameAttribute init configuration option

Usage:

<script>
  DD_RUM.init({
    ...
    trackInteractions: true,
    actionNameAttribute: 'data-custom-name'
    ...
  })
</script>

<a onclick="triggerSomeRequestOrDomChange()" data-custom-name="Login button">Try it out!</a>

Both data-dd-action-name and configured attribute can be used, data-dd-action-name is favored when both are present on an element.

Testing

unit, locally

I have gone over the contributing documentation.

amortemousque · 2021-06-30T10:03:43Z

packages/core/src/domain/configuration.ts

@@ -42,6 +42,7 @@ export interface UserConfiguration {
  publicApiKey?: string // deprecated
  clientToken: string
  applicationId?: string
+  actionNameAttribute?: string


I'm wondering if the name is not misleading.
It can be confused with the name of the action object we collect
Maybe something like this is clearer:

actionNameSelectorAttribute

actionNameHtmlAttribute

actionNameTrackingAttribute (to refer to the tracking section of the doc)

we will add some doc about it to explain the usage so IMO it would be clearer enough.

@hdelaby @BenoitZugmeyer @webNeat any thoughts?

About the wording: actionNameAttribute + doc LGTM, it's simple enough.

About the configuration: maybe we could have a more abstract getActionName(element, event) function instead, to allow the customer to implement their own logic to add beside our logic? That would be a bit more flexible.

a more abstract strategy sounds interesting but I'd be in favor of waiting to have the need, in order to see what could be the most relevant approach to do that.

Sounds good to me!

Yes, good to me too :)

I was thinking that having an array of attributes to check for, instead of just one would offer more flexibility, but the function getActionName also is interesting.
The current solution sounds enough to me for now.

The function idea is great! Love that concept.

packages/rum-core/src/domain/rumEventsCollection/action/getActionNameFromElement.ts

BenoitZugmeyer · 2021-06-30T13:12:45Z

packages/core/src/domain/configuration.ts

@@ -42,6 +42,7 @@ export interface UserConfiguration {
  publicApiKey?: string // deprecated
  clientToken: string
  applicationId?: string
+  actionNameAttribute?: string


About the wording: actionNameAttribute + doc LGTM, it's simple enough.

About the configuration: maybe we could have a more abstract getActionName(element, event) function instead, to allow the customer to implement their own logic to add beside our logic? That would be a bit more flexible.

codecov-commenter · 2021-06-30T13:49:24Z

Codecov Report

Merging #919 (f3c7736) into main (8084b2c) will decrease coverage by 0.01%.
The diff coverage is 76.92%.

@@            Coverage Diff             @@
##             main     #919      +/-   ##
==========================================
- Coverage   89.10%   89.09%   -0.02%     
==========================================
  Files          81       81              
  Lines        3838     3841       +3     
  Branches      855      857       +2     
==========================================
+ Hits         3420     3422       +2     
- Misses        418      419       +1

Impacted Files	Coverage Δ
...ain/rumEventsCollection/action/actionCollection.ts	`95.23% <0.00%> (ø)`
packages/core/src/domain/configuration.ts	`93.33% <50.00%> (-3.10%)`	⬇️
...ventsCollection/action/getActionNameFromElement.ts	`87.27% <87.50%> (+0.11%)`	⬆️
.../domain/rumEventsCollection/action/trackActions.ts	`97.87% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8084b2c...f3c7736. Read the comment docs.

BenoitZugmeyer

Nice!

webNeat

LGTM, just added a small question.

webNeat · 2021-06-30T20:31:21Z

packages/rum-core/src/domain/rumEventsCollection/action/getActionNameFromElement.ts

  // Proceed to get the action name in two steps:
  // * first, get the name programmatically, explicitly defined by the user.
  // * then, use strategies that are known to return good results. Those strategies will be used on
  //   the element and a few parents, but it's likely that they won't succeed at all.
  // * if no name is found this way, use strategies returning less accurate names as a fallback.
  //   Those are much likely to succeed.
  return (
-    getActionNameFromElementProgrammatically(element) ||
+    getActionNameFromElementProgrammatically(element, DEFAULT_PROGRAMMATIC_ATTRIBUTE) ||
+    (userProgrammaticAttribute && getActionNameFromElementProgrammatically(element, userProgrammaticAttribute)) ||


Can you please explain why the default attribute has priority over the user custom attribute?

it seemed more convenient for reusing a previous tagging but allow to override some elements with our own attribute if needed

webNeat · 2021-06-30T20:36:09Z

packages/core/src/domain/configuration.ts

@@ -42,6 +42,7 @@ export interface UserConfiguration {
  publicApiKey?: string // deprecated
  clientToken: string
  applicationId?: string
+  actionNameAttribute?: string


I was thinking that having an array of attributes to check for, instead of just one would offer more flexibility, but the function getActionName also is interesting.
The current solution sounds enough to me for now.

…e action name (#919) * ✨ allow users to customize the attribute used to define the action name * fix lint/format issues * style tweaks * 🐛 fix userConfig -> config * ✨ allow to have both data-dd-action-name et user configured attribute Co-authored-by: Bazyli Brzóska <bazyli.brzoska@gmail.com>

niieani and others added 3 commits June 24, 2021 23:57

✨ allow users to customize the attribute used to define the action name

4daa40b

fix lint/format issues

f4a4a4c

style tweaks

3845053

bcaudan requested a review from a team as a code owner June 30, 2021 09:16

Merge branch 'main' into niieani-bb/data-test-id

c785716

bcaudan mentioned this pull request Jun 30, 2021

✨ allow users to customize the attribute used to define the action name #903

Closed

bcaudan changed the title ~~✨ allow users to customize the attribute used to define the action name~~ ✨ [RUMF-945] allow users to customize the attribute used to define the action name Jun 30, 2021

🐛 fix userConfig -> config

7e49ea9

amortemousque reviewed Jun 30, 2021

View reviewed changes

packages/rum-core/src/domain/rumEventsCollection/action/getActionNameFromElement.ts Outdated Show resolved Hide resolved

bcaudan requested a review from BenoitZugmeyer June 30, 2021 13:02

BenoitZugmeyer reviewed Jun 30, 2021

View reviewed changes

✨ allow to have both data-dd-action-name et user configured attribute

f3c7736

BenoitZugmeyer approved these changes Jun 30, 2021

View reviewed changes

Merge branch 'main' into niieani-bb/data-test-id

e3fedbf

webNeat approved these changes Jun 30, 2021

View reviewed changes

bcaudan merged commit 3000fc5 into main Jul 1, 2021

bcaudan deleted the niieani-bb/data-test-id branch July 1, 2021 08:55

bcaudan mentioned this pull request Jul 6, 2021

[RUM] document actionNameAttribute usage DataDog/documentation#11014

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ [RUMF-945] allow users to customize the attribute used to define the action name #919

✨ [RUMF-945] allow users to customize the attribute used to define the action name #919

bcaudan commented Jun 30, 2021 •

edited

Loading

amortemousque Jun 30, 2021

bcaudan Jun 30, 2021

BenoitZugmeyer Jun 30, 2021

bcaudan Jun 30, 2021

BenoitZugmeyer Jun 30, 2021

amortemousque Jun 30, 2021

webNeat Jun 30, 2021

niieani Jul 3, 2021

BenoitZugmeyer Jun 30, 2021

codecov-commenter commented Jun 30, 2021

BenoitZugmeyer left a comment

webNeat left a comment

webNeat Jun 30, 2021

bcaudan Jul 1, 2021 •

edited

Loading

webNeat Jun 30, 2021

✨ [RUMF-945] allow users to customize the attribute used to define the action name #919

✨ [RUMF-945] allow users to customize the attribute used to define the action name #919

Conversation

bcaudan commented Jun 30, 2021 • edited Loading

Motivation

Changes

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 30, 2021

Codecov Report

BenoitZugmeyer left a comment

Choose a reason for hiding this comment

webNeat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bcaudan Jul 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bcaudan commented Jun 30, 2021 •

edited

Loading

bcaudan Jul 1, 2021 •

edited

Loading