@backstage/plugin-catalog-backend-module-github 0.4.0-next.3 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @backstage/plugin-catalog-backend-module-github
 
+## 0.4.0
+
+### Minor Changes
+
+- fa7004d9722c: Added a `catalogModuleGithubOrgEntityProvider` for the new backend system
+
+### Patch Changes
+
+- 71114ac50e02: The export for the new backend system has been moved to be the `default` export.
+
+  For example, if you are currently importing the plugin using the following pattern:
+
+  ```ts
+  import { examplePlugin } from '@backstage/plugin-example-backend';
+
+  backend.add(examplePlugin);
+  ```
+
+  It should be migrated to this:
+
+  ```ts
+  backend.add(import('@backstage/plugin-example-backend'));
+  ```
+
+- 3d63e60f3c36: Internal restructure to avoid circular imports
+- 96353bb7cb4a: Properly support custom `userTransformer` returning `undefined` in `GithubMultiOrgEntityProvider`
+- 3c44761b9191: Allow github user and team transforms to return any Entity
+- Updated dependencies
+  - @backstage/plugin-catalog-backend@1.13.0
+  - @backstage/backend-tasks@0.5.8
+  - @backstage/backend-common@0.19.5
+  - @backstage/config@1.1.0
+  - @backstage/catalog-client@1.4.4
+  - @backstage/catalog-model@1.4.2
+  - @backstage/errors@1.2.2
+  - @backstage/integration@1.7.0
+  - @backstage/plugin-catalog-common@1.0.16
+  - @backstage/types@1.1.1
+  - @backstage/backend-plugin-api@0.6.3
+  - @backstage/plugin-catalog-node@1.4.4
+  - @backstage/plugin-events-node@0.2.12
+
 ## 0.4.0-next.3
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-github",
-  "version": "0.4.0-next.3",
+  "version": "0.4.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 backendCommon = require('@backstage/backend-common');
 var alpha = require('@backstage/plugin-catalog-node/alpha');
-var GithubEntityProvider = require('./cjs/GithubEntityProvider-9bc718e3.cjs.js');
+var GithubEntityProvider = require('./cjs/GithubEntityProvider-656c132f.cjs.js');
 var backendTasks = require('@backstage/backend-tasks');
 var pluginCatalogBackendModuleGithub = require('@backstage/plugin-catalog-backend-module-github');
 require('@backstage/integration');

package/dist/cjs/{GithubEntityProvider-9bc718e3.cjs.js → GithubEntityProvider-656c132f.cjs.js}

@@ -93,56 +93,6 @@ const defaultOrganizationTeamTransformer = async (team) => {
   return entity;
 };
 
