feat: Random Failures

.github/CHANGELOG.md

@@ -92,6 +92,8 @@
 1. [EFCS] Fix ground spoiler retraction after increasing TLA slightly above 0 - @lukecologne (luke)
 1. [FWC] Improved LDG LT memo to take into account light position - @BravoMike99 (bruno_pt99)
 1. [PRESS] Add pressurization system failures - @mjuhe (Miquel Juhe)
+1. [EFB] Random Failures - @Maverickwoe (Garoomf)
+
 
 ## 0.11.0
 

fbw-a32nx/src/systems/instruments/src/EFB/index.tsx

@@ -6,6 +6,13 @@ import React from 'react';
 import { render } from '@instruments/common/index';
 import { EfbWrapper } from '@flybywiresim/flypad';
 import { A320FailureDefinitions } from '@failures';
+import { EventBusContextProvider } from '../../../../../../fbw-common/src/systems/instruments/src/EFB/event-bus-provider';
 
 // TODO: Move failure definition into VFS
-render(<EfbWrapper failures={A320FailureDefinitions} />, true, true);
+render(
+  <EventBusContextProvider>
+    <EfbWrapper failures={A320FailureDefinitions} />
+  </EventBusContextProvider>,
+  true,
+  true,
+);

fbw-common/src/jest/setupJestMock.js

@@ -2,6 +2,25 @@ let values;
 
 global.beforeEach(() => {
   values = {};
+  global.SimVar = {};
+  // MSFS SDK overrides those with a custom implementation, hence need to recreate it before every test
+  global.SimVar.GetSimVarValue = jest.fn((name, _, __) => {
+    // eslint-disable-next-line no-prototype-builtins
+    if (values.hasOwnProperty(name)) {
+      return values[name];
+    } else {
+      return 0;
+    }
+  });
+
+  global.SimVar.SetSimVarValue = jest.fn((name, _, value, __) => {
+    return new Promise((resolve, _) => {
+      values[name] = value;
+      resolve();
+    });
+  });
+
+  values = {};
 });
 
 global.SimVar = {};
@@ -18,3 +37,18 @@ global.SimVar.SetSimVarValue = jest.fn(
       resolve();
     }),
 );
+global.RunwayDesignator = jest.mock();
+global.Avionics = jest.mock();
+global.Avionics = jest.mock();
+global.Simplane = jest.mock();
+global.Simplane.getIsGrounded = jest.fn();
+global.Simplane.getEngineThrottleMode = jest.fn();
+global.ThrottleMode = jest.mock();
+global.Simplane.getAltitude = jest.fn();
+global.Simplane.getGroundSpeed = jest.fn();
+
+global.Avionics.Utils = jest.mock();
+global.document = jest.mock();
+global.document.getElementById = jest.fn();
+global.GetStoredData = jest.fn(() => 'hi');
+global.BaseInstrument = jest.fn();

fbw-common/src/systems/instruments/src/EFB/Dashboard/Widgets/Reminders/MaintenanceReminder.tsx

