Migrate to XState v5 (#3735)

* migrate settingsMachine * Guard events with properties instead * migrate settingsMachine * Migrate auth machine * Migrate file machine * Migrate depracated types * Migrate home machine * Migrate command bar machine * Version fixes * Migrate command bar machine * Migrate modeling machine * Migrate types, state.can, state.matches and state.nextEvents * Fix syntax * Pass in modelingState into editor manager instead of modeling event * Fix issue with missing command bar provider * Fix state transition * Fix type issue in Home * Make sure no guards rely on event type * Fix up command bar submission logic * Home machine tweaks to get things running * Fix AST fillet function args * Handle "Set selection" when it is called by actor onDone * Remove unused imports * A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest) * Fix injectin project to the fileTree machine * Revert "A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest)" This reverts commit 4b43ff69d1. * A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest) * Re-run CI * Restore success toasts on file/folder deletion * Replace casting with guarding against event.type * Remove console.log Co-authored-by: Jonathan Tran <jonnytran@gmail.com> * Replace all instances of event casting with guards against event.type --------- Co-authored-by: Frank Noirot <frank@kittycad.io> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Kurt Hutten Irev-Dev <k.hutten@protonmail.ch> Co-authored-by: Jonathan Tran <jonnytran@gmail.com> Co-authored-by: Frank Noirot <frank@zoo.dev>
2024-09-09 19:59:36 +03:00
parent 7c2cfba0ac
commit 5f8d4f8294
34 changed files with 3707 additions and 3139 deletions
--- a/src/machines/settingsMachine.ts
+++ b/src/machines/settingsMachine.ts
@ -1,4 +1,4 @@
-import { assign, createMachine } from 'xstate'
+import { assign, setup } from 'xstate'
 import { Themes, getSystemTheme, setThemeClass } from 'lib/theme'
 import { createSettings, settings } from 'lib/settings/initialSettings'
 import {
@ -9,177 +9,187 @@ import {
  WildcardSetEvent,
 } from 'lib/settings/settingsTypes'

-export const settingsMachine = createMachine(
-  {
-    /** @xstate-layout N4IgpgJg5mDOIC5QGUwBc0EsB2VYDpMIAbMAYlnXwEMAHW-Ae2wCNHqAnCHKZNatAFdYAbQAMAXUShajWJizNpIAB6IALAFYAnPgBMARgDsBsQDY969QGYjmzQBoQAT0SnrADnwePY61r0PAwNtMyMAX3CnVAweAiJSCio6BjQACzAAWzAAYUZiRg5xKSQQWXlFbGU1BD1PfFtfE3UzTUNNaydXBCD1b209PTEPTTMtdQNNSOj0LFx4knJKNHxMxggwYh58DYAzakFiNABVbAVi5XKFTCVSmusxPXx7bRt1DzMxI3UjD3UutwhAz4MyeHxiV5+AYRKIgGJzPCERZJFYpfDpLJgC6lK6VaqIExPMwWGwdGxBPRmAE9PSafCPMQ-EzWbQ6ELTOGzOJIxLLVbrTbbNKYKBpLaitAAUWgcGxMjk11uoBqVmBH0ZLKCrVs-xciCCwLCvhCjyMFhGHPh3IS5AASnB0AACZYI0SSS4KvF3AlafADRl1YZ2IxiRx6hBtIzPb7abQ+DxGaxmYKWrnzHnkGKO6jEYjOtN4OVlT03KrehAtOnm7Qaup6Ixm6mR6OaR4dAwjM1mVOxdM2lH8jZbXD4WBpRgAd2QAGMc2AAOIcIhF3Gl-EIRPA6yGcyh4whSnU0xGJ5GAat0OfFowma9xH9gBUK5LStUiECdMmfx+mg8hmNTY-PgMYQpoZoxh41g9q6+C0GAHDyLACL5nesBkBAzBgIQ2AAG6MAA1lhcEIZgSFWvMz4VGu5YALTbtYwEnj8HhxnooT1mG3QhmY-TmJ82gGCyjzaJEsLYAK8ClOReAelRr41HRJiMZYvysexdjUuohh+poBiGDuXzGKy0HWossmKmWyqIDR3zAZWLSahM2jWJ04YjDxHbDMmmhaYE3wmemxGIchLpxOZXpWQgNEjMB1h6WEYHqK8ZgJk2EL6N8wR1Cy-gJqJ4RAA */
-    id: 'Settings',
-    predictableActionArguments: true,
+export const settingsMachine = setup({
+  types: {
    context: {} as ReturnType<typeof createSettings>,
-    initial: 'idle',
-    states: {
-      idle: {
-        entry: ['setThemeClass', 'setClientSideSceneUnits'],
+    input: {} as ReturnType<typeof createSettings>,
+    events: {} as
+      | WildcardSetEvent<SettingsPaths>
+      | SetEventTypes
+      | {
+          type: 'set.app.theme'
+          data: { level: SettingsLevel; value: Themes }
+        }
+      | {
+          type: 'set.modeling.units'
+          data: { level: SettingsLevel; value: BaseUnit }
+        }
+      | { type: 'Reset settings'; defaultDirectory: string }
+      | { type: 'Set all settings'; settings: typeof settings },
+  },
+  actions: {
+    setEngineTheme: () => {},
+    setClientTheme: () => {},
+    'Execute AST': () => {},
+    toastSuccess: () => {},
+    setEngineEdges: () => {},
+    setEngineScaleGridVisibility: () => {},
+    setClientSideSceneUnits: () => {},
+    persistSettings: () => {},
+    resetSettings: assign(({ context, event }) => {
+      if (!('defaultDirectory' in event)) return {}
+      // Reset everything except onboarding status,
+      // which should be preserved
+      const newSettings = createSettings()
+      if (context.app.onboardingStatus.user) {
+        newSettings.app.onboardingStatus.user =
+          context.app.onboardingStatus.user
+      }
+      // We instead pass in the default directory since it's asynchronous
+      // to re-initialize, and that can be done by the caller.
+      newSettings.app.projectDirectory.default = event.defaultDirectory

-        on: {
-          '*': {
-            target: 'persisting settings',
-            actions: ['setSettingAtLevel', 'toastSuccess'],
-          },
+      return newSettings
+    }),
+    setAllSettings: assign(({ event }) => {
+      if (!('settings' in event)) return {}
+      return event.settings
+    }),
+    setSettingAtLevel: assign(({ context, event }) => {
+      if (!('data' in event)) return {}
+      const { level, value } = event.data
+      const [category, setting] = event.type
+        .replace(/^set./, '')
+        .split('.') as [keyof typeof settings, string]

-          'set.app.onboardingStatus': {
-            target: 'persisting settings',
+      // @ts-ignore
+      context[category][setting][level] = value

-            // No toast
-            actions: ['setSettingAtLevel'],
-          },
-
-          'set.app.themeColor': {
-            target: 'persisting settings',
-
-            // No toast
-            actions: ['setSettingAtLevel'],
-          },
-
-          'set.modeling.defaultUnit': {
-            target: 'persisting settings',
-
-            actions: [
-              'setSettingAtLevel',
-              'toastSuccess',
-              'setClientSideSceneUnits',
-              'Execute AST',
-            ],
-          },
-
-          'set.app.theme': {
-            target: 'persisting settings',
-
-            actions: [
-              'setSettingAtLevel',
-              'toastSuccess',
-              'setThemeClass',
-              'setEngineTheme',
-              'setClientTheme',
-            ],
-          },
-
-          'set.app.streamIdleMode': {
-            target: 'persisting settings',
-
-            actions: ['setSettingAtLevel', 'toastSuccess'],
-          },
-
-          'set.modeling.highlightEdges': {
-            target: 'persisting settings',
-
-            actions: ['setSettingAtLevel', 'toastSuccess', 'setEngineEdges'],
-          },
-
-          'Reset settings': {
-            target: 'persisting settings',
-
-            actions: [
-              'resetSettings',
-              'setThemeClass',
-              'setEngineTheme',
-              'setClientSideSceneUnits',
-              'Execute AST',
-              'setClientTheme',
-            ],
-          },
-
-          'Set all settings': {
-            actions: [
-              'setAllSettings',
-              'setThemeClass',
-              'setEngineTheme',
-              'setClientSideSceneUnits',
-              'Execute AST',
-              'setClientTheme',
-            ],
-          },
-
-          'set.modeling.showScaleGrid': {
-            target: 'persisting settings',
-            actions: [
-              'setSettingAtLevel',
-              'toastSuccess',
-              'setEngineScaleGridVisibility',
-            ],
-          },
+      const newContext = {
+        ...context,
+        [category]: {
+          ...context[category],
+          // @ts-ignore
+          [setting]: context[category][setting],
        },
-      },
+      }

-      'persisting settings': {
-        invoke: {
-          src: 'Persist settings',
-          id: 'persistSettings',
-          onDone: 'idle',
-        },
-      },
-    },
-    tsTypes: {} as import('./settingsMachine.typegen').Typegen0,
-    schema: {
-      events: {} as
-        | WildcardSetEvent<SettingsPaths>
-        | SetEventTypes
-        | {
-            type: 'set.app.theme'
-            data: { level: SettingsLevel; value: Themes }
-          }
-        | {
-            type: 'set.modeling.units'
-            data: { level: SettingsLevel; value: BaseUnit }
-          }
-        | { type: 'Reset settings'; defaultDirectory: string }
-        | { type: 'Set all settings'; settings: typeof settings },
+      return newContext
+    }),
+    setThemeClass: ({ context }) => {
+      const currentTheme = context.app.theme.current ?? Themes.System
+      setThemeClass(
+        currentTheme === Themes.System ? getSystemTheme() : currentTheme
+      )
    },
  },
-  {
-    actions: {
-      resetSettings: assign((context, { defaultDirectory }) => {
-        // Reset everything except onboarding status,
-        // which should be preserved
-        const newSettings = createSettings()
-        if (context.app.onboardingStatus.user) {
-          newSettings.app.onboardingStatus.user =
-            context.app.onboardingStatus.user
-        }
-        // We instead pass in the default directory since it's asynchronous
-        // to re-initialize, and that can be done by the caller.
-        newSettings.app.projectDirectory.default = defaultDirectory
+}).createMachine({
+  /** @xstate-layout N4IgpgJg5mDOIC5QGUwBc0EsB2VYDpMIAbMAYlnXwEMAHW-Ae2wCNHqAnCHKZNatAFdYAbQAMAXUShajWJizNpIAB6IALAFYAnPgBMARgDsBsQDY969QGYjmzQBoQAT0SnrADnwePY61r0PAwNtMyMAX3CnVAweAiJSCio6BjQACzAAWzAAYUZiRg5xKSQQWXlFbGU1BD1PfFtfE3UzTUNNaydXBCD1b209PTEPTTMtdQNNSOj0LFx4knJKNHxMxggwYh58DYAzakFiNABVbAVi5XKFTCVSmusxPXx7bRt1DzMxI3UjD3UutwhAz4MyeHxiV5+AYRKIgGJzPCERZJFYpfDpLJgC6lK6VaqIExPMwWGwdGxBPRmAE9PSafCPMQ-EzWbQ6ELTOGzOJIxLLVbrTbbNKYKBpLaitAAUWgcGxMjk11uoBqVmBH0ZLKCrVs-xciCCwLCvhCjyMFhGHPh3IS5AASnB0AACZYI0SSS4KvF3AlafADRl1YZ2IxiRx6hBtIzPb7abQ+DxGaxmYKWrnzHnkGKO6jEYjOtN4OVlT03KrehAtOnm7Qaup6Ixm6mR6OaR4dAwjM1mVOxdM2lH8jZbXD4WBpRgAd2QAGMc2AAOIcIhF3Gl-EIRPA6yGcyh4whSnU0xGJ5GAat0OfFowma9xH9gBUK5LStUiECdMmfx+mg8hmNTY-PgMYQpoZoxh41g9q6+C0GAHDyLACL5nesBkBAzBgIQ2AAG6MAA1lhcEIZgSFWvMz4VGu5YALTbtYwEnj8HhxnooT1mG3QhmY-TmJ82gGCyjzaJEsLYAK8ClOReAelRr41HRJiMZYvysexdjUuohh+poBiGDuXzGKy0HWossmKmWyqIDR3zAZWLSahM2jWJ04YjDxHbDMmmhaYE3wmemxGIchLpxOZXpWQgNEjMB1h6WEYHqK8ZgJk2EL6N8wR1Cy-gJqJ4RAA */
+  id: 'Settings',
+  initial: 'idle',
+  context: ({ input }) => {
+    return {
+      ...createSettings(),
+      ...input,
+    }
+  },
+  states: {
+    idle: {
+      entry: ['setThemeClass', 'setClientSideSceneUnits'],

-        return newSettings
-      }),
-      setAllSettings: assign((_, event) => {
-        return event.settings
-      }),
-      setSettingAtLevel: assign((context, event) => {
-        const { level, value } = event.data
-        const [category, setting] = event.type
-          .replace(/^set./, '')
-          .split('.') as [keyof typeof settings, string]
+      on: {
+        '*': {
+          target: 'persisting settings',
+          actions: ['setSettingAtLevel', 'toastSuccess'],
+        },

-        // @ts-ignore
-        context[category][setting][level] = value
+        'set.app.onboardingStatus': {
+          target: 'persisting settings',

-        const newContext = {
-          ...context,
-          [category]: {
-            ...context[category],
-            // @ts-ignore
-            [setting]: context[category][setting],
-          },
-        }
+          // No toast
+          actions: ['setSettingAtLevel'],
+        },

-        return newContext
-      }),
-      setThemeClass: (context) => {
-        const currentTheme = context.app.theme.current ?? Themes.System
-        setThemeClass(
-          currentTheme === Themes.System ? getSystemTheme() : currentTheme
-        )
+        'set.app.themeColor': {
+          target: 'persisting settings',
+
+          // No toast
+          actions: ['setSettingAtLevel'],
+        },
+
+        'set.modeling.defaultUnit': {
+          target: 'persisting settings',
+
+          actions: [
+            'setSettingAtLevel',
+            'toastSuccess',
+            'setClientSideSceneUnits',
+            'Execute AST',
+          ],
+        },
+
+        'set.app.theme': {
+          target: 'persisting settings',
+
+          actions: [
+            'setSettingAtLevel',
+            'toastSuccess',
+            'setThemeClass',
+            'setEngineTheme',
+            'setClientTheme',
+          ],
+        },
+
+        'set.app.streamIdleMode': {
+          target: 'persisting settings',
+
+          actions: ['setSettingAtLevel', 'toastSuccess'],
+        },
+
+        'set.modeling.highlightEdges': {
+          target: 'persisting settings',
+
+          actions: ['setSettingAtLevel', 'toastSuccess', 'setEngineEdges'],
+        },
+
+        'Reset settings': {
+          target: 'persisting settings',
+
+          actions: [
+            'resetSettings',
+            'setThemeClass',
+            'setEngineTheme',
+            'setClientSideSceneUnits',
+            'Execute AST',
+            'setClientTheme',
+          ],
+        },
+
+        'Set all settings': {
+          actions: [
+            'setAllSettings',
+            'setThemeClass',
+            'setEngineTheme',
+            'setClientSideSceneUnits',
+            'Execute AST',
+            'setClientTheme',
+          ],
+        },
+
+        'set.modeling.showScaleGrid': {
+          target: 'persisting settings',
+          actions: [
+            'setSettingAtLevel',
+            'toastSuccess',
+            'setEngineScaleGridVisibility',
+          ],
+        },
      },
    },
-  }
-)
+
+    'persisting settings': {
+      entry: ['persistSettings'],
+      always: 'idle',
+    },
+  },
+})