-function buildOrgHierarchy(groups) {
-  const groupsByName = new Map(groups.map((g) => [g.metadata.name, g]));
-  for (const group of groups) {
-    const selfName = group.metadata.name;
-    const parentName = group.spec.parent;
-    if (parentName) {
-      const parent = groupsByName.get(parentName);
-      if (parent && !parent.spec.children.includes(selfName)) {
-        parent.spec.children.push(selfName);
-      }
-    }
-  }
-  for (const group of groups) {
-    const selfName = group.metadata.name;
-    for (const childName of group.spec.children) {
-      const child = groupsByName.get(childName);
-      if (child && !child.spec.parent) {
-        child.spec.parent = selfName;
-      }
-    }
-  }
-}
-function assignGroupsToUsers(users, groups) {
-  var _a;
-  const groupMemberUsers = new Map(
-    groups.map((group) => {
-      var _a2;
-      const groupKey = group.metadata.namespace && group.metadata.namespace !== catalogModel.DEFAULT_NAMESPACE ? `${group.metadata.namespace}/${group.metadata.name}` : group.metadata.name;
-      return [
-        groupKey,
-        ((_a2 = group.spec.members) == null ? void 0 : _a2.map(
-          (m) => catalogModel.stringifyEntityRef(catalogModel.parseEntityRef(m, { defaultKind: "user" }))
-        )) || []
-      ];
-    })
-  );
-  const usersByRef = new Map(users.map((u) => [catalogModel.stringifyEntityRef(u), u]));
-  for (const [groupName, userRefs] of groupMemberUsers.entries()) {
-    for (const ref of userRefs) {
-      const user = usersByRef.get(ref);
-      if (user && !((_a = user.spec.memberOf) == null ? void 0 : _a.includes(groupName))) {
-        if (!user.spec.memberOf) {
-          user.spec.memberOf = [];
-        }
-        user.spec.memberOf.push(groupName);
-      }
-    }
-  }
-}
-
 function parseGithubOrgUrl(urlString) {
   const path = new URL(urlString).pathname.slice(1).split("/");
   if (path.length === 1 && path[0].length) {
@@ -212,395 +162,6 @@ function satisfiesVisibilityFilter(visibilities, visibility) {
   return lowerCaseVisibilities.includes(lowerCaseVisibility);
 }
 
-function areGroupEntities(entities) {
-  return entities.every((e) => catalogModel.isGroupEntity(e));
-}
-function areUserEntities(entities) {
-  return entities.every((e) => catalogModel.isUserEntity(e));
-}
-
-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 GithubOrgEntityProvider {
-  constructor(options) {
-    this.options = options;
-    __publicField$1(this, "credentialsProvider");
-    __publicField$1(this, "connection");
-    __publicField$1(this, "scheduleFn");
-    this.credentialsProvider = options.githubCredentialsProvider || integration.SingleInstanceGithubCredentialsProvider.create(this.options.gitHubConfig);
-  }
-  static fromConfig(config, options) {
-    var _a;
-    const integrations = integration.ScmIntegrations.fromConfig(config);
-    const gitHubConfig = (_a = integrations.github.byUrl(options.orgUrl)) == null ? void 0 : _a.config;
-    if (!gitHubConfig) {
-      throw new Error(
-        `There is no GitHub Org provider that matches ${options.orgUrl}. Please add a configuration for an integration.`
-      );
-    }
-    const logger = options.logger.child({
-      target: options.orgUrl
-    });
-    const provider = new GithubOrgEntityProvider({
-      id: options.id,
-      orgUrl: options.orgUrl,
-      logger,
-      gitHubConfig,
-      githubCredentialsProvider: options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations),
-      userTransformer: options.userTransformer,
-      teamTransformer: options.teamTransformer
-    });
-    provider.schedule(options.schedule);
-    return provider;
-  }
-  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
-  getProviderName() {
-    return `GithubOrgEntityProvider:${this.options.id}`;
-  }
-  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
-  async connect(connection) {
-    var _a;
-    this.connection = connection;
-    await ((_a = this.scheduleFn) == null ? void 0 : _a.call(this));
-  }
-  /**
-   * Runs one single complete ingestion. This is only necessary if you use
-   * manual scheduling.
-   */
-  async read(options) {
-    var _a;
-    if (!this.connection) {
-      throw new Error("Not initialized");
-    }
-    const logger = (_a = options == null ? void 0 : options.logger) != null ? _a : this.options.logger;
-    const { markReadComplete } = trackProgress(logger);
-    const { headers, type: tokenType } = await this.credentialsProvider.getCredentials({
-      url: this.options.orgUrl
-    });
-    const client = graphql.graphql.defaults({
-      baseUrl: this.options.gitHubConfig.apiBaseUrl,
-      headers
-    });
-    const { org } = parseGithubOrgUrl(this.options.orgUrl);
-    const { users } = await getOrganizationUsers(
-      client,
-      org,
-      tokenType,
-      this.options.userTransformer
-    );
-    const { teams } = await getOrganizationTeams(
-      client,
-      org,
-      this.options.teamTransformer
-    );
-    if (areGroupEntities(teams)) {
-      buildOrgHierarchy(teams);
-      if (areUserEntities(users)) {
-        assignGroupsToUsers(users, teams);
-      }
-    }
-    const { markCommitComplete } = markReadComplete({ users, teams });
-    await this.connection.applyMutation({
-      type: "full",
-      entities: [...users, ...teams].map((entity) => ({
-        locationKey: `github-org-provider:${this.options.id}`,
-        entity: withLocations(
-          `https://${this.options.gitHubConfig.host}`,
-          org,
-          entity
-        )
-      }))
-    });
-    markCommitComplete();
-  }
-  /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.onEvent} */
-  async onEvent(params) {
-    const { logger } = this.options;
-    logger.debug(`Received event from ${params.topic}`);
-    const addEntitiesOperation = createAddEntitiesOperation(
-      this.options.id,
-      this.options.gitHubConfig.host
-    );
-    const removeEntitiesOperation = createRemoveEntitiesOperation(
-      this.options.id,
-      this.options.gitHubConfig.host
-    );
-    const replaceEntitiesOperation = createReplaceEntitiesOperation(
-      this.options.id,
-      this.options.gitHubConfig.host
-    );
-    if (params.topic.includes("organization")) {
-      const orgEvent = params.eventPayload;
-      if (orgEvent.action === "member_added" || orgEvent.action === "member_removed") {
-        const createDeltaOperation = orgEvent.action === "member_added" ? addEntitiesOperation : removeEntitiesOperation;
-        await this.onMemberChangeInOrganization(orgEvent, createDeltaOperation);
-      }
-    }
-    if (params.topic.includes("team")) {
-      const teamEvent = params.eventPayload;
-      if (teamEvent.action === "created" || teamEvent.action === "deleted") {
-        const createDeltaOperation = teamEvent.action === "created" ? addEntitiesOperation : removeEntitiesOperation;
-        await this.onTeamChangeInOrganization(teamEvent, createDeltaOperation);
-      } else if (teamEvent.action === "edited") {
-        await this.onTeamEditedInOrganization(
-          teamEvent,
-          replaceEntitiesOperation
-        );
-      }
-    }
-    if (params.topic.includes("membership")) {
-      const membershipEvent = params.eventPayload;
-      this.onMembershipChangedInOrganization(
-        membershipEvent,
-        replaceEntitiesOperation
-      );
-    }
-    return;
-  }
-  /** {@inheritdoc @backstage/plugin-events-node#EventSubscriber.supportsEventTopics} */
-  supportsEventTopics() {
-    return ["github.organization", "github.team", "github.membership"];
-  }
-  async onTeamEditedInOrganization(event, createDeltaOperation) {
-    var _a, _b;
-    if (!this.connection) {
-      throw new Error("Not initialized");
-    }
-    const teamSlug = event.team.slug;
-    const { headers, type: tokenType } = await this.credentialsProvider.getCredentials({
-      url: this.options.orgUrl
-    });
-    const client = graphql.graphql.defaults({
-      baseUrl: this.options.gitHubConfig.apiBaseUrl,
-      headers
-    });
-    const { org } = parseGithubOrgUrl(this.options.orgUrl);
-    const { team } = await getOrganizationTeam(
-      client,
-      org,
-      teamSlug,
-      this.options.teamTransformer
-    );
-    const { users } = await getOrganizationUsers(
-      client,
-      org,
-      tokenType,
-      this.options.userTransformer
-    );
-    if (!catalogModel.isGroupEntity(team)) {
-      return;
-    }
-    const usersFromChangedGroup = team.spec.members || [];
-    const usersToRebuild = users.filter(
-      (u) => usersFromChangedGroup.includes(u.metadata.name)
-    );
-    const { teams } = await getOrganizationTeamsFromUsers(
-      client,
-      org,
-      usersToRebuild.map((u) => u.metadata.name),
-      this.options.teamTransformer
-    );
-    if (areGroupEntities(teams)) {
-      buildOrgHierarchy(teams);
-      if (areUserEntities(usersToRebuild)) {
-        assignGroupsToUsers(usersToRebuild, teams);
-      }
-    }
-    const oldName = ((_a = event.changes.name) == null ? void 0 : _a.from) || event.team.name;
-    const oldSlug = oldName.toLowerCase().replaceAll(/\s/gi, "-");
-    const oldDescription = ((_b = event.changes.description) == null ? void 0 : _b.from) || event.team.description;
-    const oldDescriptionSlug = oldDescription == null ? void 0 : oldDescription.toLowerCase().replaceAll(/\s/gi, "-");
-    const { removed } = createDeltaOperation(org, [
-      {
-        ...team,
-        metadata: {
-          name: oldSlug,
-          description: oldDescriptionSlug
-        }
-      }
-    ]);
-    const { added } = createDeltaOperation(org, [...usersToRebuild, ...teams]);
-    await this.connection.applyMutation({
-      type: "delta",
-      removed,
-      added
-    });
-  }
-  async onMembershipChangedInOrganization(event, createDeltaOperation) {
-    if (!this.connection) {
-      throw new Error("Not initialized");
-    }
-    if (!("slug" in event.team)) {
-      return;
-    }
-    const teamSlug = event.team.slug;
-    const userLogin = event.member.login;
-    const { headers, type: tokenType } = await this.credentialsProvider.getCredentials({
-      url: this.options.orgUrl
-    });
-    const client = graphql.graphql.defaults({
-      baseUrl: this.options.gitHubConfig.apiBaseUrl,
-      headers
-    });
-    const { org } = parseGithubOrgUrl(this.options.orgUrl);
-    const { team } = await getOrganizationTeam(
-      client,
-      org,
-      teamSlug,
-      this.options.teamTransformer
-    );
-    const { users } = await getOrganizationUsers(
-      client,
-      org,
-      tokenType,
-      this.options.userTransformer
-    );
-    const usersToRebuild = users.filter((u) => u.metadata.name === userLogin);
-    const { teams } = await getOrganizationTeamsFromUsers(
-      client,
-      org,
-      [userLogin],
-      this.options.teamTransformer
-    );
-    if (!teams.some((t) => t.metadata.name === team.metadata.name)) {
-      teams.push(team);
-    }
-    if (areGroupEntities(teams)) {
-      buildOrgHierarchy(teams);
-      if (areUserEntities(usersToRebuild)) {
-        assignGroupsToUsers(usersToRebuild, teams);
-      }
-    }
-    const { added, removed } = createDeltaOperation(org, [
-      ...usersToRebuild,
-      ...teams
-    ]);
-    await this.connection.applyMutation({
-      type: "delta",
-      removed,
-      added
-    });
-  }
-  async onTeamChangeInOrganization(event, createDeltaOperation) {
-    var _a, _b;
-    if (!this.connection) {
-      throw new Error("Not initialized");
-    }
-    const organizationTeamTransformer = this.options.teamTransformer || defaultOrganizationTeamTransformer;
-    const { name, html_url: url, description, slug } = event.team;
-    const org = event.organization.login;
-    const { headers } = await this.credentialsProvider.getCredentials({
-      url: this.options.orgUrl
-    });
-    const client = graphql.graphql.defaults({
-      baseUrl: this.options.gitHubConfig.apiBaseUrl,
-      headers
-    });
-    const group = await organizationTeamTransformer(
-      {
-        name,
-        slug,
-        editTeamUrl: `${url}/edit`,
-        combinedSlug: `${org}/${slug}`,
-        description: description || void 0,
-        parentTeam: { slug: ((_b = (_a = event.team) == null ? void 0 : _a.parent) == null ? void 0 : _b.slug) || "" },
-        // entity will be removed
-        members: []
-      },
-      {
-        org,
-        client,
-        query: ""
-      }
-    );
-    const { added, removed } = createDeltaOperation(org, [group]);
-    await this.connection.applyMutation({
-      type: "delta",
-      removed,
-      added
-    });
-  }
-  async onMemberChangeInOrganization(event, createDeltaOperation) {
-    if (!this.connection) {
-      throw new Error("Not initialized");
-    }
-    const userTransformer = this.options.userTransformer || defaultUserTransformer;
-    const { name, avatar_url: avatarUrl, email, login } = event.membership.user;
-    const org = event.organization.login;
-    const { headers } = await this.credentialsProvider.getCredentials({
-      url: this.options.orgUrl
-    });
-    const client = graphql.graphql.defaults({
-      baseUrl: this.options.gitHubConfig.apiBaseUrl,
-      headers
-    });
-    const user = await userTransformer(
-      {
-        name,
-        avatarUrl,
-        login,
-        email: email || void 0,
-        // we don't have this information in the event, so the refresh will handle that for us
-        organizationVerifiedDomainEmails: []
-      },
-      {
-        org,
-        client,
-        query: ""
-      }
-    );
-    const { added, removed } = createDeltaOperation(org, [user]);
-    await this.connection.applyMutation({
-      type: "delta",
-      removed,
-      added
-    });
-  }
-  schedule(schedule) {
-    if (!schedule || schedule === "manual") {
-      return;
-    }
-    this.scheduleFn = async () => {
-      const id = `${this.getProviderName()}:refresh`;
-      await schedule.run({
-        id,
-        fn: async () => {
-          const logger = this.options.logger.child({
-            class: GithubOrgEntityProvider.prototype.constructor.name,
-            taskId: id,
-            taskInstanceId: uuid__namespace.v4()
-          });
-          try {
-            await this.read({ logger });
-          } catch (error) {
-            logger.error(`${this.getProviderName()} refresh failed`, error);
-          }
-        }
-      });
-    };
-  }
-}
-function trackProgress(logger) {
-  let timestamp = Date.now();
-  let summary;
-  logger.info("Reading GitHub users and teams");
-  function markReadComplete(read) {
-    summary = `${read.users.length} GitHub users and ${read.teams.length} GitHub teams`;
-    const readDuration = ((Date.now() - timestamp) / 1e3).toFixed(1);
-    timestamp = Date.now();
-    logger.info(`Read ${summary} in ${readDuration} seconds. Committing...`);
-    return { markCommitComplete };
-  }
-  function markCommitComplete() {
-    const commitDuration = ((Date.now() - timestamp) / 1e3).toFixed(1);
-    logger.info(`Committed ${summary} in ${commitDuration} seconds.`);
-  }
-  return { markReadComplete };
-}
 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;
