Remove deprecated UrlReaders and update usages

Signed-off-by: Johan Haals <johan.haals@gmail.com>

plugins/techdocs-node/src/helpers.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { resolveSafeChildPath } from '@backstage/backend-plugin-api';
 import {
   Entity,
@@ -143,7 +143,7 @@ export const getLocationForEntity = (
  * @param opts - Options for configuring the reader, e.g. logger, etag, etc.
  */
 export const getDocFilesFromRepository = async (
-  reader: UrlReader,
+  reader: UrlReaderService,
   entity: Entity,
   opts?: { etag?: string; logger?: Logger },
 ): Promise<PreparerResponse> => {

plugins/techdocs-node/src/stages/prepare/dir.test.ts

@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { UrlReader, loggerToWinstonLogger } from '@backstage/backend-common';
+import { loggerToWinstonLogger } from '@backstage/backend-common';
 import { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';
 import { ConfigReader } from '@backstage/config';
 import { DirectoryPreparer } from './dir';
 import { mockServices } from '@backstage/backend-test-utils';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 function normalizePath(path: string) {
   return path
@@ -46,7 +47,7 @@ const createMockEntity = (annotations: {}) => {
 };
 
 const mockConfig = new ConfigReader({});
-const mockUrlReader: jest.Mocked<UrlReader> = {
+const mockUrlReader: jest.Mocked<UrlReaderService> = {
   readUrl: jest.fn(),
   readTree: jest.fn(),
   search: jest.fn(),

plugins/techdocs-node/src/stages/prepare/dir.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { Entity } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import { InputError } from '@backstage/errors';
@@ -38,7 +38,7 @@ import {
  */
 export class DirectoryPreparer implements PreparerBase {
   private readonly scmIntegrations: ScmIntegrationRegistry;
-  private readonly reader: UrlReader;
+  private readonly reader: UrlReaderService;
 
   /**
    * Returns a directory preparer instance
@@ -55,7 +55,7 @@ export class DirectoryPreparer implements PreparerBase {
   private constructor(
     config: Config,
     _logger: Logger | null,
-    reader: UrlReader,
+    reader: UrlReaderService,
   ) {
     this.reader = reader;
     this.scmIntegrations = ScmIntegrations.fromConfig(config);

plugins/techdocs-node/src/stages/prepare/types.ts

@@ -15,7 +15,7 @@
  */
 
 import type { Entity } from '@backstage/catalog-model';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { Logger } from 'winston';
 
 /**
@@ -30,7 +30,7 @@ export type ETag = string;
  */
 export type PreparerConfig = {
   logger: Logger;
-  reader: UrlReader;
+  reader: UrlReaderService;
 };
 
 /**

plugins/techdocs-node/src/stages/prepare/url.ts

@@ -15,7 +15,7 @@
  */
 
 import { assertError } from '@backstage/errors';
-import { UrlReader } from '@backstage/backend-common';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 import { Entity } from '@backstage/catalog-model';
 import { Logger } from 'winston';
 import { getDocFilesFromRepository } from '../../helpers';
@@ -32,7 +32,7 @@ import {
  */
 export class UrlPreparer implements PreparerBase {
   private readonly logger: Logger;
-  private readonly reader: UrlReader;
+  private readonly reader: UrlReaderService;
 
   /**
    * Returns a directory preparer instance
@@ -42,7 +42,7 @@ export class UrlPreparer implements PreparerBase {
     return new UrlPreparer(options.reader, options.logger);
   }
 
-  private constructor(reader: UrlReader, logger: Logger) {
+  private constructor(reader: UrlReaderService, logger: Logger) {
     this.logger = logger;
     this.reader = reader;
   }