brl/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

extensionSystem: Improve error formatting

Browse Source 
This exposes the formatted error with stack trace and proper location of
SyntaxErrors over the bus, instead of just the message.

<https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3041>

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3041>
This commit is contained in:
Philip Chimento 2024-01-02 16:29:08 -08:00 committed by Florian Müllner
parent 1692004b6b
commit 71befc5ff7
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
js/misc/errorUtils.js
View File

@ -14,8 +14,8 @@ function formatExceptionStack(error) {
return `\n\nStack trace:\n${indentedStack}`;
}
function formatExceptionWithCause(error, seenCauses) {
let fmt = formatExceptionStack(error);
function formatExceptionWithCause(error, seenCauses, showStack) {
let fmt = showStack ? formatExceptionStack(error) : '';
const {cause} = error;
if (!cause)
@ -39,9 +39,12 @@ function formatExceptionWithCause(error, seenCauses) {
* location where a SyntaxError was thrown into account.
*
* @param {Error} error The error to format
* @param {object} options Formatting options
* @param {boolean} options.showStack Whether to show the stack trace (default
* true)
* @returns {string} The formatted string
*/
export function formatError(error) {
export function formatError(error, {showStack = true} = {}) {
try {
let fmt = `${error}`;
if (error === null || typeof error !== 'object')
@ -49,12 +52,13 @@ export function formatError(error) {
if (error instanceof SyntaxError) {
fmt += formatSyntaxErrorLocation(error);
fmt += formatExceptionStack(error);
if (showStack)
fmt += formatExceptionStack(error);
return fmt;
}
const seenCauses = new Set([error]);
fmt += formatExceptionWithCause(error, seenCauses);
fmt += formatExceptionWithCause(error, seenCauses, showStack);
return fmt;
} catch (e) {
return `(could not display error: ${e})`;

4
js/ui/extensionSystem.js
View File

@ -9,6 +9,7 @@ import * as Signals from '../misc/signals.js';
import * as Config from '../misc/config.js';
import * as ExtensionDownloader from './extensionDownloader.js';
import {formatError} from '../misc/errorUtils.js';
import {ExtensionState, ExtensionType} from '../misc/extensionUtils.js';
import * as FileUtils from '../misc/fileUtils.js';
import * as Main from './main.js';
@ -359,8 +360,7 @@ export class ExtensionManager extends Signals.EventEmitter {
if (!extension)
return;
const message = error instanceof Error
? error.message : error.toString();
const message = formatError(error, {showStack: false});
console.debug(`Changing state of extension ${uuid} to ERROR`);
extension.error = message;