Make onboarding optional, able to be ignored on desktop by franknoirot · Pull Request #6564 · KittyCAD/modeling-app

franknoirot · 2025-04-29T00:53:44Z

Closes #6542. Makes onboarding tutorial optional on both desktop and web, removing all redirection behavior.

Both platforms

Whenever the user dismisses the tutorial before, during, or after doing it, we show a toast telling them one place to find the replay button
The same code path now occurs for replay workflows via native help menu, lower-right help menu, and settings

Desktop

No toasts or dialogs are shown
If the user has not yet begun the tutorial, a dismissible button appears in the home page sidebar
Whenever the user begins, continues, or replays the tutorial, we create a new project on their behalf and navigate to it
If the user is in the middle of the tutorial, the home page button says "continue" instead of "start"

Screenshare.-.2025-04-29.9_46_32.AM-compressed.mp4

Browser

If the user has not yet begun or completed the tutorial, a toast appears to begin or dismiss
If the user's code is not the web tutorial's code, a warning toast is shown after the first acceptance

Screenshare.-.2025-04-29.9_49_57.AM-compressed.mp4

Tests

I consolidated all tests within onboarding-tests.spec.ts into one longer test. Several of those tests—like the "avatar text" tests—checked behavior that will become irrelevant this week when we update the onboarding to no longer mention all the menus and UI. Some of them were redundant, each checking that the code reset and the model was loaded. This test checks that, clicks through all onboarding steps and back, and verifies the "always create a new project" behavior on desktop in several ways. I left a TODO comment in that test that another test will need to be written for the divergent web onboarding behavior when we support browser E2E tests again.

Other

This PR removes one of our circular dependencies.

qa-wolf · 2025-04-29T00:53:48Z

QA Wolf here! As you write new code it's important that your test coverage is keeping up.
Click here to request test coverage for this PR!

vercel · 2025-04-29T00:53:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
modeling-app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 30, 2025 6:28pm

codecov · 2025-04-29T01:23:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.63%. Comparing base (5e200ae) to head (f1fc230).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6564      +/-   ##
==========================================
+ Coverage   85.60%   85.63%   +0.02%     
==========================================
  Files         108      108              
  Lines       47362    47362              
==========================================
+ Hits        40546    40558      +12     
+ Misses       6816     6804      -12

Flag	Coverage Δ
rust	`85.63% <ø> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/routes/Onboarding/utils.tsx

franknoirot · 2025-04-29T15:25:16Z

Sorry gotta address something flaky(?) about my new consolidated test. It passes locally on MacOS

nadr0 · 2025-04-29T15:59:43Z

The create a new project always is great. I think it is less friction, less complex code on our end to option select all the scenarios of what could be in the system.

nadr0 · 2025-04-29T16:01:08Z

known-circular.txt

  6) src/lib/singletons.ts -> src/clientSideScene/sceneEntities.ts -> src/clientSideScene/segments.ts -> src/components/Toolbar/angleLengthInfo.ts
  7) src/lib/singletons.ts -> src/clientSideScene/sceneEntities.ts -> src/clientSideScene/segments.ts
  8) src/hooks/useModelingContext.ts -> src/components/ModelingMachineProvider.tsx -> src/components/Toolbar/Intersect.tsx -> src/components/SetHorVertDistanceModal.tsx -> src/lib/useCalculateKclExpression.ts
-  9) src/routes/Onboarding/index.tsx -> src/routes/Onboarding/Camera.tsx -> src/routes/Onboarding/utils.tsx


this is mega

nadr0 · 2025-04-29T16:04:32Z

src/components/Providers/SystemIOProviderDesktop.tsx

      const requestedPath = `${PATHS.FILE}/${encodeURIComponent(
        projectPathWithoutSpecificKCLFile
-      )}`
+      )}${requestedProjectName.subRoute || ''}`


nadr0 · 2025-04-29T16:14:14Z

Found one bug?

npm run tron:start
cat ~/.config/zoo-modeling-app/settings.toml says onboarding_status = "dismissed"
click Replay onboarding tutorial from the native menu
it creates a new project but does not navigate me

I think any of the replay options when it is dismissed is not navigating? It creates the project but no navigation?

graphite-app · 2025-04-29T16:58:24Z

src/routes/Onboarding/utils.tsx

