From bd613dd8509b5173e050fff196e480f46b0f0d42 Mon Sep 17 00:00:00 2001
From: Marek Calus <marek-calus@wp.pl>
Date: Fri, 20 Nov 2020 14:30:49 +0100
Subject: [PATCH] Code review adjustments

---
 plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts | 6 +++---
 plugins/catalog-backend/src/ingestion/types.ts            | 8 +++++++-
 plugins/catalog-backend/src/service/CatalogBuilder.ts     | 4 ++--
 plugins/catalog-backend/src/service/router.ts             | 2 +-
 4 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts b/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts
index 611505d707..97df326fc5 100644
--- a/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts
+++ b/plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts
@@ -22,13 +22,13 @@ import {
   LocationAnalyzer,
 } from './types';
 
-export class LocationAnalyzerClient implements LocationAnalyzer {
+export class RepoLocationAnalyzer implements LocationAnalyzer {
   private readonly logger: Logger;
 
   constructor(logger: Logger) {
     this.logger = logger;
   }
-  async generateConfig(
+  async analyzeLocation(
     request: AnalyzeLocationRequest,
   ): Promise<AnalyzeLocationResponse> {
     const { owner, name, source } = parseGitUri(request.location.target);
@@ -40,7 +40,7 @@ export class LocationAnalyzerClient implements LocationAnalyzer {
         // Probably won't handle properly self-hosted git providers with custom url
         annotations: { [`${source}/project-slug`]: `${owner}/${name}` },
       },
-      spec: { type: 'other', owner: owner, lifecycle: 'unknown' },
+      spec: { type: 'other', lifecycle: 'unknown' },
     };
 
     this.logger.debug(`entity created for ${request.location.target}`);
diff --git a/plugins/catalog-backend/src/ingestion/types.ts b/plugins/catalog-backend/src/ingestion/types.ts
index 79a5387247..c8d642b6b5 100644
--- a/plugins/catalog-backend/src/ingestion/types.ts
+++ b/plugins/catalog-backend/src/ingestion/types.ts
@@ -75,7 +75,13 @@ export type ReadLocationError = {
 //
 
 export type LocationAnalyzer = {
-  generateConfig(
+  /**
+   * Generates an entity configuration for given git repository. It's used for
+   * importing new component to the backstage app.
+   *
+   * @param location Git repository to analyze and generate config for.
+   */
+  analyzeLocation(
     location: AnalyzeLocationRequest,
   ): Promise<AnalyzeLocationResponse>;
 };
diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts
index 439b85591f..0fee610ce6 100644
--- a/plugins/catalog-backend/src/service/CatalogBuilder.ts
+++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts
@@ -52,7 +52,7 @@ import {
   UrlReaderProcessor,
 } from '../ingestion';
 import { CatalogRulesEnforcer } from '../ingestion/CatalogRules';
-import { LocationAnalyzerClient } from '../ingestion/LocationAnalyzer';
+import { RepoLocationAnalyzer } from '../ingestion/LocationAnalyzer';
 import { BuiltinKindsEntityProcessor } from '../ingestion/processors/BuiltinKindsEntityProcessor';
 import { LdapOrgReaderProcessor } from '../ingestion/processors/LdapOrgReaderProcessor';
 import {
@@ -232,7 +232,7 @@ export class CatalogBuilder {
       locationReader,
       logger,
     );
-    const locationAnalyzer = new LocationAnalyzerClient(logger);
+    const locationAnalyzer = new RepoLocationAnalyzer(logger);
 
     return {
       entitiesCatalog,
diff --git a/plugins/catalog-backend/src/service/router.ts b/plugins/catalog-backend/src/service/router.ts
index d11ed49253..43c2967233 100644
--- a/plugins/catalog-backend/src/service/router.ts
+++ b/plugins/catalog-backend/src/service/router.ts
@@ -139,7 +139,7 @@ export async function createRouter(
   if (locationAnalyzer) {
     router.post('/analyze-location', async (req, res) => {
       const input = await validateRequestBody(req, analyzeLocationSchema);
-      const output = await locationAnalyzer.generateConfig(input);
+      const output = await locationAnalyzer.analyzeLocation(input);
       res.status(200).send(output);
     });
   }