🎨 (dmk) [LIVE-22278]: Add InvalidGetFirmwareMetadataResponseError (#1094)

Author: fAnselmi-Ledger

.changeset/happy-bottles-fetch.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/device-management-kit": minor
+---
+
+Add InvalidGetFirmwareMetadataResponseError

packages/device-management-kit/src/api/command/Errors.ts

@@ -44,3 +44,14 @@ export class InvalidResponseFormatError implements DmkError {
     this.originalError = new Error(message ?? "Invalid response format.");
   }
 }
+
+export class InvalidGetFirmwareMetadataResponseError implements DmkError {
+  readonly _tag = "InvalidGetFirmwareMetadataResponseError";
+  readonly originalError: Error;
+
+  constructor(message?: string) {
+    this.originalError = new Error(
+      message ?? "Invalid Firmware Metadata response error.",
+    );
+  }
+}

packages/device-management-kit/src/api/command/model/CommandResult.ts

@@ -1,6 +1,7 @@
 import {
   type InvalidBatteryDataError,
   type InvalidBatteryStatusTypeError,
+  type InvalidGetFirmwareMetadataResponseError,
   type InvalidResponseFormatError,
   type InvalidStatusWordError,
 } from "@api/command/Errors";
@@ -25,6 +26,7 @@ export type CommandErrorResult<SpecificErrorCodes = void> = {
     | InvalidBatteryStatusTypeError
     | InvalidResponseFormatError
     | InvalidStatusWordError
+    | InvalidGetFirmwareMetadataResponseError
     | UnknownDeviceExchangeError;
   status: CommandResultStatus.Error;
 };
@@ -45,6 +47,7 @@ export function CommandResultFactory<Data, SpecificErrorCodes = void>({
         | InvalidBatteryStatusTypeError
         | InvalidResponseFormatError
         | InvalidStatusWordError
+        | InvalidGetFirmwareMetadataResponseError
         | UnknownDeviceExchangeError;
     }): CommandResult<Data, SpecificErrorCodes> {
   if (error) {

packages/device-management-kit/src/api/device-action/task/GetFirmwareMetadataTask.test.ts

@@ -1,6 +1,9 @@
 import { EitherAsync } from "purify-ts";
 
-import { InvalidStatusWordError } from "@api/command/Errors";
+import {
+  InvalidGetFirmwareMetadataResponseError,
+  InvalidStatusWordError,
+} from "@api/command/Errors";
 import { CommandResultFactory } from "@api/command/model/CommandResult";
 import { type GetOsVersionResponse } from "@api/command/os/GetOsVersionCommand";
 import { makeDeviceActionInternalApiMock } from "@api/device-action/__test-utils__/makeInternalApi";
@@ -229,7 +232,7 @@ describe("GetFirmwareMetadataTask", () => {
     );
   });
 
-  it("should fail if device version cannot be fetched", async () => {
+  it("should fail if device version cannot be fetched with InvalidGetFirmwareMetadataResponseError", async () => {
     // GIVEN
     apiMock.sendCommand.mockResolvedValueOnce(
       CommandResultFactory({ data: OS_VERSION }),
@@ -246,14 +249,12 @@ describe("GetFirmwareMetadataTask", () => {
     // THEN
     expect(result).toStrictEqual(
       CommandResultFactory({
-        error: new InvalidStatusWordError(
-          "Cannot fetch current firmware metadata",
-        ),
+        error: new InvalidGetFirmwareMetadataResponseError(),
       }),
     );
   });
 
-  it("should fail if firmware version cannot be fetched", async () => {
+  it("should fail if firmware version cannot be fetched with InvalidGetFirmwareMetadataResponseError", async () => {
     // GIVEN
     apiMock.sendCommand.mockResolvedValueOnce(
       CommandResultFactory({ data: OS_VERSION }),
@@ -270,9 +271,7 @@ describe("GetFirmwareMetadataTask", () => {
     // THEN
     expect(result).toStrictEqual(
       CommandResultFactory({
-        error: new InvalidStatusWordError(
-          "Cannot fetch current firmware metadata",
-        ),
+        error: new InvalidGetFirmwareMetadataResponseError(),
       }),
     );
   });

packages/device-management-kit/src/api/device-action/task/GetFirmwareMetadataTask.ts

@@ -1,4 +1,4 @@
-import { InvalidStatusWordError } from "@api/command/Errors";
+import { InvalidGetFirmwareMetadataResponseError } from "@api/command/Errors";
 import {
   type CommandResult,
   CommandResultFactory,
@@ -51,9 +51,7 @@ export class GetFirmwareMetadataTask {
       );
     if (result.isLeft()) {
       return CommandResultFactory({
-        error: new InvalidStatusWordError(
-          "Cannot fetch current firmware metadata",
-        ),
+        error: new InvalidGetFirmwareMetadataResponseError(),
       });
     }
     const { deviceVersion, currentFirmware } = result.unsafeCoerce();

packages/device-management-kit/src/api/index.ts

@@ -6,7 +6,10 @@ export { ApduParser } from "@api/apdu/utils/ApduParser";
 export * from "@api/apdu/utils/AppBuilderError";
 export { ByteArrayBuilder } from "@api/apdu/utils/ByteArrayBuilder";
 export { ByteArrayParser } from "@api/apdu/utils/ByteArrayParser";
-export { InvalidStatusWordError } from "@api/command/Errors";
+export {
+  InvalidGetFirmwareMetadataResponseError,
+  InvalidStatusWordError,
+} from "@api/command/Errors";
 export {
   CommandResultFactory,
   CommandResultStatus,