-      : onboardingRoutes[stepNumber]
-  const goToNext = useNextClick(onboardingPaths.INDEX + (nextStep?.path ?? ''))
+      : onboardingPathsArray[stepNumber]
+  const goToNext = useNextClick(nextStep + onboardingPaths.INDEX)


The concatenation of nextStep + onboardingPaths.INDEX may create invalid URL paths since onboardingPaths.INDEX is '/'. When appended to another path, this would result in paths like /camera/ instead of the likely intended /camera. Consider using a path joining utility or template string that properly handles path segments to ensure valid URL construction.

Suggested change

const goToNext = useNextClick(nextStep + onboardingPaths.INDEX)

const goToNext = useNextClick(nextStep === '' ? onboardingPaths.INDEX : `/${nextStep}`)

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

codspeed-hq · 2025-04-29T17:12:28Z

CodSpeed Instrumentation Performance Report

Merging #6564 will not alter performance

_{Comparing franknoirot/adhoc/optional-onboarding (de781e5) with main (0002295)}

Summary

✅ 54 untouched benchmarks

franknoirot · 2025-04-29T17:57:45Z

Found one bug?

npm run tron:start

cat ~/.config/zoo-modeling-app/settings.toml says onboarding_status = "dismissed"

click Replay onboarding tutorial from the native menu

it creates a new project but does not navigate me

I think any of the replay options when it is dismissed is not navigating? It creates the project but no navigation?

Hey @nadr0 sorry I might have gotten the branch in a bad state trying to clear up the circular dependency I had added. I am not experiencing this as of now, would you mind double-checking?

…ttyCAD/modeling-app into franknoirot/adhoc/optional-onboarding

…e sep

graphite-app · 2025-04-29T21:34:12Z

src/routes/Onboarding/utils.tsx

