@ledgerhq/live-common
Version:
Common ground for the Ledger Live apps
289 lines • 13.2 kB
JavaScript
import { getOnboardingStatePolling } from "./getOnboardingStatePolling";
import { from, TimeoutError } from "rxjs";
import * as rxjsOperators from "rxjs/operators";
import { DeviceModelId } from "@ledgerhq/devices";
import Transport from "@ledgerhq/hw-transport";
import { DeviceExtractOnboardingStateError, DisconnectedDevice, LockedDeviceError, UnexpectedBootloader, } from "@ledgerhq/errors";
import { withDevice } from "./deviceAccess";
import { getVersion } from "../device/use-cases/getVersionUseCase";
import { extractOnboardingState, OnboardingStep } from "./extractOnboardingState";
import { SeedPhraseType } from "@ledgerhq/types-live";
import { DeviceDisconnectedWhileSendingError } from "@ledgerhq/device-management-kit";
jest.mock("./deviceAccess");
jest.mock("../device/use-cases/getVersionUseCase");
jest.mock("./extractOnboardingState");
jest.mock("@ledgerhq/hw-transport");
jest.useFakeTimers();
const aDevice = {
deviceId: "DEVICE_ID_A",
deviceName: "DEVICE_NAME_A",
modelId: DeviceModelId.stax,
wired: false,
};
// As extractOnboardingState is mocked, the firmwareInfo
// returned by getVersion does not matter
const aFirmwareInfo = {
isBootloader: false,
rawVersion: "",
targetId: 0,
mcuVersion: "",
flags: Buffer.from([]),
};
const pollingPeriodMs = 1000;
const mockedGetVersion = jest.mocked(getVersion);
const mockedWithDevice = jest.mocked(withDevice);
mockedWithDevice.mockReturnValue(job => from(job(new Transport())));
const mockedExtractOnboardingState = jest.mocked(extractOnboardingState);
describe("getOnboardingStatePolling", () => {
let anOnboardingState;
let onboardingStatePollingSubscription;
beforeEach(() => {
anOnboardingState = {
isOnboarded: false,
isInRecoveryMode: false,
seedPhraseType: SeedPhraseType.TwentyFour,
currentSeedWordIndex: 0,
currentOnboardingStep: OnboardingStep.NewDevice,
charonSupported: false,
charonStatus: null,
};
});
afterEach(() => {
mockedGetVersion.mockClear();
mockedExtractOnboardingState.mockClear();
jest.clearAllTimers();
onboardingStatePollingSubscription?.unsubscribe();
});
describe("When a communication error occurs while fetching the device state", () => {
describe("and when the error is allowed and thrown before the defined timeout", () => {
it("should update the onboarding state to null and keep track of the allowed error", done => {
mockedGetVersion.mockRejectedValue(new DisconnectedDevice("An allowed error"));
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toBeNull();
expect(value.allowedError).toBeInstanceOf(DisconnectedDevice);
expect(value.lockedDevice).toBe(false);
done();
}
catch (expectError) {
done(expectError);
}
},
});
// The timeout is equal to pollingPeriodMs by default
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
it("should update the onboarding state to null and keep track of the allowed DMK error", done => {
mockedGetVersion.mockRejectedValue(new DeviceDisconnectedWhileSendingError("An allowed error"));
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toBeNull();
expect(value.allowedError).toBeInstanceOf(DeviceDisconnectedWhileSendingError);
expect(value.lockedDevice).toBe(false);
done();
}
catch (expectError) {
done(expectError);
}
},
});
// The timeout is equal to pollingPeriodMs by default
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
});
describe("and when the error is due to a locked device", () => {
it("should update the lockedDevice, update the onboarding state to null and keep track of the allowed error", done => {
mockedGetVersion.mockRejectedValue(new LockedDeviceError());
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toBeNull();
expect(value.allowedError).toBeInstanceOf(LockedDeviceError);
expect(value.lockedDevice).toBe(true);
done();
}
catch (expectError) {
done(expectError);
}
},
});
// The timeout is equal to pollingPeriodMs by default
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
});
describe("and when a timeout occurred before the error (because the response from the device took too long)", () => {
it("should update the allowed error value to notify the consumer", done => {
const safeGuardTimeoutMs = pollingPeriodMs + 500;
mockedGetVersion.mockResolvedValue(aFirmwareInfo);
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
safeGuardTimeoutMs,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toBeNull();
expect(value.allowedError).toBeInstanceOf(TimeoutError);
expect(value.lockedDevice).toBe(false);
done();
}
catch (expectError) {
done(expectError);
}
},
});
// Waits more than the timeout
jest.advanceTimersByTime(safeGuardTimeoutMs + 1);
});
});
describe("and when the error is fatal and thrown before the defined timeout", () => {
it("should notify the consumer that a unallowed error occurred", done => {
mockedGetVersion.mockRejectedValue(new Error("Unknown error"));
const device = aDevice;
getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
error: error => {
try {
expect(error).toBeInstanceOf(Error);
expect(error?.message).toBe("Unknown error");
done();
}
catch (expectError) {
done(expectError);
}
},
});
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
});
});
describe("When the fetched device state is incorrect", () => {
it("should return a null onboarding state, and keep track of the extract error", done => {
mockedGetVersion.mockResolvedValue(aFirmwareInfo);
mockedExtractOnboardingState.mockImplementation(() => {
throw new DeviceExtractOnboardingStateError("Some incorrect device info");
});
const device = aDevice;
onboardingStatePollingSubscription = getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toBeNull();
expect(value.allowedError).toBeInstanceOf(DeviceExtractOnboardingStateError);
expect(value.lockedDevice).toBe(false);
done();
}
catch (expectError) {
done(expectError);
}
},
});
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
});
describe("When polling returns a correct device state", () => {
it("should return a correct onboarding state", done => {
mockedGetVersion.mockResolvedValue(aFirmwareInfo);
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
onboardingStatePollingSubscription = getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
try {
expect(value.allowedError).toBeNull();
expect(value.onboardingState).toEqual(anOnboardingState);
expect(value.lockedDevice).toBe(false);
done();
}
catch (expectError) {
done(expectError);
}
},
error: error => {
done(error);
},
});
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
it("should poll a new onboarding state after the defined period of time", done => {
mockedGetVersion.mockResolvedValue(aFirmwareInfo);
mockedExtractOnboardingState.mockReturnValue(anOnboardingState);
const device = aDevice;
// Did not manage to test that the polling is repeated by using jest's fake timer
// and advanceTimersByTime method or equivalent.
// Hacky test: spy on the repeatWhen operator to see if it has been called.
const spiedRepeat = jest.spyOn(rxjsOperators, "repeat");
onboardingStatePollingSubscription = getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
safeGuardTimeoutMs: pollingPeriodMs * 10,
}).subscribe({
next: value => {
try {
expect(value.onboardingState).toEqual(anOnboardingState);
expect(value.allowedError).toBeNull();
expect(value.lockedDevice).toBe(false);
expect(spiedRepeat).toHaveBeenCalledTimes(1);
done();
}
catch (expectError) {
done(expectError);
}
},
error: error => {
done(error);
},
});
});
});
describe("When the device is in bootloader mode", () => {
it("should throw an error so it is considered a fatal error", done => {
mockedGetVersion.mockResolvedValue({ ...aFirmwareInfo, isBootloader: true });
const device = aDevice;
onboardingStatePollingSubscription = getOnboardingStatePolling({
deviceId: device.deviceId,
pollingPeriodMs,
}).subscribe({
next: value => {
done(`It should have thrown an error. Received value: ${JSON.stringify(value)}`);
},
error: error => {
try {
expect(error).toBeInstanceOf(UnexpectedBootloader);
done();
}
catch (expectError) {
done(expectError);
}
},
});
jest.advanceTimersByTime(pollingPeriodMs - 1);
});
});
});
//# sourceMappingURL=getOnboardingStatePolling.test.js.map