Merge pull request #281 from justinlampley/ForceUpload

Add Force Upload Support

graphql.schema.json

@@ -2329,6 +2329,12 @@
             "description": null,
             "isDeprecated": false,
             "deprecationReason": null
+          },
+          {
+            "name": "TargetMismatch",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
           }
         ],
         "possibleTypes": null
@@ -2455,6 +2461,12 @@
             "description": null,
             "isDeprecated": false,
             "deprecationReason": null
+          },
+          {
+            "name": "ForceFlash",
+            "description": null,
+            "isDeprecated": false,
+            "deprecationReason": null
           }
         ],
         "possibleTypes": null

src/api/src/library/FirmwareBuilder/index.ts

@@ -3,6 +3,7 @@ import path from 'path';
 import Platformio from '../Platformio';
 import { CommandResult, NoOpFunc, OnOutputFunc } from '../Commander';
 import UserDefineKey from './Enum/UserDefineKey';
+import UploadType from '../Platformio/Enum/UploadType';
 
 interface UserDefinesCompatiblityResult {
   compatible: boolean;
@@ -75,9 +76,16 @@ export default class FirmwareBuilder {
     userDefines: string,
     firmwarePath: string,
     serialPort: string | undefined,
-    onOutput: OnOutputFunc = NoOpFunc
+    onOutput: OnOutputFunc = NoOpFunc,
+    uploadType: UploadType
   ): Promise<CommandResult> {
     await this.storeUserDefines(firmwarePath, userDefines);
-    return this.platformio.flash(firmwarePath, target, serialPort, onOutput);
+    return this.platformio.flash(
+      firmwarePath,
+      target,
+      serialPort,
+      onOutput,
+      uploadType
+    );
   }
 }

src/api/src/library/Platformio/Enum/UploadType.ts

@@ -0,0 +1,6 @@
+enum UploadType {
+  Normal = 'upload',
+  Force = 'uploadforce',
+}
+
+export default UploadType;

src/api/src/library/Platformio/index.ts

@@ -5,6 +5,7 @@ import path from 'path';
 import child_process from 'child_process';
 import Commander, { CommandResult, NoOpFunc, OnOutputFunc } from '../Commander';
 import { LoggerService } from '../../logger';