+  // TODO: this is not navigating to the correct `/onboarding/blah` path yet
+  navigate(
+    makeUrlPathRelative(
+      `${PATHS.ONBOARDING.INDEX}${makeUrlPathRelative(onboardingStatus)}`
+    )


The nested makeUrlPathRelative calls here are unnecessarily complex and error-prone. Consider using the newly created joinRouterPaths utility function instead, which would handle path construction more reliably:

navigate(joinRouterPaths(PATHS.ONBOARDING.INDEX, onboardingStatus))

This would ensure proper path formatting and avoid potential issues with duplicate or missing slashes.

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

pierremtb

Didn't test on web but desktop looks great! And so does the code diff

This reverts commit 820082d.

Revert "Make onboarding optional, able to be ignored on desktop (#6564)" This reverts commit 820082d.

Oversight on my part while refactoring the onboarding system in #6564. The new centralized `acceptOnboarding` workflow constructs a relative path, so we have to get out of the settings before invoking it.

Fix resetting onboarding in web after #6564 Oversight on my part while refactoring the onboarding system in #6564. The new centralized `acceptOnboarding` workflow constructs a relative path, so we have to get out of the settings before invoking it.

vercel bot deployed to Preview April 29, 2025 01:04 View deployment

franknoirot force-pushed the franknoirot/adhoc/optional-onboarding branch from bfa0690 to 0d3725f Compare April 29, 2025 13:33

vercel bot deployed to Preview April 29, 2025 13:45 View deployment

franknoirot force-pushed the franknoirot/adhoc/optional-onboarding branch from 0d3725f to fba9f83 Compare April 29, 2025 13:52

franknoirot requested a review from a team April 29, 2025 14:04

vercel bot deployed to Preview April 29, 2025 14:04 View deployment

franknoirot marked this pull request as ready for review April 29, 2025 14:53

graphite-app bot reviewed Apr 29, 2025

View reviewed changes

src/routes/Onboarding/utils.tsx Show resolved Hide resolved

vercel bot deployed to Preview April 29, 2025 15:18 View deployment

nadr0 reviewed Apr 29, 2025

View reviewed changes

graphite-app bot reviewed Apr 29, 2025

View reviewed changes

vercel bot deployed to Preview April 29, 2025 17:10 View deployment

franknoirot force-pushed the franknoirot/adhoc/optional-onboarding branch 2 times, most recently from 6c69d65 to 81aaa97 Compare April 29, 2025 17:50

vercel bot deployed to Preview April 29, 2025 18:02 View deployment

franknoirot added 6 commits April 29, 2025 14:07

Remove unused telemetryLoader

9fa99ed

Remove onboarding redirect behavior

58757ad

Allow subRoute to be passed to navigateToProject

a613700

Replace warning dialog routes with toasts

f061da2

Wire up new utilities and toasts to UI components

808ea6e

Add home sidebar buttons for tutorial flow

855fe8d

Merge branch 'franknoirot/adhoc/optional-onboarding' of github.com:Ki…

5196776

…ttyCAD/modeling-app into franknoirot/adhoc/optional-onboarding

vercel bot deployed to Preview April 29, 2025 21:28 View deployment

fix: filename parsing is correct now for onboarding with the last fil…

fcbf6bd

…e sep

graphite-app bot reviewed Apr 29, 2025

View reviewed changes

franknoirot added 2 commits April 29, 2025 17:41

Fix e2e test state checks that are diff on Linux

ed2e73f

Merge branch 'main' into franknoirot/adhoc/optional-onboarding

98fbee7

vercel bot deployed to Preview April 29, 2025 21:45 View deployment

vercel bot deployed to Preview April 29, 2025 21:59 View deployment

franknoirot added 2 commits April 30, 2025 10:37

Create onboarding project entirely through systemIOMachine

9380469

Merge branch 'main' into franknoirot/adhoc/optional-onboarding

1ee6342

vercel bot deployed to Preview April 30, 2025 14:49 View deployment

Merge branch 'main' into franknoirot/adhoc/optional-onboarding

803f48c

vercel bot deployed to Preview April 30, 2025 17:21 View deployment

Fix Windows path construction

20edda2

vercel bot deployed to Preview April 30, 2025 18:15 View deployment

Merge branch 'main' into franknoirot/adhoc/optional-onboarding

de781e5

vercel bot deployed to Preview April 30, 2025 18:28 View deployment

pierremtb approved these changes Apr 30, 2025

View reviewed changes

jessfraz approved these changes Apr 30, 2025

View reviewed changes

franknoirot merged commit 820082d into main Apr 30, 2025
67 checks passed

franknoirot deleted the franknoirot/adhoc/optional-onboarding branch April 30, 2025 18:43

franknoirot added a commit that referenced this pull request Apr 30, 2025

Revert "Make onboarding optional, able to be ignored on desktop (#6564)"

05166f1

This reverts commit 820082d.

franknoirot mentioned this pull request Apr 30, 2025

Revert "Make onboarding optional, able to be ignored on desktop" #6610

Merged

franknoirot added a commit that referenced this pull request May 1, 2025

Revert "Make onboarding optional, able to be ignored on desktop" (#6610)

2d77aa0

Revert "Make onboarding optional, able to be ignored on desktop (#6564)" This reverts commit 820082d.

franknoirot mentioned this pull request May 1, 2025

Make onboarding optional, able to be ignored on desktop (take 2) #6628

Merged

This was referenced May 2, 2025

Make onboarding optional, able to be ignored on desktop (take 2) sourcery-ai-experiments/modeling-app#2

Open

Make onboarding optional, able to be ignored on desktop (take 2) sourcery-ai-experiments/modeling-app#3

Open

franknoirot mentioned this pull request May 2, 2025

Fix resetting onboarding from settings in web after #6564 #6675

Merged

	const goToNext = useNextClick(nextStep + onboardingPaths.INDEX)
	const goToNext = useNextClick(nextStep === '' ? onboardingPaths.INDEX : `/${nextStep}`)

Conversation

franknoirot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Both platforms

Desktop

Browser

Tests

Other

Uh oh!

qa-wolf bot commented Apr 29, 2025

Uh oh!

vercel bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

franknoirot commented Apr 29, 2025

Uh oh!

nadr0 commented Apr 29, 2025

Uh oh!

nadr0 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

nadr0 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

nadr0 commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graphite-app bot Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Instrumentation Performance Report

Merging #6564 will not alter performance

Summary

Uh oh!

franknoirot commented Apr 29, 2025

Uh oh!

graphite-app bot Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

pierremtb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

franknoirot commented Apr 29, 2025 •

edited

Loading

vercel bot commented Apr 29, 2025 •

edited

Loading

codecov bot commented Apr 29, 2025 •

edited

Loading

nadr0 commented Apr 29, 2025 •

edited

Loading

codspeed-hq bot commented Apr 29, 2025 •

edited

Loading