@backstage/plugin-catalog-backend 0.0.0-nightly-202201122931 → 0.0.0-nightly-202201323044

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @backstage/plugin-catalog-backend
 
-## 0.0.0-nightly-202201122931
+## 0.0.0-nightly-202201323044
 
 ### Minor Changes
 
@@ -11,20 +11,21 @@
 ### Patch Changes
 
 - 0ae759dad4: Add catalog permission rules.
+- 3b4d8caff6: Allow a custom GithubCredentialsProvider to be passed to the GitHub processors.
 - 5333451def: Cleaned up API exports
 - 730d01ab1a: Add apply-conditions endpoint for evaluating conditional permissions in catalog backend.
 - Updated dependencies
-  - @backstage/config@0.0.0-nightly-202201122931
-  - @backstage/plugin-permission-node@0.0.0-nightly-202201122931
-  - @backstage/backend-common@0.0.0-nightly-202201122931
-  - @backstage/integration@0.0.0-nightly-202201122931
-  - @backstage/errors@0.0.0-nightly-202201122931
-  - @backstage/catalog-client@0.0.0-nightly-202201122931
-  - @backstage/catalog-model@0.0.0-nightly-202201122931
-  - @backstage/search-common@0.0.0-nightly-202201122931
-  - @backstage/types@0.0.0-nightly-202201122931
-  - @backstage/plugin-catalog-common@0.0.0-nightly-202201122931
-  - @backstage/plugin-permission-common@0.0.0-nightly-202201122931
+  - @backstage/config@0.0.0-nightly-202201323044
+  - @backstage/integration@0.0.0-nightly-202201323044
+  - @backstage/backend-common@0.0.0-nightly-202201323044
+  - @backstage/plugin-permission-node@0.0.0-nightly-202201323044
+  - @backstage/errors@0.0.0-nightly-202201323044
+  - @backstage/catalog-client@0.0.0-nightly-202201323044
+  - @backstage/catalog-model@0.0.0-nightly-202201323044
+  - @backstage/search-common@0.0.0-nightly-202201323044
+  - @backstage/types@0.0.0-nightly-202201323044
+  - @backstage/plugin-catalog-common@0.0.0-nightly-202201323044
+  - @backstage/plugin-permission-common@0.0.0-nightly-202201323044
 
 ## 0.19.4
 

package/dist/index.cjs.js

