Skip to content
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

change: [M3-7731] - Tag breadcrumb label edit icon on Linode Details page for analytics #10183

Merged

Conversation

mjac0bs
Copy link
Contributor

@mjac0bs mjac0bs commented Feb 12, 2024

Description 📝

In the breadcrumb on a Linode detail page, we want a custom event to track the use of the inline edit label feature.

Changes 🔄

  • Adds sendEditBreadcrumbEvent, which fires whenever the edit (pencil) icon is clicked on a Linode's details page.
  • Adds sendUpdateLinodeLabelEvent, which fires when the label is updated in the editable breadcrumb and when the label is updated on the Settings tab.

Preview 📷

Component Custom Event
image image
Screenshot 2024-02-13 at 2 46 56 PM Screenshot 2024-02-13 at 2 46 32 PM
Screenshot 2024-02-13 at 2 54 51 PM Screenshot 2024-02-13 at 2 46 17 PM

How to test 🧪

Prerequisites

(How to setup test environment)

  • Check out this PR and yarn dev
  • Go to http://localhost:3000 and turn on analytics logs for Adobe:
    • In the browser console, type _satellite.setDebug(true)
  • Have a linode on your account

Verification steps

(How to verify changes)

  • Go to the details page for a linode
  • Click on the edit icon
  • Observe the Adobe event above in the browser console log, which confirms the custom event has fired upon icon click
  • Confirm the analytics event matches the request in the internal ticket
  • See the additional screenshots to test the other events

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@mjac0bs mjac0bs self-assigned this Feb 12, 2024
@mjac0bs mjac0bs added the Analytics Relating to Analytics migration project or Adobe Analytics label Feb 12, 2024
@mjac0bs mjac0bs marked this pull request as ready for review February 12, 2024 22:33
@mjac0bs mjac0bs requested a review from a team as a code owner February 12, 2024 22:33
@mjac0bs mjac0bs requested review from bnussman-akamai and jaalah-akamai and removed request for a team February 12, 2024 22:33
Copy link
Member

@bnussman-akamai bnussman-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if there is any value in putting an event on the Linode Details Settings tab so we can compare usage

Screenshot 2024-02-12 at 5 37 48 PM

@mjac0bs
Copy link
Contributor Author

mjac0bs commented Feb 12, 2024

I wonder if there is any value in putting an event on the Linode Details Settings tab so we can compare usage

@bnussman-akamai - Good idea! I'll confirm with Matthew.

@mjac0bs mjac0bs added the UX/UI Changes for UI/UX to review label Feb 13, 2024
@mjac0bs mjac0bs added Ready for Review and removed UX/UI Changes for UI/UX to review labels Feb 13, 2024
@mjac0bs
Copy link
Contributor Author

mjac0bs commented Feb 13, 2024

I wonder if there is any value in putting an event on the Linode Details Settings tab so we can compare usage

@bnussman-akamai - Good idea! I'll confirm with Matthew.

Done in a8cee99. Used one event with a label differentiator to track successful label updates both via breadcrumb and Settings tab, in addition to our initial event to track the click of the edit icon. Matthew agreed these suggestions made sense.

Copy link

github-actions bot commented Feb 13, 2024

Coverage Report:
Base Coverage: 81.26%
Current Coverage: 81.23%

Copy link
Member

@bnussman-akamai bnussman-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thank you!

Copy link
Contributor

@abailly-akamai abailly-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Confirmed events being sent ✅

Curious to see what comes out of it. Do we have a success criteria for this?

@@ -158,6 +160,10 @@ export const EditableText = (props: PassThroughProps) => {
};

const openEdit = () => {
// Send analytics when pencil icon is clicked.
if (analyticsEvent) {
analyticsEvent();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this read sendAnalyticsEvent() or handleAnalyticsEvent()?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

Do we have a success criteria for this?

Good question. I'm circling back with UX about this - will update the internal ticket to reflect the response. And for the future, adding "Success Criteria" as a field in our analytics event template ticket would help make sure this is defined and communicated when the tagging request is made - that's a change I'll make.

@bnussman-akamai bnussman-akamai added Approved Multiple approvals and ready to merge! and removed Ready for Review labels Feb 14, 2024
@mjac0bs mjac0bs merged commit ff0a6a8 into linode:develop Feb 14, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Analytics Relating to Analytics migration project or Adobe Analytics Approved Multiple approvals and ready to merge!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants