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

Shepherd tour steps with advanceOn keys do not trigger the tour's onNext callback #5062

Open
cstns opened this issue Jan 28, 2025 · 0 comments
Labels
bug Something isn't working needs-triage Needs looking at to decide what to do size:S - 2 Sizing estimation point

Comments

@cstns
Copy link
Contributor

cstns commented Jan 28, 2025

Current Behavior

The title pretty much sums it up. If a shepherd tour stage has an advanceOn key, the onNext callback is not getting called. This might be why we're seeing these drop offs in posthog.

This might be because we're adding the handler only on the 'next' button in frontend/src/tours/Tours.js:112 although this feels like it should be triggered automatically by the framework itself.

Another quirk was that shepherd did not trigger the onComplete handler by default when the last stage of the tour was accomplished when the last step had an advanceOn key (see frontend/src/tours/tour-first-device.js:50). This was only happening when vue click event handlers were added to the elements shepherd was tracking (a fix in where we re-emit the click event for shepherd can be found here frontend/src/pages/team/Devices/dialogs/DeviceCredentialsDialog.vue:126).

Although we're using the vue-shepherd library, it doesn't seem to play nice with vue.

Expected Behavior

all tour stage events should be triggered and captured correctly.

Steps To Reproduce

place console logs in the tour event handlers and follow the first-devices tour, which is most evident.

Environment

  • FlowFuse version: 2.13.1
  • Node.js version: N/A
  • npm version: N/A
  • Platform/OS: N/A
  • Browser: N/A

Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

@cstns cstns added bug Something isn't working needs-triage Needs looking at to decide what to do size:S - 2 Sizing estimation point labels Jan 28, 2025
@cstns cstns changed the title Shepherd tour steps with advanceOn steps do not trigger the tour's onNext callback Shepherd tour steps with advanceOn keys do not trigger the tour's onNext callback Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs-triage Needs looking at to decide what to do size:S - 2 Sizing estimation point
Projects
Status: No status
Development

No branches or pull requests

1 participant