scaffolder-backend: add Publishers.fromConfig

packages/backend/src/plugins/scaffolder.ts

@@ -19,16 +19,9 @@ import {
   createRouter,
   Preparers,
   Publishers,
-  GithubPublisher,
-  GitlabPublisher,
-  AzurePublisher,
   CreateReactAppTemplater,
   Templaters,
-  RepoVisibilityOptions,
 } from '@backstage/plugin-scaffolder-backend';
-import { Octokit } from '@octokit/rest';
-import { Gitlab } from '@gitbeaker/node';
-import { getPersonalAccessTokenHandler, WebApi } from 'azure-devops-node-api';
 import type { PluginEnvironment } from '../types';
 import Docker from 'dockerode';
 
@@ -43,98 +36,10 @@ export default async function createPlugin({
   templaters.register('cra', craTemplater);
 
   const preparers = await Preparers.fromConfig(config, { logger });
-
-  const publishers = new Publishers();
-
-  const githubConfig = config.getOptionalConfig('scaffolder.github');
-
-  if (githubConfig) {
-    try {
-      const repoVisibility = githubConfig.getString(
-        'visibility',
-      ) as RepoVisibilityOptions;
-
-      const githubToken = githubConfig.getString('token');
-      const githubHost =
-        githubConfig.getOptionalString('host') ?? 'https://github.com';
-      const githubClient = new Octokit({
-        auth: githubToken,
-        baseUrl: githubHost,
-      });
-      const githubPublisher = new GithubPublisher({
-        client: githubClient,
-        token: githubToken,
-        repoVisibility,
-      });
-
-      publishers.register('file', githubPublisher);
-      publishers.register('github', githubPublisher);
-    } catch (e) {
-      const providerName = 'github';
-      if (process.env.NODE_ENV !== 'development') {
-        throw new Error(
-          `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
-        );
-      }
-
-      logger.warn(
-        `Skipping ${providerName} scaffolding provider, ${e.message}`,
-      );
-    }
-  }
-
-  const gitLabConfig = config.getOptionalConfig('scaffolder.gitlab.api');
-  if (gitLabConfig) {
-    try {
-      const gitLabToken = gitLabConfig.getString('token');
-      const gitLabClient = new Gitlab({
-        host: gitLabConfig.getOptionalString('baseUrl'),
-        token: gitLabToken,
-      });
-      const gitLabPublisher = new GitlabPublisher(gitLabClient, gitLabToken);
-      publishers.register('gitlab', gitLabPublisher);
-      publishers.register('gitlab/api', gitLabPublisher);
-    } catch (e) {
-      const providerName = 'gitlab';
-      if (process.env.NODE_ENV !== 'development') {
-        throw new Error(
-          `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
-        );
-      }
-
-      logger.warn(
-        `Skipping ${providerName} scaffolding provider, ${e.message}`,
-      );
-    }
-  }
-
-  const azureConfig = config.getOptionalConfig('scaffolder.azure');
-  if (azureConfig) {
-    try {
-      const baseUrl = azureConfig.getString('baseUrl');
-      const azureToken = azureConfig.getConfig('api').getString('token');
-
-      const authHandler = getPersonalAccessTokenHandler(azureToken);
-      const webApi = new WebApi(baseUrl, authHandler);
-      const azureClient = await webApi.getGitApi();
-
-      const azurePublisher = new AzurePublisher(azureClient, azureToken);
-      publishers.register('azure/api', azurePublisher);
-    } catch (e) {
-      const providerName = 'azure';
-      if (process.env.NODE_ENV !== 'development') {
-        throw new Error(
-          `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
-        );
-      }
-
-      logger.warn(
-        `Skipping ${providerName} scaffolding provider, ${e.message}`,
-      );
-    }
-  }
+  const publishers = await Publishers.fromConfig(config, { logger });
 
   const dockerClient = new Docker();
+
   return await createRouter({
     preparers,
     templaters,

plugins/scaffolder-backend/src/scaffolder/stages/publish/publishers.ts

@@ -14,26 +14,146 @@
  * limitations under the License.
  */
 
+import { Logger } from 'winston';
+import { Octokit } from '@octokit/rest';
+import { Gitlab } from '@gitbeaker/node';
+import { getPersonalAccessTokenHandler, WebApi } from 'azure-devops-node-api';
+import { Config } from '@backstage/config';
 import { TemplateEntityV1alpha1 } from '@backstage/catalog-model';
-import { parseLocationAnnotation } from '../helpers';
+import {
+  DeprecatedLocationTypeDetector,
+  makeDeprecatedLocationTypeDetector,
+  parseLocationAnnotation,
+} from '../helpers';
 import { PublisherBase, PublisherBuilder } from './types';
 import { RemoteProtocol } from '../types';
+import { GithubPublisher, RepoVisibilityOptions } from './github';
+import { GitlabPublisher } from './gitlab';
+import { AzurePublisher } from './azure';
 
 export class Publishers implements PublisherBuilder {
   private publisherMap = new Map<RemoteProtocol, PublisherBase>();
 
+  constructor(private readonly typeDetector?: DeprecatedLocationTypeDetector) {}
+
   register(protocol: RemoteProtocol, publisher: PublisherBase) {
     this.publisherMap.set(protocol, publisher);
   }
 
   get(template: TemplateEntityV1alpha1): PublisherBase {
-    const { protocol } = parseLocationAnnotation(template);
+    const { protocol, location } = parseLocationAnnotation(template);
     const publisher = this.publisherMap.get(protocol);
 
     if (!publisher) {
+      if ((protocol as string) === 'url') {
+        const type = this.typeDetector?.(location);
+        const publisher2 =
+          type && this.publisherMap.get(type as RemoteProtocol);
+        if (publisher2) {
+          return publisher2;
+        }
+        throw new Error(`No preparer integration found for url "${location}"`);
+      }
       throw new Error(`No publisher registered for type: "${protocol}"`);
     }
 
     return publisher;
   }
+
+  static async fromConfig(
+    config: Config,
+    { logger }: { logger: Logger },
+  ): Promise<PublisherBuilder> {
+    const typeDetector = makeDeprecatedLocationTypeDetector(config);
+    const publishers = new Publishers(typeDetector);
+
+    const githubConfig = config.getOptionalConfig('scaffolder.github');
+    if (githubConfig) {
+      try {
+        const repoVisibility = githubConfig.getString(
+          'visibility',
+        ) as RepoVisibilityOptions;
+
+        const githubToken = githubConfig.getString('token');
+        const githubHost =
+          githubConfig.getOptionalString('host') ?? 'https://github.com';
+        const githubClient = new Octokit({
+          auth: githubToken,
+          baseUrl: githubHost,
+        });
+        const githubPublisher = new GithubPublisher({
+          client: githubClient,
+          token: githubToken,
+          repoVisibility,
+        });
+
+        publishers.register('file', githubPublisher);
+        publishers.register('github', githubPublisher);
+      } catch (e) {
+        const providerName = 'github';
+        if (process.env.NODE_ENV !== 'development') {
+          throw new Error(
+            `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
+          );
+        }
+
+        logger.warn(
+          `Skipping ${providerName} scaffolding provider, ${e.message}`,
+        );
+      }
+    }
+
+    const gitLabConfig = config.getOptionalConfig('scaffolder.gitlab.api');
+    if (gitLabConfig) {
+      try {
+        const gitLabToken = gitLabConfig.getString('token');
+        const gitLabClient = new Gitlab({
+          host: gitLabConfig.getOptionalString('baseUrl'),
+          token: gitLabToken,
+        });
+        const gitLabPublisher = new GitlabPublisher(gitLabClient, gitLabToken);
+        publishers.register('gitlab', gitLabPublisher);
+        publishers.register('gitlab/api', gitLabPublisher);
+      } catch (e) {
+        const providerName = 'gitlab';
+        if (process.env.NODE_ENV !== 'development') {
+          throw new Error(
+            `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
+          );
+        }
+
+        logger.warn(
+          `Skipping ${providerName} scaffolding provider, ${e.message}`,
+        );
+      }
+    }
+
+    const azureConfig = config.getOptionalConfig('scaffolder.azure');
+    if (azureConfig) {
+      try {
+        const baseUrl = azureConfig.getString('baseUrl');
+        const azureToken = azureConfig.getConfig('api').getString('token');
+
+        const authHandler = getPersonalAccessTokenHandler(azureToken);
+        const webApi = new WebApi(baseUrl, authHandler);
+        const azureClient = await webApi.getGitApi();
+
+        const azurePublisher = new AzurePublisher(azureClient, azureToken);
+        publishers.register('azure/api', azurePublisher);
+      } catch (e) {
+        const providerName = 'azure';
+        if (process.env.NODE_ENV !== 'development') {
+          throw new Error(
+            `Failed to initialize ${providerName} scaffolding provider, ${e.message}`,
+          );
+        }
+
+        logger.warn(
+          `Skipping ${providerName} scaffolding provider, ${e.message}`,
+        );
+      }
+    }
+
+    return publishers;
+  }
 }