fix: handle error when target is not well formatted url

immobiliare · Mar 6, 2023 · ca49ad4 · ca49ad4
1 parent a2cab01
commit ca49ad4
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 3 deletions.
diff --git a/packages/gitlab-backend/src/processor/processor.test.ts b/packages/gitlab-backend/src/processor/processor.test.ts
@@ -190,4 +190,34 @@ describe('Processor', () => {
  entity.metadata?.annotations?.[GITLAB_PROJECT_ID]
  ).toBeUndefined();
  });
+
+ it('The processor should check if an entity is allowed before the target check', async () => {
+ const processor = new GitlabFillerProcessor(config);
+ const entity: Entity = {
+ apiVersion: 'backstage.io/v1alpha1',
+ kind: 'Component',
+ metadata: {
+ name: 'backstage',
+ },
+ };
+ await expect(
+ processor.postProcessEntity(
+ entity,
+ {
+ type: 'url',
+ // Target is not a URL
+ target: 'my.custom-gitlab.com/backstage/backstage/blob/next/catalog.yaml',
+ },
+ () => undefined
+ )
+ ).resolves.toEqual(entity);
+
+ expect(
+ entity.metadata?.annotations?.[GITLAB_PROJECT_SLUG]
+ ).toBeUndefined();
+ expect(entity.metadata?.annotations?.[GITLAB_INSTANCE]).toBeUndefined();
+ expect(
+ entity.metadata?.annotations?.[GITLAB_PROJECT_ID]
+ ).toBeUndefined();
+ });
 });
diff --git a/packages/gitlab-backend/src/processor/processor.ts b/packages/gitlab-backend/src/processor/processor.ts
@@ -42,7 +42,7 @@ export class GitlabFillerProcessor implements CatalogProcessor {
  _emit: CatalogProcessorEmit
  ): Promise<Entity> {
  // Check if it is a GitLab Host
- if (this.isValidLocation(location) && this.isAllowedEntity(entity)) {
+ if (this.isAllowedEntity(entity) && this.isValidLocation(location)) {
  if (!entity.metadata.annotations) entity.metadata.annotations = {};
  // Generate Project Slug if not specified
  if (
@@ -82,8 +82,12 @@ export class GitlabFillerProcessor implements CatalogProcessor {
  private isValidLocation({ target, type }: LocationSpec): boolean {
  if (type !== 'url') return false;
 
- const url = new URL(target);
-
+ let url: URL;
+ try {
+ url = new URL(target);
+ } catch (e) {
+ return false;
+ }
  // Check if it is valid gitlab Host
  return this.gitLabIntegrationsConfig.some((config) => {
  const baseUrl = new URL(config.baseUrl);