@backstage/plugin-catalog-backend-module-github 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,14 @@
1
+ # @backstage/plugin-catalog-backend-module-github
2
+
3
+ ## 0.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - d4934e19b1: Added package, moving out GitHub specific functionality from the catalog-backend
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies
12
+ - @backstage/backend-common@0.13.0
13
+ - @backstage/plugin-catalog-backend@0.24.0
14
+ - @backstage/catalog-model@0.13.0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2020 The Backstage Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,8 @@
1
+ # Catalog Backend Module for GitHub
2
+
3
+ This is an extension module to the plugin-catalog-backend plugin, providing extensions targeted at GitHub offerings.
4
+
5
+ ## Getting started
6
+
7
+ See [Backstage documentation](https://backstage.io/docs/integrations/github/discovery) for details on how to install
8
+ and configure the plugin.
@@ -0,0 +1,571 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var integration = require('@backstage/integration');
6
+ var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
7
+ var graphql = require('@octokit/graphql');
8
+ var catalogModel = require('@backstage/catalog-model');
9
+ var lodash = require('lodash');
10
+
11
+ function readGithubMultiOrgConfig(config) {
12
+ var _a;
13
+ const orgConfigs = (_a = config.getOptionalConfigArray("orgs")) != null ? _a : [];
14
+ return orgConfigs.map((c) => {
15
+ var _a2, _b;
16
+ return {
17
+ name: c.getString("name"),
18
+ groupNamespace: ((_a2 = c.getOptionalString("groupNamespace")) != null ? _a2 : c.getString("name")).toLowerCase(),
19
+ userNamespace: (_b = c.getOptionalString("userNamespace")) != null ? _b : void 0
20
+ };
21
+ });
22
+ }
23
+
24
+ async function getOrganizationUsers(client, org, tokenType, userNamespace) {
25
+ const query = `
26
+ query users($org: String!, $email: Boolean!, $cursor: String) {
27
+ organization(login: $org) {
28
+ membersWithRole(first: 100, after: $cursor) {
29
+ pageInfo { hasNextPage, endCursor }
30
+ nodes {
31
+ avatarUrl,
32
+ bio,
33
+ email @include(if: $email),
34
+ login,
35
+ name
36
+ }
37
+ }
38
+ }
39
+ }`;
40
+ const mapper = (user) => {
41
+ const entity = {
42
+ apiVersion: "backstage.io/v1alpha1",
43
+ kind: "User",
44
+ metadata: {
45
+ name: user.login,
46
+ annotations: {
47
+ "github.com/user-login": user.login
48
+ }
49
+ },
50
+ spec: {
51
+ profile: {},
52
+ memberOf: []
53
+ }
54
+ };
55
+ if (userNamespace)
56
+ entity.metadata.namespace = userNamespace;
57
+ if (user.bio)
58
+ entity.metadata.description = user.bio;
59
+ if (user.name)
60
+ entity.spec.profile.displayName = user.name;
61
+ if (user.email)
62
+ entity.spec.profile.email = user.email;
63
+ if (user.avatarUrl)
64
+ entity.spec.profile.picture = user.avatarUrl;
65
+ return entity;
66
+ };
67
+ const users = await queryWithPaging(client, query, (r) => {
68
+ var _a;
69
+ return (_a = r.organization) == null ? void 0 : _a.membersWithRole;
70
+ }, mapper, { org, email: tokenType === "token" });
71
+ return { users };
72
+ }
73
+ async function getOrganizationTeams(client, org, orgNamespace) {
74
+ const query = `
75
+ query teams($org: String!, $cursor: String) {
76
+ organization(login: $org) {
77
+ teams(first: 100, after: $cursor) {
78
+ pageInfo { hasNextPage, endCursor }
79
+ nodes {
80
+ slug
81
+ combinedSlug
82
+ name
83
+ description
84
+ avatarUrl
85
+ parentTeam { slug }
86
+ members(first: 100, membership: IMMEDIATE) {
87
+ pageInfo { hasNextPage }
88
+ nodes { login }
89
+ }
90
+ }
91
+ }
92
+ }
93
+ }`;
94
+ const groupMemberUsers = /* @__PURE__ */ new Map();
95
+ const mapper = async (team) => {
96
+ const entity = {
97
+ apiVersion: "backstage.io/v1alpha1",
98
+ kind: "Group",
99
+ metadata: {
100
+ name: team.slug,
101
+ annotations: {
102
+ "github.com/team-slug": team.combinedSlug
103
+ }
104
+ },
105
+ spec: {
106
+ type: "team",
107
+ profile: {},
108
+ children: []
109
+ }
110
+ };
111
+ if (orgNamespace) {
112
+ entity.metadata.namespace = orgNamespace;
113
+ }
114
+ if (team.description) {
115
+ entity.metadata.description = team.description;
116
+ }
117
+ if (team.name) {
118
+ entity.spec.profile.displayName = team.name;
119
+ }
120
+ if (team.avatarUrl) {
121
+ entity.spec.profile.picture = team.avatarUrl;
122
+ }
123
+ if (team.parentTeam) {
124
+ entity.spec.parent = team.parentTeam.slug;
125
+ }
126
+ const memberNames = [];
127
+ const groupKey = orgNamespace ? `${orgNamespace}/${team.slug}` : team.slug;
128
+ groupMemberUsers.set(groupKey, memberNames);
129
+ if (!team.members.pageInfo.hasNextPage) {
130
+ for (const user of team.members.nodes) {
131
+ memberNames.push(user.login);
132
+ }
133
+ } else {
134
+ const { members } = await getTeamMembers(client, org, team.slug);
135
+ for (const userLogin of members) {
136
+ memberNames.push(userLogin);
137
+ }
138
+ }
139
+ return entity;
140
+ };
141
+ const groups = await queryWithPaging(client, query, (r) => {
142
+ var _a;
143
+ return (_a = r.organization) == null ? void 0 : _a.teams;
144
+ }, mapper, { org });
145
+ return { groups, groupMemberUsers };
146
+ }
147
+ async function getOrganizationRepositories(client, org) {
148
+ const query = `
149
+ query repositories($org: String!, $cursor: String) {
150
+ repositoryOwner(login: $org) {
151
+ login
152
+ repositories(first: 100, after: $cursor) {
153
+ nodes {
154
+ name
155
+ url
156
+ isArchived
157
+ defaultBranchRef {
158
+ name
159
+ }
160
+ }
161
+ pageInfo {
162
+ hasNextPage
163
+ endCursor
164
+ }
165
+ }
166
+ }
167
+ }`;
168
+ const repositories = await queryWithPaging(client, query, (r) => {
169
+ var _a;
170
+ return (_a = r.repositoryOwner) == null ? void 0 : _a.repositories;
171
+ }, (x) => x, { org });
172
+ return { repositories };
173
+ }
174
+ async function getTeamMembers(client, org, teamSlug) {
175
+ const query = `
176
+ query members($org: String!, $teamSlug: String!, $cursor: String) {
177
+ organization(login: $org) {
178
+ team(slug: $teamSlug) {
179
+ members(first: 100, after: $cursor, membership: IMMEDIATE) {
180
+ pageInfo { hasNextPage, endCursor }
181
+ nodes { login }
182
+ }
183
+ }
184
+ }
185
+ }`;
186
+ const members = await queryWithPaging(client, query, (r) => {
187
+ var _a, _b;
188
+ return (_b = (_a = r.organization) == null ? void 0 : _a.team) == null ? void 0 : _b.members;
189
+ }, (user) => user.login, { org, teamSlug });
190
+ return { members };
191
+ }
192
+ async function queryWithPaging(client, query, connection, mapper, variables) {
193
+ const result = [];
194
+ let cursor = void 0;
195
+ for (let j = 0; j < 1e3; ++j) {
196
+ const response = await client(query, {
197
+ ...variables,
198
+ cursor
199
+ });
200
+ const conn = connection(response);
201
+ if (!conn) {
202
+ throw new Error(`Found no match for ${JSON.stringify(variables)}`);
203
+ }
204
+ for (const node of conn.nodes) {
205
+ result.push(await mapper(node));
206
+ }
207
+ if (!conn.pageInfo.hasNextPage) {
208
+ break;
209
+ } else {
210
+ cursor = conn.pageInfo.endCursor;
211
+ }
212
+ }
213
+ return result;
214
+ }
215
+
216
+ function buildOrgHierarchy(groups) {
217
+ const groupsByName = new Map(groups.map((g) => [g.metadata.name, g]));
218
+ for (const group of groups) {
219
+ const selfName = group.metadata.name;
220
+ const parentName = group.spec.parent;
221
+ if (parentName) {
222
+ const parent = groupsByName.get(parentName);
223
+ if (parent && !parent.spec.children.includes(selfName)) {
224
+ parent.spec.children.push(selfName);
225
+ }
226
+ }
227
+ }
228
+ for (const group of groups) {
229
+ const selfName = group.metadata.name;
230
+ for (const childName of group.spec.children) {
231
+ const child = groupsByName.get(childName);
232
+ if (child && !child.spec.parent) {
233
+ child.spec.parent = selfName;
234
+ }
235
+ }
236
+ }
237
+ }
238
+ function assignGroupsToUsers(users, groupMemberUsers) {
239
+ const usersByName = new Map(users.map((u) => [u.metadata.name, u]));
240
+ for (const [groupName, userNames] of groupMemberUsers.entries()) {
241
+ for (const userName of userNames) {
242
+ const user = usersByName.get(userName);
243
+ if (user && !user.spec.memberOf.includes(groupName)) {
244
+ user.spec.memberOf.push(groupName);
245
+ }
246
+ }
247
+ }
248
+ }
249
+
250
+ function parseGitHubOrgUrl(urlString) {
251
+ const path = new URL(urlString).pathname.substr(1).split("/");
252
+ if (path.length === 1 && path[0].length) {
253
+ return { org: decodeURIComponent(path[0]) };
254
+ }
255
+ throw new Error(`Expected a URL pointing to /<org>`);
256
+ }
257
+
258
+ class GithubDiscoveryProcessor {
259
+ static fromConfig(config, options) {
260
+ const integrations = integration.ScmIntegrations.fromConfig(config);
261
+ return new GithubDiscoveryProcessor({
262
+ ...options,
263
+ integrations
264
+ });
265
+ }
266
+ constructor(options) {
267
+ this.integrations = options.integrations;
268
+ this.logger = options.logger;
269
+ this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
270
+ }
271
+ getProcessorName() {
272
+ return "GithubDiscoveryProcessor";
273
+ }
274
+ async readLocation(location, _optional, emit) {
275
+ var _a, _b;
276
+ if (location.type !== "github-discovery") {
277
+ return false;
278
+ }
279
+ const gitHubConfig = (_a = this.integrations.github.byUrl(location.target)) == null ? void 0 : _a.config;
280
+ if (!gitHubConfig) {
281
+ throw new Error(`There is no GitHub integration that matches ${location.target}. Please add a configuration entry for it under integrations.github`);
282
+ }
283
+ const { org, repoSearchPath, catalogPath, branch, host } = parseUrl(location.target);
284
+ const orgUrl = `https://${host}/${org}`;
285
+ const { headers } = await this.githubCredentialsProvider.getCredentials({
286
+ url: orgUrl
287
+ });
288
+ const client = graphql.graphql.defaults({
289
+ baseUrl: gitHubConfig.apiBaseUrl,
290
+ headers
291
+ });
292
+ const startTimestamp = Date.now();
293
+ this.logger.info(`Reading GitHub repositories from ${location.target}`);
294
+ const { repositories } = await getOrganizationRepositories(client, org);
295
+ const matching = repositories.filter((r) => !r.isArchived && repoSearchPath.test(r.name));
296
+ const duration = ((Date.now() - startTimestamp) / 1e3).toFixed(1);
297
+ this.logger.debug(`Read ${repositories.length} GitHub repositories (${matching.length} matching the pattern) in ${duration} seconds`);
298
+ for (const repository of matching) {
299
+ const branchName = branch === "-" ? (_b = repository.defaultBranchRef) == null ? void 0 : _b.name : branch;
300
+ if (!branchName) {
301
+ this.logger.info(`the repository ${repository.url} does not have a default branch, skipping`);
302
+ continue;
303
+ }
304
+ const path = `/blob/${branchName}${catalogPath}`;
305
+ emit(pluginCatalogBackend.processingResult.location({
306
+ type: "url",
307
+ target: `${repository.url}${path}`,
308
+ presence: "optional"
309
+ }));
310
+ }
311
+ return true;
312
+ }
313
+ }
314
+ function parseUrl(urlString) {
315
+ const url = new URL(urlString);
316
+ const path = url.pathname.substr(1).split("/");
317
+ if (path.length > 2 && path[0].length && path[1].length) {
318
+ return {
319
+ org: decodeURIComponent(path[0]),
320
+ repoSearchPath: escapeRegExp(decodeURIComponent(path[1])),
321
+ branch: decodeURIComponent(path[3]),
322
+ catalogPath: `/${decodeURIComponent(path.slice(4).join("/"))}`,
323
+ host: url.host
324
+ };
325
+ } else if (path.length === 1 && path[0].length) {
326
+ return {
327
+ org: decodeURIComponent(path[0]),
328
+ host: url.host,
329
+ repoSearchPath: escapeRegExp("*"),
330
+ catalogPath: "/catalog-info.yaml",
331
+ branch: "-"
332
+ };
333
+ }
334
+ throw new Error(`Failed to parse ${urlString}`);
335
+ }
336
+ function escapeRegExp(str) {
337
+ return new RegExp(`^${str.replace(/\*/g, ".*")}$`);
338
+ }
339
+
340
+ class GithubMultiOrgReaderProcessor {
341
+ static fromConfig(config, options) {
342
+ const c = config.getOptionalConfig("catalog.processors.githubMultiOrg");
343
+ const integrations = integration.ScmIntegrations.fromConfig(config);
344
+ return new GithubMultiOrgReaderProcessor({
345
+ ...options,
346
+ integrations,
347
+ orgs: c ? readGithubMultiOrgConfig(c) : []
348
+ });
349
+ }
350
+ constructor(options) {
351
+ this.integrations = options.integrations;
352
+ this.logger = options.logger;
353
+ this.orgs = options.orgs;
354
+ this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
355
+ }
356
+ getProcessorName() {
357
+ return "GithubMultiOrgReaderProcessor";
358
+ }
359
+ async readLocation(location, _optional, emit) {
360
+ var _a, _b;
361
+ if (location.type !== "github-multi-org") {
362
+ return false;
363
+ }
364
+ const gitHubConfig = (_a = this.integrations.github.byUrl(location.target)) == null ? void 0 : _a.config;
365
+ if (!gitHubConfig) {
366
+ throw new Error(`There is no GitHub integration that matches ${location.target}. Please add a configuration entry for it under integrations.github`);
367
+ }
368
+ const allUsersMap = /* @__PURE__ */ new Map();
369
+ const baseUrl = new URL(location.target).origin;
370
+ const orgsToProcess = this.orgs.length ? this.orgs : await this.getAllOrgs(gitHubConfig);
371
+ for (const orgConfig of orgsToProcess) {
372
+ try {
373
+ const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
374
+ url: `${baseUrl}/${orgConfig.name}`
375
+ });
376
+ const client = graphql.graphql.defaults({
377
+ baseUrl: gitHubConfig.apiBaseUrl,
378
+ headers
379
+ });
380
+ const startTimestamp = Date.now();
381
+ this.logger.info(`Reading GitHub users and teams for org: ${orgConfig.name}`);
382
+ const { users } = await getOrganizationUsers(client, orgConfig.name, tokenType, orgConfig.userNamespace);
383
+ const { groups, groupMemberUsers } = await getOrganizationTeams(client, orgConfig.name, orgConfig.groupNamespace);
384
+ const duration = ((Date.now() - startTimestamp) / 1e3).toFixed(1);
385
+ this.logger.debug(`Read ${users.length} GitHub users and ${groups.length} GitHub teams from ${orgConfig.name} in ${duration} seconds`);
386
+ let prefix = (_b = orgConfig.userNamespace) != null ? _b : "";
387
+ if (prefix.length > 0)
388
+ prefix += "/";
389
+ users.forEach((u) => {
390
+ if (!allUsersMap.has(prefix + u.metadata.name)) {
391
+ allUsersMap.set(prefix + u.metadata.name, u);
392
+ }
393
+ });
394
+ for (const [groupName, userNames] of groupMemberUsers.entries()) {
395
+ for (const userName of userNames) {
396
+ const user = allUsersMap.get(prefix + userName);
397
+ if (user && !user.spec.memberOf.includes(groupName)) {
398
+ user.spec.memberOf.push(groupName);
399
+ }
400
+ }
401
+ }
402
+ buildOrgHierarchy(groups);
403
+ for (const group of groups) {
404
+ emit(pluginCatalogBackend.processingResult.entity(location, group));
405
+ }
406
+ } catch (e) {
407
+ this.logger.error(`Failed to read GitHub org data for ${orgConfig.name}: ${e}`);
408
+ }
409
+ }
410
+ const allUsers = Array.from(allUsersMap.values());
411
+ for (const user of allUsers) {
412
+ emit(pluginCatalogBackend.processingResult.entity(location, user));
413
+ }
414
+ return true;
415
+ }
416
+ async getAllOrgs(gitHubConfig) {
417
+ const githubAppMux = new integration.GithubAppCredentialsMux(gitHubConfig);
418
+ const installs = await githubAppMux.getAllInstallations();
419
+ return installs.map((install) => install.target_type === "Organization" && install.account && install.account.login ? {
420
+ name: install.account.login,
421
+ groupNamespace: install.account.login.toLowerCase()
422
+ } : void 0).filter(Boolean);
423
+ }
424
+ }
425
+
426
+ class GitHubOrgEntityProvider {
427
+ constructor(options) {
428
+ this.options = options;
429
+ this.githubCredentialsProvider = options.githubCredentialsProvider || integration.SingleInstanceGithubCredentialsProvider.create(options.gitHubConfig);
430
+ }
431
+ static fromConfig(config, options) {
432
+ var _a;
433
+ const integrations = integration.ScmIntegrations.fromConfig(config);
434
+ const gitHubConfig = (_a = integrations.github.byUrl(options.orgUrl)) == null ? void 0 : _a.config;
435
+ if (!gitHubConfig) {
436
+ throw new Error(`There is no GitHub Org provider that matches ${options.orgUrl}. Please add a configuration for an integration.`);
437
+ }
438
+ const logger = options.logger.child({
439
+ target: options.orgUrl
440
+ });
441
+ return new GitHubOrgEntityProvider({
442
+ id: options.id,
443
+ orgUrl: options.orgUrl,
444
+ logger,
445
+ gitHubConfig,
446
+ githubCredentialsProvider: options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations)
447
+ });
448
+ }
449
+ getProviderName() {
450
+ return `GitHubOrgEntityProvider:${this.options.id}`;
451
+ }
452
+ async connect(connection) {
453
+ this.connection = connection;
454
+ }
455
+ async read() {
456
+ if (!this.connection) {
457
+ throw new Error("Not initialized");
458
+ }
459
+ const { markReadComplete } = trackProgress(this.options.logger);
460
+ const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
461
+ url: this.options.orgUrl
462
+ });
463
+ const client = graphql.graphql.defaults({
464
+ baseUrl: this.options.gitHubConfig.apiBaseUrl,
465
+ headers
466
+ });
467
+ const { org } = parseGitHubOrgUrl(this.options.orgUrl);
468
+ const { users } = await getOrganizationUsers(client, org, tokenType);
469
+ const { groups, groupMemberUsers } = await getOrganizationTeams(client, org);
470
+ assignGroupsToUsers(users, groupMemberUsers);
471
+ buildOrgHierarchy(groups);
472
+ const { markCommitComplete } = markReadComplete({ users, groups });
473
+ await this.connection.applyMutation({
474
+ type: "full",
475
+ entities: [...users, ...groups].map((entity) => ({
476
+ locationKey: `github-org-provider:${this.options.id}`,
477
+ entity: withLocations(`https://${this.options.gitHubConfig.host}`, org, entity)
478
+ }))
479
+ });
480
+ markCommitComplete();
481
+ }
482
+ }
483
+ function trackProgress(logger) {
484
+ let timestamp = Date.now();
485
+ let summary;
486
+ logger.info("Reading GitHub users and groups");
487
+ function markReadComplete(read) {
488
+ summary = `${read.users.length} GitHub users and ${read.groups.length} GitHub groups`;
489
+ const readDuration = ((Date.now() - timestamp) / 1e3).toFixed(1);
490
+ timestamp = Date.now();
491
+ logger.info(`Read ${summary} in ${readDuration} seconds. Committing...`);
492
+ return { markCommitComplete };
493
+ }
494
+ function markCommitComplete() {
495
+ const commitDuration = ((Date.now() - timestamp) / 1e3).toFixed(1);
496
+ logger.info(`Committed ${summary} in ${commitDuration} seconds.`);
497
+ }
498
+ return { markReadComplete };
499
+ }
500
+ function withLocations(baseUrl, org, entity) {
501
+ const location = entity.kind === "Group" ? `url:${baseUrl}/orgs/${org}/teams/${entity.metadata.name}` : `url:${baseUrl}/${entity.metadata.name}`;
502
+ return lodash.merge({
503
+ metadata: {
504
+ annotations: {
505
+ [catalogModel.ANNOTATION_LOCATION]: location,
506
+ [catalogModel.ANNOTATION_ORIGIN_LOCATION]: location
507
+ }
508
+ }
509
+ }, entity);
510
+ }
511
+
512
+ class GithubOrgReaderProcessor {
513
+ static fromConfig(config, options) {
514
+ const integrations = integration.ScmIntegrations.fromConfig(config);
515
+ return new GithubOrgReaderProcessor({
516
+ ...options,
517
+ integrations
518
+ });
519
+ }
520
+ constructor(options) {
521
+ this.integrations = options.integrations;
522
+ this.githubCredentialsProvider = options.githubCredentialsProvider || integration.DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);
523
+ this.logger = options.logger;
524
+ }
525
+ getProcessorName() {
526
+ return "GithubOrgReaderProcessor";
527
+ }
528
+ async readLocation(location, _optional, emit) {
529
+ if (location.type !== "github-org") {
530
+ return false;
531
+ }
532
+ const { client, tokenType } = await this.createClient(location.target);
533
+ const { org } = parseGitHubOrgUrl(location.target);
534
+ const startTimestamp = Date.now();
535
+ this.logger.info("Reading GitHub users and groups");
536
+ const { users } = await getOrganizationUsers(client, org, tokenType);
537
+ const { groups, groupMemberUsers } = await getOrganizationTeams(client, org);
538
+ const duration = ((Date.now() - startTimestamp) / 1e3).toFixed(1);
539
+ this.logger.debug(`Read ${users.length} GitHub users and ${groups.length} GitHub groups in ${duration} seconds`);
540
+ assignGroupsToUsers(users, groupMemberUsers);
541
+ buildOrgHierarchy(groups);
542
+ for (const group of groups) {
543
+ emit(pluginCatalogBackend.processingResult.entity(location, group));
544
+ }
545
+ for (const user of users) {
546
+ emit(pluginCatalogBackend.processingResult.entity(location, user));
547
+ }
548
+ return true;
549
+ }
550
+ async createClient(orgUrl) {
551
+ var _a;
552
+ const gitHubConfig = (_a = this.integrations.github.byUrl(orgUrl)) == null ? void 0 : _a.config;
553
+ if (!gitHubConfig) {
554
+ throw new Error(`There is no GitHub Org provider that matches ${orgUrl}. Please add a configuration for an integration.`);
555
+ }
556
+ const { headers, type: tokenType } = await this.githubCredentialsProvider.getCredentials({
557
+ url: orgUrl
558
+ });
559
+ const client = graphql.graphql.defaults({
560
+ baseUrl: gitHubConfig.apiBaseUrl,
561
+ headers
562
+ });
563
+ return { client, tokenType };
564
+ }
565
+ }
566
+
567
+ exports.GitHubOrgEntityProvider = GitHubOrgEntityProvider;
568
+ exports.GithubDiscoveryProcessor = GithubDiscoveryProcessor;
569
+ exports.GithubMultiOrgReaderProcessor = GithubMultiOrgReaderProcessor;
570
+ exports.GithubOrgReaderProcessor = GithubOrgReaderProcessor;
571
+ //# sourceMappingURL=index.cjs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/lib/config.ts","../src/lib/github.ts","../src/lib/org.ts","../src/lib/util.ts","../src/GithubDiscoveryProcessor.ts","../src/GithubMultiOrgReaderProcessor.ts","../src/GitHubOrgEntityProvider.ts","../src/GithubOrgReaderProcessor.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\n\n/**\n * The configuration parameters for a multi-org GitHub processor.\n * @public\n */\nexport type GithubMultiOrgConfig = Array<{\n /**\n * The name of the GitHub org to process.\n */\n name: string;\n /**\n * The namespace of the group created for this org.\n */\n groupNamespace: string;\n /**\n * The namespace of the users created for this org. If not specified defaults to undefined.\n */\n userNamespace: string | undefined;\n}>;\n\nexport function readGithubMultiOrgConfig(config: Config): GithubMultiOrgConfig {\n const orgConfigs = config.getOptionalConfigArray('orgs') ?? [];\n return orgConfigs.map(c => ({\n name: c.getString('name'),\n groupNamespace: (\n c.getOptionalString('groupNamespace') ?? c.getString('name')\n ).toLowerCase(),\n userNamespace: c.getOptionalString('userNamespace') ?? undefined,\n }));\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { GroupEntity, UserEntity } from '@backstage/catalog-model';\nimport { GithubCredentialType } from '@backstage/integration';\nimport { graphql } from '@octokit/graphql';\n\n// Graphql types\n\nexport type QueryResponse = {\n organization?: Organization;\n repositoryOwner?: Organization | User;\n};\n\nexport type Organization = {\n membersWithRole?: Connection<User>;\n team?: Team;\n teams?: Connection<Team>;\n repositories?: Connection<Repository>;\n};\n\nexport type PageInfo = {\n hasNextPage: boolean;\n endCursor?: string;\n};\n\nexport type User = {\n login: string;\n bio?: string;\n avatarUrl?: string;\n email?: string;\n name?: string;\n repositories?: Connection<Repository>;\n};\n\nexport type Team = {\n slug: string;\n combinedSlug: string;\n name?: string;\n description?: string;\n avatarUrl?: string;\n parentTeam?: Team;\n members: Connection<User>;\n};\n\nexport type Repository = {\n name: string;\n url: string;\n isArchived: boolean;\n defaultBranchRef: {\n name: string;\n } | null;\n};\n\nexport type Connection<T> = {\n pageInfo: PageInfo;\n nodes: T[];\n};\n\n/**\n * Gets all the users out of a GitHub organization.\n *\n * Note that the users will not have their memberships filled in.\n *\n * @param client - An octokit graphql client\n * @param org - The slug of the org to read\n */\nexport async function getOrganizationUsers(\n client: typeof graphql,\n org: string,\n tokenType: GithubCredentialType,\n userNamespace?: string,\n): Promise<{ users: UserEntity[] }> {\n const query = `\n query users($org: String!, $email: Boolean!, $cursor: String) {\n organization(login: $org) {\n membersWithRole(first: 100, after: $cursor) {\n pageInfo { hasNextPage, endCursor }\n nodes {\n avatarUrl,\n bio,\n email @include(if: $email),\n login,\n name\n }\n }\n }\n }`;\n\n // There is no user -> teams edge, so we leave the memberships empty for\n // now and let the team iteration handle it instead\n const mapper = (user: User) => {\n const entity: UserEntity = {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'User',\n metadata: {\n name: user.login,\n annotations: {\n 'github.com/user-login': user.login,\n },\n },\n spec: {\n profile: {},\n memberOf: [],\n },\n };\n\n if (userNamespace) entity.metadata.namespace = userNamespace;\n if (user.bio) entity.metadata.description = user.bio;\n if (user.name) entity.spec.profile!.displayName = user.name;\n if (user.email) entity.spec.profile!.email = user.email;\n if (user.avatarUrl) entity.spec.profile!.picture = user.avatarUrl;\n\n return entity;\n };\n\n const users = await queryWithPaging(\n client,\n query,\n r => r.organization?.membersWithRole,\n mapper,\n { org, email: tokenType === 'token' },\n );\n\n return { users };\n}\n\n/**\n * Gets all the teams out of a GitHub organization.\n *\n * Note that the teams will not have any relations apart from parent filled in.\n *\n * @param client - An octokit graphql client\n * @param org - The slug of the org to read\n */\nexport async function getOrganizationTeams(\n client: typeof graphql,\n org: string,\n orgNamespace?: string,\n): Promise<{\n groups: GroupEntity[];\n groupMemberUsers: Map<string, string[]>;\n}> {\n const query = `\n query teams($org: String!, $cursor: String) {\n organization(login: $org) {\n teams(first: 100, after: $cursor) {\n pageInfo { hasNextPage, endCursor }\n nodes {\n slug\n combinedSlug\n name\n description\n avatarUrl\n parentTeam { slug }\n members(first: 100, membership: IMMEDIATE) {\n pageInfo { hasNextPage }\n nodes { login }\n }\n }\n }\n }\n }`;\n\n // Gets populated inside the mapper below\n const groupMemberUsers = new Map<string, string[]>();\n\n const mapper = async (team: Team) => {\n const entity: GroupEntity = {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'Group',\n metadata: {\n name: team.slug,\n annotations: {\n 'github.com/team-slug': team.combinedSlug,\n },\n },\n spec: {\n type: 'team',\n profile: {},\n children: [],\n },\n };\n\n if (orgNamespace) {\n entity.metadata.namespace = orgNamespace;\n }\n\n if (team.description) {\n entity.metadata.description = team.description;\n }\n if (team.name) {\n entity.spec.profile!.displayName = team.name;\n }\n if (team.avatarUrl) {\n entity.spec.profile!.picture = team.avatarUrl;\n }\n if (team.parentTeam) {\n entity.spec.parent = team.parentTeam.slug;\n }\n\n const memberNames: string[] = [];\n const groupKey = orgNamespace ? `${orgNamespace}/${team.slug}` : team.slug;\n groupMemberUsers.set(groupKey, memberNames);\n\n if (!team.members.pageInfo.hasNextPage) {\n // We got all the members in one go, run the fast path\n for (const user of team.members.nodes) {\n memberNames.push(user.login);\n }\n } else {\n // There were more than a hundred immediate members - run the slow\n // path of fetching them explicitly\n const { members } = await getTeamMembers(client, org, team.slug);\n for (const userLogin of members) {\n memberNames.push(userLogin);\n }\n }\n\n return entity;\n };\n\n const groups = await queryWithPaging(\n client,\n query,\n r => r.organization?.teams,\n mapper,\n { org },\n );\n\n return { groups, groupMemberUsers };\n}\n\nexport async function getOrganizationRepositories(\n client: typeof graphql,\n org: string,\n): Promise<{ repositories: Repository[] }> {\n const query = `\n query repositories($org: String!, $cursor: String) {\n repositoryOwner(login: $org) {\n login\n repositories(first: 100, after: $cursor) {\n nodes {\n name\n url\n isArchived\n defaultBranchRef {\n name\n }\n }\n pageInfo {\n hasNextPage\n endCursor\n }\n }\n }\n }`;\n\n const repositories = await queryWithPaging(\n client,\n query,\n r => r.repositoryOwner?.repositories,\n x => x,\n { org },\n );\n\n return { repositories };\n}\n\n/**\n * Gets all the users out of a GitHub organization.\n *\n * Note that the users will not have their memberships filled in.\n *\n * @param client - An octokit graphql client\n * @param org - The slug of the org to read\n * @param teamSlug - The slug of the team to read\n */\nexport async function getTeamMembers(\n client: typeof graphql,\n org: string,\n teamSlug: string,\n): Promise<{ members: string[] }> {\n const query = `\n query members($org: String!, $teamSlug: String!, $cursor: String) {\n organization(login: $org) {\n team(slug: $teamSlug) {\n members(first: 100, after: $cursor, membership: IMMEDIATE) {\n pageInfo { hasNextPage, endCursor }\n nodes { login }\n }\n }\n }\n }`;\n\n const members = await queryWithPaging(\n client,\n query,\n r => r.organization?.team?.members,\n user => user.login,\n { org, teamSlug },\n );\n\n return { members };\n}\n\n//\n// Helpers\n//\n\n/**\n * Assists in repeatedly executing a query with a paged response.\n *\n * Requires that the query accepts a $cursor variable.\n *\n * @param client - The octokit client\n * @param query - The query to execute\n * @param connection - A function that, given the response, picks out the actual\n * Connection object that's being iterated\n * @param mapper - A function that, given one of the nodes in the Connection,\n * returns the model mapped form of it\n * @param variables - The variable values that the query needs, minus the cursor\n */\nexport async function queryWithPaging<\n GraphqlType,\n OutputType,\n Variables extends {},\n Response = QueryResponse,\n>(\n client: typeof graphql,\n query: string,\n connection: (response: Response) => Connection<GraphqlType> | undefined,\n mapper: (item: GraphqlType) => Promise<OutputType> | OutputType,\n variables: Variables,\n): Promise<OutputType[]> {\n const result: OutputType[] = [];\n\n let cursor: string | undefined = undefined;\n for (let j = 0; j < 1000 /* just for sanity */; ++j) {\n const response: Response = await client(query, {\n ...variables,\n cursor,\n });\n\n const conn = connection(response);\n if (!conn) {\n throw new Error(`Found no match for ${JSON.stringify(variables)}`);\n }\n\n for (const node of conn.nodes) {\n result.push(await mapper(node));\n }\n\n if (!conn.pageInfo.hasNextPage) {\n break;\n } else {\n cursor = conn.pageInfo.endCursor;\n }\n }\n\n return result;\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { GroupEntity, UserEntity } from '@backstage/catalog-model';\n\nexport function buildOrgHierarchy(groups: GroupEntity[]) {\n const groupsByName = new Map(groups.map(g => [g.metadata.name, g]));\n\n //\n // Make sure that g.parent.children contain g\n //\n\n for (const group of groups) {\n const selfName = group.metadata.name;\n const parentName = group.spec.parent;\n if (parentName) {\n const parent = groupsByName.get(parentName);\n if (parent && !parent.spec.children.includes(selfName)) {\n parent.spec.children.push(selfName);\n }\n }\n }\n\n //\n // Make sure that g.children.parent is g\n //\n\n for (const group of groups) {\n const selfName = group.metadata.name;\n for (const childName of group.spec.children) {\n const child = groupsByName.get(childName);\n if (child && !child.spec.parent) {\n child.spec.parent = selfName;\n }\n }\n }\n}\n\n// Ensure that users have their direct group memberships.\nexport function assignGroupsToUsers(\n users: UserEntity[],\n groupMemberUsers: Map<string, string[]>,\n) {\n const usersByName = new Map(users.map(u => [u.metadata.name, u]));\n for (const [groupName, userNames] of groupMemberUsers.entries()) {\n for (const userName of userNames) {\n const user = usersByName.get(userName);\n if (user && !user.spec.memberOf.includes(groupName)) {\n user.spec.memberOf.push(groupName);\n }\n }\n }\n}\n\n// Ensure that users have their transitive group memberships. Requires that\n// the groups were previously processed with buildOrgHierarchy()\nexport function buildMemberOf(groups: GroupEntity[], users: UserEntity[]) {\n const groupsByName = new Map(groups.map(g => [g.metadata.name, g]));\n\n users.forEach(user => {\n const transitiveMemberOf = new Set<string>();\n\n const todo = [\n ...user.spec.memberOf,\n ...groups\n .filter(g => g.spec.members?.includes(user.metadata.name))\n .map(g => g.metadata.name),\n ];\n\n for (;;) {\n const current = todo.pop();\n if (!current) {\n break;\n }\n\n if (!transitiveMemberOf.has(current)) {\n transitiveMemberOf.add(current);\n const group = groupsByName.get(current);\n if (group?.spec.parent) {\n todo.push(group.spec.parent);\n }\n }\n }\n\n user.spec.memberOf = [...transitiveMemberOf];\n });\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport function parseGitHubOrgUrl(urlString: string): { org: string } {\n const path = new URL(urlString).pathname.substr(1).split('/');\n\n // /backstage\n if (path.length === 1 && path[0].length) {\n return { org: decodeURIComponent(path[0]) };\n }\n\n throw new Error(`Expected a URL pointing to /<org>`);\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport {\n DefaultGithubCredentialsProvider,\n GithubCredentialsProvider,\n ScmIntegrationRegistry,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n LocationSpec,\n processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { graphql } from '@octokit/graphql';\nimport { Logger } from 'winston';\nimport { getOrganizationRepositories } from './lib';\n\n/**\n * Extracts repositories out of a GitHub org.\n *\n * The following will create locations for all projects which have a catalog-info.yaml\n * on the default branch. The first is shorthand for the second.\n *\n * target: \"https://github.com/backstage\"\n * or\n * target: https://github.com/backstage/*\\/blob/-/catalog-info.yaml\n *\n * You may also explicitly specify the source branch:\n *\n * target: https://github.com/backstage/*\\/blob/main/catalog-info.yaml\n *\n * @public\n **/\nexport class GithubDiscoveryProcessor implements CatalogProcessor {\n private readonly integrations: ScmIntegrationRegistry;\n private readonly logger: Logger;\n private readonly githubCredentialsProvider: GithubCredentialsProvider;\n\n static fromConfig(\n config: Config,\n options: {\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n },\n ) {\n const integrations = ScmIntegrations.fromConfig(config);\n\n return new GithubDiscoveryProcessor({\n ...options,\n integrations,\n });\n }\n\n constructor(options: {\n integrations: ScmIntegrationRegistry;\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n }) {\n this.integrations = options.integrations;\n this.logger = options.logger;\n this.githubCredentialsProvider =\n options.githubCredentialsProvider ||\n DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);\n }\n getProcessorName(): string {\n return 'GithubDiscoveryProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'github-discovery') {\n return false;\n }\n\n const gitHubConfig = this.integrations.github.byUrl(\n location.target,\n )?.config;\n if (!gitHubConfig) {\n throw new Error(\n `There is no GitHub integration that matches ${location.target}. Please add a configuration entry for it under integrations.github`,\n );\n }\n\n const { org, repoSearchPath, catalogPath, branch, host } = parseUrl(\n location.target,\n );\n\n // Building the org url here so that the github creds provider doesn't need to know\n // about how to handle the wild card which is special for this processor.\n const orgUrl = `https://${host}/${org}`;\n\n const { headers } = await this.githubCredentialsProvider.getCredentials({\n url: orgUrl,\n });\n\n const client = graphql.defaults({\n baseUrl: gitHubConfig.apiBaseUrl,\n headers,\n });\n\n // Read out all of the raw data\n const startTimestamp = Date.now();\n this.logger.info(`Reading GitHub repositories from ${location.target}`);\n\n const { repositories } = await getOrganizationRepositories(client, org);\n const matching = repositories.filter(\n r => !r.isArchived && repoSearchPath.test(r.name),\n );\n\n const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n this.logger.debug(\n `Read ${repositories.length} GitHub repositories (${matching.length} matching the pattern) in ${duration} seconds`,\n );\n\n for (const repository of matching) {\n const branchName =\n branch === '-' ? repository.defaultBranchRef?.name : branch;\n\n if (!branchName) {\n this.logger.info(\n `the repository ${repository.url} does not have a default branch, skipping`,\n );\n continue;\n }\n\n const path = `/blob/${branchName}${catalogPath}`;\n\n emit(\n processingResult.location({\n type: 'url',\n target: `${repository.url}${path}`,\n // Not all locations may actually exist, since the user defined them as a wildcard pattern.\n // Thus, we emit them as optional and let the downstream processor find them while not outputting\n // an error if it couldn't.\n presence: 'optional',\n }),\n );\n }\n\n return true;\n }\n}\n\n/*\n * Helpers\n */\n\nexport function parseUrl(urlString: string): {\n org: string;\n repoSearchPath: RegExp;\n catalogPath: string;\n branch: string;\n host: string;\n} {\n const url = new URL(urlString);\n const path = url.pathname.substr(1).split('/');\n\n // /backstage/techdocs-*/blob/master/catalog-info.yaml\n // can also be\n // /backstage\n if (path.length > 2 && path[0].length && path[1].length) {\n return {\n org: decodeURIComponent(path[0]),\n repoSearchPath: escapeRegExp(decodeURIComponent(path[1])),\n branch: decodeURIComponent(path[3]),\n catalogPath: `/${decodeURIComponent(path.slice(4).join('/'))}`,\n host: url.host,\n };\n } else if (path.length === 1 && path[0].length) {\n return {\n org: decodeURIComponent(path[0]),\n host: url.host,\n repoSearchPath: escapeRegExp('*'),\n catalogPath: '/catalog-info.yaml',\n branch: '-',\n };\n }\n\n throw new Error(`Failed to parse ${urlString}`);\n}\n\nexport function escapeRegExp(str: string): RegExp {\n return new RegExp(`^${str.replace(/\\*/g, '.*')}$`);\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport {\n DefaultGithubCredentialsProvider,\n GithubAppCredentialsMux,\n GithubCredentialsProvider,\n GitHubIntegrationConfig,\n ScmIntegrationRegistry,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n LocationSpec,\n processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { graphql } from '@octokit/graphql';\nimport { Logger } from 'winston';\nimport {\n buildOrgHierarchy,\n getOrganizationTeams,\n getOrganizationUsers,\n GithubMultiOrgConfig,\n readGithubMultiOrgConfig,\n} from './lib';\n\n/**\n * Extracts teams and users out of a multiple GitHub orgs namespaced per org.\n *\n * Be aware that this processor may not be compatible with future org structures in the catalog.\n *\n * @public\n */\nexport class GithubMultiOrgReaderProcessor implements CatalogProcessor {\n private readonly integrations: ScmIntegrationRegistry;\n private readonly orgs: GithubMultiOrgConfig;\n private readonly logger: Logger;\n private readonly githubCredentialsProvider: GithubCredentialsProvider;\n\n static fromConfig(\n config: Config,\n options: {\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n },\n ) {\n const c = config.getOptionalConfig('catalog.processors.githubMultiOrg');\n const integrations = ScmIntegrations.fromConfig(config);\n\n return new GithubMultiOrgReaderProcessor({\n ...options,\n integrations,\n orgs: c ? readGithubMultiOrgConfig(c) : [],\n });\n }\n\n constructor(options: {\n integrations: ScmIntegrationRegistry;\n logger: Logger;\n orgs: GithubMultiOrgConfig;\n githubCredentialsProvider?: GithubCredentialsProvider;\n }) {\n this.integrations = options.integrations;\n this.logger = options.logger;\n this.orgs = options.orgs;\n this.githubCredentialsProvider =\n options.githubCredentialsProvider ||\n DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);\n }\n getProcessorName(): string {\n return 'GithubMultiOrgReaderProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'github-multi-org') {\n return false;\n }\n\n const gitHubConfig = this.integrations.github.byUrl(\n location.target,\n )?.config;\n if (!gitHubConfig) {\n throw new Error(\n `There is no GitHub integration that matches ${location.target}. Please add a configuration entry for it under integrations.github`,\n );\n }\n\n const allUsersMap = new Map();\n const baseUrl = new URL(location.target).origin;\n\n const orgsToProcess = this.orgs.length\n ? this.orgs\n : await this.getAllOrgs(gitHubConfig);\n\n for (const orgConfig of orgsToProcess) {\n try {\n const { headers, type: tokenType } =\n await this.githubCredentialsProvider.getCredentials({\n url: `${baseUrl}/${orgConfig.name}`,\n });\n const client = graphql.defaults({\n baseUrl: gitHubConfig.apiBaseUrl,\n headers,\n });\n\n const startTimestamp = Date.now();\n this.logger.info(\n `Reading GitHub users and teams for org: ${orgConfig.name}`,\n );\n const { users } = await getOrganizationUsers(\n client,\n orgConfig.name,\n tokenType,\n orgConfig.userNamespace,\n );\n const { groups, groupMemberUsers } = await getOrganizationTeams(\n client,\n orgConfig.name,\n orgConfig.groupNamespace,\n );\n\n const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n this.logger.debug(\n `Read ${users.length} GitHub users and ${groups.length} GitHub teams from ${orgConfig.name} in ${duration} seconds`,\n );\n\n let prefix: string = orgConfig.userNamespace ?? '';\n if (prefix.length > 0) prefix += '/';\n\n users.forEach(u => {\n if (!allUsersMap.has(prefix + u.metadata.name)) {\n allUsersMap.set(prefix + u.metadata.name, u);\n }\n });\n\n for (const [groupName, userNames] of groupMemberUsers.entries()) {\n for (const userName of userNames) {\n const user = allUsersMap.get(prefix + userName);\n if (user && !user.spec.memberOf.includes(groupName)) {\n user.spec.memberOf.push(groupName);\n }\n }\n }\n buildOrgHierarchy(groups);\n\n for (const group of groups) {\n emit(processingResult.entity(location, group));\n }\n } catch (e) {\n this.logger.error(\n `Failed to read GitHub org data for ${orgConfig.name}: ${e}`,\n );\n }\n }\n\n const allUsers = Array.from(allUsersMap.values());\n for (const user of allUsers) {\n emit(processingResult.entity(location, user));\n }\n\n return true;\n }\n\n // Note: Does not support usage of PATs\n private async getAllOrgs(\n gitHubConfig: GitHubIntegrationConfig,\n ): Promise<GithubMultiOrgConfig> {\n const githubAppMux = new GithubAppCredentialsMux(gitHubConfig);\n const installs = await githubAppMux.getAllInstallations();\n\n return installs\n .map(install =>\n install.target_type === 'Organization' &&\n install.account &&\n install.account.login\n ? {\n name: install.account.login,\n groupNamespace: install.account.login.toLowerCase(),\n }\n : undefined,\n )\n .filter(Boolean) as GithubMultiOrgConfig;\n }\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n ANNOTATION_LOCATION,\n ANNOTATION_ORIGIN_LOCATION,\n Entity,\n} from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n DefaultGithubCredentialsProvider,\n GithubCredentialsProvider,\n GitHubIntegrationConfig,\n ScmIntegrations,\n SingleInstanceGithubCredentialsProvider,\n} from '@backstage/integration';\nimport {\n EntityProvider,\n EntityProviderConnection,\n} from '@backstage/plugin-catalog-backend';\nimport { graphql } from '@octokit/graphql';\nimport { merge } from 'lodash';\nimport { Logger } from 'winston';\nimport {\n assignGroupsToUsers,\n buildOrgHierarchy,\n getOrganizationTeams,\n getOrganizationUsers,\n parseGitHubOrgUrl,\n} from './lib';\n\n// TODO: Consider supporting an (optional) webhook that reacts on org changes\n/** @public */\nexport class GitHubOrgEntityProvider implements EntityProvider {\n private connection?: EntityProviderConnection;\n private githubCredentialsProvider: GithubCredentialsProvider;\n\n static fromConfig(\n config: Config,\n options: {\n id: string;\n orgUrl: string;\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n },\n ) {\n const integrations = ScmIntegrations.fromConfig(config);\n const gitHubConfig = integrations.github.byUrl(options.orgUrl)?.config;\n\n if (!gitHubConfig) {\n throw new Error(\n `There is no GitHub Org provider that matches ${options.orgUrl}. Please add a configuration for an integration.`,\n );\n }\n\n const logger = options.logger.child({\n target: options.orgUrl,\n });\n\n return new GitHubOrgEntityProvider({\n id: options.id,\n orgUrl: options.orgUrl,\n logger,\n gitHubConfig,\n githubCredentialsProvider:\n options.githubCredentialsProvider ||\n DefaultGithubCredentialsProvider.fromIntegrations(integrations),\n });\n }\n\n constructor(\n private options: {\n id: string;\n orgUrl: string;\n gitHubConfig: GitHubIntegrationConfig;\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n },\n ) {\n this.githubCredentialsProvider =\n options.githubCredentialsProvider ||\n SingleInstanceGithubCredentialsProvider.create(options.gitHubConfig);\n }\n\n getProviderName() {\n return `GitHubOrgEntityProvider:${this.options.id}`;\n }\n\n async connect(connection: EntityProviderConnection) {\n this.connection = connection;\n }\n\n async read() {\n if (!this.connection) {\n throw new Error('Not initialized');\n }\n\n const { markReadComplete } = trackProgress(this.options.logger);\n\n const { headers, type: tokenType } =\n await this.githubCredentialsProvider.getCredentials({\n url: this.options.orgUrl,\n });\n const client = graphql.defaults({\n baseUrl: this.options.gitHubConfig.apiBaseUrl,\n headers,\n });\n\n const { org } = parseGitHubOrgUrl(this.options.orgUrl);\n const { users } = await getOrganizationUsers(client, org, tokenType);\n const { groups, groupMemberUsers } = await getOrganizationTeams(\n client,\n org,\n );\n assignGroupsToUsers(users, groupMemberUsers);\n buildOrgHierarchy(groups);\n\n const { markCommitComplete } = markReadComplete({ users, groups });\n\n await this.connection.applyMutation({\n type: 'full',\n entities: [...users, ...groups].map(entity => ({\n locationKey: `github-org-provider:${this.options.id}`,\n entity: withLocations(\n `https://${this.options.gitHubConfig.host}`,\n org,\n entity,\n ),\n })),\n });\n\n markCommitComplete();\n }\n}\n\n// Helps wrap the timing and logging behaviors\nfunction trackProgress(logger: Logger) {\n let timestamp = Date.now();\n let summary: string;\n\n logger.info('Reading GitHub users and groups');\n\n function markReadComplete(read: { users: unknown[]; groups: unknown[] }) {\n summary = `${read.users.length} GitHub users and ${read.groups.length} GitHub groups`;\n const readDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n timestamp = Date.now();\n logger.info(`Read ${summary} in ${readDuration} seconds. Committing...`);\n return { markCommitComplete };\n }\n\n function markCommitComplete() {\n const commitDuration = ((Date.now() - timestamp) / 1000).toFixed(1);\n logger.info(`Committed ${summary} in ${commitDuration} seconds.`);\n }\n\n return { markReadComplete };\n}\n\n// Makes sure that emitted entities have a proper location\nexport function withLocations(\n baseUrl: string,\n org: string,\n entity: Entity,\n): Entity {\n const location =\n entity.kind === 'Group'\n ? `url:${baseUrl}/orgs/${org}/teams/${entity.metadata.name}`\n : `url:${baseUrl}/${entity.metadata.name}`;\n return merge(\n {\n metadata: {\n annotations: {\n [ANNOTATION_LOCATION]: location,\n [ANNOTATION_ORIGIN_LOCATION]: location,\n },\n },\n },\n entity,\n ) as Entity;\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport {\n DefaultGithubCredentialsProvider,\n GithubCredentialsProvider,\n GithubCredentialType,\n ScmIntegrationRegistry,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n LocationSpec,\n processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { graphql } from '@octokit/graphql';\nimport { Logger } from 'winston';\nimport {\n assignGroupsToUsers,\n buildOrgHierarchy,\n getOrganizationTeams,\n getOrganizationUsers,\n parseGitHubOrgUrl,\n} from './lib';\n\ntype GraphQL = typeof graphql;\n\n/**\n * Extracts teams and users out of a GitHub org.\n * @public\n */\nexport class GithubOrgReaderProcessor implements CatalogProcessor {\n private readonly integrations: ScmIntegrationRegistry;\n private readonly logger: Logger;\n private readonly githubCredentialsProvider: GithubCredentialsProvider;\n\n static fromConfig(\n config: Config,\n options: {\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n },\n ) {\n const integrations = ScmIntegrations.fromConfig(config);\n\n return new GithubOrgReaderProcessor({\n ...options,\n integrations,\n });\n }\n\n constructor(options: {\n integrations: ScmIntegrationRegistry;\n logger: Logger;\n githubCredentialsProvider?: GithubCredentialsProvider;\n }) {\n this.integrations = options.integrations;\n this.githubCredentialsProvider =\n options.githubCredentialsProvider ||\n DefaultGithubCredentialsProvider.fromIntegrations(this.integrations);\n this.logger = options.logger;\n }\n getProcessorName(): string {\n return 'GithubOrgReaderProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'github-org') {\n return false;\n }\n\n const { client, tokenType } = await this.createClient(location.target);\n const { org } = parseGitHubOrgUrl(location.target);\n\n // Read out all of the raw data\n const startTimestamp = Date.now();\n this.logger.info('Reading GitHub users and groups');\n\n const { users } = await getOrganizationUsers(client, org, tokenType);\n const { groups, groupMemberUsers } = await getOrganizationTeams(\n client,\n org,\n );\n\n const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n this.logger.debug(\n `Read ${users.length} GitHub users and ${groups.length} GitHub groups in ${duration} seconds`,\n );\n\n assignGroupsToUsers(users, groupMemberUsers);\n buildOrgHierarchy(groups);\n\n // Done!\n for (const group of groups) {\n emit(processingResult.entity(location, group));\n }\n for (const user of users) {\n emit(processingResult.entity(location, user));\n }\n\n return true;\n }\n\n private async createClient(\n orgUrl: string,\n ): Promise<{ client: GraphQL; tokenType: GithubCredentialType }> {\n const gitHubConfig = this.integrations.github.byUrl(orgUrl)?.config;\n\n if (!gitHubConfig) {\n throw new Error(\n `There is no GitHub Org provider that matches ${orgUrl}. Please add a configuration for an integration.`,\n );\n }\n\n const { headers, type: tokenType } =\n await this.githubCredentialsProvider.getCredentials({\n url: orgUrl,\n });\n\n const client = graphql.defaults({\n baseUrl: gitHubConfig.apiBaseUrl,\n headers,\n });\n\n return { client, tokenType };\n }\n}\n"],"names":["ScmIntegrations","DefaultGithubCredentialsProvider","graphql","processingResult","GithubAppCredentialsMux","SingleInstanceGithubCredentialsProvider","merge","ANNOTATION_LOCATION","ANNOTATION_ORIGIN_LOCATION"],"mappings":";;;;;;;;;;kCAqCyC,QAAsC;AArC/E;AAsCE,QAAM,aAAa,aAAO,uBAAuB,YAA9B,YAAyC;AAC5D,SAAO,WAAW,IAAI,OAAE;AAvC1B;AAuC8B;AAAA,MAC1B,MAAM,EAAE,UAAU;AAAA,MAClB,gBACE,UAAE,kBAAkB,sBAApB,aAAyC,EAAE,UAAU,SACrD;AAAA,MACF,eAAe,QAAE,kBAAkB,qBAApB,YAAwC;AAAA;AAAA;AAAA;;oCCqCzD,QACA,KACA,WACA,eACkC;AAClC,QAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBd,QAAM,SAAS,CAAC,SAAe;AAC7B,UAAM,SAAqB;AAAA,MACzB,YAAY;AAAA,MACZ,MAAM;AAAA,MACN,UAAU;AAAA,QACR,MAAM,KAAK;AAAA,QACX,aAAa;AAAA,UACX,yBAAyB,KAAK;AAAA;AAAA;AAAA,MAGlC,MAAM;AAAA,QACJ,SAAS;AAAA,QACT,UAAU;AAAA;AAAA;AAId,QAAI;AAAe,aAAO,SAAS,YAAY;AAC/C,QAAI,KAAK;AAAK,aAAO,SAAS,cAAc,KAAK;AACjD,QAAI,KAAK;AAAM,aAAO,KAAK,QAAS,cAAc,KAAK;AACvD,QAAI,KAAK;AAAO,aAAO,KAAK,QAAS,QAAQ,KAAK;AAClD,QAAI,KAAK;AAAW,aAAO,KAAK,QAAS,UAAU,KAAK;AAExD,WAAO;AAAA;AAGT,QAAM,QAAQ,MAAM,gBAClB,QACA,OACA,OAAE;AApIN;AAoIS,mBAAE,iBAAF,mBAAgB;AAAA,KACrB,QACA,EAAE,KAAK,OAAO,cAAc;AAG9B,SAAO,EAAE;AAAA;oCAYT,QACA,KACA,cAIC;AACD,QAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAsBd,QAAM,uCAAuB;AAE7B,QAAM,SAAS,OAAO,SAAe;AACnC,UAAM,SAAsB;AAAA,MAC1B,YAAY;AAAA,MACZ,MAAM;AAAA,MACN,UAAU;AAAA,QACR,MAAM,KAAK;AAAA,QACX,aAAa;AAAA,UACX,wBAAwB,KAAK;AAAA;AAAA;AAAA,MAGjC,MAAM;AAAA,QACJ,MAAM;AAAA,QACN,SAAS;AAAA,QACT,UAAU;AAAA;AAAA;AAId,QAAI,cAAc;AAChB,aAAO,SAAS,YAAY;AAAA;AAG9B,QAAI,KAAK,aAAa;AACpB,aAAO,SAAS,cAAc,KAAK;AAAA;AAErC,QAAI,KAAK,MAAM;AACb,aAAO,KAAK,QAAS,cAAc,KAAK;AAAA;AAE1C,QAAI,KAAK,WAAW;AAClB,aAAO,KAAK,QAAS,UAAU,KAAK;AAAA;AAEtC,QAAI,KAAK,YAAY;AACnB,aAAO,KAAK,SAAS,KAAK,WAAW;AAAA;AAGvC,UAAM,cAAwB;AAC9B,UAAM,WAAW,eAAe,GAAG,gBAAgB,KAAK,SAAS,KAAK;AACtE,qBAAiB,IAAI,UAAU;AAE/B,QAAI,CAAC,KAAK,QAAQ,SAAS,aAAa;AAEtC,iBAAW,QAAQ,KAAK,QAAQ,OAAO;AACrC,oBAAY,KAAK,KAAK;AAAA;AAAA,WAEnB;AAGL,YAAM,EAAE,YAAY,MAAM,eAAe,QAAQ,KAAK,KAAK;AAC3D,iBAAW,aAAa,SAAS;AAC/B,oBAAY,KAAK;AAAA;AAAA;AAIrB,WAAO;AAAA;AAGT,QAAM,SAAS,MAAM,gBACnB,QACA,OACA,OAAE;AA9ON;AA8OS,mBAAE,iBAAF,mBAAgB;AAAA,KACrB,QACA,EAAE;AAGJ,SAAO,EAAE,QAAQ;AAAA;2CAIjB,QACA,KACyC;AACzC,QAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAqBd,QAAM,eAAe,MAAM,gBACzB,QACA,OACA,OAAE;AAlRN;AAkRS,mBAAE,oBAAF,mBAAmB;AAAA,KACxB,OAAK,GACL,EAAE;AAGJ,SAAO,EAAE;AAAA;8BAaT,QACA,KACA,UACgC;AAChC,QAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYd,QAAM,UAAU,MAAM,gBACpB,QACA,OACA,OAAE;AAvTN;AAuTS,yBAAE,iBAAF,mBAAgB,SAAhB,mBAAsB;AAAA,KAC3B,UAAQ,KAAK,OACb,EAAE,KAAK;AAGT,SAAO,EAAE;AAAA;+BA0BT,QACA,OACA,YACA,QACA,WACuB;AACvB,QAAM,SAAuB;AAE7B,MAAI,SAA6B;AACjC,WAAS,IAAI,GAAG,IAAI,KAA4B,EAAE,GAAG;AACnD,UAAM,WAAqB,MAAM,OAAO,OAAO;AAAA,SAC1C;AAAA,MACH;AAAA;AAGF,UAAM,OAAO,WAAW;AACxB,QAAI,CAAC,MAAM;AACT,YAAM,IAAI,MAAM,sBAAsB,KAAK,UAAU;AAAA;AAGvD,eAAW,QAAQ,KAAK,OAAO;AAC7B,aAAO,KAAK,MAAM,OAAO;AAAA;AAG3B,QAAI,CAAC,KAAK,SAAS,aAAa;AAC9B;AAAA,WACK;AACL,eAAS,KAAK,SAAS;AAAA;AAAA;AAI3B,SAAO;AAAA;;2BCnWyB,QAAuB;AACvD,QAAM,eAAe,IAAI,IAAI,OAAO,IAAI,OAAK,CAAC,EAAE,SAAS,MAAM;AAM/D,aAAW,SAAS,QAAQ;AAC1B,UAAM,WAAW,MAAM,SAAS;AAChC,UAAM,aAAa,MAAM,KAAK;AAC9B,QAAI,YAAY;AACd,YAAM,SAAS,aAAa,IAAI;AAChC,UAAI,UAAU,CAAC,OAAO,KAAK,SAAS,SAAS,WAAW;AACtD,eAAO,KAAK,SAAS,KAAK;AAAA;AAAA;AAAA;AAShC,aAAW,SAAS,QAAQ;AAC1B,UAAM,WAAW,MAAM,SAAS;AAChC,eAAW,aAAa,MAAM,KAAK,UAAU;AAC3C,YAAM,QAAQ,aAAa,IAAI;AAC/B,UAAI,SAAS,CAAC,MAAM,KAAK,QAAQ;AAC/B,cAAM,KAAK,SAAS;AAAA;AAAA;AAAA;AAAA;6BAQ1B,OACA,kBACA;AACA,QAAM,cAAc,IAAI,IAAI,MAAM,IAAI,OAAK,CAAC,EAAE,SAAS,MAAM;AAC7D,aAAW,CAAC,WAAW,cAAc,iBAAiB,WAAW;AAC/D,eAAW,YAAY,WAAW;AAChC,YAAM,OAAO,YAAY,IAAI;AAC7B,UAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,SAAS,YAAY;AACnD,aAAK,KAAK,SAAS,KAAK;AAAA;AAAA;AAAA;AAAA;;2BC7CE,WAAoC;AACpE,QAAM,OAAO,IAAI,IAAI,WAAW,SAAS,OAAO,GAAG,MAAM;AAGzD,MAAI,KAAK,WAAW,KAAK,KAAK,GAAG,QAAQ;AACvC,WAAO,EAAE,KAAK,mBAAmB,KAAK;AAAA;AAGxC,QAAM,IAAI,MAAM;AAAA;;+BCyBgD;AAAA,SAKzD,WACL,QACA,SAIA;AACA,UAAM,eAAeA,4BAAgB,WAAW;AAEhD,WAAO,IAAI,yBAAyB;AAAA,SAC/B;AAAA,MACH;AAAA;AAAA;AAAA,EAIJ,YAAY,SAIT;AACD,SAAK,eAAe,QAAQ;AAC5B,SAAK,SAAS,QAAQ;AACtB,SAAK,4BACH,QAAQ,6BACRC,6CAAiC,iBAAiB,KAAK;AAAA;AAAA,EAE3D,mBAA2B;AACzB,WAAO;AAAA;AAAA,QAGH,aACJ,UACA,WACA,MACkB;AAxFtB;AAyFI,QAAI,SAAS,SAAS,oBAAoB;AACxC,aAAO;AAAA;AAGT,UAAM,eAAe,WAAK,aAAa,OAAO,MAC5C,SAAS,YADU,mBAElB;AACH,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MACR,+CAA+C,SAAS;AAAA;AAI5D,UAAM,EAAE,KAAK,gBAAgB,aAAa,QAAQ,SAAS,SACzD,SAAS;AAKX,UAAM,SAAS,WAAW,QAAQ;AAElC,UAAM,EAAE,YAAY,MAAM,KAAK,0BAA0B,eAAe;AAAA,MACtE,KAAK;AAAA;AAGP,UAAM,SAASC,gBAAQ,SAAS;AAAA,MAC9B,SAAS,aAAa;AAAA,MACtB;AAAA;AAIF,UAAM,iBAAiB,KAAK;AAC5B,SAAK,OAAO,KAAK,oCAAoC,SAAS;AAE9D,UAAM,EAAE,iBAAiB,MAAM,4BAA4B,QAAQ;AACnE,UAAM,WAAW,aAAa,OAC5B,OAAK,CAAC,EAAE,cAAc,eAAe,KAAK,EAAE;AAG9C,UAAM,WAAa,OAAK,QAAQ,kBAAkB,KAAM,QAAQ;AAChE,SAAK,OAAO,MACV,QAAQ,aAAa,+BAA+B,SAAS,mCAAmC;AAGlG,eAAW,cAAc,UAAU;AACjC,YAAM,aACJ,WAAW,MAAM,iBAAW,qBAAX,mBAA6B,OAAO;AAEvD,UAAI,CAAC,YAAY;AACf,aAAK,OAAO,KACV,kBAAkB,WAAW;AAE/B;AAAA;AAGF,YAAM,OAAO,SAAS,aAAa;AAEnC,WACEC,sCAAiB,SAAS;AAAA,QACxB,MAAM;AAAA,QACN,QAAQ,GAAG,WAAW,MAAM;AAAA,QAI5B,UAAU;AAAA;AAAA;AAKhB,WAAO;AAAA;AAAA;kBAQc,WAMvB;AACA,QAAM,MAAM,IAAI,IAAI;AACpB,QAAM,OAAO,IAAI,SAAS,OAAO,GAAG,MAAM;AAK1C,MAAI,KAAK,SAAS,KAAK,KAAK,GAAG,UAAU,KAAK,GAAG,QAAQ;AACvD,WAAO;AAAA,MACL,KAAK,mBAAmB,KAAK;AAAA,MAC7B,gBAAgB,aAAa,mBAAmB,KAAK;AAAA,MACrD,QAAQ,mBAAmB,KAAK;AAAA,MAChC,aAAa,IAAI,mBAAmB,KAAK,MAAM,GAAG,KAAK;AAAA,MACvD,MAAM,IAAI;AAAA;AAAA,aAEH,KAAK,WAAW,KAAK,KAAK,GAAG,QAAQ;AAC9C,WAAO;AAAA,MACL,KAAK,mBAAmB,KAAK;AAAA,MAC7B,MAAM,IAAI;AAAA,MACV,gBAAgB,aAAa;AAAA,MAC7B,aAAa;AAAA,MACb,QAAQ;AAAA;AAAA;AAIZ,QAAM,IAAI,MAAM,mBAAmB;AAAA;sBAGR,KAAqB;AAChD,SAAO,IAAI,OAAO,IAAI,IAAI,QAAQ,OAAO;AAAA;;oCCzJ4B;AAAA,SAM9D,WACL,QACA,SAIA;AACA,UAAM,IAAI,OAAO,kBAAkB;AACnC,UAAM,eAAeH,4BAAgB,WAAW;AAEhD,WAAO,IAAI,8BAA8B;AAAA,SACpC;AAAA,MACH;AAAA,MACA,MAAM,IAAI,yBAAyB,KAAK;AAAA;AAAA;AAAA,EAI5C,YAAY,SAKT;AACD,SAAK,eAAe,QAAQ;AAC5B,SAAK,SAAS,QAAQ;AACtB,SAAK,OAAO,QAAQ;AACpB,SAAK,4BACH,QAAQ,6BACRC,6CAAiC,iBAAiB,KAAK;AAAA;AAAA,EAE3D,mBAA2B;AACzB,WAAO;AAAA;AAAA,QAGH,aACJ,UACA,WACA,MACkB;AA5FtB;AA6FI,QAAI,SAAS,SAAS,oBAAoB;AACxC,aAAO;AAAA;AAGT,UAAM,eAAe,WAAK,aAAa,OAAO,MAC5C,SAAS,YADU,mBAElB;AACH,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MACR,+CAA+C,SAAS;AAAA;AAI5D,UAAM,kCAAkB;AACxB,UAAM,UAAU,IAAI,IAAI,SAAS,QAAQ;AAEzC,UAAM,gBAAgB,KAAK,KAAK,SAC5B,KAAK,OACL,MAAM,KAAK,WAAW;AAE1B,eAAW,aAAa,eAAe;AACrC,UAAI;AACF,cAAM,EAAE,SAAS,MAAM,cACrB,MAAM,KAAK,0BAA0B,eAAe;AAAA,UAClD,KAAK,GAAG,WAAW,UAAU;AAAA;AAEjC,cAAM,SAASC,gBAAQ,SAAS;AAAA,UAC9B,SAAS,aAAa;AAAA,UACtB;AAAA;AAGF,cAAM,iBAAiB,KAAK;AAC5B,aAAK,OAAO,KACV,2CAA2C,UAAU;AAEvD,cAAM,EAAE,UAAU,MAAM,qBACtB,QACA,UAAU,MACV,WACA,UAAU;AAEZ,cAAM,EAAE,QAAQ,qBAAqB,MAAM,qBACzC,QACA,UAAU,MACV,UAAU;AAGZ,cAAM,WAAa,OAAK,QAAQ,kBAAkB,KAAM,QAAQ;AAChE,aAAK,OAAO,MACV,QAAQ,MAAM,2BAA2B,OAAO,4BAA4B,UAAU,WAAW;AAGnG,YAAI,SAAiB,gBAAU,kBAAV,YAA2B;AAChD,YAAI,OAAO,SAAS;AAAG,oBAAU;AAEjC,cAAM,QAAQ,OAAK;AACjB,cAAI,CAAC,YAAY,IAAI,SAAS,EAAE,SAAS,OAAO;AAC9C,wBAAY,IAAI,SAAS,EAAE,SAAS,MAAM;AAAA;AAAA;AAI9C,mBAAW,CAAC,WAAW,cAAc,iBAAiB,WAAW;AAC/D,qBAAW,YAAY,WAAW;AAChC,kBAAM,OAAO,YAAY,IAAI,SAAS;AACtC,gBAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,SAAS,YAAY;AACnD,mBAAK,KAAK,SAAS,KAAK;AAAA;AAAA;AAAA;AAI9B,0BAAkB;AAElB,mBAAW,SAAS,QAAQ;AAC1B,eAAKC,sCAAiB,OAAO,UAAU;AAAA;AAAA,eAElC,GAAP;AACA,aAAK,OAAO,MACV,sCAAsC,UAAU,SAAS;AAAA;AAAA;AAK/D,UAAM,WAAW,MAAM,KAAK,YAAY;AACxC,eAAW,QAAQ,UAAU;AAC3B,WAAKA,sCAAiB,OAAO,UAAU;AAAA;AAGzC,WAAO;AAAA;AAAA,QAIK,WACZ,cAC+B;AAC/B,UAAM,eAAe,IAAIC,oCAAwB;AACjD,UAAM,WAAW,MAAM,aAAa;AAEpC,WAAO,SACJ,IAAI,aACH,QAAQ,gBAAgB,kBACxB,QAAQ,WACR,QAAQ,QAAQ,QACZ;AAAA,MACE,MAAM,QAAQ,QAAQ;AAAA,MACtB,gBAAgB,QAAQ,QAAQ,MAAM;AAAA,QAExC,QAEL,OAAO;AAAA;AAAA;;8BC1JiD;AAAA,EAqC7D,YACU,SAOR;AAPQ;AAQR,SAAK,4BACH,QAAQ,6BACRC,oDAAwC,OAAO,QAAQ;AAAA;AAAA,SA5CpD,WACL,QACA,SAMA;AA1DJ;AA2DI,UAAM,eAAeL,4BAAgB,WAAW;AAChD,UAAM,eAAe,mBAAa,OAAO,MAAM,QAAQ,YAAlC,mBAA2C;AAEhE,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MACR,gDAAgD,QAAQ;AAAA;AAI5D,UAAM,SAAS,QAAQ,OAAO,MAAM;AAAA,MAClC,QAAQ,QAAQ;AAAA;AAGlB,WAAO,IAAI,wBAAwB;AAAA,MACjC,IAAI,QAAQ;AAAA,MACZ,QAAQ,QAAQ;AAAA,MAChB;AAAA,MACA;AAAA,MACA,2BACE,QAAQ,6BACRC,6CAAiC,iBAAiB;AAAA;AAAA;AAAA,EAkBxD,kBAAkB;AAChB,WAAO,2BAA2B,KAAK,QAAQ;AAAA;AAAA,QAG3C,QAAQ,YAAsC;AAClD,SAAK,aAAa;AAAA;AAAA,QAGd,OAAO;AACX,QAAI,CAAC,KAAK,YAAY;AACpB,YAAM,IAAI,MAAM;AAAA;AAGlB,UAAM,EAAE,qBAAqB,cAAc,KAAK,QAAQ;AAExD,UAAM,EAAE,SAAS,MAAM,cACrB,MAAM,KAAK,0BAA0B,eAAe;AAAA,MAClD,KAAK,KAAK,QAAQ;AAAA;AAEtB,UAAM,SAASC,gBAAQ,SAAS;AAAA,MAC9B,SAAS,KAAK,QAAQ,aAAa;AAAA,MACnC;AAAA;AAGF,UAAM,EAAE,QAAQ,kBAAkB,KAAK,QAAQ;AAC/C,UAAM,EAAE,UAAU,MAAM,qBAAqB,QAAQ,KAAK;AAC1D,UAAM,EAAE,QAAQ,qBAAqB,MAAM,qBACzC,QACA;AAEF,wBAAoB,OAAO;AAC3B,sBAAkB;AAElB,UAAM,EAAE,uBAAuB,iBAAiB,EAAE,OAAO;AAEzD,UAAM,KAAK,WAAW,cAAc;AAAA,MAClC,MAAM;AAAA,MACN,UAAU,CAAC,GAAG,OAAO,GAAG,QAAQ,IAAI;AAAW,QAC7C,aAAa,uBAAuB,KAAK,QAAQ;AAAA,QACjD,QAAQ,cACN,WAAW,KAAK,QAAQ,aAAa,QACrC,KACA;AAAA;AAAA;AAKN;AAAA;AAAA;AAKJ,uBAAuB,QAAgB;AACrC,MAAI,YAAY,KAAK;AACrB,MAAI;AAEJ,SAAO,KAAK;AAEZ,4BAA0B,MAA+C;AACvE,cAAU,GAAG,KAAK,MAAM,2BAA2B,KAAK,OAAO;AAC/D,UAAM,eAAiB,OAAK,QAAQ,aAAa,KAAM,QAAQ;AAC/D,gBAAY,KAAK;AACjB,WAAO,KAAK,QAAQ,cAAc;AAClC,WAAO,EAAE;AAAA;AAGX,gCAA8B;AAC5B,UAAM,iBAAmB,OAAK,QAAQ,aAAa,KAAM,QAAQ;AACjE,WAAO,KAAK,aAAa,cAAc;AAAA;AAGzC,SAAO,EAAE;AAAA;uBAKT,SACA,KACA,QACQ;AACR,QAAM,WACJ,OAAO,SAAS,UACZ,OAAO,gBAAgB,aAAa,OAAO,SAAS,SACpD,OAAO,WAAW,OAAO,SAAS;AACxC,SAAOI,aACL;AAAA,IACE,UAAU;AAAA,MACR,aAAa;AAAA,SACVC,mCAAsB;AAAA,SACtBC,0CAA6B;AAAA;AAAA;AAAA,KAIpC;AAAA;;+BChJ8D;AAAA,SAKzD,WACL,QACA,SAIA;AACA,UAAM,eAAeR,4BAAgB,WAAW;AAEhD,WAAO,IAAI,yBAAyB;AAAA,SAC/B;AAAA,MACH;AAAA;AAAA;AAAA,EAIJ,YAAY,SAIT;AACD,SAAK,eAAe,QAAQ;AAC5B,SAAK,4BACH,QAAQ,6BACRC,6CAAiC,iBAAiB,KAAK;AACzD,SAAK,SAAS,QAAQ;AAAA;AAAA,EAExB,mBAA2B;AACzB,WAAO;AAAA;AAAA,QAGH,aACJ,UACA,WACA,MACkB;AAClB,QAAI,SAAS,SAAS,cAAc;AAClC,aAAO;AAAA;AAGT,UAAM,EAAE,QAAQ,cAAc,MAAM,KAAK,aAAa,SAAS;AAC/D,UAAM,EAAE,QAAQ,kBAAkB,SAAS;AAG3C,UAAM,iBAAiB,KAAK;AAC5B,SAAK,OAAO,KAAK;AAEjB,UAAM,EAAE,UAAU,MAAM,qBAAqB,QAAQ,KAAK;AAC1D,UAAM,EAAE,QAAQ,qBAAqB,MAAM,qBACzC,QACA;AAGF,UAAM,WAAa,OAAK,QAAQ,kBAAkB,KAAM,QAAQ;AAChE,SAAK,OAAO,MACV,QAAQ,MAAM,2BAA2B,OAAO,2BAA2B;AAG7E,wBAAoB,OAAO;AAC3B,sBAAkB;AAGlB,eAAW,SAAS,QAAQ;AAC1B,WAAKE,sCAAiB,OAAO,UAAU;AAAA;AAEzC,eAAW,QAAQ,OAAO;AACxB,WAAKA,sCAAiB,OAAO,UAAU;AAAA;AAGzC,WAAO;AAAA;AAAA,QAGK,aACZ,QAC+D;AA5HnE;AA6HI,UAAM,eAAe,WAAK,aAAa,OAAO,MAAM,YAA/B,mBAAwC;AAE7D,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MACR,gDAAgD;AAAA;AAIpD,UAAM,EAAE,SAAS,MAAM,cACrB,MAAM,KAAK,0BAA0B,eAAe;AAAA,MAClD,KAAK;AAAA;AAGT,UAAM,SAASD,gBAAQ,SAAS;AAAA,MAC9B,SAAS,aAAa;AAAA,MACtB;AAAA;AAGF,WAAO,EAAE,QAAQ;AAAA;AAAA;;;;;;;"}
@@ -0,0 +1,130 @@
1
+ import { Config } from '@backstage/config';
2
+ import { GithubCredentialsProvider, ScmIntegrationRegistry, GitHubIntegrationConfig } from '@backstage/integration';
3
+ import { CatalogProcessor, LocationSpec, CatalogProcessorEmit, EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
4
+ import { Logger } from 'winston';
5
+
6
+ /**
7
+ * Extracts repositories out of a GitHub org.
8
+ *
9
+ * The following will create locations for all projects which have a catalog-info.yaml
10
+ * on the default branch. The first is shorthand for the second.
11
+ *
12
+ * target: "https://github.com/backstage"
13
+ * or
14
+ * target: https://github.com/backstage/*\/blob/-/catalog-info.yaml
15
+ *
16
+ * You may also explicitly specify the source branch:
17
+ *
18
+ * target: https://github.com/backstage/*\/blob/main/catalog-info.yaml
19
+ *
20
+ * @public
21
+ **/
22
+ declare class GithubDiscoveryProcessor implements CatalogProcessor {
23
+ private readonly integrations;
24
+ private readonly logger;
25
+ private readonly githubCredentialsProvider;
26
+ static fromConfig(config: Config, options: {
27
+ logger: Logger;
28
+ githubCredentialsProvider?: GithubCredentialsProvider;
29
+ }): GithubDiscoveryProcessor;
30
+ constructor(options: {
31
+ integrations: ScmIntegrationRegistry;
32
+ logger: Logger;
33
+ githubCredentialsProvider?: GithubCredentialsProvider;
34
+ });
35
+ getProcessorName(): string;
36
+ readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
37
+ }
38
+
39
+ /**
40
+ * The configuration parameters for a multi-org GitHub processor.
41
+ * @public
42
+ */
43
+ declare type GithubMultiOrgConfig = Array<{
44
+ /**
45
+ * The name of the GitHub org to process.
46
+ */
47
+ name: string;
48
+ /**
49
+ * The namespace of the group created for this org.
50
+ */
51
+ groupNamespace: string;
52
+ /**
53
+ * The namespace of the users created for this org. If not specified defaults to undefined.
54
+ */
55
+ userNamespace: string | undefined;
56
+ }>;
57
+
58
+ /**
59
+ * Extracts teams and users out of a multiple GitHub orgs namespaced per org.
60
+ *
61
+ * Be aware that this processor may not be compatible with future org structures in the catalog.
62
+ *
63
+ * @public
64
+ */
65
+ declare class GithubMultiOrgReaderProcessor implements CatalogProcessor {
66
+ private readonly integrations;
67
+ private readonly orgs;
68
+ private readonly logger;
69
+ private readonly githubCredentialsProvider;
70
+ static fromConfig(config: Config, options: {
71
+ logger: Logger;
72
+ githubCredentialsProvider?: GithubCredentialsProvider;
73
+ }): GithubMultiOrgReaderProcessor;
74
+ constructor(options: {
75
+ integrations: ScmIntegrationRegistry;
76
+ logger: Logger;
77
+ orgs: GithubMultiOrgConfig;
78
+ githubCredentialsProvider?: GithubCredentialsProvider;
79
+ });
80
+ getProcessorName(): string;
81
+ readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
82
+ private getAllOrgs;
83
+ }
84
+
85
+ /** @public */
86
+ declare class GitHubOrgEntityProvider implements EntityProvider {
87
+ private options;
88
+ private connection?;
89
+ private githubCredentialsProvider;
90
+ static fromConfig(config: Config, options: {
91
+ id: string;
92
+ orgUrl: string;
93
+ logger: Logger;
94
+ githubCredentialsProvider?: GithubCredentialsProvider;
95
+ }): GitHubOrgEntityProvider;
96
+ constructor(options: {
97
+ id: string;
98
+ orgUrl: string;
99
+ gitHubConfig: GitHubIntegrationConfig;
100
+ logger: Logger;
101
+ githubCredentialsProvider?: GithubCredentialsProvider;
102
+ });
103
+ getProviderName(): string;
104
+ connect(connection: EntityProviderConnection): Promise<void>;
105
+ read(): Promise<void>;
106
+ }
107
+
108
+ /**
109
+ * Extracts teams and users out of a GitHub org.
110
+ * @public
111
+ */
112
+ declare class GithubOrgReaderProcessor implements CatalogProcessor {
113
+ private readonly integrations;
114
+ private readonly logger;
115
+ private readonly githubCredentialsProvider;
116
+ static fromConfig(config: Config, options: {
117
+ logger: Logger;
118
+ githubCredentialsProvider?: GithubCredentialsProvider;
119
+ }): GithubOrgReaderProcessor;
120
+ constructor(options: {
121
+ integrations: ScmIntegrationRegistry;
122
+ logger: Logger;
123
+ githubCredentialsProvider?: GithubCredentialsProvider;
124
+ });
125
+ getProcessorName(): string;
126
+ readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
127
+ private createClient;
128
+ }
129
+
130
+ export { GitHubOrgEntityProvider, GithubDiscoveryProcessor, GithubMultiOrgConfig, GithubMultiOrgReaderProcessor, GithubOrgReaderProcessor };
package/package.json ADDED
@@ -0,0 +1,58 @@
1
+ {
2
+ "name": "@backstage/plugin-catalog-backend-module-github",
3
+ "description": "A Backstage catalog backend module that helps integrate towards GitHub",
4
+ "version": "0.1.0",
5
+ "main": "dist/index.cjs.js",
6
+ "types": "dist/index.d.ts",
7
+ "license": "Apache-2.0",
8
+ "private": false,
9
+ "publishConfig": {
10
+ "access": "public",
11
+ "main": "dist/index.cjs.js",
12
+ "types": "dist/index.d.ts"
13
+ },
14
+ "backstage": {
15
+ "role": "backend-plugin-module"
16
+ },
17
+ "homepage": "https://backstage.io",
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "https://github.com/backstage/backstage",
21
+ "directory": "plugins/catalog-backend-module-github"
22
+ },
23
+ "keywords": [
24
+ "backstage"
25
+ ],
26
+ "scripts": {
27
+ "build": "backstage-cli package build",
28
+ "lint": "backstage-cli package lint",
29
+ "test": "backstage-cli package test",
30
+ "prepack": "backstage-cli package prepack",
31
+ "postpack": "backstage-cli package postpack",
32
+ "clean": "backstage-cli package clean",
33
+ "start": "backstage-cli package start"
34
+ },
35
+ "dependencies": {
36
+ "@backstage/backend-common": "^0.13.0",
37
+ "@backstage/catalog-model": "^0.13.0",
38
+ "@backstage/config": "^0.1.15",
39
+ "@backstage/errors": "^0.2.2",
40
+ "@backstage/integration": "^0.8.0",
41
+ "@backstage/plugin-catalog-backend": "^0.24.0",
42
+ "@backstage/types": "^0.1.3",
43
+ "@octokit/graphql": "^4.5.8",
44
+ "lodash": "^4.17.21",
45
+ "msw": "^0.35.0",
46
+ "node-fetch": "^2.6.7",
47
+ "winston": "^3.2.1"
48
+ },
49
+ "devDependencies": {
50
+ "@backstage/backend-test-utils": "^0.1.21",
51
+ "@backstage/cli": "^0.15.2",
52
+ "@types/lodash": "^4.14.151"
53
+ },
54
+ "files": [
55
+ "dist"
56
+ ],
57
+ "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a"
58
+ }