@@ -1107,6 +1107,7 @@ class GithubDiscoveryProcessor {
   constructor(options) {
     this.integrations = options.integrations;
     this.logger = options.logger;
+    this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
   }
   async readLocation(location$1, _optional, emit) {
     var _a, _b;
@@ -1119,7 +1120,9 @@ class GithubDiscoveryProcessor {
     }
     const { org, repoSearchPath, catalogPath, branch, host } = parseUrl$2(location$1.target);
     const orgUrl = `https://${host}/${org}`;
-    const { headers } = await integration.SingleInstanceGithubCredentialsProvider.create(gitHubConfig).getCredentials({ url: orgUrl });
+    const { headers } = await this.githubCredentialsProvider.getCredentials({
+      url: orgUrl
+    });
     const client = graphql.graphql.defaults({
       baseUrl: gitHubConfig.apiBaseUrl,
       headers
@@ -1304,6 +1307,7 @@ class GithubOrgReaderProcessor {
   }
   constructor(options) {
     this.integrations = options.integrations;
+    this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
     this.logger = options.logger;
   }
   async readLocation(location, _optional, emit) {
@@ -1334,8 +1338,7 @@ class GithubOrgReaderProcessor {
     if (!gitHubConfig) {
       throw new Error(`There is no GitHub Org provider that matches ${orgUrl}. Please add a configuration for an integration.`);
     }
-    const credentialsProvider = integration.SingleInstanceGithubCredentialsProvider.create(gitHubConfig);
-    const { headers, type: tokenType } = await credentialsProvider.getCredentials({
+    const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
       url: orgUrl
     });
     const client = graphql.graphql.defaults({
@@ -1360,6 +1363,7 @@ class GithubMultiOrgReaderProcessor {
     this.integrations = options.integrations;
     this.logger = options.logger;
     this.orgs = options.orgs;
+    this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
   }
   async readLocation(location, _optional, emit) {
     var _a, _b;
@@ -1372,11 +1376,10 @@ class GithubMultiOrgReaderProcessor {
     }
     const allUsersMap = /* @__PURE__ */ new Map();
     const baseUrl = new URL(location.target).origin;
-    const credentialsProvider = integration.SingleInstanceGithubCredentialsProvider.create(gitHubConfig);
     const orgsToProcess = this.orgs.length ? this.orgs : await this.getAllOrgs(gitHubConfig);
     for (const orgConfig of orgsToProcess) {
       try {
-        const { headers, type: tokenType } = await credentialsProvider.getCredentials({
+        const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
           url: `${baseUrl}/${orgConfig.name}`
         });
         const client = graphql.graphql.defaults({
@@ -1842,7 +1845,7 @@ const defaultEntityDataParser = async function* defaultEntityDataParser2({ data,
 class GitHubOrgEntityProvider {
   constructor(options) {
     this.options = options;
-    this.credentialsProvider = integration.SingleInstanceGithubCredentialsProvider.create(options.gitHubConfig);
+    this.githubCredentialsProvider = options.githubCredentialsProvider || integration.SingleInstanceGithubCredentialsProvider.create(options.gitHubConfig);
   }
   static fromConfig(config, options) {
     var _a;
@@ -1858,7 +1861,8 @@ class GitHubOrgEntityProvider {
       id: options.id,
       orgUrl: options.orgUrl,
       logger,
-      gitHubConfig
+      gitHubConfig,
+      githubCredentialsProvider: options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations)
     });
   }
   getProviderName() {
@@ -1872,7 +1876,7 @@ class GitHubOrgEntityProvider {
       throw new Error("Not initialized");
     }
     const { markReadComplete } = trackProgress(this.options.logger);
-    const { headers, type: tokenType } = await this.credentialsProvider.getCredentials({
+    const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
       url: this.options.orgUrl
     });
     const client = graphql.graphql.defaults({
@@ -5104,12 +5108,19 @@ class NextCatalogBuilder {
   getDefaultProcessors() {
     const { config, logger, reader } = this.env;
     const integrations = integration.ScmIntegrations.fromConfig(config);
+    const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
     return [
       new FileReaderProcessor(),
       BitbucketDiscoveryProcessor.fromConfig(config, { logger }),
       AzureDevOpsDiscoveryProcessor.fromConfig(config, { logger }),
-      GithubDiscoveryProcessor.fromConfig(config, { logger }),
-      GithubOrgReaderProcessor.fromConfig(config, { logger }),
+      GithubDiscoveryProcessor.fromConfig(config, {
+        logger,
+        githubCredentialsProvider
+      }),
+      GithubOrgReaderProcessor.fromConfig(config, {
+        logger,
+        githubCredentialsProvider
+      }),
       GitLabDiscoveryProcessor.fromConfig(config, { logger }),
       new UrlReaderProcessor({ reader, logger }),
       CodeOwnersProcessor.fromConfig(config, { logger, reader }),
@@ -5314,6 +5325,7 @@ class CatalogBuilder {
   buildProcessors() {
     const { config, logger, reader } = this.env;
     const integrations = integration.ScmIntegrations.fromConfig(config);
+    const githubCredentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
     this.checkDeprecatedReaderProcessors();
     const placeholderResolvers = {
       json: jsonPlaceholderResolver,
@@ -5331,7 +5343,13 @@ class CatalogBuilder {
       new BuiltinKindsEntityProcessor()
     ];
     if (!this.processorsReplace) {
-      processors.push(new FileReaderProcessor(), BitbucketDiscoveryProcessor.fromConfig(config, { logger }), GithubDiscoveryProcessor.fromConfig(config, { logger }), AzureDevOpsDiscoveryProcessor.fromConfig(config, { logger }), GithubOrgReaderProcessor.fromConfig(config, { logger }), GitLabDiscoveryProcessor.fromConfig(config, { logger }), new UrlReaderProcessor({ reader, logger }), CodeOwnersProcessor.fromConfig(config, { logger, reader }), new LocationEntityProcessor({ integrations }), new AnnotateLocationEntityProcessor({ integrations }));
+      processors.push(new FileReaderProcessor(), BitbucketDiscoveryProcessor.fromConfig(config, { logger }), GithubDiscoveryProcessor.fromConfig(config, {
+        logger,
+        githubCredentialsProvider
+      }), AzureDevOpsDiscoveryProcessor.fromConfig(config, { logger }), GithubOrgReaderProcessor.fromConfig(config, {
+        logger,
+        githubCredentialsProvider
+      }), GitLabDiscoveryProcessor.fromConfig(config, { logger }), new UrlReaderProcessor({ reader, logger }), CodeOwnersProcessor.fromConfig(config, { logger, reader }), new LocationEntityProcessor({ integrations }), new AnnotateLocationEntityProcessor({ integrations }));
     }
     processors.push(...this.processors);
     return processors;