From e1057d9a506d7763ffdad4d5aaf1c84c4c6414eb Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Thu, 12 Nov 2020 12:33:58 +0100
Subject: [PATCH] backend-common: provide a ReadTreeResponseFactory instance to
 all ReaderFactories

---
 .../src/reading/AzureUrlReader.test.ts          | 17 +++++++++++++++--
 .../src/reading/GitlabUrlReader.test.ts         | 17 +++++++++++++++--
 .../backend-common/src/reading/UrlReaders.ts    |  4 +++-
 packages/backend-common/src/reading/types.ts    |  2 ++
 4 files changed, 35 insertions(+), 5 deletions(-)

diff --git a/packages/backend-common/src/reading/AzureUrlReader.test.ts b/packages/backend-common/src/reading/AzureUrlReader.test.ts
index 24b435006a..6efc7641b8 100644
--- a/packages/backend-common/src/reading/AzureUrlReader.test.ts
+++ b/packages/backend-common/src/reading/AzureUrlReader.test.ts
@@ -20,9 +20,14 @@ import { ConfigReader } from '@backstage/config';
 import { getVoidLogger } from '../logging';
 import { AzureUrlReader } from './AzureUrlReader';
 import { msw } from '@backstage/test-utils';
+import { ReadTreeResponseFactory } from './tree';
 
 const logger = getVoidLogger();
 
+const treeResponseFactory = ReadTreeResponseFactory.create({
+  config: new ConfigReader({}),
+});
+
 describe('AzureUrlReader', () => {
   const worker = setupServer();
   msw.setupDefaultHandlers(worker);
@@ -87,7 +92,11 @@ describe('AzureUrlReader', () => {
       }),
     },
   ])('should handle happy path %#', async ({ url, config, response }) => {
-    const [{ reader }] = AzureUrlReader.factory({ config, logger });
+    const [{ reader }] = AzureUrlReader.factory({
+      config,
+      logger,
+      treeResponseFactory,
+    });
 
     const data = await reader.read(url);
     const res = await JSON.parse(data.toString('utf-8'));
@@ -115,7 +124,11 @@ describe('AzureUrlReader', () => {
     },
   ])('should handle error path %#', async ({ url, config, error }) => {
     await expect(async () => {
-      const [{ reader }] = AzureUrlReader.factory({ config, logger });
+      const [{ reader }] = AzureUrlReader.factory({
+        config,
+        logger,
+        treeResponseFactory,
+      });
       await reader.read(url);
     }).rejects.toThrow(error);
   });
diff --git a/packages/backend-common/src/reading/GitlabUrlReader.test.ts b/packages/backend-common/src/reading/GitlabUrlReader.test.ts
index 4b3aa471c3..3a76c0631b 100644
--- a/packages/backend-common/src/reading/GitlabUrlReader.test.ts
+++ b/packages/backend-common/src/reading/GitlabUrlReader.test.ts
@@ -20,9 +20,14 @@ import { ConfigReader } from '@backstage/config';
 import { getVoidLogger } from '../logging';
 import { GitlabUrlReader } from './GitlabUrlReader';
 import { msw } from '@backstage/test-utils';
+import { ReadTreeResponseFactory } from './tree';
 
 const logger = getVoidLogger();
 
+const treeResponseFactory = ReadTreeResponseFactory.create({
+  config: new ConfigReader({}),
+});
+
 describe('GitlabUrlReader', () => {
   const worker = setupServer();
 
@@ -98,7 +103,11 @@ describe('GitlabUrlReader', () => {
       }),
     },
   ])('should handle happy path %#', async ({ url, config, response }) => {
-    const [{ reader }] = GitlabUrlReader.factory({ config, logger });
+    const [{ reader }] = GitlabUrlReader.factory({
+      config,
+      logger,
+      treeResponseFactory,
+    });
 
     const data = await reader.read(url);
     const res = await JSON.parse(data.toString('utf-8'));
@@ -114,7 +123,11 @@ describe('GitlabUrlReader', () => {
     },
   ])('should handle error path %#', async ({ url, config, error }) => {
     await expect(async () => {
-      const [{ reader }] = GitlabUrlReader.factory({ config, logger });
+      const [{ reader }] = GitlabUrlReader.factory({
+        config,
+        logger,
+        treeResponseFactory,
+      });
       await reader.read(url);
     }).rejects.toThrow(error);
   });
diff --git a/packages/backend-common/src/reading/UrlReaders.ts b/packages/backend-common/src/reading/UrlReaders.ts
index e1d99a2c49..2bb5617907 100644
--- a/packages/backend-common/src/reading/UrlReaders.ts
+++ b/packages/backend-common/src/reading/UrlReaders.ts
@@ -23,6 +23,7 @@ import { BitbucketUrlReader } from './BitbucketUrlReader';
 import { GithubUrlReader } from './GithubUrlReader';
 import { GitlabUrlReader } from './GitlabUrlReader';
 import { FetchUrlReader } from './FetchUrlReader';
+import { ReadTreeResponseFactory } from './tree';
 
 type CreateOptions = {
   /** Root config object */
@@ -49,9 +50,10 @@ export class UrlReaders {
     fallback,
   }: CreateOptions): UrlReader {
     const mux = new UrlReaderPredicateMux({ fallback: fallback });
+    const treeResponseFactory = ReadTreeResponseFactory.create({ config });
 
     for (const factory of factories ?? []) {
-      const tuples = factory({ config, logger: logger });
+      const tuples = factory({ config, logger: logger, treeResponseFactory });
 
       for (const tuple of tuples) {
         mux.register(tuple);
diff --git a/packages/backend-common/src/reading/types.ts b/packages/backend-common/src/reading/types.ts
index 8a78e9d65f..bf53e98ef2 100644
--- a/packages/backend-common/src/reading/types.ts
+++ b/packages/backend-common/src/reading/types.ts
@@ -16,6 +16,7 @@
 
 import { Logger } from 'winston';
 import { Config } from '@backstage/config';
+import { ReadTreeResponseFactory } from './tree';
 
 export type ReadTreeOptions = {
   /** A filter that can be used to select which files should be extracted. By default all files are extracted */
@@ -46,6 +47,7 @@ export type UrlReaderPredicateTuple = {
 export type ReaderFactory = (options: {
   config: Config;
   logger: Logger;
+  treeResponseFactory: ReadTreeResponseFactory;
 }) => UrlReaderPredicateTuple[];
 
 export type File = {