From f7ce7c56590a9ff94e2ac71e50735bd9e4562da5 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 5 Aug 2021 19:16:23 +0200 Subject: [PATCH] backend-common: more informative error message when no url reader is matched Signed-off-by: Patrik Oldsberg --- .changeset/eighty-glasses-mate.md | 5 +++++ .../backend-common/src/reading/UrlReaderPredicateMux.ts | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 .changeset/eighty-glasses-mate.md diff --git a/.changeset/eighty-glasses-mate.md b/.changeset/eighty-glasses-mate.md new file mode 100644 index 0000000000..d71ef8fd42 --- /dev/null +++ b/.changeset/eighty-glasses-mate.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Use a more informative error message when URL reading isn't allowed due to no reader matching the target URL. diff --git a/packages/backend-common/src/reading/UrlReaderPredicateMux.ts b/packages/backend-common/src/reading/UrlReaderPredicateMux.ts index 4a166cb517..bbe94a0fb4 100644 --- a/packages/backend-common/src/reading/UrlReaderPredicateMux.ts +++ b/packages/backend-common/src/reading/UrlReaderPredicateMux.ts @@ -52,7 +52,11 @@ export class UrlReaderPredicateMux implements UrlReader { } } - throw new NotAllowedError(`Reading from '${url}' is not allowed`); + throw new NotAllowedError( + `Reading from '${url}' is not allowed. ` + + `You may need to configure an integration for the target host, or add it ` + + `to the configured list of allowed hosts at 'backend.reading.allow'`, + ); } async readUrl(