forked from Cloud-Pipelines/pipeline-editor
-
Notifications
You must be signed in to change notification settings - Fork 6
feat: Guided Tours Completion Metrics #2412
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
Open
camielvs
wants to merge
1
commit into
06-10-feat_guided_tour_-_secrets
Choose a base branch
from
06-11-feat_guided_tours_completion_metrics
base: 06-10-feat_guided_tour_-_secrets
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
118 changes: 118 additions & 0 deletions
118
src/providers/TourProvider/TourTelemetryBridge.test.tsx
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| import { render } from "@testing-library/react"; | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; | ||
|
|
||
| import type { TourDefinition } from "@/components/Learn/tours/registry"; | ||
|
|
||
| import { TourTelemetryBridge } from "./TourTelemetryBridge"; | ||
|
|
||
| const track = vi.fn(); | ||
| const recordCompletion = vi.fn(() => ({ | ||
| completionCount: 1, | ||
| previouslyCompleted: false, | ||
| })); | ||
|
|
||
| let tourState: { currentStep: number }; | ||
| let tour: TourDefinition | null; | ||
|
|
||
| vi.mock("@reactour/tour", () => ({ | ||
| useTour: () => tourState, | ||
| })); | ||
|
|
||
| vi.mock("@/providers/AnalyticsProvider", () => ({ | ||
| useAnalytics: () => ({ track }), | ||
| })); | ||
|
|
||
| vi.mock("./TourModeContext", () => ({ | ||
| useTourMode: () => (tour ? { tour } : null), | ||
| })); | ||
|
|
||
| vi.mock("./tourCompletion", () => ({ | ||
| useRecordTourCompletion: () => recordCompletion, | ||
| useTourCompletions: () => ({ data: undefined }), | ||
| })); | ||
|
|
||
| const TOUR: TourDefinition = { | ||
| id: "first-pipeline", | ||
| steps: [ | ||
| { selector: "#a", content: "a", interaction: "add-task" }, | ||
| { selector: "#b", content: "b" }, | ||
| { selector: "#c", content: "c" }, | ||
| ], | ||
| }; | ||
|
|
||
| function eventsOfType(type: string) { | ||
| return track.mock.calls.filter(([actionType]) => actionType === type); | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| tour = TOUR; | ||
| tourState = { currentStep: 0 }; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.clearAllMocks(); | ||
| }); | ||
|
|
||
| describe("TourTelemetryBridge", () => { | ||
| it("fires step_viewed once per step reached", () => { | ||
| const { rerender } = render(<TourTelemetryBridge />); | ||
| tourState = { currentStep: 1 }; | ||
| rerender(<TourTelemetryBridge />); | ||
| tourState = { currentStep: 1 }; | ||
| rerender(<TourTelemetryBridge />); | ||
|
|
||
| const steps = eventsOfType("learning_hub.tours.step_viewed"); | ||
| expect(steps).toHaveLength(2); | ||
| expect(steps[0][1]).toMatchObject({ | ||
| tour_id: "first-pipeline", | ||
| step_index: 0, | ||
| step_count: 3, | ||
| interaction: "add-task", | ||
| }); | ||
| expect(steps[1][1]).toMatchObject({ | ||
| step_index: 1, | ||
| interaction: undefined, | ||
| }); | ||
| }); | ||
|
|
||
| it("marks completion and fires completed on reaching the last step", () => { | ||
| const { rerender } = render(<TourTelemetryBridge />); | ||
| tourState = { currentStep: 2 }; | ||
| rerender(<TourTelemetryBridge />); | ||
|
|
||
| expect(recordCompletion).toHaveBeenCalledTimes(1); | ||
| const completed = eventsOfType("learning_hub.tours.completed"); | ||
| expect(completed).toHaveLength(1); | ||
| expect(completed[0][1]).toMatchObject({ | ||
| tour_id: "first-pipeline", | ||
| step_count: 3, | ||
| completion_count: 1, | ||
| }); | ||
| }); | ||
|
|
||
| it("fires exited with furthest_step when unmounted before completing", () => { | ||
| const { rerender, unmount } = render(<TourTelemetryBridge />); | ||
| tourState = { currentStep: 1 }; | ||
| rerender(<TourTelemetryBridge />); | ||
| unmount(); | ||
|
|
||
| const exited = eventsOfType("learning_hub.tours.exited"); | ||
| expect(exited).toHaveLength(1); | ||
| expect(exited[0][1]).toMatchObject({ | ||
| tour_id: "first-pipeline", | ||
| furthest_step: 1, | ||
| step_count: 3, | ||
| percent_complete: 67, | ||
| }); | ||
| }); | ||
|
|
||
| it("does not fire exited when the tour completed", () => { | ||
| const { rerender, unmount } = render(<TourTelemetryBridge />); | ||
| tourState = { currentStep: 2 }; | ||
| rerender(<TourTelemetryBridge />); | ||
| unmount(); | ||
|
|
||
| expect(eventsOfType("learning_hub.tours.exited")).toHaveLength(0); | ||
| }); | ||
| }); |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import { useTour } from "@reactour/tour"; | ||
| import { useEffect, useRef } from "react"; | ||
|
|
||
| import { useAnalytics } from "@/providers/AnalyticsProvider"; | ||
|
|
||
| import { useRecordTourCompletion, useTourCompletions } from "./tourCompletion"; | ||
| import { useTourMode } from "./TourModeContext"; | ||
|
|
||
| export function TourTelemetryBridge() { | ||
| const { currentStep } = useTour(); | ||
| const tourMode = useTourMode(); | ||
| const { track } = useAnalytics(); | ||
| const recordCompletion = useRecordTourCompletion(); | ||
| const { data: completions } = useTourCompletions(); | ||
|
|
||
| const tour = tourMode?.tour; | ||
| const stepCount = tour?.steps.length ?? 0; | ||
|
|
||
| const startedAtRef = useRef<number>(Date.now()); | ||
| const furthestRef = useRef(0); | ||
| const seenStepsRef = useRef<Set<number>>(new Set()); | ||
| const completedRef = useRef(false); | ||
| const previouslyCompletedRef = useRef(false); | ||
|
|
||
| useEffect(() => { | ||
| if (!completedRef.current && tour) { | ||
| previouslyCompletedRef.current = Boolean(completions?.[tour.id]); | ||
| } | ||
| }, [completions, tour]); | ||
|
|
||
| useEffect(() => { | ||
| if (!tour || stepCount === 0) return; | ||
|
|
||
| if (currentStep > furthestRef.current) { | ||
| furthestRef.current = currentStep; | ||
| } | ||
|
|
||
| if (!seenStepsRef.current.has(currentStep)) { | ||
| seenStepsRef.current.add(currentStep); | ||
| track("learning_hub.tours.step_viewed", { | ||
| tour_id: tour.id, | ||
| step_index: currentStep, | ||
| step_count: stepCount, | ||
| interaction: tour.steps[currentStep]?.interaction, | ||
| }); | ||
| } | ||
|
|
||
| if (currentStep >= stepCount - 1 && !completedRef.current) { | ||
| completedRef.current = true; | ||
| const { completionCount, previouslyCompleted } = recordCompletion( | ||
| tour.id, | ||
| ); | ||
| previouslyCompletedRef.current = previouslyCompleted; | ||
| track("learning_hub.tours.completed", { | ||
| tour_id: tour.id, | ||
| step_count: stepCount, | ||
| completion_count: completionCount, | ||
| previously_completed: previouslyCompleted, | ||
| duration_ms: Date.now() - startedAtRef.current, | ||
| }); | ||
| } | ||
| }, [currentStep, tour, stepCount, track, recordCompletion]); | ||
|
camielvs marked this conversation as resolved.
|
||
|
|
||
| useEffect(() => { | ||
| if (!tour) return undefined; | ||
| return () => { | ||
| if (completedRef.current) return; | ||
| const furthest = furthestRef.current; | ||
| track("learning_hub.tours.exited", { | ||
| tour_id: tour.id, | ||
| furthest_step: furthest, | ||
| step_count: stepCount, | ||
| percent_complete: | ||
| stepCount > 0 ? Math.round(((furthest + 1) / stepCount) * 100) : 0, | ||
| duration_ms: Date.now() - startedAtRef.current, | ||
| previously_completed: previouslyCompletedRef.current, | ||
| }); | ||
| }; | ||
| }, [tour, stepCount, track]); | ||
|
|
||
| return null; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.