feat: add download support for UF2 firmwares (#102)

raphaelcoeffic · web-flow · commit 32b0cd3de560 · 2025-05-04T08:26:38.000+10:00
* feat: add download support for UF2 firmwares

* fix: throw error if build failed
diff --git a/e2e/pages/firmware-wizard/firmware-selection.spec.ts b/e2e/pages/firmware-wizard/firmware-selection.spec.ts
@@ -129,7 +129,7 @@ const streamToString = (stream: Readable): Promise<string> => {
       // Start waiting for the download
       !isElectron ? page.waitForEvent("download") : undefined,
       // Perform the action that initiates download
-      (await queries.getByText("Download .bin")).click(),
+      (await queries.getByText("Download file")).click(),
     ]);
 
     // In browser we can use the download event
diff --git a/locales/be/flashing.json b/locales/be/flashing.json
@@ -37,7 +37,7 @@
   "DFU connection active": "Злучэнне DFU актыўна",
   "Done": "Гатова",
   "Download": "Загрузка",
-  "Download .bin": "Загрузка .bin",
+  "Download file": "Загрузка file",
   "Download firmware data": "Загрузка дадзеных убудаванага ПЗ",
   "Downloaded": "Загружана",
   "Downloading": "Загружаецца",
diff --git a/locales/cs/flashing.json b/locales/cs/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU spojení aktivní",
   "Done": "Hotovo",
   "Download": "Stáhnout",
-  "Download .bin": "Stáhnout .bin",
+  "Download file": "Stáhnout file",
   "Download firmware data": "Stáhnout firmware",
   "Downloaded": "Staženo",
   "Downloading": "Stahuji",
diff --git a/locales/da/flashing.json b/locales/da/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU forbindelse aktiv",
   "Done": "Klar",
   "Download": "Hent",
-  "Download .bin": "Hent .bin",
+  "Download file": "Hent file",
   "Download firmware data": "Henter firmware informationer",
   "Downloaded": "Hentet",
   "Downloading": "Henter",
diff --git a/locales/de/flashing.json b/locales/de/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU-Verbindung aktiv",
   "Done": "Fertig",
   "Download": "Herunterladen",
-  "Download .bin": ".bin herunterladen",
+  "Download file": "Datei herunterladen",
   "Download firmware data": "Firmware-Daten herunterladen",
   "Downloaded": "Heruntergeladen",
   "Downloading": "wird heruntergeladen",
diff --git a/locales/es/flashing.json b/locales/es/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU connection active",
   "Done": "Done",
   "Download": "Download",
-  "Download .bin": "Download .bin",
+  "Download file": "Download file",
   "Download firmware data": "Download firmware data",
   "Downloaded": "Downloaded",
   "Downloading": "Downloading",
diff --git a/locales/fr/flashing.json b/locales/fr/flashing.json
@@ -37,7 +37,7 @@
   "DFU connection active": "DFU connection active",
   "Done": "Done",
   "Download": "Download",
-  "Download .bin": "Download .bin",
+  "Download file": "Download file",
   "Download firmware data": "Download firmware data",
   "Downloaded": "Downloaded",
   "Downloading": "Downloading",
diff --git a/locales/it/flashing.json b/locales/it/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "Connessione DFU attiva",
   "Done": "Completato",
   "Download": "Scarica",
-  "Download .bin": "Scarica .bin",
+  "Download file": "Scarica file",
   "Download firmware data": "Scarica i dati del firmware",
   "Downloaded": "Scaricato",
   "Downloading": "Scaricando",
diff --git a/locales/ru/flashing.json b/locales/ru/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "Соединение DFU активно",
   "Done": "Готово",
   "Download": "Загрузка",
-  "Download .bin": "Загрузка .bin",
+  "Download file": "Загрузка file",
   "Download firmware data": "Загрузка данных встроенного ПО",
   "Downloaded": "Загруженно",
   "Downloading": "Загружается",
diff --git a/locales/sv/flashing.json b/locales/sv/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU-anslutning aktiv",
   "Done": "Klar",
   "Download": "Ladda ner",
-  "Download .bin": "Ladda ner .bin",
+  "Download file": "Ladda ner file",
   "Download firmware data": "Hämtar firmwareinformation",
   "Downloaded": "Nerladdad",
   "Downloading": "Laddar ner",
diff --git a/locales/zh/flashing.json b/locales/zh/flashing.json
@@ -40,7 +40,7 @@
   "DFU connection active": "DFU 模式已激活",
   "Done": "完成",
   "Download": "下载",
-  "Download .bin": "下载 .bin",
+  "Download file": "下载 file",
   "Download firmware data": "下载固件数据",
   "Downloaded": "已下载",
   "Downloading": "正在下载",
diff --git a/src/renderer/components/firmware/DownloadFirmwareButton.tsx b/src/renderer/components/firmware/DownloadFirmwareButton.tsx
@@ -22,6 +22,32 @@ type Props = {
   isCloudBuild?: boolean;
 };
 
