Improves error messages.

This commit is contained in:
Henning Dieterichs
2020-03-18 18:53:35 +01:00
parent d2e0138bae
commit 9efd1d7cd6
14 changed files with 203 additions and 58 deletions

View File

@@ -6,7 +6,11 @@ import {
} from "./DataExtractionProvider";
import { Config, DebugAdapterConfig } from "../../Config";
import { GenericDataExtractionProvider } from "./GenericDataExtractionProviderFactory";
import { registerUpdateReconciler, hotClass } from "@hediet/node-reload";
registerUpdateReconciler(module);
@hotClass(module)
export class ConfiguredDataExtractionProviderFactory
implements DataExtractionProviderFactory {
constructor(private readonly config: Config) {}

View File

@@ -3,6 +3,7 @@ import {
DataExtractorId,
} from "@hediet/debug-visualizer-data-extraction";
import { VsCodeDebugSession } from "../../VsCodeDebugger";
import { FormattedMessage } from "../../contract";
export interface DataExtractionProviderFactory {
createDataExtractionProvider(
@@ -15,7 +16,7 @@ export interface DataExtractionProvider {
args: DataExtractionProviderArgs
): Promise<
| { kind: "data"; result: DataExtractionResult }
| { kind: "error"; message: string }
| { kind: "error"; message: FormattedMessage }
>;
}

View File

@@ -9,7 +9,12 @@ import {
DataExtractionProviderArgs,
} from "./DataExtractionProvider";
import { parseEvaluationResultFromGenericDebugAdapter } from "./parseEvaluationResultFromGenericDebugAdapter";
import { FormattedMessage } from "../../contract";
import { hotClass, registerUpdateReconciler } from "@hediet/node-reload";
registerUpdateReconciler(module);
@hotClass(module)
export class GenericDataExtractionProviderFactory
implements DataExtractionProviderFactory {
createDataExtractionProvider(
@@ -28,7 +33,7 @@ export class GenericDataExtractionProvider implements DataExtractionProvider {
frameId,
}: DataExtractionProviderArgs): Promise<
| { kind: "data"; result: DataExtractionResult }
| { kind: "error"; message: string }
| { kind: "error"; message: FormattedMessage }
> {
const finalExpression = this.getFinalExpression({
expression,
@@ -44,7 +49,20 @@ export class GenericDataExtractionProvider implements DataExtractionProvider {
} catch (error) {
return {
kind: "error",
message: error.message,
message: {
kind: "list",
items: [
error.message,
`Used debug adapter: ${this.session.session.configuration.type}`,
{
kind: "inlineList",
items: [
"Evaluated expression is",
{ kind: "code", content: finalExpression },
],
},
],
},
};
}

View File

@@ -11,7 +11,12 @@ import {
DataExtractionProvider,
DataExtractionProviderArgs,
} from "./DataExtractionProvider";
import { FormattedMessage } from "../../contract";
import { registerUpdateReconciler, hotClass } from "@hediet/node-reload";
registerUpdateReconciler(module);
@hotClass(module)
export class JsDataExtractionProviderFactory
implements DataExtractionProviderFactory {
createDataExtractionProvider(
@@ -39,7 +44,7 @@ class JsDataEvaluator implements DataExtractionProvider {
frameId,
}: DataExtractionProviderArgs): Promise<
| { kind: "data"; result: DataExtractionResult }
| { kind: "error"; message: string }
| { kind: "error"; message: FormattedMessage }
> {
while (true) {
try {

View File

@@ -2,12 +2,13 @@ import {
DataExtractionResult,
isExtractedData,
} from "@hediet/debug-visualizer-data-extraction";
import { FormattedMessage } from "../../contract";
export function parseEvaluationResultFromGenericDebugAdapter(
resultText: string
):
| { kind: "data"; result: DataExtractionResult }
| { kind: "error"; message: string } {
| { kind: "error"; message: FormattedMessage } {
const jsonData = resultText.trim();
let resultObj;
@@ -37,7 +38,26 @@ export function parseEvaluationResultFromGenericDebugAdapter(
if (!isExtractedData(resultObj)) {
return {
kind: "error",
message: "Data does not match ExtractedData interface.",
message: {
kind: "list",
items: [
"Evaluation result does not match ExtractedData interface.",
{
kind: "inlineList",
items: [
"Evaluation result was:",
{
kind: "code",
content: JSON.stringify(
resultObj,
undefined,
4
),
},
],
},
],
},
};
}
} catch (e) {
@@ -69,8 +89,26 @@ function parseJson(str: string) {
try {
return JSON.parse(str);
} catch (error) {
throw new Error(
`Could not parse \`${str}\` as JSON.\n${error.message}`
);
throw new FormattedError({
kind: "list",
items: [
"Could not parse evaluation result as JSON:",
error.message,
{
kind: "inlineList",
items: [
"Evaluation result was:",
{
kind: "code",
content: str,
},
],
},
],
});
}
}
class FormattedError {
constructor(public readonly message: FormattedMessage) {}
}

View File

@@ -18,9 +18,24 @@ function unchecked<T>(): types.Type<T, any, unknown> {
);
}
export type FormattedMessage =
| string
| {
kind: "list";
items: FormattedMessage[];
}
| {
kind: "inlineList";
items: FormattedMessage[];
}
| {
kind: "code";
content: string;
};
export type DataExtractionState =
| { kind: "loading" }
| { kind: "error"; message: string }
| { kind: "error"; message: FormattedMessage }
| { kind: "noDebugSession" }
| {
kind: "data";