@backstage/plugin-catalog-backend-module-github 0.6.1-next.2 → 0.6.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @backstage/plugin-catalog-backend-module-github
 
+## 0.6.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.5.24-next.0
+  - @backstage/backend-common@0.22.1-next.0
+  - @backstage/plugin-catalog-backend@1.23.0-next.0
+  - @backstage/plugin-events-node@0.3.5-next.0
+  - @backstage/backend-plugin-api@0.6.19-next.0
+  - @backstage/plugin-catalog-node@1.12.1-next.0
+  - @backstage/catalog-client@1.6.5
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/integration@1.11.0
+  - @backstage/plugin-catalog-common@1.0.23
+
+## 0.6.1
+
+### Patch Changes
+
+- 0b50143: GitHub push events now schedule a refresh on entities that have a `refresh_key` matching the `catalogPath` config itself.
+  This allows to support a `catalogPath` configuration that uses glob patterns.
+- f2a2a83: Updated to use the new `catalogAnalysisExtensionPoint` API.
+- 5bdeaa7: Added `alwaysUseDefaultNamespace` option to `GithubMultiOrgEntityProvider`.
+
+  If set to true, the provider will use `default` as the namespace for all group entities. Groups with the same name across different orgs will be considered the same group.
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.12.0
+  - @backstage/plugin-catalog-backend@1.22.0
+  - @backstage/catalog-model@1.5.0
+  - @backstage/backend-common@0.22.0
+  - @backstage/backend-plugin-api@0.6.18
+  - @backstage/backend-tasks@0.5.23
+  - @backstage/plugin-events-node@0.3.4
+  - @backstage/integration@1.11.0
+  - @backstage/catalog-client@1.6.5
+  - @backstage/plugin-catalog-common@1.0.23
+
 ## 0.6.1-next.2
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-github",
-  "version": "0.6.1-next.2",
+  "version": "0.6.2-next.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var backendPluginApi = require('@backstage/backend-plugin-api');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
 var pluginEventsNode = require('@backstage/plugin-events-node');
-var GithubEntityProvider = require('./cjs/GithubEntityProvider-CiEweAnD.cjs.js');
+var GithubEntityProvider = require('./cjs/GithubEntityProvider-C-D2ftt3.cjs.js');
 require('@backstage/catalog-client');
 require('@backstage/integration');
 require('@octokit/rest');

package/dist/cjs/{GithubEntityProvider-CiEweAnD.cjs.js → GithubEntityProvider-C-D2ftt3.cjs.js}

