Add array mutation helper and add missing arming disable flags (#4334)

* Add array helper

* Apply change to debug

* Remove auto imported nonsense

* Remove commented code

* Extract to separate import

* Include new file

* Fix order

* Change parameter order

* Update virtualfc

* Add missing disarmFlagElements

* Add helper function to add an array instead of single element

Author: haslinghuis

src/js/VirtualFC.js

@@ -5,6 +5,7 @@ import FC from "./fc";
 import CONFIGURATOR, { API_VERSION_1_47 } from "./data_storage";
 import { OSD } from "./tabs/osd";
 import semver from "semver";
+import { addArrayElement, addArrayElementAfter } from "./utils/array";
 
 const VirtualFC = {
     // these values are manufactured to unlock all the functionality of the configurator, they dont represent actual hardware
@@ -224,9 +225,9 @@ const VirtualFC = {
         ];
 
         if (semver.gte(virtualFC.CONFIG.apiVersion, API_VERSION_1_47)) {
-            virtualFC.AUX_CONFIG.splice(virtualFC.AUX_CONFIG.indexOf("HORIZON") + 1, 0, "ALT_HOLD");
-            virtualFC.AUX_CONFIG.splice(virtualFC.AUX_CONFIG.indexOf("CAMSTAB") + 1, 0, "POS_HOLD");
-            virtualFC.AUX_CONFIG.push("CHIRP");
+            addArrayElementAfter(virtualFC.AUX_CONFIG, "HORIZON", "ALT_HOLD");
+            addArrayElementAfter(virtualFC.AUX_CONFIG, "CAMSTAB", "POS_HOLD");
+            addArrayElement(virtualFC.AUX_CONFIG, "CHIRP");
         }
 
         FC.AUX_CONFIG_IDS = [

src/js/debug.js

@@ -1,6 +1,7 @@
 import FC from "./fc.js";
 import { API_VERSION_1_46, API_VERSION_1_47 } from "./data_storage";
 import semver from "semver";
+import { removeArrayElement, addArrayElement, replaceArrayElement, addArrayElementAfter } from "./utils/array";
 
 const DEBUG = {
     modes: [
@@ -823,11 +824,12 @@ function update() {
     }
 
     if (semver.gte(FC.CONFIG.apiVersion, API_VERSION_1_47)) {
-        DEBUG.modes.splice(DEBUG.modes.indexOf("GPS_RESCUE_THROTTLE_PID"), 1, "AUTOPILOT_ALTITUDE");
-        DEBUG.modes.splice(DEBUG.modes.indexOf("GYRO_SCALED"), 1);
-        DEBUG.modes.splice(DEBUG.modes.indexOf("RANGEFINDER_QUALITY") + 1, 0, "OPTICALFLOW");
-        DEBUG.modes.push("AUTOPILOT_POSITION");
-        DEBUG.modes.push("CHIRP");
+        replaceArrayElement(DEBUG.modes, "GPS_RESCUE_THROTTLE_PID", "AUTOPILOT_ALTITUDE");
+        removeArrayElement(DEBUG.modes, "GYRO_SCALED");
+        addArrayElementAfter(DEBUG.modes, "RANGEFINDER_QUALITY", "OPTICALFLOW");
+        addArrayElement(DEBUG.modes, "AUTOPILOT_POSITION");
+        addArrayElement(DEBUG.modes, "CHIRP");
+
         delete DEBUG.fieldNames.GPS_RESCUE_THROTTLE_PID;
         delete DEBUG.fieldNames.GYRO_SCALED;
 
@@ -887,8 +889,8 @@ function update() {
             "debug[7]": "pidA",
         };
 
-        DEBUG.enableFields.splice(DEBUG.enableFields.indexOf("Gyro") + 1, 0, "Attitude");
-        DEBUG.enableFields.push("Servo");
+        addArrayElementAfter(DEBUG.enableFields, "Gyro", "Attitude");
+        addArrayElement(DEBUG.enableFields, "Servo");
     }
 }
 

src/js/sensor_types.js

@@ -1,6 +1,7 @@
 import semver from "semver";
 import FC from "./fc";
 import { API_VERSION_1_47 } from "./data_storage";
+import { removeArrayElement, addArrayElement, addArrayElementAfter } from "./utils/array";
 
 export function sensorTypes() {
     const sensorTypes = {
@@ -102,37 +103,23 @@ export function sensorTypes() {
         },
     };
 
-    function removeElement(elements, element) {
-        const index = elements.indexOf(element);
-        if (index !== -1) {
-            elements.splice(index, 1);
-        }
-    }
-
-    function addElement(elements, element, afterElement) {
-        const elementIndex = elements.indexOf(element);
-        if (elementIndex === -1) {
-            elements.splice(elements.indexOf(afterElement) + 1, 0, element);
-        }
-    }
-
     const gyroElements = sensorTypes.gyro.elements;
     const accElements = sensorTypes.acc.elements;
     const gpsElements = sensorTypes.gps.elements;
 
     // remove deprecated sensors or add new ones
     if (semver.gte(FC.CONFIG.apiVersion, API_VERSION_1_47)) {
-        removeElement(gyroElements, "L3G4200D");
-        removeElement(gyroElements, "MPU3050");
-        addElement(gyroElements, "IIM42653", "LSM6DSV16X");
+        removeArrayElement(gyroElements, "L3G4200D");
+        removeArrayElement(gyroElements, "MPU3050");
+        addArrayElementAfter(gyroElements, "LSM6DSV16X", "IIM42653");
 
-        removeElement(accElements, "ADXL345");
-        removeElement(accElements, "MMA8452");
-        removeElement(accElements, "BMA280");
-        removeElement(accElements, "LSM303DLHC");
-        addElement(accElements, "IIM42653", "LSM6DSV16X");
+        removeArrayElement(accElements, "ADXL345");
+        removeArrayElement(accElements, "MMA8452");
+        removeArrayElement(accElements, "BMA280");
+        removeArrayElement(accElements, "LSM303DLHC");
+        addArrayElementAfter(accElements, "LSM6DSV16X", "IIM42653");
 
-        addElement(gpsElements, "VIRTUAL", "MSP");
+        addArrayElement(gpsElements, "VIRTUAL");
     }
 
     return sensorTypes;

src/js/tabs/setup.js

@@ -13,6 +13,7 @@ import { gui_log } from "../gui_log";
 import $ from "jquery";
 import { ispConnected } from "../utils/connection";
 import { sensorTypes } from "../sensor_types";
+import { addArrayElementsAfter, replaceArrayElement } from "../utils/array";
 
 const setup = {
     yaw_fix: 0.0,
@@ -252,11 +253,11 @@ setup.initialize = function (callback) {
             ];
 
             if (semver.gte(FC.CONFIG.apiVersion, API_VERSION_1_46)) {
-                disarmFlagElements.splice(disarmFlagElements.indexOf("RPMFILTER"), 1, "DSHOT_TELEM");
+                replaceArrayElement(disarmFlagElements, "RPMFILTER", "DSHOT_TELEM");
             }
 
             if (semver.gte(FC.CONFIG.apiVersion, API_VERSION_1_47)) {
-                disarmFlagElements.splice(disarmFlagElements.indexOf("MOTOR_PROTOCOL"), 0, "CRASHFLIP");
+                addArrayElementsAfter(disarmFlagElements, "MOTOR_PROTOCOL", ["CRASHFLIP", "ALTHOLD", "POSHOLD"]);
             }
 
             // Arming allowed flag

src/js/utils/array.js

@@ -0,0 +1,83 @@
+/**
+ * Removes a specified element from an array if it exists.
+ *
+ * @param {Array} elements - The array from which to remove the element.
+ * @param {*} element - The element to be removed from the array.
+ */
+export function removeArrayElement(elements, element) {
+    const index = elements.indexOf(element);
+    if (index !== -1) {
+        elements.splice(index, 1);
+    }
+}
+
+/**
+ * Adds an element to an array after a specified element if the element is not already present in the array.
+ *
+ * @param {Array} elements - The array to which the element will be added.
+ * @param {*} afterElement - The element after which the new element will be added.
+ * @param {*} element - The element to be added to the array.
+ */
+export function addArrayElementAfter(elements, afterElement, element) {
+    const elementIndex = elements.indexOf(element);
+    if (elementIndex === -1) {
+        elements.splice(elements.indexOf(afterElement) + 1, 0, element);
+    }
+}
+
+/**
+ * Adds new elements to an array after a specified element, ensuring no duplicates.
+ *
+ * @param {Array} elements - The original array to modify.
+ * @param {*} afterElement - The element after which new elements will be added.
+ * @param {Array} newElements - The new elements to add to the array.
+ */
+export function addArrayElementsAfter(elements, afterElement, newElements) {
+    const afterElementIndex = elements.indexOf(afterElement);
+    if (afterElementIndex === -1) {
+        return;
+    }
+
+    const newElementsToAdd = newElements.filter((element) => !elements.includes(element));
+    elements.splice(afterElementIndex + 1, 0, ...newElementsToAdd);
+}
+
+/**
+ * Adds an element to an array before a specified element if the element is not already present in the array.
+ *
+ * @param {Array} elements - The array to which the element will be added.
+ * @param {*} beforeElement - The element before which the new element will be added.
+ * @param {*} element - The element to be added to the array.
+ */
+export function addArrayElementBefore(elements, beforeElement, element) {
+    const elementIndex = elements.indexOf(element);
+    if (elementIndex === -1) {
+        elements.splice(elements.indexOf(beforeElement), 0, element);
+    }
+}
+
+/**
+ * Adds an element to an array if it is not already present.
+ *
+ * @param {Array} elements - The array to which the element should be added.
+ * @param {*} element - The element to add to the array.
+ */
+export function addArrayElement(elements, element) {
+    if (!elements.includes(element)) {
+        elements.push(element);
+    }
+}
+
+/**
+ * Replaces an element in an array with a new element.
+ *
+ * @param {Array} elements - The array containing the element to be replaced.
+ * @param {*} element - The element to be replaced.
+ * @param {*} replacement - The new element to replace the old element.
+ */
+export function replaceArrayElement(elements, element, replacement) {
+    const index = elements.indexOf(element);
+    if (index !== -1) {
+        elements[index] = replacement;
+    }
+}