+import UploadType from './Enum/UploadType';
 
 interface PlatformioCoreState {
   core_version: string;
@@ -229,7 +230,8 @@ export default class Platformio {
     projectDir: string,
     environment: string,
     serialPort: string | undefined,
-    onUpdate: OnOutputFunc = NoOpFunc
+    onUpdate: OnOutputFunc = NoOpFunc,
+    uploadType: UploadType
   ) {
     const params = [
       'run',
@@ -238,7 +240,7 @@ export default class Platformio {
       '--environment',
       environment,
       '--target',
-      'upload',
+      uploadType,
     ];
     if (serialPort !== undefined && serialPort !== null) {
       params.push('--upload-port');

src/api/src/models/enum/BuildFirmwareErrorType.ts

@@ -7,6 +7,7 @@ enum BuildFirmwareErrorType {
   BuildError = 'BuildError',
   FlashError = 'FlashError',
   GenericError = 'GenericError',
+  TargetMismatch = 'TargetMismatch',
 }
 
 registerEnumType(BuildFirmwareErrorType, {

src/api/src/models/enum/BuildJobType.ts

@@ -3,6 +3,7 @@ import { registerEnumType } from 'type-graphql';
 enum BuildJobType {
   Build = 'Build',
   BuildAndFlash = 'BuildAndFlash',
+  ForceFlash = 'ForceFlash',
 }
 
 registerEnumType(BuildJobType, {

src/api/src/services/Firmware/index.ts

@@ -25,6 +25,7 @@ import FirmwareBuilder from '../../library/FirmwareBuilder';
 import { LoggerService } from '../../logger';
 import UserDefineKey from '../../library/FirmwareBuilder/Enum/UserDefineKey';
 import PullRequest from '../../models/PullRequest';
+import UploadType from '../../library/Platformio/Enum/UploadType';
 
 interface FirmwareVersionData {
   source: FirmwareSource;
@@ -454,29 +455,54 @@ export default class FirmwareService {
         );
       }
 
-      if (params.type === BuildJobType.BuildAndFlash) {
+      if (
+        params.type === BuildJobType.BuildAndFlash ||
+        params.type === BuildJobType.ForceFlash
+      ) {
         await this.updateProgress(
           BuildProgressNotificationType.Info,
           BuildFirmwareStep.FLASHING_FIRMWARE
         );
+
+        let uploadType: UploadType;
+        switch (params.type) {
+          case BuildJobType.BuildAndFlash:
+            uploadType = UploadType.Normal;
+            break;
+          case BuildJobType.ForceFlash:
+            uploadType = UploadType.Force;
+            break;
+          default:
+            throw new Error(`Unknown build job type ${params.type}`);
+        }
+
         const flashResult = await this.builder.flash(
           params.target,
           userDefines,
           firmwarePath,
           params.serialDevice,
           (output) => {
             this.updateLogs(output);
-          }
+          },
+          uploadType
         );
         if (!flashResult.success) {
           this.logger?.error('flash error', undefined, {
             stderr: flashResult.stderr,
             stdout: flashResult.stdout,
           });
+          const uploadErrorRegexp = /\*\*\* \[upload\] Error (-*\d+)/g;
+          let uploadError = 0;
+          const matches = [...flashResult.stderr.matchAll(uploadErrorRegexp)];
+          if (matches.length > 0) {
+            uploadError = Number.parseInt(matches[0][1], 10);
+          }
           return new BuildFlashFirmwareResult(
             false,
             flashResult.stderr,
-            BuildFirmwareErrorType.FlashError
+            uploadError === -2
+              ? BuildFirmwareErrorType.TargetMismatch
+              : BuildFirmwareErrorType.FlashError
           );
         }
       }

src/ui/components/BuildProgressBar/index.tsx

@@ -46,6 +46,7 @@ const BuildProgressBar: FunctionComponent<BuildProgressBarProps> = memo(
           }
           break;
         case BuildJobType.BuildAndFlash:
+        case BuildJobType.ForceFlash:
           switch (notification.step) {
             case BuildFirmwareStep.VERIFYING_BUILD_SYSTEM:
               return 5;

src/ui/components/BuildResponse/index.tsx

@@ -37,6 +37,8 @@ const BuildResponse: FunctionComponent<BuildResponseProps> = memo(
           return 'Build error';
         case BuildFirmwareErrorType.FlashError:
           return 'Flash error';
+        case BuildFirmwareErrorType.TargetMismatch:
+          return 'The target you are trying to flash does not match the devices current target, if you are sure you want to do this, click Force Flash below';
         default:
           return '';
       }

src/ui/components/SplitButton/index.tsx

@@ -0,0 +1,112 @@
+import * as React from 'react';
+import Button from '@mui/material/Button';
+import ButtonGroup, { ButtonGroupProps } from '@mui/material/ButtonGroup';
+import ArrowDropDownIcon from '@mui/icons-material/ArrowDropDown';
+import ClickAwayListener from '@mui/material/ClickAwayListener';
+import Grow from '@mui/material/Grow';
+import Paper from '@mui/material/Paper';
+import Popper from '@mui/material/Popper';
+import MenuItem from '@mui/material/MenuItem';
+import MenuList from '@mui/material/MenuList';
+import { FunctionComponent, useState } from 'react';
+import { uniqueId } from 'lodash';
+
+export interface Option {
+  label: string;
+  value: string;
+}
+
+interface SplitButtonProps extends ButtonGroupProps {
+  options: Option[];
+  onButtonClick: (value: string | null) => void;
+}
+
+const SplitButton: FunctionComponent<SplitButtonProps> = ({
+  options,
+  onButtonClick,
+  ...props
+}) => {
+  const [open, setOpen] = React.useState(false);
+  const anchorRef = React.useRef<HTMLDivElement | null>(null);
+  const [selectedIndex, setSelectedIndex] = React.useState(0);
+  const [splitButtonMenuId] = useState(() => uniqueId('split-button-menu-'));
+
+  const handleClick = () => {
+    onButtonClick(options[selectedIndex].value);
+  };
+
+  const handleMenuItemClick = (event: any, index: number) => {
+    setSelectedIndex(index);
+    setOpen(false);
+  };
+
+  const handleToggle = () => {
+    setOpen((prevOpen) => !prevOpen);
+  };
+
+  const handleClose = (event: any) => {
+    if (
+      anchorRef.current &&
+      event.target &&
+      anchorRef.current.contains(event.target)
+    ) {
+      return;
+    }
+
+    setOpen(false);
+  };
+
+  return (
+    <>
+      <ButtonGroup {...props} ref={anchorRef}>
+        <Button onClick={handleClick}>{options[selectedIndex].label}</Button>
+        <Button
+          size="small"
+          aria-controls={open ? splitButtonMenuId : undefined}
+          aria-expanded={open ? 'true' : undefined}
+          aria-label="select button"
+          aria-haspopup="menu"
+          onClick={handleToggle}
+        >
+          <ArrowDropDownIcon />
+        </Button>
+      </ButtonGroup>
+      <Popper
+        open={open}
+        anchorEl={anchorRef.current}
+        role={undefined}
+        transition
+        disablePortal
+        style={{ zIndex: 2 }}
+      >
+        {({ TransitionProps, placement }) => (
+          <Grow
+            {...TransitionProps}
+            style={{
+              transformOrigin:
+                placement === 'bottom' ? 'center top' : 'center bottom',
+            }}
+          >
+            <Paper>
+              <ClickAwayListener onClickAway={handleClose}>
+                <MenuList id={splitButtonMenuId}>
+                  {options.map((option, index) => (
+                    <MenuItem
+                      key={option.value}
+                      selected={index === selectedIndex}
+                      onClick={(event) => handleMenuItemClick(event, index)}
+                    >
+                      {option.label}
+                    </MenuItem>
+                  ))}
+                </MenuList>
+              </ClickAwayListener>
+            </Paper>
+          </Grow>
+        )}
+      </Popper>
+    </>
+  );
+};
+
+export default SplitButton;

src/ui/gql/generated/types.ts

@@ -294,6 +294,7 @@ export enum BuildFirmwareErrorType {
   BuildError = 'BuildError',
   FlashError = 'FlashError',
   GenericError = 'GenericError',
+  TargetMismatch = 'TargetMismatch',
 }
 
 export type BuildFlashFirmwareInput = {
@@ -309,6 +310,7 @@ export type BuildFlashFirmwareInput = {
 export enum BuildJobType {
   Build = 'Build',
   BuildAndFlash = 'BuildAndFlash',
+  ForceFlash = 'ForceFlash',
 }
 
 export type FirmwareVersionDataInput = {