Remove circular dependencies

In reference to issue #5563 this does the initial work to remove
all the circular dependencies that we have encountered while
building backstage using bazel. The next step will be to implement
a method to catch these circular dependencies before they get
merged in

Signed-off-by: jrusso1020 <jrusso@brex.com>

packages/integration/src/ScmIntegrations.ts

@@ -20,11 +20,8 @@ import { BitbucketIntegration } from './bitbucket/BitbucketIntegration';
 import { GitHubIntegration } from './github/GitHubIntegration';
 import { GitLabIntegration } from './gitlab/GitLabIntegration';
 import { defaultScmResolveUrl } from './helpers';
-import {
-  ScmIntegration,
-  ScmIntegrationRegistry,
-  ScmIntegrationsGroup,
-} from './types';
+import { ScmIntegration, ScmIntegrationsGroup } from './types';
+import { ScmIntegrationRegistry } from './registry';
 
 type IntegrationsByType = {
   azure: ScmIntegrationsGroup<AzureIntegration>;

packages/integration/src/index.ts

@@ -21,8 +21,5 @@ export * from './gitlab';
 export * from './googleGcs';
 export { defaultScmResolveUrl } from './helpers';
 export { ScmIntegrations } from './ScmIntegrations';
-export type {
-  ScmIntegration,
-  ScmIntegrationRegistry,
-  ScmIntegrationsGroup,
-} from './types';
+export type { ScmIntegration, ScmIntegrationsGroup } from './types';
+export type { ScmIntegrationRegistry } from './registry';

packages/integration/src/registry.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ScmIntegration, ScmIntegrationsGroup } from './types';
+import { AzureIntegration } from './azure/AzureIntegration';
+import { BitbucketIntegration } from './bitbucket/BitbucketIntegration';
+import { GitHubIntegration } from './github/GitHubIntegration';
+import { GitLabIntegration } from './gitlab/GitLabIntegration';
+
+/**
+ * Holds all registered SCM integrations, of all types.
+ */
+export interface ScmIntegrationRegistry
+  extends ScmIntegrationsGroup<ScmIntegration> {
+  azure: ScmIntegrationsGroup<AzureIntegration>;
+  bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
+  github: ScmIntegrationsGroup<GitHubIntegration>;
+  gitlab: ScmIntegrationsGroup<GitLabIntegration>;
+
+  /**
+   * Resolves an absolute or relative URL in relation to a base URL.
+   *
+   * This method is adapted for use within SCM systems, so relative URLs are
+   * within the context of the root of the hierarchy pointed to by the base
+   * URL.
+   *
+   * For example, if the base URL is  `<repo root url>/folder/a.yaml`, i.e.
+   * within the file tree of a certain repo, an absolute path of `/b.yaml` does
+   * not resolve to `https://hostname/b.yaml` but rather to
+   * `<repo root url>/b.yaml` inside the file tree of that same repo.
+   *
+   * @param options.url The (absolute or relative) URL or path to resolve
+   * @param options.base The base URL onto which this resolution happens
+   * @param options.lineNumber The line number in the target file to link to, starting with 1. Only applicable when linking to files.
+   */
+  resolveUrl(options: {
+    url: string;
+    base: string;
+    lineNumber?: number;
+  }): string;
+
+  /**
+   * Resolves the edit URL for a file within the SCM system.
+   *
+   * Most SCM systems have a web interface that allows viewing and editing files
+   * in the repository. The returned URL directly jumps into the edit mode for
+   * the file.
+   * If this is not possible, the integration can fall back to a URL to view
+   * the file in the web interface.
+   *
+   * @param url The absolute URL to the file that should be edited.
+   */
+  resolveEditUrl(url: string): string;
+}

packages/integration/src/types.ts

@@ -15,10 +15,6 @@
  */
 
 import { Config } from '@backstage/config';
-import { AzureIntegration } from './azure/AzureIntegration';
-import { BitbucketIntegration } from './bitbucket/BitbucketIntegration';
-import { GitHubIntegration } from './github/GitHubIntegration';
-import { GitLabIntegration } from './gitlab/GitLabIntegration';
 
 /**
  * Encapsulates a single SCM integration.
@@ -95,52 +91,6 @@ export interface ScmIntegrationsGroup<T extends ScmIntegration> {
   byHost(host: string): T | undefined;
 }
 
-/**
- * Holds all registered SCM integrations, of all types.
- */
-export interface ScmIntegrationRegistry
-  extends ScmIntegrationsGroup<ScmIntegration> {
-  azure: ScmIntegrationsGroup<AzureIntegration>;
-  bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
-  github: ScmIntegrationsGroup<GitHubIntegration>;
-  gitlab: ScmIntegrationsGroup<GitLabIntegration>;
-
-  /**
-   * Resolves an absolute or relative URL in relation to a base URL.
-   *
-   * This method is adapted for use within SCM systems, so relative URLs are
-   * within the context of the root of the hierarchy pointed to by the base
-   * URL.
-   *
-   * For example, if the base URL is  `<repo root url>/folder/a.yaml`, i.e.
-   * within the file tree of a certain repo, an absolute path of `/b.yaml` does
-   * not resolve to `https://hostname/b.yaml` but rather to
-   * `<repo root url>/b.yaml` inside the file tree of that same repo.
-   *
-   * @param options.url The (absolute or relative) URL or path to resolve
-   * @param options.base The base URL onto which this resolution happens
-   * @param options.lineNumber The line number in the target file to link to, starting with 1. Only applicable when linking to files.
-   */
-  resolveUrl(options: {
-    url: string;
-    base: string;
-    lineNumber?: number;
-  }): string;
-
-  /**
-   * Resolves the edit URL for a file within the SCM system.
-   *
-   * Most SCM systems have a web interface that allows viewing and editing files
-   * in the repository. The returned URL directly jumps into the edit mode for
-   * the file.
-   * If this is not possible, the integration can fall back to a URL to view
-   * the file in the web interface.
-   *
-   * @param url The absolute URL to the file that should be edited.
-   */
-  resolveEditUrl(url: string): string;
-}
-
 export type ScmIntegrationsFactory<T extends ScmIntegration> = (options: {
   config: Config;
 }) => ScmIntegrationsGroup<T>;