@@ -36,18 +36,12 @@ function _interopNamespaceCompat(e) {
 var parseGitUrl__default = /*#__PURE__*/_interopDefaultCompat(parseGitUrl);
 var uuid__namespace = /*#__PURE__*/_interopNamespaceCompat(uuid);
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 class GithubLocationAnalyzer {
+  catalogClient;
+  githubCredentialsProvider;
+  integrations;
+  auth;
   constructor(options) {
-    __publicField$1(this, "catalogClient");
-    __publicField$1(this, "githubCredentialsProvider");
-    __publicField$1(this, "integrations");
-    __publicField$1(this, "auth");
     this.catalogClient = new catalogClient.CatalogClient({ discoveryApi: options.discovery });
     this.integrations = integration.ScmIntegrations.fromConfig(options.config);
     this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
@@ -59,7 +53,7 @@ class GithubLocationAnalyzer {
   }
   supports(url) {
     const integration = this.integrations.byUrl(url);
-    return (integration == null ? void 0 : integration.type) === "github";
+    return integration?.type === "github";
   }
   async analyze(options) {
     const { url, catalogFilename } = options;
@@ -185,21 +179,20 @@ function parseGithubOrgUrl(urlString) {
   throw new Error(`Expected a URL pointing to /<org>`);
 }
 function satisfiesTopicFilter(topics, topicFilter) {
-  var _a, _b, _c, _d;
   if (!topicFilter)
     return true;
   if (!topicFilter.include && !topicFilter.exclude)
     return true;
-  if (!((_a = topicFilter.include) == null ? void 0 : _a.length) && !((_b = topicFilter.exclude) == null ? void 0 : _b.length))
+  if (!topicFilter.include?.length && !topicFilter.exclude?.length)
     return true;
-  if (((_c = topicFilter.include) == null ? void 0 : _c.length) && !topicFilter.exclude) {
+  if (topicFilter.include?.length && !topicFilter.exclude) {
     for (const topic of topics) {
       if (topicFilter.include.includes(topic))
         return true;
     }
     return false;
   }
-  if (!topicFilter.include && ((_d = topicFilter.exclude) == null ? void 0 : _d.length)) {
+  if (!topicFilter.include && topicFilter.exclude?.length) {
     if (!topics.length)
       return true;
     for (const topic of topics) {
@@ -247,10 +240,9 @@ function satisfiesVisibilityFilter(visibilities, visibility) {
 }
 
 function withLocations(baseUrl, org, entity) {
-  var _a, _b;
-  const login = ((_a = entity.metadata.annotations) == null ? void 0 : _a[ANNOTATION_GITHUB_USER_LOGIN]) || entity.metadata.name;
+  const login = entity.metadata.annotations?.[ANNOTATION_GITHUB_USER_LOGIN] || entity.metadata.name;
   let team = entity.metadata.name;
-  const slug = (_b = entity.metadata.annotations) == null ? void 0 : _b[ANNOTATION_GITHUB_TEAM_SLUG];
+  const slug = entity.metadata.annotations?.[ANNOTATION_GITHUB_TEAM_SLUG];
   if (slug) {
     const [_, slugTeam] = splitTeamSlug(slug);
     team = slugTeam;
@@ -290,10 +282,7 @@ async function getOrganizationUsers(client, org, tokenType, userTransformer = de
     client,
     query,
     org,
-    (r) => {
-      var _a;
-      return (_a = r.organization) == null ? void 0 : _a.membersWithRole;
-    },
+    (r) => r.organization?.membersWithRole,
     userTransformer,
     {
       org,
@@ -353,10 +342,7 @@ async function getOrganizationTeams(client, org, teamTransformer = defaultOrgani
     client,
     query,
     org,
-    (r) => {
-      var _a;
-      return (_a = r.organization) == null ? void 0 : _a.teams;
-    },
+    (r) => r.organization?.teams,
     materialisedTeams,
     { org }
   );
@@ -420,10 +406,7 @@ async function getOrganizationTeamsFromUsers(client, org, userLogins, teamTransf
     client,
     query,
     org,
-    (r) => {
-      var _a;
-      return (_a = r.organization) == null ? void 0 : _a.teams;
-    },
+    (r) => r.organization?.teams,
     materialisedTeams,
     { org, userLogins }
   );
@@ -443,17 +426,13 @@ async function getOrganizationsFromUser(client, user) {
     client,
     query,
     "",
-    (r) => {
-      var _a;
-      return (_a = r.user) == null ? void 0 : _a.organizations;
-    },
+    (r) => r.user?.organizations,
     async (o) => o.login,
     { user }
   );
   return { orgs };
 }
 async function getOrganizationTeam(client, org, teamSlug, teamTransformer = defaultOrganizationTeamTransformer) {
-  var _a, _b;
   const query = `
   query teams($org: String!, $teamSlug: String!) {
       organization(login: $org) {
@@ -494,9 +473,9 @@ async function getOrganizationTeam(client, org, teamSlug, teamTransformer = defa
     org,
     teamSlug
   });
-  if (!((_a = response.organization) == null ? void 0 : _a.team))
+  if (!response.organization?.team)
     throw new Error(`Found no match for team ${teamSlug}`);
-  const team = await materialisedTeam((_b = response.organization) == null ? void 0 : _b.team, {
+  const team = await materialisedTeam(response.organization?.team, {
     query,
     client,
     org
@@ -555,10 +534,7 @@ async function getOrganizationRepositories(client, org, catalogPath) {
     client,
     query,
     org,
-    (r) => {
-      var _a;
-      return (_a = r.repositoryOwner) == null ? void 0 : _a.repositories;
-    },
+    (r) => r.repositoryOwner?.repositories,
     async (x) => x,
     { org, catalogPathRef }
   );
@@ -580,10 +556,7 @@ async function getTeamMembers(client, org, teamSlug) {
     client,
     query,
     org,
-    (r) => {
-      var _a, _b;
-      return (_b = (_a = r.organization) == null ? void 0 : _a.team) == null ? void 0 : _b.members;
-    },
+    (r) => r.organization?.team?.members,
     async (user) => user,
     { org, teamSlug }
   );
@@ -662,22 +635,21 @@ function readProviderConfigs(config) {
   });
 }
 function readProviderConfig(id, config) {
-  var _a, _b, _c, _d;
   const organization = config.getString("organization");
-  const catalogPath = (_a = config.getOptionalString("catalogPath")) != null ? _a : DEFAULT_CATALOG_PATH;
-  const host = (_b = config.getOptionalString("host")) != null ? _b : "github.com";
+  const catalogPath = config.getOptionalString("catalogPath") ?? DEFAULT_CATALOG_PATH;
+  const host = config.getOptionalString("host") ?? "github.com";
   const repositoryPattern = config.getOptionalString("filters.repository");
   const branchPattern = config.getOptionalString("filters.branch");
-  const allowForks = (_c = config.getOptionalBoolean("filters.allowForks")) != null ? _c : true;
-  const topicFilterInclude = config == null ? void 0 : config.getOptionalStringArray(
+  const allowForks = config.getOptionalBoolean("filters.allowForks") ?? true;
+  const topicFilterInclude = config?.getOptionalStringArray(
     "filters.topic.include"
   );
-  const topicFilterExclude = config == null ? void 0 : config.getOptionalStringArray(
+  const topicFilterExclude = config?.getOptionalStringArray(
     "filters.topic.exclude"
   );
-  const validateLocationsExist = (_d = config == null ? void 0 : config.getOptionalBoolean("validateLocationsExist")) != null ? _d : false;
+  const validateLocationsExist = config?.getOptionalBoolean("validateLocationsExist") ?? false;
   const catalogPathContainsWildcard = catalogPath.includes("*");
-  const visibilityFilterInclude = config == null ? void 0 : config.getOptionalStringArray("filters.visibility");
+  const visibilityFilterInclude = config?.getOptionalStringArray("filters.visibility");
   if (validateLocationsExist && catalogPathContainsWildcard) {
     throw Error(
       `Error while processing GitHub provider config. The catalog path ${catalogPath} contains a wildcard, which is incompatible with validation of locations existing before emitting them. Ensure that validateLocationsExist is set to false.`
@@ -714,38 +686,21 @@ function compileRegExp(pattern) {
   return new RegExp(fullLinePattern);
 }
 
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 const TOPIC_REPO_PUSH = "github.push";
 class GithubEntityProvider {
-  constructor(config, integration$1, logger, taskRunner, events) {
-    __publicField(this, "config");
-    __publicField(this, "events");
-    __publicField(this, "logger");
-    __publicField(this, "integration");
-    __publicField(this, "scheduleFn");
-    __publicField(this, "connection");
-    __publicField(this, "githubCredentialsProvider");
-    this.config = config;
-    this.events = events;
-    this.integration = integration$1.config;
-    this.logger = logger.child({
-      target: this.getProviderName()
-    });
-    this.scheduleFn = this.createScheduleFn(taskRunner);
-    this.githubCredentialsProvider = integration.SingleInstanceGithubCredentialsProvider.create(integration$1.config);
-  }
+  config;
+  events;
+  logger;
+  integration;
+  scheduleFn;
+  connection;
+  githubCredentialsProvider;
   static fromConfig(config, options) {
     if (!options.schedule && !options.scheduler) {
       throw new Error("Either schedule or scheduler must be provided.");
     }
     const integrations = integration.ScmIntegrations.fromConfig(config);
     return readProviderConfigs(config).map((providerConfig) => {
-      var _a;
       const integrationHost = providerConfig.host;
       const integration = integrations.github.byHost(integrationHost);
       if (!integration) {
@@ -758,7 +713,7 @@ class GithubEntityProvider {
           `No schedule provided neither via code nor config for github-provider:${providerConfig.id}.`
         );
       }
-      const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
+      const taskRunner = options.schedule ?? options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
       return new GithubEntityProvider(
         providerConfig,
         integration,
@@ -768,19 +723,28 @@ class GithubEntityProvider {
       );
     });
   }
+  constructor(config, integration$1, logger, taskRunner, events) {
+    this.config = config;
+    this.events = events;
+    this.integration = integration$1.config;
+    this.logger = logger.child({
+      target: this.getProviderName()
+    });
+    this.scheduleFn = this.createScheduleFn(taskRunner);
+    this.githubCredentialsProvider = integration.SingleInstanceGithubCredentialsProvider.create(integration$1.config);
+  }
   /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
   getProviderName() {
     return `github-provider:${this.config.id}`;
   }
   /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
   async connect(connection) {
-    var _a;
     this.connection = connection;
-    await ((_a = this.events) == null ? void 0 : _a.subscribe({
+    await this.events?.subscribe({
       id: this.getProviderName(),
       topics: [TOPIC_REPO_PUSH],
       onEvent: (params) => this.onEvent(params)
-    }));
+    });
     return await this.scheduleFn();
   }
   createScheduleFn(taskRunner) {
@@ -841,15 +805,14 @@ class GithubEntityProvider {
     });
     const { repositories: repositoriesFromGithub } = await getOrganizationRepositories(client, organization, catalogPath);
     const repositories = repositoriesFromGithub.map((r) => {
-      var _a, _b;
       return {
         url: r.url,
         name: r.name,
-        defaultBranchRef: (_a = r.defaultBranchRef) == null ? void 0 : _a.name,
+        defaultBranchRef: r.defaultBranchRef?.name,
         repositoryTopics: r.repositoryTopics.nodes.map((t) => t.topic.name),
         isArchived: r.isArchived,
         isFork: r.isFork,
-        isCatalogInfoFilePresent: ((_b = r.catalogInfoFile) == null ? void 0 : _b.__typename) === "Blob" && r.catalogInfoFile.text !== "",
+        isCatalogInfoFilePresent: r.catalogInfoFile?.__typename === "Blob" && r.catalogInfoFile.text !== "",
         visibility: r.visibility
       };
     });
@@ -861,11 +824,10 @@ class GithubEntityProvider {
     return repositories;
   }
   matchesFilters(repositories) {
-    var _a, _b, _c, _d, _e, _f;
-    const repositoryFilter = (_a = this.config.filters) == null ? void 0 : _a.repository;
-    const topicFilters = (_b = this.config.filters) == null ? void 0 : _b.topic;
-    const allowForks = (_d = (_c = this.config.filters) == null ? void 0 : _c.allowForks) != null ? _d : true;
-    const visibilities = (_f = (_e = this.config.filters) == null ? void 0 : _e.visibility) != null ? _f : [];
+    const repositoryFilter = this.config.filters?.repository;
+    const topicFilters = this.config.filters?.topic;
+    const allowForks = this.config.filters?.allowForks ?? true;
+    const visibilities = this.config.filters?.visibility ?? [];
     const matchingRepositories = repositories.filter((r) => {
       const repoTopics = r.repositoryTopics;
       return !r.isArchived && (!repositoryFilter || repositoryFilter.test(r.name)) && satisfiesTopicFilter(repoTopics, topicFilters) && satisfiesForkFilter(allowForks, r.isFork) && satisfiesVisibilityFilter(visibilities, r.visibility) && r.defaultBranchRef;
@@ -873,8 +835,7 @@ class GithubEntityProvider {
     return matchingRepositories;
   }
   createLocationUrl(repository) {
-    var _a;
-    const branch = ((_a = this.config.filters) == null ? void 0 : _a.branch) || repository.defaultBranchRef || "-";
+    const branch = this.config.filters?.branch || repository.defaultBranchRef || "-";
     const catalogFile = this.config.catalogPath.startsWith("/") ? this.config.catalogPath.substring(1) : this.config.catalogPath;
     return `${repository.url}/blob/${branch}/${catalogFile}`;
   }
@@ -898,7 +859,6 @@ class GithubEntityProvider {
     return [TOPIC_REPO_PUSH];
   }
   async onRepoPush(event) {
-    var _a;
     if (!this.connection) {
       throw new Error("Not initialized");
     }
@@ -911,7 +871,7 @@ class GithubEntityProvider {
     const repoName = event.repository.name;
     const repoUrl = event.repository.url;
     this.logger.debug(`handle github:push event for ${repoName} - ${repoUrl}`);
-    const branch = ((_a = this.config.filters) == null ? void 0 : _a.branch) || event.repository.default_branch;
+    const branch = this.config.filters?.branch || event.repository.default_branch;
     if (!event.ref.includes(branch)) {
       this.logger.debug(`skipping push event from ref ${event.ref}`);
       return;
@@ -1025,4 +985,4 @@ exports.getOrganizationsFromUser = getOrganizationsFromUser;
 exports.parseGithubOrgUrl = parseGithubOrgUrl;
 exports.splitTeamSlug = splitTeamSlug;
 exports.withLocations = withLocations;
-//# sourceMappingURL=GithubEntityProvider-CiEweAnD.cjs.js.map
+//# sourceMappingURL=GithubEntityProvider-C-D2ftt3.cjs.js.map