LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

Error: add support to log additional info (not shown in Modal)

Browse source 
`doError` supported either a string or object, and so far there are no instances where the object version is used, so this enhancement should be safe to do without affecting anyone.

## Change
For the object version, support an additional `cause` parameter that will be logged but not show in the GUI.
This commit is contained in:
infinite-persistence 2022-01-06 15:26:03 +08:00
parent a4d2c6b0a6
commit ad07ee0de3
No known key found for this signature in database
GPG key ID: B9C3252EDC3D0AA0
1 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
ui/modal/modalError/view.jsx
View file

@ -3,8 +3,11 @@ import { Lbryio } from 'lbryinc';
import React from 'react'; import React from 'react';
import { Modal } from 'modal/modal'; import { Modal } from 'modal/modal';
// Note: It accepts an object for 'error', but never pass Error itself as Error
// cannot be stringified (unless the code below is updated to handle that).
type Props = { type Props = {
error: string | { message: string }, error: string | { message: string, cause?: any },
closeModal: () => void, closeModal: () => void,
}; };
@ -15,20 +18,28 @@ class ModalError extends React.PureComponent<Props> {
// Yuck // Yuck
// https://github.com/lbryio/lbry-sdk/issues/1118 // https://github.com/lbryio/lbry-sdk/issues/1118
// The sdk logs failed downloads, they happen so often that it's mostly noise in the desktop logs // The sdk logs failed downloads, they happen so often that it's mostly noise in the desktop logs
const errorMessage = typeof error === 'string' ? error : error.message; let errorMessage = typeof error === 'string' ? error : error.message;
const skipLog = const skipLog =
errorMessage.startsWith('Failed to download') || errorMessage.startsWith('Failed to download') ||
errorMessage.endsWith('Uploading the same file from multiple tabs or windows is not allowed.'); errorMessage.endsWith('Uploading the same file from multiple tabs or windows is not allowed.');
if (error.cause) {
try {
errorMessage += ' => ' + (JSON.stringify(error.cause, null, '\t') || '');
} catch (e) {
console.error(e); // eslint-disable-line no-console
}
}
if (process.env.NODE_ENV === 'production' && !skipLog) { if (process.env.NODE_ENV === 'production' && !skipLog) {
Lbryio.call('event', 'desktop_error', { error_message: JSON.stringify(error) }); Lbryio.call('event', 'desktop_error', { error_message: errorMessage });
} }
} }
render() { render() {
const { closeModal, error } = this.props; const { closeModal, error } = this.props;
const errorObj = typeof error === 'string' ? { message: error } : error; const errorObj = typeof error === 'string' ? { message: error, cause: undefined } : error;
const errorKeyLabels = { const errorKeyLabels = {
connectionString: __('API connection string'), connectionString: __('API connection string'),
@ -37,17 +48,20 @@ class ModalError extends React.PureComponent<Props> {
code: __('Error code'), code: __('Error code'),
message: __('Error message'), message: __('Error message'),
data: __('Error data'), data: __('Error data'),
cause: 'skip',
}; };
const errorInfoList = []; const errorInfoList = [];
for (const key of Object.keys(errorObj)) { for (const key of Object.keys(errorObj)) {
const val = typeof errorObj[key] === 'string' ? errorObj[key] : JSON.stringify(errorObj[key]);
const label = errorKeyLabels[key]; const label = errorKeyLabels[key];
errorInfoList.push( if (label !== 'skip') {
<li key={key}> const val = typeof errorObj[key] === 'string' ? errorObj[key] : JSON.stringify(errorObj[key]);
<strong>{label}</strong>: {val} errorInfoList.push(
</li> <li key={key}>
); <strong>{label}</strong>: {val}
</li>
);
}
} }
return ( return (