@ledgerhq/live-common/src/hw/isUpdateAvailable.test.ts

Common ground for the Ledger Live apps

import isUpdateAvailable from "./isUpdateAvailable";
import { deviceInfo155, deviceInfo222 } from "../apps/mock";
import { AppAndVersion } from "../hw/connectApp";
import { LiveConfig } from "@ledgerhq/live-config/LiveConfig";

LiveConfig.setConfig({
  config_nanoapp_ethereum: {
    type: "object",
    default: {
      minVersion: "1.10.3-0",
    },
  },
});
describe("isUpdateAvailable tests", () => {
  const scenarios = [
    {
      name: "Old device, outdated app expects no update, needs fw update",
      deviceInfo: deviceInfo155,
      expectedResult: false,
      outdatedApp: {
        name: "Ethereum",
        version: "1.0.0",
        flags: 0,
      },
    },
    {
      name: "Old device, up-to-date app expect no update",
      deviceInfo: deviceInfo155,
      expectedResult: false,
      outdatedApp: {
        name: "Ethereum",
        version: "1.0.0",
        flags: 0,
      },
    },
    // FIXME The deviceInfo used for this scenario only works while its FW version is the one in prod,
    // whenever the prod version changes this test will start failing because new nano apps don't get pushed on
    // older FW version.
    //
    // The fix for now is to generate and use a new deviceInfo based on prod FW version:
    // This can be done with REPL:
    // > Connect on USB a device that's on FW prod version
    // > https://live.ledger.tools/repl (chrome only)
    // > WebHid transport or another one
    // > getAppAndVersion command
    // > dump the generated data in a new deviceInfo and use it here
    {
      name: "New device, outdated app expects an update",
      deviceInfo: deviceInfo222,
      expectedResult: true,
      outdatedApp: {
        name: "Ethereum",
        version: "1.9.0",
      },
    },
  ];

  // We part from the fact that we are only calling this when we know the currently
  // installed application does not meet the minimum so we don't really need more cases
  // to cover.
  scenarios.forEach(({ name, deviceInfo, outdatedApp, expectedResult }) => {
    it(name, async () => {
      jest.mock("../manager/api");
      // I don't know how to avoid the internal API calls to the Manager API.
      const result = await isUpdateAvailable(deviceInfo, outdatedApp as AppAndVersion);
      expect(result).toBe(expectedResult);
    });
  });
});