+function isUF2Payload(buffer: ArrayBuffer): boolean {
+  // Need at least 8 bytes to check the magic numbers
+  if (buffer.byteLength < 8) {
+    return false;
+  }
+
+  // UF2 magic numbers at the start of each block
+  const UF2_MAGIC_START1 = 0x0a324655; // "UF2\n"
+  const UF2_MAGIC_START2 = 0x9e5d5157; // Randomly selected
+
+  // Create a DataView to read the buffer
+  const view = new DataView(buffer);
+
+  try {
+    // Read magic numbers from the first block
+    const magicStart1 = view.getUint32(0, true);
+    const magicStart2 = view.getUint32(4, true);
+
+    // If first block doesn't match the magic numbers, it's not UF2
+    return magicStart1 === UF2_MAGIC_START1 && magicStart2 === UF2_MAGIC_START2;
+  } catch (error) {
+    // If there's any error accessing the buffer, it's not a valid UF2
+    return false;
+  }
+}
+
 const DownloadFirmwareButton: React.FC<Props> = ({
   target,
   version,
@@ -63,7 +89,7 @@ const DownloadFirmwareButton: React.FC<Props> = ({
         {
           description: t(`Firmware data`),
           accept: {
-            "application/octet-stream": [".bin"],
+            "application/octet-stream": [".bin", ".uf2"],
           },
         },
       ],
@@ -96,9 +122,11 @@ const DownloadFirmwareButton: React.FC<Props> = ({
 
       const fileData = response.data.cloudFirmware.base64Data;
       const flagValues = flags.map((flag) => flag.value).join("-");
+      const decodedData = base64ArrayBuffer.decode(fileData);
+      const ext = isUF2Payload(decodedData) ? "uf2" : "bin";
       await promptAndDownload(
-        `${version}-${target}-${flagValues}.bin`,
-        base64ArrayBuffer.decode(fileData)
+        `${version}-${target}-${flagValues}.${ext}`,
+        decodedData
       );
     } else if (validPrVersion) {
       const response = await client.query({
@@ -130,9 +158,11 @@ const DownloadFirmwareButton: React.FC<Props> = ({
         response.data.edgeTxPr?.commit?.firmwareBundle?.target?.base64Data;
 
       if (fileData) {
+        const decodedData = base64ArrayBuffer.decode(fileData);
+        const ext = isUF2Payload(decodedData) ? "uf2" : "bin";
         await promptAndDownload(
-          `${target}-${commitId.slice(0, 7)}.bin`,
-          base64ArrayBuffer.decode(fileData)
+          `${target}-${commitId.slice(0, 7)}.${ext}`,
+          decodedData
         );
       }
     } else if (!isLocal && target && version) {
@@ -161,10 +191,9 @@ const DownloadFirmwareButton: React.FC<Props> = ({
         response.data.edgeTxRelease?.firmwareBundle.target?.base64Data;
 
       if (fileData) {
-        await promptAndDownload(
-          `${target}-${version}.bin`,
-          base64ArrayBuffer.decode(fileData)
-        );
+        const decodedData = base64ArrayBuffer.decode(fileData);
+        const ext = isUF2Payload(decodedData) ? "uf2" : "bin";
+        await promptAndDownload(`${target}-${version}.${ext}`, decodedData);
       }
     }
   };
diff --git a/src/renderer/pages/dev/flash/PrBuildsFlasher.tsx b/src/renderer/pages/dev/flash/PrBuildsFlasher.tsx
@@ -90,7 +90,7 @@ const PrBuildsFlasher: React.FC = () => {
         <Controls>
           <Space size="small">
             <DownloadFirmwareButton target={target} version={version}>
-              {t(`Download .bin`)}
+              {t(`Download file`)}
             </DownloadFirmwareButton>
             <FlashButton
               loading={creatingJob}
diff --git a/src/renderer/pages/flash/steps/FirmwareSelectionStep.tsx b/src/renderer/pages/flash/steps/FirmwareSelectionStep.tsx
@@ -239,7 +239,7 @@ const FirmwareStep: StepComponent = ({ onNext }) => {
             selectedFlags={selectedFlags}
             isCloudBuild={activeTab === "cloudbuild"}
           >
-            {t(`Download .bin`)}
+            {t(`Download file`)}
           </DownloadFirmwareButton>
         )}
         <FlashButton
diff --git a/src/shared/backend/services/cloudbuild.ts b/src/shared/backend/services/cloudbuild.ts
@@ -122,6 +122,11 @@ export const waitForJobSuccess = async (
       }
       updateStatus({ jobStatus: jobStatus.status, startedAt });
 
+      if (jobStatus.status === "BUILD_ERROR") {
+        clearTimeout(timeoutId);
+        throw new Error("Build failed");
+      }
+
       if (jobStatus.status === "BUILD_SUCCESS") {
         clearTimeout(timeoutId);
         return jobStatus;
diff --git a/src/shared/backend/services/firmwareStore.ts b/src/shared/backend/services/firmwareStore.ts
@@ -19,6 +19,8 @@ const firmwareBundleBlobs: Record<string, Promise<Blob>> = {};
 
 const firmwareTargetsCache: Record<string, Promise<Target[]>> = {};
 
+const firmwarePattern = /(\.bin|\.uf2)$/i;
+
 const firmwareBundle = async (url: string): Promise<ZipInfoRaw> => {
   // For github action related assets we can't use Range reads :(
   const reader = url.includes("api.github.com")
@@ -82,7 +84,10 @@ export const firmwareTargets = async (
 
 const firmwareFileNameToId = (fileName: string): string => {
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const withoutExtension = fileName.split("/").pop()!.replace(".bin", "");
+  const withoutExtension = fileName
+    .split("/")
+    .pop()!
+    .replace(firmwarePattern, "");
   const withoutCommitHash = withoutExtension.split("-").slice(0, -1).join("-");
 
   return withoutCommitHash;
@@ -95,7 +100,8 @@ export const fetchFirmware = async (
   const { entries } = await firmwareBundle(firmwareBundleUrl);
   const firmwareFile = entries.find(
     (entry) =>
-      entry.name.endsWith(".bin") && firmwareFileNameToId(entry.name) === target
+      entry.name.match(firmwarePattern) &&
+      firmwareFileNameToId(entry.name) === target
   );
 
   if (!firmwareFile) {
