joystick: restore MANUAL_CONTROL axes saved by a newer version

1.19 persisted those axes as data-lake ids, and this version still
sends MAVLink. Re-run the conversion when the vehicle sync replaces
the mapping so a stick that arrives after boot is not left at zero.

Author: rafaellehmkuhl

src/libs/joystick/protocols.ts

@@ -2,6 +2,7 @@ import { type ProtocolAction, JoystickProtocolActionsMapping } from '@/types/joy
 
 import { availableCockpitActions } from './protocols/cockpit-actions'
 import { availableDataLakeActions } from './protocols/data-lake'
+import { migrateDataLakeAxesToMavlinkManualControl } from './protocols/data-lake-axis-migration'
 import {
   availableMavlinkManualControlButtonFunctions,
   mavlinkManualControlAxes,
@@ -30,5 +31,5 @@ export const allAvailableButtons = (): ProtocolAction[] => {
 export const performJoystickMappingMigrations = (
   mappings: JoystickProtocolActionsMapping[]
 ): JoystickProtocolActionsMapping[] => {
-  return migrateMavlinkManualControlButtons(mappings)
+  return migrateDataLakeAxesToMavlinkManualControl(migrateMavlinkManualControlButtons(mappings))
 }

src/libs/joystick/protocols/data-lake-axis-migration.ts

@@ -0,0 +1,48 @@
+import { type JoystickProtocolActionsMapping, JoystickProtocol } from '@/types/joystick'
+
+// Inverse of 1.19's migrateMavlinkManualControlAxes: that version persisted these data-lake ids
+// and 1.18 still drives MANUAL_CONTROL from the MAVLink axis actions.
+const dataLakeManualControlAxisById: Record<
+  string,
+  {
+    /**
+     *
+     */
+    protocol: JoystickProtocol.MAVLinkManualControl
+    /**
+     *
+     */
+    id: string
+    /**
+     *
+     */
+    name: string
+  }
+> = {
+  'inputs/mavlink/axis-x': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_x', name: 'Axis X' },
+  'inputs/mavlink/axis-y': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_y', name: 'Axis Y' },
+  'inputs/mavlink/axis-z': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_z', name: 'Axis Z' },
+  'inputs/mavlink/axis-r': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_r', name: 'Axis R' },
+  'inputs/mavlink/axis-s': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_s', name: 'Axis S' },
+  'inputs/mavlink/axis-t': { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_t', name: 'Axis T' },
+}
+
+/**
+ * Turns 1.19 data-lake MANUAL_CONTROL axis bindings back into MAVLink axis actions.
+ * @param {JoystickProtocolActionsMapping[]} mappings - Stored joystick mappings
+ * @returns {JoystickProtocolActionsMapping[]} The mappings, with those axes restored
+ */
+export const migrateDataLakeAxesToMavlinkManualControl = (
+  mappings: JoystickProtocolActionsMapping[]
+): JoystickProtocolActionsMapping[] => {
+  const migratedMappings = JSON.parse(JSON.stringify(mappings)) as JoystickProtocolActionsMapping[]
+  mappings.forEach((mapping, mappingIndex) => {
+    Object.entries(mapping.axesCorrespondencies ?? {}).forEach(([axisIndex, axisConfig]) => {
+      if (axisConfig.action?.protocol !== JoystickProtocol.DataLakeVariable) return
+      const replacement = dataLakeManualControlAxisById[axisConfig.action.id]
+      if (!replacement) return
+      migratedMappings[mappingIndex].axesCorrespondencies[axisIndex as unknown as number].action = replacement
+    })
+  })
+  return migratedMappings
+}

src/stores/controller.ts

@@ -83,11 +83,17 @@ export const useControllerStore = defineStore('controller', () => {
     if (migrated) protocolMapping.value = migrated
   })
 
-  // Run schema migrations on the current mapping
-  const migratedArray = performJoystickMappingMigrations([protocolMapping.value])
-  if (migratedArray.length > 0) {
-    protocolMapping.value = migratedArray[0]
-  }
+  // Re-run when the vehicle sync replaces the mapping so 1.19's data-lake MANUAL_CONTROL axes
+  // are turned back into the MAVLink actions this version still sends.
+  watch(
+    protocolMapping,
+    (mapping) => {
+      const [migrated] = performJoystickMappingMigrations([mapping])
+      if (JSON.stringify(migrated) === JSON.stringify(toRaw(mapping))) return
+      protocolMapping.value = migrated
+    },
+    { immediate: true }
+  )
 
   const cockpitStdMappings = computed<typeof availableGamepadToCockpitMaps>(() => {
     const mappings = {} as typeof availableGamepadToCockpitMaps

src/tests/libs/joystick/axis-migration.test.ts

@@ -0,0 +1,63 @@
+import { expect, test } from 'vitest'
+
+import { migrateDataLakeAxesToMavlinkManualControl } from '@/libs/joystick/protocols/data-lake-axis-migration'
+import { type JoystickProtocolActionsMapping, CockpitModifierKeyOption, JoystickProtocol } from '@/types/joystick'
+
+const mappingWithAxes = (
+  axesCorrespondencies: JoystickProtocolActionsMapping['axesCorrespondencies']
+): JoystickProtocolActionsMapping => ({
+  name: 't',
+  hash: 'h',
+  axesCorrespondencies,
+  buttonsCorrespondencies: {
+    [CockpitModifierKeyOption.regular]: {},
+    [CockpitModifierKeyOption.shift]: {},
+  },
+})
+
+test('turns 1.19 data-lake manual-control axes back into MAVLink axes', () => {
+  const [migrated] = migrateDataLakeAxesToMavlinkManualControl([
+    mappingWithAxes({
+      0: {
+        action: { protocol: JoystickProtocol.DataLakeVariable, id: 'inputs/mavlink/axis-x', name: 'Axis X' },
+        min: 1000,
+        max: -1000,
+      },
+      1: {
+        action: { protocol: JoystickProtocol.DataLakeVariable, id: 'inputs/mavlink/axis-y', name: 'Axis Y' },
+        min: -1000,
+        max: 1000,
+      },
+    }),
+  ])
+
+  expect(migrated.axesCorrespondencies[0].action).toMatchObject({
+    protocol: JoystickProtocol.MAVLinkManualControl,
+    id: 'axis_x',
+  })
+  expect(migrated.axesCorrespondencies[0].min).toBe(1000)
+  expect(migrated.axesCorrespondencies[1].action.id).toBe('axis_y')
+})
+
+test('leaves already-MAVLink axes and unrelated data-lake axes alone', () => {
+  const [migrated] = migrateDataLakeAxesToMavlinkManualControl([
+    mappingWithAxes({
+      0: {
+        action: { protocol: JoystickProtocol.MAVLinkManualControl, id: 'axis_x', name: 'Axis X' },
+        min: -1000,
+        max: 1000,
+      },
+      1: {
+        action: { protocol: JoystickProtocol.DataLakeVariable, id: 'camera-zoom', name: 'Camera Zoom' },
+        min: 0,
+        max: 1,
+      },
+    }),
+  ])
+
+  expect(migrated.axesCorrespondencies[0].action.id).toBe('axis_x')
+  expect(migrated.axesCorrespondencies[1].action).toMatchObject({
+    protocol: JoystickProtocol.DataLakeVariable,
+    id: 'camera-zoom',
+  })
+})