@@ -27,16 +27,15 @@ const ActiveFailureCard: FC<ActiveFailureCardProps> = ({ ata, name }) => {
       onClick={() => {
         dispatch(setSearchQuery(name.toUpperCase()));
 
-        const lastFailurePath = findLatestSeenPathname(history, '/failures');
-
+        const lastFailurePath = findLatestSeenPathname(history, '/failures/failure-list');
         if (!ata) {
-          history.push('/failures/compact');
+          history.push('/failures/failure-list/compact');
         }
 
         if (!lastFailurePath || lastFailurePath.includes('comfort')) {
-          history.push(`/failures/comfort/${ata}`);
+          history.push(`/failures/failure-list/comfort/${ata}`);
         } else {
-          history.push('/failures/compact');
+          history.push('/failures/failure-list/compact');
         }
       }}
     >
@@ -51,7 +50,10 @@ export const MaintenanceReminder = () => {
   const { allFailures, activeFailures } = useFailuresOrchestrator();
 
   return (
-    <RemindersSection title={t('Dashboard.ImportantInformation.Maintenance.Title')} pageLinkPath="/failures">
+    <RemindersSection
+      title={t('Dashboard.ImportantInformation.Maintenance.Title')}
+      pageLinkPath="/failures/failure-list"
+    >
       <div className="flex flex-row flex-wrap">
         {Array.from(activeFailures)
           // Sorts the failures by name length, greatest to least

fbw-common/src/systems/instruments/src/EFB/Efb.tsx

@@ -48,7 +48,7 @@ import { Performance } from './Performance/Performance';
 import { Navigation } from './Navigation/Navigation';
 import { ATC } from './ATC/ATC';
 import { Settings } from './Settings/Settings';
-import { Failures } from './Failures/Failures';
+import { FailuresHome } from './Failures/Failures';
 import { Presets } from './Presets/Presets';
 import { clearEfbState, store, useAppDispatch, useAppSelector } from './Store/store';
 import { setFlightPlanProgress } from './Store/features/flightProgress';
@@ -62,6 +62,7 @@ import './Assets/Slider.scss';
 
 import 'react-toastify/dist/ReactToastify.css';
 import './toast.css';
+import { FailureGeneratorsInit } from 'instruments/src/EFB/Failures/FailureGenerators/EFBFailureGeneratorsInit';
 
 export interface EfbWrapperProps {
   failures: FailureDefinition[]; // TODO: Move failure definition into VFS
@@ -404,7 +405,11 @@ export const Efb: React.FC<EfbProps> = ({ aircraftChecklistsProp }) => {
   switch (powerState) {
     case PowerStates.SHUTOFF:
     case PowerStates.STANDBY:
-      return <div className="h-screen w-screen" onClick={offToLoaded} />;
+      return (
+        <div className="h-screen w-screen" onClick={offToLoaded}>
+          <FailureGeneratorsInit />
+        </div>
+      );
     case PowerStates.LOADING:
     case PowerStates.SHUTDOWN:
       return <LoadingScreen />;
@@ -436,7 +441,7 @@ export const Efb: React.FC<EfbProps> = ({ aircraftChecklistsProp }) => {
                     <Route path="/performance" component={Performance} />
                     <Route path="/navigation" component={Navigation} />
                     <Route path="/atc" component={ATC} />
-                    <Route path="/failures" component={Failures} />
+                    <Route path="/failures" component={FailuresHome} />
                     <Route path="/checklists" component={Checklists} />
                     <Route path="/presets" component={Presets} />
                     <Route path="/settings" component={Settings} />

fbw-common/src/systems/instruments/src/EFB/Failures/FailureGenerators/EFBAltitudeFailureGenerator.tsx

@@ -0,0 +1,143 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
+import { usePersistentProperty } from '@flybywiresim/fbw-sdk';
+
+import React, { useMemo, useState } from 'react';
+import {
+  FailureGenContext,
+  FailureGenData,
+  FailureGenMode,
+  ModalContext,
+  setNewSetting,
+} from 'instruments/src/EFB/Failures/FailureGenerators/EFBRandomFailureGen';
+
+import { ArrowDownRight, ArrowUpRight } from 'react-bootstrap-icons';
+import {
+  ButtonIcon,
+  FailureGeneratorChoiceSetting,
+  FailureGeneratorSingleSetting,
+} from 'instruments/src/EFB/Failures/FailureGenerators/EFBFailureGeneratorSettingsUI';
+import { t } from '@flybywiresim/flypad';
+
+enum Direction {
+  Climb = 0,
+  Descent = 1,
+}
+
+const settingName = 'EFB_FAILURE_GENERATOR_SETTING_ALTITUDE';
+const defaultNumberOfFailuresAtOnce = 1;
+const defaultMaxNumberOfFailures = 2;
+const defaultMinAltitudeHundredsFeet = 80;
+const defaultMaxAltitudeHundredsFeet = 250;
+const additionalSetting = [
+  FailureGenMode.FailureGenTakeOff,
+  defaultNumberOfFailuresAtOnce,
+  defaultMaxNumberOfFailures,
+  Direction.Climb,
+  defaultMinAltitudeHundredsFeet,
+  defaultMaxAltitudeHundredsFeet,
+];
+const numberOfSettingsPerGenerator = 6;
+const uniqueGenPrefix = 'A';
+const genName = 'Altitude';
+const alias = () => t('Failures.Generators.GenAlt');
+const disableTakeOffRearm = false;
+
+const AltitudeConditionIndex = 3;
+const AltitudeMinIndex = 4;
+const AltitudeMaxIndex = 5;
+
+export const failureGenConfigAltitude: () => FailureGenData = () => {
+  const [setting, setSetting] = usePersistentProperty(settingName);
+  const [armedState, setArmedState] = useState<boolean[]>();
+  const settings = useMemo(() => {
+    const splitString = setting?.split(',');
+    if (splitString) return splitString.map((it: string) => parseFloat(it));
+    return [];
+  }, [setting]);
+
+  return {
+    setSetting,
+    settings,
+    setting,
+    numberOfSettingsPerGenerator,
+    uniqueGenPrefix,
+    additionalSetting,
+    genName,
+    alias,
+    disableTakeOffRearm,
+    generatorSettingComponents,
+    armedState,
+    setArmedState,
+  };
+};
+
+const generatorSettingComponents = (
+  genNumber: number,
+  modalContext: ModalContext,
+  failureGenContext: FailureGenContext,
+) => {
+  const settings = modalContext.failureGenData.settings;
+  const settingTable = [
+    <FailureGeneratorChoiceSetting
+      title={t('Failures.Generators.AltitudeCondition')}
+      failureGenContext={failureGenContext}
+      generatorSettings={modalContext.failureGenData}
+      multiChoice={climbDescentMode}
+      setNewSetting={setNewSetting}
+      genIndex={genNumber}
+      settingIndex={AltitudeConditionIndex}
+      value={settings[genNumber * numberOfSettingsPerGenerator + AltitudeConditionIndex]}
+    />,
+    <FailureGeneratorSingleSetting
+      title={t('Failures.Generators.AltitudeMin')}
+      unit={t('Failures.Generators.feet')}
+      min={0}
+      max={settings[genNumber * numberOfSettingsPerGenerator + AltitudeMaxIndex] * 100}
+      value={settings[genNumber * numberOfSettingsPerGenerator + AltitudeMinIndex]}
+      mult={100}
+      setNewSetting={setNewSetting}
+      generatorSettings={modalContext.failureGenData}
+      genIndex={genNumber}
+      settingIndex={AltitudeMinIndex}
+      failureGenContext={failureGenContext}
+    />,
+    <FailureGeneratorSingleSetting
+      title={t('Failures.Generators.AltitudeMax')}
+      unit={t('Failures.Generators.feet')}
+      min={settings[genNumber * numberOfSettingsPerGenerator + AltitudeMinIndex] * 100}
+      max={40000}
+      value={settings[genNumber * numberOfSettingsPerGenerator + AltitudeMaxIndex]}
+      mult={100}
+      setNewSetting={setNewSetting}
+      generatorSettings={modalContext.failureGenData}
+      genIndex={genNumber}
+      settingIndex={AltitudeMaxIndex}
+      failureGenContext={failureGenContext}
+    />,
+  ];
+  return settingTable;
+};
+
+const climbDescentMode: ButtonIcon[] = [
+  {
+    icon: (
+      <>
+        <ArrowUpRight />
+      </>
+    ),
+    settingVar: 0,
+    setting: 'Climb',
+  },
+  {
+    icon: (
+      <>
+        <ArrowDownRight />
+      </>
+    ),
+    settingVar: 1,
+    setting: 'Descent',
+  },
+];