use "error" when type is Error

This renames "err" to "error" when the type is Error for consistency
(fixes redux complaints about non-serializable err).
This commit is contained in:
David Lechner
2022-10-17 13:44:21 -05:00
committed by David Lechner
parent 186fd4cd71
commit e67ae1c52b
10 changed files with 42 additions and 38 deletions
+3 -2
View File
@@ -16,11 +16,12 @@ export const didWrite = createAction((id: number) => ({
id,
}));
export const didFailToWrite = createAction((id: number, err: Error) => ({
export const didFailToWrite = createAction((id: number, error: Error) => ({
type: 'bleUart.action.didFailToWrite',
id,
err,
error,
}));
export const didNotify = createAction((value: DataView) => ({
type: 'bleUart.action.didNotify',
value,
+7 -7
View File
@@ -28,10 +28,10 @@ export const didWriteCommand = createAction((id: number) => ({
/**
* Action that indicates sending a command to the Pybricks service control characteristic failed.
*/
export const didFailToWriteCommand = createAction((id: number, err: Error) => ({
export const didFailToWriteCommand = createAction((id: number, error: Error) => ({
type: 'blePybricksService.action.didFailToWriteCommand',
id,
err,
error,
}));
/**
@@ -113,10 +113,10 @@ export const didSendCommand = createAction((id: number) => ({
* @param id Unique identifier for the transaction from the corresponding "send" command.
* @param err The error that was raised.
*/
export const didFailToSendCommand = createAction((id: number, err: Error) => ({
export const didFailToSendCommand = createAction((id: number, error: Error) => ({
type: 'blePybricksServiceCommand.action.didFailToSend',
id,
err,
error,
}));
/** Action types for events received from the Pybricks service control characteristic. */
@@ -132,11 +132,11 @@ export const didReceiveStatusReport = createAction((statusFlags: number) => ({
/**
* Pseudo-event = actionCreator((not received from hub) indicating that there was a protocol error.
* @param err The error that was caught.
* @param error The error that was caught.
*/
export const eventProtocolError = createAction((err: Error) => ({
export const eventProtocolError = createAction((error: Error) => ({
type: 'blePybricksServiceEvent.action.protocolError',
err,
error,
}));
/**
+1 -1
View File
@@ -85,7 +85,7 @@ function* encodeRequest(): Generator {
});
if (failedToSend) {
yield* put(didFailToSendCommand(action.id, failedToSend.err));
yield* put(didFailToSendCommand(action.id, failedToSend.error));
} else {
yield* put(didSendCommand(action.id));
}
+3 -3
View File
@@ -14,13 +14,13 @@ import {
function handlePybricksEventProtocolError(
action: ReturnType<typeof pybricksEventProtocolError>,
): void {
console.error(action.err);
console.error(action.error);
}
function handleBleUartDidFailToWrite(
action: ReturnType<typeof bleUartDidFailToWrite>,
): void {
console.error(action.err);
console.error(action.error);
}
function handleBootloaderDidFailToConnect(
@@ -32,7 +32,7 @@ function handleBootloaderDidFailToConnect(
}
function handleBootloaderDidError(action: ReturnType<typeof bootloaderDidError>): void {
console.error(action.err);
console.error(action.error);
}
function handleFileStorageDidFailToStoreTextFileValue(
+6 -6
View File
@@ -60,7 +60,7 @@ export type FailToFinishReasonFailedToConnect =
export type FailToFinishReasonTimedOut = Reason<FailToFinishReasonType.TimedOut>;
export type FailToFinishReasonBleError = Reason<FailToFinishReasonType.BleError> & {
err: Error;
error: Error;
};
export type FailToFinishReasonDisconnected =
@@ -97,7 +97,7 @@ export type FailToFinishReasonFailedToCompile =
Reason<FailToFinishReasonType.FailedToCompile>;
export type FailToFinishReasonUnknown = Reason<FailToFinishReasonType.Unknown> & {
err: Error;
error: Error;
};
export type FailToFinishReason =
@@ -178,7 +178,7 @@ function didFailToFinishCreator(reason: FailToFinishReasonType.TimedOut): {
function didFailToFinishCreator(
reason: FailToFinishReasonType.BleError,
err: Error,
error: Error,
): {
type: typeof didFailToFinishType;
reason: FailToFinishReasonBleError;
@@ -244,7 +244,7 @@ function didFailToFinishCreator(reason: FailToFinishReasonType.FailedToCompile):
function didFailToFinishCreator(
reason: FailToFinishReasonType.Unknown,
err: Error,
error: Error,
): {
type: typeof didFailToFinishType;
reason: FailToFinishReasonUnknown;
@@ -274,7 +274,7 @@ function didFailToFinishCreator(
}
return {
type: didFailToFinishType,
reason: { reason, err: arg1 },
reason: { reason, error: arg1 },
};
}
@@ -344,7 +344,7 @@ function didFailToFinishCreator(
}
return {
type: didFailToFinishType,
reason: { reason, err: arg1 },
reason: { reason, error: arg1 },
};
}
+1 -1
View File
@@ -113,7 +113,7 @@ function* waitForDidRequest(id: number): SagaGenerator<ReturnType<typeof didRequ
if (failedToRequest) {
yield* put(
didFailToFinish(FailToFinishReasonType.BleError, failedToRequest.err),
didFailToFinish(FailToFinishReasonType.BleError, failedToRequest.error),
);
yield* disconnectAndCancel();
}
+5 -5
View File
@@ -238,7 +238,7 @@ function* handleDownloadAndRun(action: ReturnType<typeof downloadAndRun>): Gener
});
if (didFailToSend) {
throw didFailToSend.err;
throw didFailToSend.error;
}
for (let i = 0; i < didCompile.file.size; i += chunkSize) {
@@ -262,7 +262,7 @@ function* handleDownloadAndRun(action: ReturnType<typeof downloadAndRun>): Gener
});
if (didFailToSend) {
throw didFailToSend.err;
throw didFailToSend.error;
}
}
@@ -285,7 +285,7 @@ function* handleDownloadAndRun(action: ReturnType<typeof downloadAndRun>): Gener
});
if (didFailToSend2) {
throw didFailToSend2.err;
throw didFailToSend2.error;
}
yield* put(didFinishDownload());
@@ -301,7 +301,7 @@ function* handleDownloadAndRun(action: ReturnType<typeof downloadAndRun>): Gener
});
if (didFailToStart) {
throw didFailToStart.err;
throw didFailToStart.error;
}
} catch (err) {
// istanbul ignore if
@@ -344,7 +344,7 @@ function* handleStop(): Generator {
if (failedToSend) {
// TODO: probably want to check error. If hub disconnected, ignore error
// otherwise indicate error to user
console.error(failedToSend.err);
console.error(failedToSend.error);
}
}
+9 -9
View File
@@ -63,10 +63,10 @@ function didFailToConnectCreator(
function didFailToConnectCreator(
reason: BootloaderConnectionFailureReason.Unknown,
err: Error,
error: Error,
): Action<typeof didFailToConnectType> & {
reason: BootloaderConnectionFailureReason.Unknown;
err: Error;
error: Error;
};
function didFailToConnectCreator<T extends BootloaderConnectionFailureReason>(
@@ -103,9 +103,9 @@ export const didFailToConnect = createAction(didFailToConnectCreator);
/**
* There was a connection error.
*/
export const didError = createAction((err: Error) => ({
export const didError = createAction((error: Error) => ({
type: 'bootloader.action.connection.didError',
err,
error,
}));
/**
@@ -127,9 +127,9 @@ export const didSend = createAction(() => ({
/**
* Sending a message failed with error.
*/
export const didFailToSend = createAction((err: Error) => ({
export const didFailToSend = createAction((error: Error) => ({
type: 'bootloader.action.connection.didFailToSend',
err,
error,
}));
/**
@@ -249,12 +249,12 @@ export const didRequest = createAction((id: number) => ({
/**
* Creates an action that indicates a request failed to send.
* @param id The unique identifier of the action.
* @param err The error message.
* @param error The error message.
*/
export const didFailToRequest = createAction((id: number, err: Error) => ({
export const didFailToRequest = createAction((id: number, error: Error) => ({
type: 'bootloader.action.didFailToRequest',
id,
err,
error,
}));
// Bootloader response actions for receiving responses from the connection.
+2 -2
View File
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2020,2022 The Pybricks Authors
// Copyright (c) 2020-2022 The Pybricks Authors
//
// Handles LEGO Wireless Protocol v3 Bootloader protocol.
@@ -121,7 +121,7 @@ function* encodeRequest(): Generator {
});
if (failedToSend) {
yield* put(didFailToRequest(action.id, failedToSend.err));
yield* put(didFailToRequest(action.id, failedToSend.error));
} else {
yield* put(didRequest(action.id));
}
+5 -2
View File
@@ -192,7 +192,10 @@ function* showFlashFirmwareError(
yield* showSingleton(Level.Error, I18nId.FlashFirmwareTimedOut);
break;
case FailToFinishReasonType.BleError:
yield* showUnexpectedError(I18nId.FlashFirmwareBleError, action.reason.err);
yield* showUnexpectedError(
I18nId.FlashFirmwareBleError,
action.reason.error,
);
break;
case FailToFinishReasonType.Disconnected:
yield* showSingleton(Level.Error, I18nId.FlashFirmwareDisconnected);
@@ -238,7 +241,7 @@ function* showFlashFirmwareError(
case FailToFinishReasonType.Unknown:
yield* showUnexpectedError(
I18nId.FlashFirmwareUnexpectedError,
action.reason.err,
action.reason.error,
);
break;
}