backend-common,techdocs-backend: refactor .readTree to accept options and implement GitHub reader with response utils

plugins/techdocs-backend/src/helpers.test.ts

@@ -19,7 +19,7 @@ import { UrlReader, ReadTreeResponse } from '@backstage/backend-common';
 import { Entity } from '@backstage/catalog-model';
 
 describe('getDocFilesFromRepository', () => {
-  it('should take the directory from UrlReader.readTree and add the docs path when mkdocs.yml is in root', async () => {
+  it('should read a remote directory using UrlReader.readTree', async () => {
     class MockUrlReader implements UrlReader {
       async read() {
         return Buffer.from('mock');
@@ -45,7 +45,7 @@ describe('getDocFilesFromRepository', () => {
         namespace: 'default',
         annotations: {
           'backstage.io/techdocs-ref':
-            'url:https://github.com/backstage/backstage/blob/master/mkdocs.yml',
+            'url:https://github.com/backstage/backstage/blob/master/subfolder/',
         },
         name: 'mytestcomponent',
         description: 'A component for testing',
@@ -64,54 +64,6 @@ describe('getDocFilesFromRepository', () => {
       mockEntity,
     );
 
-    expect(output).toBe('/tmp/testfolder/.');
-  });
-
-  it('should take the directory from UrlReader.readTree and add the docs path when mkdocs.yml is in a subfolder', async () => {
-    class MockUrlReader implements UrlReader {
-      async read() {
-        return Buffer.from('mock');
-      }
-
-      async readTree(): Promise<ReadTreeResponse> {
-        return {
-          dir: async () => {
-            return '/tmp/testfolder';
-          },
-          files: async () => {
-            return [];
-          },
-          archive: async () => {
-            return Buffer.from('');
-          },
-        };
-      }
-    }
-
-    const mockEntity: Entity = {
-      metadata: {
-        namespace: 'default',
-        annotations: {
-          'backstage.io/techdocs-ref':
-            'url:https://github.com/backstage/backstage/blob/master/subfolder/mkdocs.yml',
-        },
-        name: 'mytestcomponent',
-        description: 'A component for testing',
-      },
-      apiVersion: 'backstage.io/v1alpha1',
-      kind: 'Component',
-      spec: {
-        type: 'documentation',
-        lifecycle: 'experimental',
-        owner: 'testuser',
-      },
-    };
-
-    const output = await getDocFilesFromRepository(
-      new MockUrlReader(),
-      mockEntity,
-    );
-
-    expect(output).toBe('/tmp/testfolder/subfolder');
+    expect(output).toBe('/tmp/testfolder');
   });
 });

plugins/techdocs-backend/src/helpers.ts

@@ -179,21 +179,10 @@ export const getDocFilesFromRepository = async (
     entity,
   );
 
-  const { ref, filepath: mkdocsPath } = parseGitUrl(target);
-
-  const docsRootPath = path.dirname(mkdocsPath);
-  const docsFolderPath = path.join(docsRootPath, 'docs');
-
   if (reader.readTree) {
-    const readTreeResponse = await reader.readTree(
-      parseGitUrl(target).toString(),
-      ref,
-      [mkdocsPath, docsFolderPath],
-    );
+    const response = await reader.readTree(target);
 
-    const tmpDir = await readTreeResponse.dir();
-
-    return `${tmpDir}/${docsRootPath}`;
+    return response.dir();
   }
 
   throw new Error(