Improve the ResponseParseError description

In case of a `ResponseParseError` instead of comparing the versions of
httpd and the web client strictly, we should make sure to check if httpd
fulfills the web clients version requirement (to be the same major
version) and else fallback to a more verbose error about the different
versions.
This commit is contained in:
Sebastian Martinez
2024-12-04 22:11:36 +01:00
parent 2075c320f3
commit 544cdca396
3 changed files with 10 additions and 17 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
{
"nodes": {
"fallbackPublicExplorer": "https://app.radicle.xyz/nodes/$host/$rid$path",
"apiVersion": "6.0.0",
"requiredApiVersion": "^6.0.0",
"defaultHttpdPort": 443,
"defaultHttpdScheme": "https"
},
+8 -15
View File
@@ -4,7 +4,7 @@
import type { ZodIssue, ZodType, TypeOf } from "zod";
import config from "virtual:config";
import { compare } from "compare-versions";
import { satisfies } from "compare-versions";
export interface BaseUrl {
hostname: string;
@@ -52,26 +52,19 @@ export class ResponseParseError extends Error {
public constructor(
method: string,
body: unknown,
apiVersion: string | undefined,
apiVersion: string,
zodIssues: ZodIssue[],
path?: string,
) {
super("Failed to parse response body");
const explorerRequiredApiVersion = config.nodes.requiredApiVersion;
const nodeApiVersion = apiVersion;
let description: string;
if (
apiVersion === undefined ||
compare(apiVersion, config.nodes.apiVersion, "<")
) {
description = `The node you are fetching from seems to be outdated, make sure the httpd API version is at least ${config.nodes.apiVersion} currently ${apiVersion ?? "unknown"}.`;
} else if (
config.nodes.apiVersion === undefined ||
compare(apiVersion, config.nodes.apiVersion, ">")
) {
description = `The web client you are using is outdated, make sure it supports at least ${apiVersion} to interact with this node currently ${config.nodes.apiVersion ?? "unknown"}.`;
if (!satisfies(nodeApiVersion, explorerRequiredApiVersion)) {
description = `The node you are fetching from (v${nodeApiVersion}) doesn't match the version requirements of the web client ${explorerRequiredApiVersion}.`;
} else {
description =
"This is usually due to a version mismatch between the seed and the web interface.";
description = `The node (v${nodeApiVersion}) matches the version requirement of the web client (${explorerRequiredApiVersion}), but the web client isn't able to parse the response.`;
}
this.apiVersion = apiVersion;
this.description =
@@ -122,7 +115,7 @@ export class Fetcher {
): Promise<TypeOf<T>> {
const response = await this.fetch({
...params,
query: { ...params.query, v: config.nodes.apiVersion },
query: { ...params.query, v: config.nodes.requiredApiVersion },
});
if (!response.ok) {
Vendored
+1 -1
View File
@@ -1,7 +1,7 @@
declare module "virtual:*" {
const config: {
nodes: {
apiVersion: string;
requiredApiVersion: string;
fallbackPublicExplorer: string;
defaultHttpdPort: number;
defaultLocalHttpdPort: number;