From 920004b48661798320ae1edc26419846019da98d Mon Sep 17 00:00:00 2001 From: Joshua Jung Date: Thu, 26 Sep 2024 17:19:49 -0500 Subject: [PATCH] Fixing getProjectId error message to be more descriptive Signed-off-by: Joshua Jung --- .changeset/rude-apricots-eat.md | 6 ++++++ .../src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts | 4 +++- packages/integration/src/gitlab/core.ts | 4 +++- 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 .changeset/rude-apricots-eat.md diff --git a/.changeset/rude-apricots-eat.md b/.changeset/rude-apricots-eat.md new file mode 100644 index 0000000000..198d6a0ec7 --- /dev/null +++ b/.changeset/rude-apricots-eat.md @@ -0,0 +1,6 @@ +--- +'@backstage/backend-defaults': patch +'@backstage/integration': patch +--- + +Updating error message for getProjectId when fetching Gitlab project from its url to be more accurate diff --git a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts index dd6a0970d2..d0607767c2 100644 --- a/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts +++ b/packages/backend-defaults/src/entrypoints/urlReader/lib/GitlabUrlReader.test.ts @@ -697,7 +697,9 @@ describe('GitlabUrlReader', () => { (gitlabProcessor as any).getGitlabFetchUrl( 'https://gitlab.com/some/random/endpoint', ), - ).rejects.toThrow('Please provide full path to yaml file from GitLab'); + ).rejects.toThrow( + 'Failed converting /some/random/endpoint to a project id. Url path must include /blob/.', + ); }); }); diff --git a/packages/integration/src/gitlab/core.ts b/packages/integration/src/gitlab/core.ts index 94f4b65d9f..c7f8dd036f 100644 --- a/packages/integration/src/gitlab/core.ts +++ b/packages/integration/src/gitlab/core.ts @@ -116,7 +116,9 @@ export async function getProjectId( const url = new URL(target); if (!url.pathname.includes('/blob/')) { - throw new Error('Please provide full path to yaml file from GitLab'); + throw new Error( + `Failed converting ${url.pathname} to a project id. Url path must include /blob/.`, + ); } try {