@@ -1349,11 +910,9 @@ class GithubEntityProvider {
 exports.ANNOTATION_GITHUB_TEAM_SLUG = ANNOTATION_GITHUB_TEAM_SLUG;
 exports.ANNOTATION_GITHUB_USER_LOGIN = ANNOTATION_GITHUB_USER_LOGIN;
 exports.GithubEntityProvider = GithubEntityProvider;
-exports.GithubOrgEntityProvider = GithubOrgEntityProvider;
-exports.areGroupEntities = areGroupEntities;
-exports.areUserEntities = areUserEntities;
-exports.assignGroupsToUsers = assignGroupsToUsers;
-exports.buildOrgHierarchy = buildOrgHierarchy;
+exports.createAddEntitiesOperation = createAddEntitiesOperation;
+exports.createRemoveEntitiesOperation = createRemoveEntitiesOperation;
+exports.createReplaceEntitiesOperation = createReplaceEntitiesOperation;
 exports.defaultOrganizationTeamTransformer = defaultOrganizationTeamTransformer;
 exports.defaultUserTransformer = defaultUserTransformer;
 exports.getOrganizationRepositories = getOrganizationRepositories;
@@ -1364,4 +923,5 @@ exports.getOrganizationUsers = getOrganizationUsers;
 exports.getOrganizationsFromUser = getOrganizationsFromUser;
 exports.parseGithubOrgUrl = parseGithubOrgUrl;
 exports.splitTeamSlug = splitTeamSlug;
-//# sourceMappingURL=GithubEntityProvider-9bc718e3.cjs.js.map
+exports.withLocations = withLocations;
+//# sourceMappingURL=GithubEntityProvider-656c132f.cjs.js.map