@backstage/plugin-catalog-backend-module-gitlab 0.6.4 → 0.6.5-next.1
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 +29 -0
- package/config.d.ts +12 -0
- package/dist/index.d.ts +10 -0
- package/dist/lib/client.cjs.js.map +1 -1
- package/dist/providers/GitlabDiscoveryEntityProvider.cjs.js +3 -1
- package/dist/providers/GitlabDiscoveryEntityProvider.cjs.js.map +1 -1
- package/dist/providers/config.cjs.js +6 -1
- package/dist/providers/config.cjs.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-gitlab
|
|
2
2
|
|
|
3
|
+
## 0.6.5-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/integration@1.16.3-next.0
|
|
9
|
+
- @backstage/backend-defaults@0.9.0-next.1
|
|
10
|
+
- @backstage/backend-plugin-api@1.2.1
|
|
11
|
+
- @backstage/catalog-model@1.7.3
|
|
12
|
+
- @backstage/config@1.3.2
|
|
13
|
+
- @backstage/plugin-catalog-common@1.1.3
|
|
14
|
+
- @backstage/plugin-catalog-node@1.16.1
|
|
15
|
+
- @backstage/plugin-events-node@0.4.9
|
|
16
|
+
|
|
17
|
+
## 0.6.5-next.0
|
|
18
|
+
|
|
19
|
+
### Patch Changes
|
|
20
|
+
|
|
21
|
+
- a568cda: add filter for repos by membership and topics
|
|
22
|
+
- Updated dependencies
|
|
23
|
+
- @backstage/backend-defaults@0.9.0-next.0
|
|
24
|
+
- @backstage/backend-plugin-api@1.2.1
|
|
25
|
+
- @backstage/catalog-model@1.7.3
|
|
26
|
+
- @backstage/config@1.3.2
|
|
27
|
+
- @backstage/integration@1.16.2
|
|
28
|
+
- @backstage/plugin-catalog-common@1.1.3
|
|
29
|
+
- @backstage/plugin-catalog-node@1.16.1
|
|
30
|
+
- @backstage/plugin-events-node@0.4.9
|
|
31
|
+
|
|
3
32
|
## 0.6.4
|
|
4
33
|
|
|
5
34
|
### Patch Changes
|
package/config.d.ts
CHANGED
|
@@ -72,6 +72,18 @@ export interface Config {
|
|
|
72
72
|
* Should be in the format group/subgroup/repo, with no leading or trailing slashes.
|
|
73
73
|
*/
|
|
74
74
|
excludeRepos?: string[];
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* (Optional) If true, limit by repositories that the current user is a member of.
|
|
78
|
+
* See: https://docs.gitlab.com/api/projects/#list-projects
|
|
79
|
+
*/
|
|
80
|
+
membership?: boolean;
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* (Optional) List of topic names. Limit results to repositories that match all of given topics.
|
|
84
|
+
* See: https://docs.gitlab.com/api/projects/#list-projects
|
|
85
|
+
*/
|
|
86
|
+
topics?: string;
|
|
75
87
|
};
|
|
76
88
|
};
|
|
77
89
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -258,6 +258,16 @@ type GitlabProviderConfig = {
|
|
|
258
258
|
* Defaults to `false`
|
|
259
259
|
*/
|
|
260
260
|
includeUsersWithoutSeat?: boolean;
|
|
261
|
+
/**
|
|
262
|
+
* If true, the membership parameter is set to true in the GitLab API request.
|
|
263
|
+
* See: https://docs.gitlab.com/api/projects/#list-projects
|
|
264
|
+
*/
|
|
265
|
+
membership?: boolean;
|
|
266
|
+
/**
|
|
267
|
+
* Optional comma seperated list of topics to filter projects by, as specified in the GitLab API documentation:
|
|
268
|
+
* https://docs.gitlab.com/api/projects/#list-projects
|
|
269
|
+
*/
|
|
270
|
+
topics?: string;
|
|
261
271
|
};
|
|
262
272
|
/**
|
|
263
273
|
* Customize how group names are generated
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.cjs.js","sources":["../../src/lib/client.ts"],"sourcesContent":["/*\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\n// NOTE(freben): Intentionally uses node-fetch because of https://github.com/backstage/backstage/issues/28190\nimport fetch from 'node-fetch';\n\nimport {\n getGitLabRequestOptions,\n GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport {\n GitLabDescendantGroupsResponse,\n GitLabGroup,\n GitLabGroupMembersResponse,\n GitLabProject,\n GitLabUser,\n PagedResponse,\n} from './types';\n\nexport type CommonListOptions = {\n [key: string]: string | number | boolean | undefined;\n per_page?: number | undefined;\n page?: number | undefined;\n active?: boolean;\n};\n\ninterface ListProjectOptions extends CommonListOptions {\n archived?: boolean;\n group?: string;\n}\n\ninterface UserListOptions extends CommonListOptions {\n without_project_bots?: boolean | undefined;\n exclude_internal?: boolean | undefined;\n}\n\nexport class GitLabClient {\n private readonly config: GitLabIntegrationConfig;\n private readonly logger: LoggerService;\n\n constructor(options: {\n config: GitLabIntegrationConfig;\n logger: LoggerService;\n }) {\n this.config = options.config;\n this.logger = options.logger;\n }\n\n /**\n * Indicates whether the client is for a SaaS or self managed GitLab instance.\n */\n isSelfManaged(): boolean {\n return this.config.host !== 'gitlab.com';\n }\n\n async listProjects(\n options?: ListProjectOptions,\n ): Promise<PagedResponse<any>> {\n if (options?.group) {\n return this.pagedRequest(\n `/groups/${encodeURIComponent(options?.group)}/projects`,\n {\n ...options,\n include_subgroups: true,\n },\n );\n }\n\n return this.pagedRequest(`/projects`, options);\n }\n\n async getProjectById(\n projectId: number,\n options?: CommonListOptions,\n ): Promise<GitLabProject> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(\n `/projects/${projectId}`,\n options,\n );\n\n return response;\n }\n\n async getGroupById(\n groupId: number,\n options?: CommonListOptions,\n ): Promise<GitLabGroup> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(`/groups/${groupId}`, options);\n\n return response;\n }\n\n async getUserById(\n userId: number,\n options?: CommonListOptions,\n ): Promise<GitLabUser> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(`/users/${userId}`, options);\n\n return response;\n }\n\n async listGroupMembers(\n groupPath: string,\n options?: CommonListOptions,\n ): Promise<PagedResponse<GitLabUser>> {\n return this.pagedRequest(\n `/groups/${encodeURIComponent(groupPath)}/members/all`,\n options,\n );\n }\n\n async listUsers(\n options?: UserListOptions,\n ): Promise<PagedResponse<GitLabUser>> {\n return this.pagedRequest(`/users?`, {\n ...options,\n without_project_bots: true,\n exclude_internal: true,\n });\n }\n\n async listSaaSUsers(\n groupPath: string,\n options?: CommonListOptions,\n includeUsersWithoutSeat?: boolean,\n ): Promise<PagedResponse<GitLabUser>> {\n const botFilterRegex = /^(?:project|group)_(\\w+)_bot_(\\w+)$/;\n\n return this.listGroupMembers(groupPath, {\n ...options,\n active: true, // Users with seat are always active but for users without seat we need to filter\n show_seat_info: true,\n }).then(resp => {\n // Filter is optional to allow to import Gitlab Free users without seats\n // https://github.com/backstage/backstage/issues/26438\n // Filter out API tokens https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#bot-users-for-projects\n if (includeUsersWithoutSeat) {\n resp.items = resp.items.filter(user => {\n return !botFilterRegex.test(user.username);\n });\n } else {\n resp.items = resp.items.filter(user => user.is_using_seat);\n }\n return resp;\n });\n }\n\n async listGroups(\n options?: CommonListOptions,\n ): Promise<PagedResponse<GitLabGroup>> {\n return this.pagedRequest(`/groups`, options);\n }\n\n // https://docs.gitlab.com/ee/api/groups.html#list-group-details\n // id can either be group id or encoded full path\n async getGroupByPath(\n groupPath: string,\n options?: CommonListOptions,\n ): Promise<GitLabGroup> {\n return this.nonPagedRequest(\n `/groups/${encodeURIComponent(groupPath)}`,\n options,\n );\n }\n\n async listDescendantGroups(\n groupPath: string,\n ): Promise<PagedResponse<GitLabGroup>> {\n const items: GitLabGroup[] = [];\n let hasNextPage: boolean = false;\n let endCursor: string | null = null;\n\n do {\n const response: GitLabDescendantGroupsResponse = await fetch(\n `${this.config.baseUrl}/api/graphql`,\n {\n method: 'POST',\n headers: {\n ...getGitLabRequestOptions(this.config).headers,\n ['Content-Type']: 'application/json',\n },\n body: JSON.stringify({\n variables: { group: groupPath, endCursor },\n query: /* GraphQL */ `\n query listDescendantGroups($group: ID!, $endCursor: String) {\n group(fullPath: $group) {\n descendantGroups(first: 100, after: $endCursor) {\n nodes {\n id\n name\n description\n fullPath\n visibility\n parent {\n id\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n }\n }\n }\n }\n `,\n }),\n },\n ).then(r => r.json());\n if (response.errors) {\n throw new Error(`GraphQL errors: ${JSON.stringify(response.errors)}`);\n }\n\n if (!response.data.group?.descendantGroups?.nodes) {\n this.logger.warn(\n `Couldn't get groups under ${groupPath}. The provided token might not have sufficient permissions`,\n );\n continue;\n }\n\n for (const groupItem of response.data.group.descendantGroups.nodes.filter(\n group => group?.id,\n )) {\n const formattedGroupResponse = {\n id: Number(groupItem.id.replace(/^gid:\\/\\/gitlab\\/Group\\//, '')),\n name: groupItem.name,\n description: groupItem.description,\n full_path: groupItem.fullPath,\n visibility: groupItem.visibility,\n parent_id: Number(\n groupItem.parent.id.replace(/^gid:\\/\\/gitlab\\/Group\\//, ''),\n ),\n };\n\n items.push(formattedGroupResponse);\n }\n ({ hasNextPage, endCursor } =\n response.data.group.descendantGroups.pageInfo);\n } while (hasNextPage);\n return { items };\n }\n\n async getGroupMembers(\n groupPath: string,\n relations: string[],\n ): Promise<PagedResponse<GitLabUser>> {\n const items: GitLabUser[] = [];\n let hasNextPage: boolean = false;\n let endCursor: string | null = null;\n do {\n const response: GitLabGroupMembersResponse = await fetch(\n `${this.config.baseUrl}/api/graphql`,\n {\n method: 'POST',\n headers: {\n ...getGitLabRequestOptions(this.config).headers,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({\n variables: { group: groupPath, relations: relations, endCursor },\n query: /* GraphQL */ `\n query getGroupMembers(\n $group: ID!\n $relations: [GroupMemberRelation!]\n $endCursor: String\n ) {\n group(fullPath: $group) {\n groupMembers(\n first: 100\n relations: $relations\n after: $endCursor\n ) {\n nodes {\n user {\n id\n username\n publicEmail\n name\n state\n webUrl\n avatarUrl\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n }\n }\n }\n }\n `,\n }),\n },\n ).then(r => r.json());\n if (response.errors) {\n throw new Error(`GraphQL errors: ${JSON.stringify(response.errors)}`);\n }\n\n if (!response.data.group?.groupMembers?.nodes) {\n this.logger.warn(\n `Couldn't get members for group ${groupPath}. The provided token might not have sufficient permissions`,\n );\n continue;\n }\n\n for (const userItem of response.data.group.groupMembers.nodes.filter(\n user => user.user?.id,\n )) {\n const formattedUserResponse = {\n id: Number(userItem.user.id.replace(/^gid:\\/\\/gitlab\\/User\\//, '')),\n username: userItem.user.username,\n email: userItem.user.publicEmail,\n name: userItem.user.name,\n state: userItem.user.state,\n web_url: userItem.user.webUrl,\n avatar_url: userItem.user.avatarUrl,\n };\n\n items.push(formattedUserResponse);\n }\n ({ hasNextPage, endCursor } = response.data.group.groupMembers.pageInfo);\n } while (hasNextPage);\n return { items };\n }\n\n /**\n * General existence check.\n *\n * @param projectPath - The path to the project\n * @param branch - The branch used to search\n * @param filePath - The path to the file\n */\n async hasFile(\n projectPath: string,\n branch: string,\n filePath: string,\n ): Promise<boolean> {\n const endpoint: string = `/projects/${encodeURIComponent(\n projectPath,\n )}/repository/files/${encodeURIComponent(filePath)}`;\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n request.searchParams.append('ref', branch);\n\n const response = await fetch(request.toString(), {\n headers: getGitLabRequestOptions(this.config).headers,\n method: 'HEAD',\n });\n\n if (!response.ok) {\n if (response.status >= 500) {\n this.logger.debug(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n return false;\n }\n\n return true;\n }\n\n /**\n * Performs a request against a given paginated GitLab endpoint.\n *\n * This method may be used to perform authenticated REST calls against any\n * paginated GitLab endpoint which uses X-NEXT-PAGE headers. The return value\n * can be be used with the {@link paginated} async-generator function to yield\n * each item from the paged request.\n *\n * @see {@link paginated}\n * @param endpoint - The request endpoint, e.g. /projects.\n * @param options - Request queryString options which may also include page variables.\n */\n async pagedRequest<T = any>(\n endpoint: string,\n options?: CommonListOptions,\n ): Promise<PagedResponse<T>> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n\n for (const key in options) {\n if (options.hasOwnProperty(key)) {\n const value = options[key];\n if (value !== undefined && value !== '') {\n request.searchParams.append(key, value.toString());\n }\n }\n }\n\n this.logger.debug(`Fetching: ${request.toString()}`);\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\n );\n\n if (!response.ok) {\n throw new Error(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n\n return response.json().then(items => {\n const nextPage = response.headers.get('x-next-page');\n\n return {\n items,\n nextPage: nextPage ? Number(nextPage) : null,\n } as PagedResponse<any>;\n });\n }\n\n async nonPagedRequest<T = any>(\n endpoint: string,\n options?: CommonListOptions,\n ): Promise<T> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n\n for (const key in options) {\n if (options.hasOwnProperty(key)) {\n const value = options[key];\n if (value !== undefined && value !== '') {\n request.searchParams.append(key, value.toString());\n }\n }\n }\n\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\n );\n\n if (!response.ok) {\n throw new Error(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n\n return response.json();\n }\n}\n\n/**\n * Advances through each page and provides each item from a paginated request.\n *\n * The async generator function yields each item from repeated calls to the\n * provided request function. The generator walks through each available page by\n * setting the page key in the options passed into the request function and\n * making repeated calls until there are no more pages.\n *\n * @see {@link pagedRequest}\n * @param request - Function which returns a PagedResponse to walk through.\n * @param options - Initial ListOptions for the request function.\n */\nexport async function* paginated<T = any>(\n request: (options: CommonListOptions) => Promise<PagedResponse<T>>,\n options: CommonListOptions,\n) {\n let res;\n do {\n res = await request(options);\n options.page = res.nextPage;\n for (const item of res.items) {\n yield item;\n }\n } while (res.nextPage);\n}\n"],"names":["fetch","getGitLabRequestOptions"],"mappings":";;;;;;;;;AAkDO,MAAM,YAAa,CAAA;AAAA,EACP,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAGT,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AAAA;AACxB;AAAA;AAAA;AAAA,EAKA,aAAyB,GAAA;AACvB,IAAO,OAAA,IAAA,CAAK,OAAO,IAAS,KAAA,YAAA;AAAA;AAC9B,EAEA,MAAM,aACJ,OAC6B,EAAA;AAC7B,IAAA,IAAI,SAAS,KAAO,EAAA;AAClB,MAAA,OAAO,IAAK,CAAA,YAAA;AAAA,QACV,CAAW,QAAA,EAAA,kBAAA,CAAmB,OAAS,EAAA,KAAK,CAAC,CAAA,SAAA,CAAA;AAAA,QAC7C;AAAA,UACE,GAAG,OAAA;AAAA,UACH,iBAAmB,EAAA;AAAA;AACrB,OACF;AAAA;AAGF,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,SAAA,CAAA,EAAa,OAAO,CAAA;AAAA;AAC/C,EAEA,MAAM,cACJ,CAAA,SAAA,EACA,OACwB,EAAA;AAExB,IAAM,MAAA,QAAA,GAAW,MAAM,IAAK,CAAA,eAAA;AAAA,MAC1B,aAAa,SAAS,CAAA,CAAA;AAAA,MACtB;AAAA,KACF;AAEA,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,YACJ,CAAA,OAAA,EACA,OACsB,EAAA;AAEtB,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,gBAAgB,CAAW,QAAA,EAAA,OAAO,IAAI,OAAO,CAAA;AAEzE,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,WACJ,CAAA,MAAA,EACA,OACqB,EAAA;AAErB,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,gBAAgB,CAAU,OAAA,EAAA,MAAM,IAAI,OAAO,CAAA;AAEvE,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,gBACJ,CAAA,SAAA,EACA,OACoC,EAAA;AACpC,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,SAAS,CAAC,CAAA,YAAA,CAAA;AAAA,MACxC;AAAA,KACF;AAAA;AACF,EAEA,MAAM,UACJ,OACoC,EAAA;AACpC,IAAO,OAAA,IAAA,CAAK,aAAa,CAAW,OAAA,CAAA,EAAA;AAAA,MAClC,GAAG,OAAA;AAAA,MACH,oBAAsB,EAAA,IAAA;AAAA,MACtB,gBAAkB,EAAA;AAAA,KACnB,CAAA;AAAA;AACH,EAEA,MAAM,aAAA,CACJ,SACA,EAAA,OAAA,EACA,uBACoC,EAAA;AACpC,IAAA,MAAM,cAAiB,GAAA,qCAAA;AAEvB,IAAO,OAAA,IAAA,CAAK,iBAAiB,SAAW,EAAA;AAAA,MACtC,GAAG,OAAA;AAAA,MACH,MAAQ,EAAA,IAAA;AAAA;AAAA,MACR,cAAgB,EAAA;AAAA,KACjB,CAAE,CAAA,IAAA,CAAK,CAAQ,IAAA,KAAA;AAId,MAAA,IAAI,uBAAyB,EAAA;AAC3B,QAAA,IAAA,CAAK,KAAQ,GAAA,IAAA,CAAK,KAAM,CAAA,MAAA,CAAO,CAAQ,IAAA,KAAA;AACrC,UAAA,OAAO,CAAC,cAAA,CAAe,IAAK,CAAA,IAAA,CAAK,QAAQ,CAAA;AAAA,SAC1C,CAAA;AAAA,OACI,MAAA;AACL,QAAA,IAAA,CAAK,QAAQ,IAAK,CAAA,KAAA,CAAM,MAAO,CAAA,CAAA,IAAA,KAAQ,KAAK,aAAa,CAAA;AAAA;AAE3D,MAAO,OAAA,IAAA;AAAA,KACR,CAAA;AAAA;AACH,EAEA,MAAM,WACJ,OACqC,EAAA;AACrC,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,OAAA,CAAA,EAAW,OAAO,CAAA;AAAA;AAC7C;AAAA;AAAA,EAIA,MAAM,cACJ,CAAA,SAAA,EACA,OACsB,EAAA;AACtB,IAAA,OAAO,IAAK,CAAA,eAAA;AAAA,MACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,SAAS,CAAC,CAAA,CAAA;AAAA,MACxC;AAAA,KACF;AAAA;AACF,EAEA,MAAM,qBACJ,SACqC,EAAA;AACrC,IAAA,MAAM,QAAuB,EAAC;AAC9B,IAAA,IAAI,WAAuB,GAAA,KAAA;AAC3B,IAAA,IAAI,SAA2B,GAAA,IAAA;AAE/B,IAAG,GAAA;AACD,MAAA,MAAM,WAA2C,MAAMA,sBAAA;AAAA,QACrD,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,OAAO,CAAA,YAAA,CAAA;AAAA,QACtB;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,GAAGC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,YACxC,CAAC,cAAc,GAAG;AAAA,WACpB;AAAA,UACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,YACnB,SAAW,EAAA,EAAE,KAAO,EAAA,SAAA,EAAW,SAAU,EAAA;AAAA,YACzC,KAAA;AAAA;AAAA,cAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAAA;AAAA;AAAA,WAsBtB;AAAA;AACH,OACA,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,MAAM,CAAA;AACpB,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAI,MAAM,CAAmB,gBAAA,EAAA,IAAA,CAAK,UAAU,QAAS,CAAA,MAAM,CAAC,CAAE,CAAA,CAAA;AAAA;AAGtE,MAAA,IAAI,CAAC,QAAA,CAAS,IAAK,CAAA,KAAA,EAAO,kBAAkB,KAAO,EAAA;AACjD,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,6BAA6B,SAAS,CAAA,0DAAA;AAAA,SACxC;AACA,QAAA;AAAA;AAGF,MAAA,KAAA,MAAW,SAAa,IAAA,QAAA,CAAS,IAAK,CAAA,KAAA,CAAM,iBAAiB,KAAM,CAAA,MAAA;AAAA,QACjE,WAAS,KAAO,EAAA;AAAA,OACf,EAAA;AACD,QAAA,MAAM,sBAAyB,GAAA;AAAA,UAC7B,IAAI,MAAO,CAAA,SAAA,CAAU,GAAG,OAAQ,CAAA,0BAAA,EAA4B,EAAE,CAAC,CAAA;AAAA,UAC/D,MAAM,SAAU,CAAA,IAAA;AAAA,UAChB,aAAa,SAAU,CAAA,WAAA;AAAA,UACvB,WAAW,SAAU,CAAA,QAAA;AAAA,UACrB,YAAY,SAAU,CAAA,UAAA;AAAA,UACtB,SAAW,EAAA,MAAA;AAAA,YACT,SAAU,CAAA,MAAA,CAAO,EAAG,CAAA,OAAA,CAAQ,4BAA4B,EAAE;AAAA;AAC5D,SACF;AAEA,QAAA,KAAA,CAAM,KAAK,sBAAsB,CAAA;AAAA;AAEnC,MAAA,CAAC,EAAE,WAAa,EAAA,SAAA,KACd,QAAS,CAAA,IAAA,CAAK,MAAM,gBAAiB,CAAA,QAAA;AAAA,KAChC,QAAA,WAAA;AACT,IAAA,OAAO,EAAE,KAAM,EAAA;AAAA;AACjB,EAEA,MAAM,eACJ,CAAA,SAAA,EACA,SACoC,EAAA;AACpC,IAAA,MAAM,QAAsB,EAAC;AAC7B,IAAA,IAAI,WAAuB,GAAA,KAAA;AAC3B,IAAA,IAAI,SAA2B,GAAA,IAAA;AAC/B,IAAG,GAAA;AACD,MAAA,MAAM,WAAuC,MAAMD,sBAAA;AAAA,QACjD,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,OAAO,CAAA,YAAA,CAAA;AAAA,QACtB;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,GAAGC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,YACxC,cAAgB,EAAA;AAAA,WAClB;AAAA,UACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,YACnB,SAAW,EAAA,EAAE,KAAO,EAAA,SAAA,EAAW,WAAsB,SAAU,EAAA;AAAA,YAC/D,KAAA;AAAA;AAAA,cAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAAA;AAAA;AAAA,WA+BtB;AAAA;AACH,OACA,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,MAAM,CAAA;AACpB,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAI,MAAM,CAAmB,gBAAA,EAAA,IAAA,CAAK,UAAU,QAAS,CAAA,MAAM,CAAC,CAAE,CAAA,CAAA;AAAA;AAGtE,MAAA,IAAI,CAAC,QAAA,CAAS,IAAK,CAAA,KAAA,EAAO,cAAc,KAAO,EAAA;AAC7C,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,kCAAkC,SAAS,CAAA,0DAAA;AAAA,SAC7C;AACA,QAAA;AAAA;AAGF,MAAA,KAAA,MAAW,QAAY,IAAA,QAAA,CAAS,IAAK,CAAA,KAAA,CAAM,aAAa,KAAM,CAAA,MAAA;AAAA,QAC5D,CAAA,IAAA,KAAQ,KAAK,IAAM,EAAA;AAAA,OAClB,EAAA;AACD,QAAA,MAAM,qBAAwB,GAAA;AAAA,UAC5B,EAAA,EAAI,OAAO,QAAS,CAAA,IAAA,CAAK,GAAG,OAAQ,CAAA,yBAAA,EAA2B,EAAE,CAAC,CAAA;AAAA,UAClE,QAAA,EAAU,SAAS,IAAK,CAAA,QAAA;AAAA,UACxB,KAAA,EAAO,SAAS,IAAK,CAAA,WAAA;AAAA,UACrB,IAAA,EAAM,SAAS,IAAK,CAAA,IAAA;AAAA,UACpB,KAAA,EAAO,SAAS,IAAK,CAAA,KAAA;AAAA,UACrB,OAAA,EAAS,SAAS,IAAK,CAAA,MAAA;AAAA,UACvB,UAAA,EAAY,SAAS,IAAK,CAAA;AAAA,SAC5B;AAEA,QAAA,KAAA,CAAM,KAAK,qBAAqB,CAAA;AAAA;AAElC,MAAA,CAAC,EAAE,WAAa,EAAA,SAAA,KAAc,QAAS,CAAA,IAAA,CAAK,MAAM,YAAa,CAAA,QAAA;AAAA,KACxD,QAAA,WAAA;AACT,IAAA,OAAO,EAAE,KAAM,EAAA;AAAA;AACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAA,CACJ,WACA,EAAA,MAAA,EACA,QACkB,EAAA;AAClB,IAAA,MAAM,WAAmB,CAAa,UAAA,EAAA,kBAAA;AAAA,MACpC;AAAA,KACD,CAAA,kBAAA,EAAqB,kBAAmB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAClD,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAC9D,IAAQ,OAAA,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,EAAO,MAAM,CAAA;AAEzC,IAAA,MAAM,QAAW,GAAA,MAAMD,sBAAM,CAAA,OAAA,CAAQ,UAAY,EAAA;AAAA,MAC/C,OAAS,EAAAC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,MAC9C,MAAQ,EAAA;AAAA,KACT,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAI,IAAA,QAAA,CAAS,UAAU,GAAK,EAAA;AAC1B,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,SAC3B;AAAA;AAEF,MAAO,OAAA,KAAA;AAAA;AAGT,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,YACJ,CAAA,QAAA,EACA,OAC2B,EAAA;AAC3B,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAE9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAI,IAAA,OAAA,CAAQ,cAAe,CAAA,GAAG,CAAG,EAAA;AAC/B,QAAM,MAAA,KAAA,GAAQ,QAAQ,GAAG,CAAA;AACzB,QAAI,IAAA,KAAA,KAAU,KAAa,CAAA,IAAA,KAAA,KAAU,EAAI,EAAA;AACvC,UAAA,OAAA,CAAQ,YAAa,CAAA,MAAA,CAAO,GAAK,EAAA,KAAA,CAAM,UAAU,CAAA;AAAA;AACnD;AACF;AAGF,IAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,UAAA,EAAa,OAAQ,CAAA,QAAA,EAAU,CAAE,CAAA,CAAA;AACnD,IAAA,MAAM,WAAW,MAAMD,sBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM;AAAA,KACrC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,OAC3B;AAAA;AAGF,IAAA,OAAO,QAAS,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAS,KAAA,KAAA;AACnC,MAAA,MAAM,QAAW,GAAA,QAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,aAAa,CAAA;AAEnD,MAAO,OAAA;AAAA,QACL,KAAA;AAAA,QACA,QAAU,EAAA,QAAA,GAAW,MAAO,CAAA,QAAQ,CAAI,GAAA;AAAA,OAC1C;AAAA,KACD,CAAA;AAAA;AACH,EAEA,MAAM,eACJ,CAAA,QAAA,EACA,OACY,EAAA;AACZ,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAE9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAI,IAAA,OAAA,CAAQ,cAAe,CAAA,GAAG,CAAG,EAAA;AAC/B,QAAM,MAAA,KAAA,GAAQ,QAAQ,GAAG,CAAA;AACzB,QAAI,IAAA,KAAA,KAAU,KAAa,CAAA,IAAA,KAAA,KAAU,EAAI,EAAA;AACvC,UAAA,OAAA,CAAQ,YAAa,CAAA,MAAA,CAAO,GAAK,EAAA,KAAA,CAAM,UAAU,CAAA;AAAA;AACnD;AACF;AAGF,IAAA,MAAM,WAAW,MAAMD,sBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM;AAAA,KACrC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,OAC3B;AAAA;AAGF,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;AAcuB,gBAAA,SAAA,CACrB,SACA,OACA,EAAA;AACA,EAAI,IAAA,GAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,OAAO,CAAA;AAC3B,IAAA,OAAA,CAAQ,OAAO,GAAI,CAAA,QAAA;AACnB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,KAAO,EAAA;AAC5B,MAAM,MAAA,IAAA;AAAA;AACR,WACO,GAAI,CAAA,QAAA;AACf;;;;;"}
|
|
1
|
+
{"version":3,"file":"client.cjs.js","sources":["../../src/lib/client.ts"],"sourcesContent":["/*\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\n// NOTE(freben): Intentionally uses node-fetch because of https://github.com/backstage/backstage/issues/28190\nimport fetch from 'node-fetch';\n\nimport {\n getGitLabRequestOptions,\n GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport {\n GitLabDescendantGroupsResponse,\n GitLabGroup,\n GitLabGroupMembersResponse,\n GitLabProject,\n GitLabUser,\n PagedResponse,\n} from './types';\n\nexport type CommonListOptions = {\n [key: string]: string | number | boolean | undefined;\n per_page?: number | undefined;\n page?: number | undefined;\n active?: boolean;\n};\n\ninterface ListProjectOptions extends CommonListOptions {\n archived?: boolean;\n group?: string;\n membership?: boolean;\n topics?: string;\n}\n\ninterface UserListOptions extends CommonListOptions {\n without_project_bots?: boolean | undefined;\n exclude_internal?: boolean | undefined;\n}\n\nexport class GitLabClient {\n private readonly config: GitLabIntegrationConfig;\n private readonly logger: LoggerService;\n\n constructor(options: {\n config: GitLabIntegrationConfig;\n logger: LoggerService;\n }) {\n this.config = options.config;\n this.logger = options.logger;\n }\n\n /**\n * Indicates whether the client is for a SaaS or self managed GitLab instance.\n */\n isSelfManaged(): boolean {\n return this.config.host !== 'gitlab.com';\n }\n\n async listProjects(\n options?: ListProjectOptions,\n ): Promise<PagedResponse<any>> {\n if (options?.group) {\n return this.pagedRequest(\n `/groups/${encodeURIComponent(options?.group)}/projects`,\n {\n ...options,\n include_subgroups: true,\n },\n );\n }\n\n return this.pagedRequest(`/projects`, options);\n }\n\n async getProjectById(\n projectId: number,\n options?: CommonListOptions,\n ): Promise<GitLabProject> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(\n `/projects/${projectId}`,\n options,\n );\n\n return response;\n }\n\n async getGroupById(\n groupId: number,\n options?: CommonListOptions,\n ): Promise<GitLabGroup> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(`/groups/${groupId}`, options);\n\n return response;\n }\n\n async getUserById(\n userId: number,\n options?: CommonListOptions,\n ): Promise<GitLabUser> {\n // Make the request to the GitLab API\n const response = await this.nonPagedRequest(`/users/${userId}`, options);\n\n return response;\n }\n\n async listGroupMembers(\n groupPath: string,\n options?: CommonListOptions,\n ): Promise<PagedResponse<GitLabUser>> {\n return this.pagedRequest(\n `/groups/${encodeURIComponent(groupPath)}/members/all`,\n options,\n );\n }\n\n async listUsers(\n options?: UserListOptions,\n ): Promise<PagedResponse<GitLabUser>> {\n return this.pagedRequest(`/users?`, {\n ...options,\n without_project_bots: true,\n exclude_internal: true,\n });\n }\n\n async listSaaSUsers(\n groupPath: string,\n options?: CommonListOptions,\n includeUsersWithoutSeat?: boolean,\n ): Promise<PagedResponse<GitLabUser>> {\n const botFilterRegex = /^(?:project|group)_(\\w+)_bot_(\\w+)$/;\n\n return this.listGroupMembers(groupPath, {\n ...options,\n active: true, // Users with seat are always active but for users without seat we need to filter\n show_seat_info: true,\n }).then(resp => {\n // Filter is optional to allow to import Gitlab Free users without seats\n // https://github.com/backstage/backstage/issues/26438\n // Filter out API tokens https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#bot-users-for-projects\n if (includeUsersWithoutSeat) {\n resp.items = resp.items.filter(user => {\n return !botFilterRegex.test(user.username);\n });\n } else {\n resp.items = resp.items.filter(user => user.is_using_seat);\n }\n return resp;\n });\n }\n\n async listGroups(\n options?: CommonListOptions,\n ): Promise<PagedResponse<GitLabGroup>> {\n return this.pagedRequest(`/groups`, options);\n }\n\n // https://docs.gitlab.com/ee/api/groups.html#list-group-details\n // id can either be group id or encoded full path\n async getGroupByPath(\n groupPath: string,\n options?: CommonListOptions,\n ): Promise<GitLabGroup> {\n return this.nonPagedRequest(\n `/groups/${encodeURIComponent(groupPath)}`,\n options,\n );\n }\n\n async listDescendantGroups(\n groupPath: string,\n ): Promise<PagedResponse<GitLabGroup>> {\n const items: GitLabGroup[] = [];\n let hasNextPage: boolean = false;\n let endCursor: string | null = null;\n\n do {\n const response: GitLabDescendantGroupsResponse = await fetch(\n `${this.config.baseUrl}/api/graphql`,\n {\n method: 'POST',\n headers: {\n ...getGitLabRequestOptions(this.config).headers,\n ['Content-Type']: 'application/json',\n },\n body: JSON.stringify({\n variables: { group: groupPath, endCursor },\n query: /* GraphQL */ `\n query listDescendantGroups($group: ID!, $endCursor: String) {\n group(fullPath: $group) {\n descendantGroups(first: 100, after: $endCursor) {\n nodes {\n id\n name\n description\n fullPath\n visibility\n parent {\n id\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n }\n }\n }\n }\n `,\n }),\n },\n ).then(r => r.json());\n if (response.errors) {\n throw new Error(`GraphQL errors: ${JSON.stringify(response.errors)}`);\n }\n\n if (!response.data.group?.descendantGroups?.nodes) {\n this.logger.warn(\n `Couldn't get groups under ${groupPath}. The provided token might not have sufficient permissions`,\n );\n continue;\n }\n\n for (const groupItem of response.data.group.descendantGroups.nodes.filter(\n group => group?.id,\n )) {\n const formattedGroupResponse = {\n id: Number(groupItem.id.replace(/^gid:\\/\\/gitlab\\/Group\\//, '')),\n name: groupItem.name,\n description: groupItem.description,\n full_path: groupItem.fullPath,\n visibility: groupItem.visibility,\n parent_id: Number(\n groupItem.parent.id.replace(/^gid:\\/\\/gitlab\\/Group\\//, ''),\n ),\n };\n\n items.push(formattedGroupResponse);\n }\n ({ hasNextPage, endCursor } =\n response.data.group.descendantGroups.pageInfo);\n } while (hasNextPage);\n return { items };\n }\n\n async getGroupMembers(\n groupPath: string,\n relations: string[],\n ): Promise<PagedResponse<GitLabUser>> {\n const items: GitLabUser[] = [];\n let hasNextPage: boolean = false;\n let endCursor: string | null = null;\n do {\n const response: GitLabGroupMembersResponse = await fetch(\n `${this.config.baseUrl}/api/graphql`,\n {\n method: 'POST',\n headers: {\n ...getGitLabRequestOptions(this.config).headers,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({\n variables: { group: groupPath, relations: relations, endCursor },\n query: /* GraphQL */ `\n query getGroupMembers(\n $group: ID!\n $relations: [GroupMemberRelation!]\n $endCursor: String\n ) {\n group(fullPath: $group) {\n groupMembers(\n first: 100\n relations: $relations\n after: $endCursor\n ) {\n nodes {\n user {\n id\n username\n publicEmail\n name\n state\n webUrl\n avatarUrl\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n }\n }\n }\n }\n `,\n }),\n },\n ).then(r => r.json());\n if (response.errors) {\n throw new Error(`GraphQL errors: ${JSON.stringify(response.errors)}`);\n }\n\n if (!response.data.group?.groupMembers?.nodes) {\n this.logger.warn(\n `Couldn't get members for group ${groupPath}. The provided token might not have sufficient permissions`,\n );\n continue;\n }\n\n for (const userItem of response.data.group.groupMembers.nodes.filter(\n user => user.user?.id,\n )) {\n const formattedUserResponse = {\n id: Number(userItem.user.id.replace(/^gid:\\/\\/gitlab\\/User\\//, '')),\n username: userItem.user.username,\n email: userItem.user.publicEmail,\n name: userItem.user.name,\n state: userItem.user.state,\n web_url: userItem.user.webUrl,\n avatar_url: userItem.user.avatarUrl,\n };\n\n items.push(formattedUserResponse);\n }\n ({ hasNextPage, endCursor } = response.data.group.groupMembers.pageInfo);\n } while (hasNextPage);\n return { items };\n }\n\n /**\n * General existence check.\n *\n * @param projectPath - The path to the project\n * @param branch - The branch used to search\n * @param filePath - The path to the file\n */\n async hasFile(\n projectPath: string,\n branch: string,\n filePath: string,\n ): Promise<boolean> {\n const endpoint: string = `/projects/${encodeURIComponent(\n projectPath,\n )}/repository/files/${encodeURIComponent(filePath)}`;\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n request.searchParams.append('ref', branch);\n\n const response = await fetch(request.toString(), {\n headers: getGitLabRequestOptions(this.config).headers,\n method: 'HEAD',\n });\n\n if (!response.ok) {\n if (response.status >= 500) {\n this.logger.debug(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n return false;\n }\n\n return true;\n }\n\n /**\n * Performs a request against a given paginated GitLab endpoint.\n *\n * This method may be used to perform authenticated REST calls against any\n * paginated GitLab endpoint which uses X-NEXT-PAGE headers. The return value\n * can be be used with the {@link paginated} async-generator function to yield\n * each item from the paged request.\n *\n * @see {@link paginated}\n * @param endpoint - The request endpoint, e.g. /projects.\n * @param options - Request queryString options which may also include page variables.\n */\n async pagedRequest<T = any>(\n endpoint: string,\n options?: CommonListOptions,\n ): Promise<PagedResponse<T>> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n\n for (const key in options) {\n if (options.hasOwnProperty(key)) {\n const value = options[key];\n if (value !== undefined && value !== '') {\n request.searchParams.append(key, value.toString());\n }\n }\n }\n\n this.logger.debug(`Fetching: ${request.toString()}`);\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\n );\n\n if (!response.ok) {\n throw new Error(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n\n return response.json().then(items => {\n const nextPage = response.headers.get('x-next-page');\n\n return {\n items,\n nextPage: nextPage ? Number(nextPage) : null,\n } as PagedResponse<any>;\n });\n }\n\n async nonPagedRequest<T = any>(\n endpoint: string,\n options?: CommonListOptions,\n ): Promise<T> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n\n for (const key in options) {\n if (options.hasOwnProperty(key)) {\n const value = options[key];\n if (value !== undefined && value !== '') {\n request.searchParams.append(key, value.toString());\n }\n }\n }\n\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\n );\n\n if (!response.ok) {\n throw new Error(\n `Unexpected response when fetching ${request.toString()}. Expected 200 but got ${\n response.status\n } - ${response.statusText}`,\n );\n }\n\n return response.json();\n }\n}\n\n/**\n * Advances through each page and provides each item from a paginated request.\n *\n * The async generator function yields each item from repeated calls to the\n * provided request function. The generator walks through each available page by\n * setting the page key in the options passed into the request function and\n * making repeated calls until there are no more pages.\n *\n * @see {@link pagedRequest}\n * @param request - Function which returns a PagedResponse to walk through.\n * @param options - Initial ListOptions for the request function.\n */\nexport async function* paginated<T = any>(\n request: (options: CommonListOptions) => Promise<PagedResponse<T>>,\n options: CommonListOptions,\n) {\n let res;\n do {\n res = await request(options);\n options.page = res.nextPage;\n for (const item of res.items) {\n yield item;\n }\n } while (res.nextPage);\n}\n"],"names":["fetch","getGitLabRequestOptions"],"mappings":";;;;;;;;;AAoDO,MAAM,YAAa,CAAA;AAAA,EACP,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAGT,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AAAA;AACxB;AAAA;AAAA;AAAA,EAKA,aAAyB,GAAA;AACvB,IAAO,OAAA,IAAA,CAAK,OAAO,IAAS,KAAA,YAAA;AAAA;AAC9B,EAEA,MAAM,aACJ,OAC6B,EAAA;AAC7B,IAAA,IAAI,SAAS,KAAO,EAAA;AAClB,MAAA,OAAO,IAAK,CAAA,YAAA;AAAA,QACV,CAAW,QAAA,EAAA,kBAAA,CAAmB,OAAS,EAAA,KAAK,CAAC,CAAA,SAAA,CAAA;AAAA,QAC7C;AAAA,UACE,GAAG,OAAA;AAAA,UACH,iBAAmB,EAAA;AAAA;AACrB,OACF;AAAA;AAGF,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,SAAA,CAAA,EAAa,OAAO,CAAA;AAAA;AAC/C,EAEA,MAAM,cACJ,CAAA,SAAA,EACA,OACwB,EAAA;AAExB,IAAM,MAAA,QAAA,GAAW,MAAM,IAAK,CAAA,eAAA;AAAA,MAC1B,aAAa,SAAS,CAAA,CAAA;AAAA,MACtB;AAAA,KACF;AAEA,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,YACJ,CAAA,OAAA,EACA,OACsB,EAAA;AAEtB,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,gBAAgB,CAAW,QAAA,EAAA,OAAO,IAAI,OAAO,CAAA;AAEzE,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,WACJ,CAAA,MAAA,EACA,OACqB,EAAA;AAErB,IAAA,MAAM,WAAW,MAAM,IAAA,CAAK,gBAAgB,CAAU,OAAA,EAAA,MAAM,IAAI,OAAO,CAAA;AAEvE,IAAO,OAAA,QAAA;AAAA;AACT,EAEA,MAAM,gBACJ,CAAA,SAAA,EACA,OACoC,EAAA;AACpC,IAAA,OAAO,IAAK,CAAA,YAAA;AAAA,MACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,SAAS,CAAC,CAAA,YAAA,CAAA;AAAA,MACxC;AAAA,KACF;AAAA;AACF,EAEA,MAAM,UACJ,OACoC,EAAA;AACpC,IAAO,OAAA,IAAA,CAAK,aAAa,CAAW,OAAA,CAAA,EAAA;AAAA,MAClC,GAAG,OAAA;AAAA,MACH,oBAAsB,EAAA,IAAA;AAAA,MACtB,gBAAkB,EAAA;AAAA,KACnB,CAAA;AAAA;AACH,EAEA,MAAM,aAAA,CACJ,SACA,EAAA,OAAA,EACA,uBACoC,EAAA;AACpC,IAAA,MAAM,cAAiB,GAAA,qCAAA;AAEvB,IAAO,OAAA,IAAA,CAAK,iBAAiB,SAAW,EAAA;AAAA,MACtC,GAAG,OAAA;AAAA,MACH,MAAQ,EAAA,IAAA;AAAA;AAAA,MACR,cAAgB,EAAA;AAAA,KACjB,CAAE,CAAA,IAAA,CAAK,CAAQ,IAAA,KAAA;AAId,MAAA,IAAI,uBAAyB,EAAA;AAC3B,QAAA,IAAA,CAAK,KAAQ,GAAA,IAAA,CAAK,KAAM,CAAA,MAAA,CAAO,CAAQ,IAAA,KAAA;AACrC,UAAA,OAAO,CAAC,cAAA,CAAe,IAAK,CAAA,IAAA,CAAK,QAAQ,CAAA;AAAA,SAC1C,CAAA;AAAA,OACI,MAAA;AACL,QAAA,IAAA,CAAK,QAAQ,IAAK,CAAA,KAAA,CAAM,MAAO,CAAA,CAAA,IAAA,KAAQ,KAAK,aAAa,CAAA;AAAA;AAE3D,MAAO,OAAA,IAAA;AAAA,KACR,CAAA;AAAA;AACH,EAEA,MAAM,WACJ,OACqC,EAAA;AACrC,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,OAAA,CAAA,EAAW,OAAO,CAAA;AAAA;AAC7C;AAAA;AAAA,EAIA,MAAM,cACJ,CAAA,SAAA,EACA,OACsB,EAAA;AACtB,IAAA,OAAO,IAAK,CAAA,eAAA;AAAA,MACV,CAAA,QAAA,EAAW,kBAAmB,CAAA,SAAS,CAAC,CAAA,CAAA;AAAA,MACxC;AAAA,KACF;AAAA;AACF,EAEA,MAAM,qBACJ,SACqC,EAAA;AACrC,IAAA,MAAM,QAAuB,EAAC;AAC9B,IAAA,IAAI,WAAuB,GAAA,KAAA;AAC3B,IAAA,IAAI,SAA2B,GAAA,IAAA;AAE/B,IAAG,GAAA;AACD,MAAA,MAAM,WAA2C,MAAMA,sBAAA;AAAA,QACrD,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,OAAO,CAAA,YAAA,CAAA;AAAA,QACtB;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,GAAGC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,YACxC,CAAC,cAAc,GAAG;AAAA,WACpB;AAAA,UACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,YACnB,SAAW,EAAA,EAAE,KAAO,EAAA,SAAA,EAAW,SAAU,EAAA;AAAA,YACzC,KAAA;AAAA;AAAA,cAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAAA;AAAA;AAAA,WAsBtB;AAAA;AACH,OACA,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,MAAM,CAAA;AACpB,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAI,MAAM,CAAmB,gBAAA,EAAA,IAAA,CAAK,UAAU,QAAS,CAAA,MAAM,CAAC,CAAE,CAAA,CAAA;AAAA;AAGtE,MAAA,IAAI,CAAC,QAAA,CAAS,IAAK,CAAA,KAAA,EAAO,kBAAkB,KAAO,EAAA;AACjD,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,6BAA6B,SAAS,CAAA,0DAAA;AAAA,SACxC;AACA,QAAA;AAAA;AAGF,MAAA,KAAA,MAAW,SAAa,IAAA,QAAA,CAAS,IAAK,CAAA,KAAA,CAAM,iBAAiB,KAAM,CAAA,MAAA;AAAA,QACjE,WAAS,KAAO,EAAA;AAAA,OACf,EAAA;AACD,QAAA,MAAM,sBAAyB,GAAA;AAAA,UAC7B,IAAI,MAAO,CAAA,SAAA,CAAU,GAAG,OAAQ,CAAA,0BAAA,EAA4B,EAAE,CAAC,CAAA;AAAA,UAC/D,MAAM,SAAU,CAAA,IAAA;AAAA,UAChB,aAAa,SAAU,CAAA,WAAA;AAAA,UACvB,WAAW,SAAU,CAAA,QAAA;AAAA,UACrB,YAAY,SAAU,CAAA,UAAA;AAAA,UACtB,SAAW,EAAA,MAAA;AAAA,YACT,SAAU,CAAA,MAAA,CAAO,EAAG,CAAA,OAAA,CAAQ,4BAA4B,EAAE;AAAA;AAC5D,SACF;AAEA,QAAA,KAAA,CAAM,KAAK,sBAAsB,CAAA;AAAA;AAEnC,MAAA,CAAC,EAAE,WAAa,EAAA,SAAA,KACd,QAAS,CAAA,IAAA,CAAK,MAAM,gBAAiB,CAAA,QAAA;AAAA,KAChC,QAAA,WAAA;AACT,IAAA,OAAO,EAAE,KAAM,EAAA;AAAA;AACjB,EAEA,MAAM,eACJ,CAAA,SAAA,EACA,SACoC,EAAA;AACpC,IAAA,MAAM,QAAsB,EAAC;AAC7B,IAAA,IAAI,WAAuB,GAAA,KAAA;AAC3B,IAAA,IAAI,SAA2B,GAAA,IAAA;AAC/B,IAAG,GAAA;AACD,MAAA,MAAM,WAAuC,MAAMD,sBAAA;AAAA,QACjD,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,OAAO,CAAA,YAAA,CAAA;AAAA,QACtB;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,GAAGC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,YACxC,cAAgB,EAAA;AAAA,WAClB;AAAA,UACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,YACnB,SAAW,EAAA,EAAE,KAAO,EAAA,SAAA,EAAW,WAAsB,SAAU,EAAA;AAAA,YAC/D,KAAA;AAAA;AAAA,cAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAAA;AAAA;AAAA,WA+BtB;AAAA;AACH,OACA,CAAA,IAAA,CAAK,CAAK,CAAA,KAAA,CAAA,CAAE,MAAM,CAAA;AACpB,MAAA,IAAI,SAAS,MAAQ,EAAA;AACnB,QAAM,MAAA,IAAI,MAAM,CAAmB,gBAAA,EAAA,IAAA,CAAK,UAAU,QAAS,CAAA,MAAM,CAAC,CAAE,CAAA,CAAA;AAAA;AAGtE,MAAA,IAAI,CAAC,QAAA,CAAS,IAAK,CAAA,KAAA,EAAO,cAAc,KAAO,EAAA;AAC7C,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,kCAAkC,SAAS,CAAA,0DAAA;AAAA,SAC7C;AACA,QAAA;AAAA;AAGF,MAAA,KAAA,MAAW,QAAY,IAAA,QAAA,CAAS,IAAK,CAAA,KAAA,CAAM,aAAa,KAAM,CAAA,MAAA;AAAA,QAC5D,CAAA,IAAA,KAAQ,KAAK,IAAM,EAAA;AAAA,OAClB,EAAA;AACD,QAAA,MAAM,qBAAwB,GAAA;AAAA,UAC5B,EAAA,EAAI,OAAO,QAAS,CAAA,IAAA,CAAK,GAAG,OAAQ,CAAA,yBAAA,EAA2B,EAAE,CAAC,CAAA;AAAA,UAClE,QAAA,EAAU,SAAS,IAAK,CAAA,QAAA;AAAA,UACxB,KAAA,EAAO,SAAS,IAAK,CAAA,WAAA;AAAA,UACrB,IAAA,EAAM,SAAS,IAAK,CAAA,IAAA;AAAA,UACpB,KAAA,EAAO,SAAS,IAAK,CAAA,KAAA;AAAA,UACrB,OAAA,EAAS,SAAS,IAAK,CAAA,MAAA;AAAA,UACvB,UAAA,EAAY,SAAS,IAAK,CAAA;AAAA,SAC5B;AAEA,QAAA,KAAA,CAAM,KAAK,qBAAqB,CAAA;AAAA;AAElC,MAAA,CAAC,EAAE,WAAa,EAAA,SAAA,KAAc,QAAS,CAAA,IAAA,CAAK,MAAM,YAAa,CAAA,QAAA;AAAA,KACxD,QAAA,WAAA;AACT,IAAA,OAAO,EAAE,KAAM,EAAA;AAAA;AACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAA,CACJ,WACA,EAAA,MAAA,EACA,QACkB,EAAA;AAClB,IAAA,MAAM,WAAmB,CAAa,UAAA,EAAA,kBAAA;AAAA,MACpC;AAAA,KACD,CAAA,kBAAA,EAAqB,kBAAmB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAClD,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAC9D,IAAQ,OAAA,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,EAAO,MAAM,CAAA;AAEzC,IAAA,MAAM,QAAW,GAAA,MAAMD,sBAAM,CAAA,OAAA,CAAQ,UAAY,EAAA;AAAA,MAC/C,OAAS,EAAAC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CAAE,CAAA,OAAA;AAAA,MAC9C,MAAQ,EAAA;AAAA,KACT,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAI,IAAA,QAAA,CAAS,UAAU,GAAK,EAAA;AAC1B,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,SAC3B;AAAA;AAEF,MAAO,OAAA,KAAA;AAAA;AAGT,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,YACJ,CAAA,QAAA,EACA,OAC2B,EAAA;AAC3B,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAE9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAI,IAAA,OAAA,CAAQ,cAAe,CAAA,GAAG,CAAG,EAAA;AAC/B,QAAM,MAAA,KAAA,GAAQ,QAAQ,GAAG,CAAA;AACzB,QAAI,IAAA,KAAA,KAAU,KAAa,CAAA,IAAA,KAAA,KAAU,EAAI,EAAA;AACvC,UAAA,OAAA,CAAQ,YAAa,CAAA,MAAA,CAAO,GAAK,EAAA,KAAA,CAAM,UAAU,CAAA;AAAA;AACnD;AACF;AAGF,IAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,UAAA,EAAa,OAAQ,CAAA,QAAA,EAAU,CAAE,CAAA,CAAA;AACnD,IAAA,MAAM,WAAW,MAAMD,sBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM;AAAA,KACrC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,OAC3B;AAAA;AAGF,IAAA,OAAO,QAAS,CAAA,IAAA,EAAO,CAAA,IAAA,CAAK,CAAS,KAAA,KAAA;AACnC,MAAA,MAAM,QAAW,GAAA,QAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,aAAa,CAAA;AAEnD,MAAO,OAAA;AAAA,QACL,KAAA;AAAA,QACA,QAAU,EAAA,QAAA,GAAW,MAAO,CAAA,QAAQ,CAAI,GAAA;AAAA,OAC1C;AAAA,KACD,CAAA;AAAA;AACH,EAEA,MAAM,eACJ,CAAA,QAAA,EACA,OACY,EAAA;AACZ,IAAM,MAAA,OAAA,GAAU,IAAI,GAAI,CAAA,CAAA,EAAG,KAAK,MAAO,CAAA,UAAU,CAAG,EAAA,QAAQ,CAAE,CAAA,CAAA;AAE9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAI,IAAA,OAAA,CAAQ,cAAe,CAAA,GAAG,CAAG,EAAA;AAC/B,QAAM,MAAA,KAAA,GAAQ,QAAQ,GAAG,CAAA;AACzB,QAAI,IAAA,KAAA,KAAU,KAAa,CAAA,IAAA,KAAA,KAAU,EAAI,EAAA;AACvC,UAAA,OAAA,CAAQ,YAAa,CAAA,MAAA,CAAO,GAAK,EAAA,KAAA,CAAM,UAAU,CAAA;AAAA;AACnD;AACF;AAGF,IAAA,MAAM,WAAW,MAAMD,sBAAA;AAAA,MACrB,QAAQ,QAAS,EAAA;AAAA,MACjBC,mCAAA,CAAwB,KAAK,MAAM;AAAA,KACrC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kCAAA,EAAqC,QAAQ,QAAS,EAAC,0BACrD,QAAS,CAAA,MACX,CAAM,GAAA,EAAA,QAAA,CAAS,UAAU,CAAA;AAAA,OAC3B;AAAA;AAGF,IAAA,OAAO,SAAS,IAAK,EAAA;AAAA;AAEzB;AAcuB,gBAAA,SAAA,CACrB,SACA,OACA,EAAA;AACA,EAAI,IAAA,GAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,OAAO,CAAA;AAC3B,IAAA,OAAA,CAAQ,OAAO,GAAI,CAAA,QAAA;AACnB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,KAAO,EAAA;AAC5B,MAAM,MAAA,IAAA;AAAA;AACR,WACO,GAAI,CAAA,QAAA;AACf;;;;;"}
|
|
@@ -151,7 +151,9 @@ class GitlabDiscoveryEntityProvider {
|
|
|
151
151
|
group: this.config.group,
|
|
152
152
|
page: 1,
|
|
153
153
|
per_page: 50,
|
|
154
|
-
...!this.config.includeArchivedRepos && { archived: false }
|
|
154
|
+
...!this.config.includeArchivedRepos && { archived: false },
|
|
155
|
+
...this.config.membership && { membership: true },
|
|
156
|
+
...this.config.topics && { topics: this.config.topics }
|
|
155
157
|
}
|
|
156
158
|
);
|
|
157
159
|
const res = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GitlabDiscoveryEntityProvider.cjs.js","sources":["../../src/providers/GitlabDiscoveryEntityProvider.ts"],"sourcesContent":["/*\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 LoggerService,\n SchedulerService,\n SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { GitLabIntegration, ScmIntegrations } from '@backstage/integration';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n DeferredEntity,\n EntityProvider,\n EntityProviderConnection,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebhookProjectSchema, WebhookPushEventSchema } from '@gitbeaker/rest';\nimport * as uuid from 'uuid';\nimport {\n GitLabClient,\n GitLabProject,\n GitlabProviderConfig,\n paginated,\n readGitlabConfigs,\n} from '../lib';\n\nimport * as path from 'path';\n\nconst TOPIC_REPO_PUSH = 'gitlab.push';\n\ntype Result = {\n scanned: number;\n matches: GitLabProject[];\n};\n\n/**\n * Discovers catalog files located in your GitLab instance.\n * The provider will search your GitLab instance's projects and register catalog files matching the configured path\n * as Location entity and via following processing steps add all contained catalog entities.\n * This can be useful as an alternative to static locations or manually adding things to the catalog.\n *\n * @public\n */\n// <<< EventSupportChange: implemented EventSubscriber interface\nexport class GitlabDiscoveryEntityProvider implements EntityProvider {\n private readonly config: GitlabProviderConfig;\n private readonly integration: GitLabIntegration;\n private readonly logger: LoggerService;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n private readonly events?: EventsService;\n private readonly gitLabClient: GitLabClient;\n\n static fromConfig(\n config: Config,\n options: {\n logger: LoggerService;\n events?: EventsService;\n schedule?: SchedulerServiceTaskRunner;\n scheduler?: SchedulerService;\n },\n ): GitlabDiscoveryEntityProvider[] {\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n const providerConfigs = readGitlabConfigs(config);\n const integrations = ScmIntegrations.fromConfig(config).gitlab;\n const providers: GitlabDiscoveryEntityProvider[] = [];\n\n providerConfigs.forEach(providerConfig => {\n const integration = integrations.byHost(providerConfig.host);\n if (!integration) {\n throw new Error(\n `No gitlab integration found that matches host ${providerConfig.host}`,\n );\n }\n\n if (!options.schedule && !providerConfig.schedule) {\n throw new Error(\n `No schedule provided neither via code nor config for GitlabDiscoveryEntityProvider:${providerConfig.id}.`,\n );\n }\n\n const taskRunner =\n options.schedule ??\n options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n providers.push(\n new GitlabDiscoveryEntityProvider({\n ...options,\n config: providerConfig,\n integration,\n taskRunner,\n }),\n );\n });\n\n return providers;\n }\n\n /**\n * Constructs a GitlabDiscoveryEntityProvider instance.\n *\n * @param options - Configuration options including config, integration, logger, and taskRunner.\n */\n private constructor(options: {\n config: GitlabProviderConfig;\n integration: GitLabIntegration;\n logger: LoggerService;\n events?: EventsService;\n taskRunner: SchedulerServiceTaskRunner;\n }) {\n this.config = options.config;\n this.integration = options.integration;\n this.logger = options.logger.child({\n target: this.getProviderName(),\n });\n this.scheduleFn = this.createScheduleFn(options.taskRunner);\n this.events = options.events;\n this.gitLabClient = new GitLabClient({\n config: this.integration.config,\n logger: this.logger,\n });\n }\n\n getProviderName(): string {\n return `GitlabDiscoveryEntityProvider:${this.config.id}`;\n }\n\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n\n if (this.events) {\n await this.events.subscribe({\n id: this.getProviderName(),\n topics: [TOPIC_REPO_PUSH],\n onEvent: async params => {\n if (params.topic !== TOPIC_REPO_PUSH) {\n return;\n }\n\n await this.onRepoPush(params.eventPayload as WebhookPushEventSchema);\n },\n });\n }\n }\n\n /**\n * Creates a scheduled task runner for refreshing the entity provider.\n *\n * @param taskRunner - The task runner instance.\n * @returns The scheduled function.\n */\n private createScheduleFn(\n taskRunner: SchedulerServiceTaskRunner,\n ): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: GitlabDiscoveryEntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(\n `${this.getProviderName()} refresh failed, ${error}`,\n error,\n );\n }\n },\n });\n };\n }\n\n /**\n * Performs a full scan on the GitLab instance searching for locations to be ingested\n *\n * @param logger - The logger instance for logging.\n */\n async refresh(logger: LoggerService): Promise<void> {\n if (!this.connection) {\n throw new Error(\n `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n );\n }\n\n const projects = paginated<GitLabProject>(\n options => this.gitLabClient.listProjects(options),\n {\n group: this.config.group,\n page: 1,\n per_page: 50,\n ...(!this.config.includeArchivedRepos && { archived: false }),\n },\n );\n\n const res: Result = {\n scanned: 0,\n matches: [],\n };\n\n for await (const project of projects) {\n if (await this.shouldProcessProject(project, this.gitLabClient)) {\n res.scanned++;\n res.matches.push(project);\n }\n }\n\n const locations = res.matches.map(p => this.createLocationSpec(p));\n\n logger.info(\n `Processed ${locations.length} from scanned ${res.scanned} projects.`,\n );\n await this.connection.applyMutation({\n type: 'full',\n entities: locations.map(location => ({\n locationKey: this.getProviderName(),\n entity: locationSpecToLocationEntity({ location }),\n })),\n });\n }\n\n private createLocationSpec(project: GitLabProject): LocationSpec {\n const project_branch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n return {\n type: 'url',\n target: `${project.web_url}/-/blob/${project_branch}/${this.config.catalogFile}`,\n presence: 'optional',\n };\n }\n\n /**\n * Handles the \"gitlab.push\" event.\n *\n * @param event - The push event payload.\n */\n private async onRepoPush(event: WebhookPushEventSchema): Promise<void> {\n if (!this.connection) {\n throw new Error(\n `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n );\n }\n this.logger.info(\n `Received push event for ${event.project.path_with_namespace}`,\n );\n\n const project = await this.gitLabClient.getProjectById(event.project_id);\n\n if (!project) {\n this.logger.debug(\n `Ignoring push event for ${event.project.path_with_namespace}`,\n );\n\n return;\n }\n\n if (!(await this.shouldProcessProject(project, this.gitLabClient))) {\n this.logger.debug(`Skipping event ${event.project.path_with_namespace}`);\n return;\n }\n\n // Get array of added, removed or modified files from the push event\n const added = this.getFilesMatchingConfig(\n event,\n 'added',\n this.config.catalogFile,\n );\n const removed = this.getFilesMatchingConfig(\n event,\n 'removed',\n this.config.catalogFile,\n );\n const modified = this.getFilesMatchingConfig(\n event,\n 'modified',\n this.config.catalogFile,\n );\n\n // Modified files will be scheduled to a refresh\n const addedEntities = this.createLocationSpecCommitedFiles(\n event.project,\n added,\n );\n\n const removedEntities = this.createLocationSpecCommitedFiles(\n event.project,\n removed,\n );\n\n if (addedEntities.length > 0 || removedEntities.length > 0) {\n await this.connection.applyMutation({\n type: 'delta',\n added: this.toDeferredEntities(\n addedEntities.map(entity => entity.target),\n ),\n removed: this.toDeferredEntities(\n removedEntities.map(entity => entity.target),\n ),\n });\n }\n\n if (modified.length > 0) {\n const projectBranch =\n this.config.branch ??\n event.project.default_branch ??\n this.config.fallbackBranch;\n\n // scheduling a refresh to both tree and blob (https://git-scm.com/book/en/v2/Git-Internals-Git-Objects)\n await this.connection.refresh({\n keys: [\n ...modified.map(\n filePath =>\n `url:${event.project.web_url}/-/tree/${projectBranch}/${filePath}`,\n ),\n ...modified.map(\n filePath =>\n `url:${event.project.web_url}/-/blob/${projectBranch}/${filePath}`,\n ),\n ],\n });\n }\n\n this.logger.info(\n `Processed GitLab push event from ${event.project.web_url}: added ${added.length} - removed ${removed.length} - modified ${modified.length}`,\n );\n }\n\n /**\n * Gets files matching the specified commit action and catalog file name.\n *\n * @param event - The push event payload.\n * @param action - The action type ('added', 'removed', or 'modified').\n * @param catalogFile - The catalog file name.\n * @returns An array of file paths.\n */\n private getFilesMatchingConfig(\n event: WebhookPushEventSchema,\n action: 'added' | 'removed' | 'modified',\n catalogFile: string,\n ): string[] {\n if (!event.commits) {\n return [];\n }\n\n const matchingFiles = event.commits.flatMap((element: any) =>\n element[action].filter(\n (file: string) => path.basename(file) === catalogFile,\n ),\n );\n\n if (matchingFiles.length === 0) {\n this.logger.debug(\n `No files matching '${catalogFile}' found in the commits.`,\n );\n }\n\n return matchingFiles;\n }\n\n /**\n * Creates Backstage location specs for committed files.\n *\n * @param project - The GitLab project information.\n * @param addedFiles - The array of added file paths.\n * @returns An array of location specs.\n */\n private createLocationSpecCommitedFiles(\n project: WebhookProjectSchema,\n addedFiles: string[],\n ): LocationSpec[] {\n const projectBranch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n // Filter added files that match the catalog file pattern\n const matchingFiles = addedFiles.filter(\n file => path.basename(file) === this.config.catalogFile,\n );\n\n // Create a location spec for each matching file\n const locationSpecs: LocationSpec[] = matchingFiles.map(file => ({\n type: 'url',\n target: `${project.web_url}/-/blob/${projectBranch}/${file}`,\n presence: 'optional',\n }));\n\n return locationSpecs;\n }\n\n /**\n * Converts a target URL to a LocationSpec object.\n *\n * @param target - The target URL to be converted.\n * @returns The LocationSpec object representing the URL.\n */\n private toLocationSpec(target: string): LocationSpec {\n return {\n type: 'url',\n target: target,\n presence: 'optional',\n };\n }\n\n private toDeferredEntities(targets: string[]): DeferredEntity[] {\n return targets\n .map(target => {\n const location = this.toLocationSpec(target);\n\n return locationSpecToLocationEntity({ location });\n })\n .map(entity => {\n return {\n locationKey: this.getProviderName(),\n entity: entity,\n };\n });\n }\n\n private async shouldProcessProject(\n project: GitLabProject,\n client: GitLabClient,\n ): Promise<boolean> {\n if (!this.config.projectPattern.test(project.path_with_namespace ?? '')) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it does not match the project pattern ${this.config.projectPattern}.`,\n );\n return false;\n }\n\n if (\n this.config.group &&\n !project.path_with_namespace!.startsWith(`${this.config.group}/`)\n ) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it does not match the group pattern ${this.config.group}.`,\n );\n return false;\n }\n\n if (\n this.config.skipForkedRepos &&\n project.hasOwnProperty('forked_from_project')\n ) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it is a forked project.`,\n );\n return false;\n }\n\n if (this.config.excludeRepos?.includes(project.path_with_namespace ?? '')) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it is excluded.`,\n );\n return false;\n }\n\n const project_branch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n const hasFile = await client.hasFile(\n project.path_with_namespace ?? '',\n project_branch,\n this.config.catalogFile,\n );\n\n return hasFile;\n }\n}\n"],"names":["config","readGitlabConfigs","ScmIntegrations","GitLabClient","uuid","paginated","locationSpecToLocationEntity","path"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,MAAM,eAAkB,GAAA,aAAA;AAgBjB,MAAM,6BAAwD,CAAA;AAAA,EAClD,MAAA;AAAA,EACA,WAAA;AAAA,EACA,MAAA;AAAA,EACA,UAAA;AAAA,EACT,UAAA;AAAA,EACS,MAAA;AAAA,EACA,YAAA;AAAA,EAEjB,OAAO,UACL,CAAAA,QAAA,EACA,OAMiC,EAAA;AACjC,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA;AAAA;AAGlE,IAAM,MAAA,eAAA,GAAkBC,yBAAkBD,QAAM,CAAA;AAChD,IAAA,MAAM,YAAe,GAAAE,2BAAA,CAAgB,UAAW,CAAAF,QAAM,CAAE,CAAA,MAAA;AACxD,IAAA,MAAM,YAA6C,EAAC;AAEpD,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AACxC,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA;AAAA,SACtE;AAAA;AAGF,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,mFAAA,EAAsF,eAAe,EAAE,CAAA,CAAA;AAAA,SACzG;AAAA;AAGF,MAAA,MAAM,aACJ,OAAQ,CAAA,QAAA,IACR,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,6BAA8B,CAAA;AAAA,UAChC,GAAG,OAAA;AAAA,UACH,MAAQ,EAAA,cAAA;AAAA,UACR,WAAA;AAAA,UACA;AAAA,SACD;AAAA,OACH;AAAA,KACD,CAAA;AAED,IAAO,OAAA,SAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,YAAY,OAMjB,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MACjC,MAAA,EAAQ,KAAK,eAAgB;AAAA,KAC9B,CAAA;AACD,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,UAAU,CAAA;AAC1D,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAK,IAAA,CAAA,YAAA,GAAe,IAAIG,mBAAa,CAAA;AAAA,MACnC,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,QAAQ,IAAK,CAAA;AAAA,KACd,CAAA;AAAA;AACH,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,8BAAA,EAAiC,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA;AACxD,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA;AAEtB,IAAA,IAAI,KAAK,MAAQ,EAAA;AACf,MAAM,MAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,QAC1B,EAAA,EAAI,KAAK,eAAgB,EAAA;AAAA,QACzB,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,QACxB,OAAA,EAAS,OAAM,MAAU,KAAA;AACvB,UAAI,IAAA,MAAA,CAAO,UAAU,eAAiB,EAAA;AACpC,YAAA;AAAA;AAGF,UAAM,MAAA,IAAA,CAAK,UAAW,CAAA,MAAA,CAAO,YAAsC,CAAA;AAAA;AACrE,OACD,CAAA;AAAA;AACH;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA;AACF;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAQ,MAAsC,EAAA;AAClD,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,IAAK,CAAA,eAAA,EAAiB,CAAA;AAAA,OAC3E;AAAA;AAGF,IAAA,MAAM,QAAW,GAAAC,gBAAA;AAAA,MACf,CAAW,OAAA,KAAA,IAAA,CAAK,YAAa,CAAA,YAAA,CAAa,OAAO,CAAA;AAAA,MACjD;AAAA,QACE,KAAA,EAAO,KAAK,MAAO,CAAA,KAAA;AAAA,QACnB,IAAM,EAAA,CAAA;AAAA,QACN,QAAU,EAAA,EAAA;AAAA,QACV,GAAI,CAAC,IAAA,CAAK,OAAO,oBAAwB,IAAA,EAAE,UAAU,KAAM;AAAA;AAC7D,KACF;AAEA,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS;AAAC,KACZ;AAEA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAA,IAAI,MAAM,IAAK,CAAA,oBAAA,CAAqB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAG,EAAA;AAC/D,QAAI,GAAA,CAAA,OAAA,EAAA;AACJ,QAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA;AAAA;AAC1B;AAGF,IAAM,MAAA,SAAA,GAAY,IAAI,OAAQ,CAAA,GAAA,CAAI,OAAK,IAAK,CAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAEjE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAa,UAAA,EAAA,SAAA,CAAU,MAAM,CAAA,cAAA,EAAiB,IAAI,OAAO,CAAA,UAAA;AAAA,KAC3D;AACA,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,8CAAA,CAA6B,EAAE,QAAA,EAAU;AAAA,OACjD,CAAA;AAAA,KACH,CAAA;AAAA;AACH,EAEQ,mBAAmB,OAAsC,EAAA;AAC/D,IAAA,MAAM,iBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAEd,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,GAAG,OAAQ,CAAA,OAAO,WAAW,cAAc,CAAA,CAAA,EAAI,IAAK,CAAA,MAAA,CAAO,WAAW,CAAA,CAAA;AAAA,MAC9E,QAAU,EAAA;AAAA,KACZ;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,WAAW,KAA8C,EAAA;AACrE,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,IAAK,CAAA,eAAA,EAAiB,CAAA;AAAA,OAC3E;AAAA;AAEF,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAA;AAAA,KAC9D;AAEA,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,YAAa,CAAA,cAAA,CAAe,MAAM,UAAU,CAAA;AAEvE,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAA;AAAA,OAC9D;AAEA,MAAA;AAAA;AAGF,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,qBAAqB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAI,EAAA;AAClE,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,eAAA,EAAkB,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAE,CAAA,CAAA;AACvE,MAAA;AAAA;AAIF,IAAA,MAAM,QAAQ,IAAK,CAAA,sBAAA;AAAA,MACjB,KAAA;AAAA,MACA,OAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AACA,IAAA,MAAM,UAAU,IAAK,CAAA,sBAAA;AAAA,MACnB,KAAA;AAAA,MACA,SAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AACA,IAAA,MAAM,WAAW,IAAK,CAAA,sBAAA;AAAA,MACpB,KAAA;AAAA,MACA,UAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AAGA,IAAA,MAAM,gBAAgB,IAAK,CAAA,+BAAA;AAAA,MACzB,KAAM,CAAA,OAAA;AAAA,MACN;AAAA,KACF;AAEA,IAAA,MAAM,kBAAkB,IAAK,CAAA,+BAAA;AAAA,MAC3B,KAAM,CAAA,OAAA;AAAA,MACN;AAAA,KACF;AAEA,IAAA,IAAI,aAAc,CAAA,MAAA,GAAS,CAAK,IAAA,eAAA,CAAgB,SAAS,CAAG,EAAA;AAC1D,MAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,QAClC,IAAM,EAAA,OAAA;AAAA,QACN,OAAO,IAAK,CAAA,kBAAA;AAAA,UACV,aAAc,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA,MAAA,CAAO,MAAM;AAAA,SAC3C;AAAA,QACA,SAAS,IAAK,CAAA,kBAAA;AAAA,UACZ,eAAgB,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA,MAAA,CAAO,MAAM;AAAA;AAC7C,OACD,CAAA;AAAA;AAGH,IAAI,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AACvB,MAAM,MAAA,aAAA,GACJ,KAAK,MAAO,CAAA,MAAA,IACZ,MAAM,OAAQ,CAAA,cAAA,IACd,KAAK,MAAO,CAAA,cAAA;AAGd,MAAM,MAAA,IAAA,CAAK,WAAW,OAAQ,CAAA;AAAA,QAC5B,IAAM,EAAA;AAAA,UACJ,GAAG,QAAS,CAAA,GAAA;AAAA,YACV,CAAA,QAAA,KACE,OAAO,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,QAAQ,CAAA;AAAA,WACpE;AAAA,UACA,GAAG,QAAS,CAAA,GAAA;AAAA,YACV,CAAA,QAAA,KACE,OAAO,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,QAAQ,CAAA;AAAA;AACpE;AACF,OACD,CAAA;AAAA;AAGH,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAoC,iCAAA,EAAA,KAAA,CAAM,OAAQ,CAAA,OAAO,CAAW,QAAA,EAAA,KAAA,CAAM,MAAM,CAAA,WAAA,EAAc,OAAQ,CAAA,MAAM,CAAe,YAAA,EAAA,QAAA,CAAS,MAAM,CAAA;AAAA,KAC5I;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,sBAAA,CACN,KACA,EAAA,MAAA,EACA,WACU,EAAA;AACV,IAAI,IAAA,CAAC,MAAM,OAAS,EAAA;AAClB,MAAA,OAAO,EAAC;AAAA;AAGV,IAAM,MAAA,aAAA,GAAgB,MAAM,OAAQ,CAAA,OAAA;AAAA,MAAQ,CAAC,OAAA,KAC3C,OAAQ,CAAA,MAAM,CAAE,CAAA,MAAA;AAAA,QACd,CAAC,IAAA,KAAiBC,eAAK,CAAA,QAAA,CAAS,IAAI,CAAM,KAAA;AAAA;AAC5C,KACF;AAEA,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,sBAAsB,WAAW,CAAA,uBAAA;AAAA,OACnC;AAAA;AAGF,IAAO,OAAA,aAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,+BAAA,CACN,SACA,UACgB,EAAA;AAChB,IAAA,MAAM,gBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAGd,IAAA,MAAM,gBAAgB,UAAW,CAAA,MAAA;AAAA,MAC/B,UAAQA,eAAK,CAAA,QAAA,CAAS,IAAI,CAAA,KAAM,KAAK,MAAO,CAAA;AAAA,KAC9C;AAGA,IAAM,MAAA,aAAA,GAAgC,aAAc,CAAA,GAAA,CAAI,CAAS,IAAA,MAAA;AAAA,MAC/D,IAAM,EAAA,KAAA;AAAA,MACN,QAAQ,CAAG,EAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,IAAI,CAAA,CAAA;AAAA,MAC1D,QAAU,EAAA;AAAA,KACV,CAAA,CAAA;AAEF,IAAO,OAAA,aAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,eAAe,MAA8B,EAAA;AACnD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA;AAAA,MACA,QAAU,EAAA;AAAA,KACZ;AAAA;AACF,EAEQ,mBAAmB,OAAqC,EAAA;AAC9D,IAAO,OAAA,OAAA,CACJ,IAAI,CAAU,MAAA,KAAA;AACb,MAAM,MAAA,QAAA,GAAW,IAAK,CAAA,cAAA,CAAe,MAAM,CAAA;AAE3C,MAAO,OAAAD,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,KACjD,CACA,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA;AACb,MAAO,OAAA;AAAA,QACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC;AAAA,OACF;AAAA,KACD,CAAA;AAAA;AACL,EAEA,MAAc,oBACZ,CAAA,OAAA,EACA,MACkB,EAAA;AAClB,IAAI,IAAA,CAAC,KAAK,MAAO,CAAA,cAAA,CAAe,KAAK,OAAQ,CAAA,mBAAA,IAAuB,EAAE,CAAG,EAAA;AACvE,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,oBAAoB,OAAQ,CAAA,mBAAmB,CAA6C,0CAAA,EAAA,IAAA,CAAK,OAAO,cAAc,CAAA,CAAA;AAAA,OACxH;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IACE,IAAK,CAAA,MAAA,CAAO,KACZ,IAAA,CAAC,OAAQ,CAAA,mBAAA,CAAqB,UAAW,CAAA,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,KAAK,CAAA,CAAA,CAAG,CAChE,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,oBAAoB,OAAQ,CAAA,mBAAmB,CAA2C,wCAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA;AAAA,OAC7G;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IACE,KAAK,MAAO,CAAA,eAAA,IACZ,OAAQ,CAAA,cAAA,CAAe,qBAAqB,CAC5C,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,iBAAA,EAAoB,QAAQ,mBAAmB,CAAA,2BAAA;AAAA,OACjD;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IAAI,KAAK,MAAO,CAAA,YAAA,EAAc,SAAS,OAAQ,CAAA,mBAAA,IAAuB,EAAE,CAAG,EAAA;AACzE,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,iBAAA,EAAoB,QAAQ,mBAAmB,CAAA,mBAAA;AAAA,OACjD;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,MAAM,iBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAEd,IAAM,MAAA,OAAA,GAAU,MAAM,MAAO,CAAA,OAAA;AAAA,MAC3B,QAAQ,mBAAuB,IAAA,EAAA;AAAA,MAC/B,cAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AAEA,IAAO,OAAA,OAAA;AAAA;AAEX;;;;"}
|
|
1
|
+
{"version":3,"file":"GitlabDiscoveryEntityProvider.cjs.js","sources":["../../src/providers/GitlabDiscoveryEntityProvider.ts"],"sourcesContent":["/*\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 LoggerService,\n SchedulerService,\n SchedulerServiceTaskRunner,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { GitLabIntegration, ScmIntegrations } from '@backstage/integration';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n DeferredEntity,\n EntityProvider,\n EntityProviderConnection,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { EventsService } from '@backstage/plugin-events-node';\nimport { WebhookProjectSchema, WebhookPushEventSchema } from '@gitbeaker/rest';\nimport * as uuid from 'uuid';\nimport {\n GitLabClient,\n GitLabProject,\n GitlabProviderConfig,\n paginated,\n readGitlabConfigs,\n} from '../lib';\n\nimport * as path from 'path';\n\nconst TOPIC_REPO_PUSH = 'gitlab.push';\n\ntype Result = {\n scanned: number;\n matches: GitLabProject[];\n};\n\n/**\n * Discovers catalog files located in your GitLab instance.\n * The provider will search your GitLab instance's projects and register catalog files matching the configured path\n * as Location entity and via following processing steps add all contained catalog entities.\n * This can be useful as an alternative to static locations or manually adding things to the catalog.\n *\n * @public\n */\n// <<< EventSupportChange: implemented EventSubscriber interface\nexport class GitlabDiscoveryEntityProvider implements EntityProvider {\n private readonly config: GitlabProviderConfig;\n private readonly integration: GitLabIntegration;\n private readonly logger: LoggerService;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n private readonly events?: EventsService;\n private readonly gitLabClient: GitLabClient;\n\n static fromConfig(\n config: Config,\n options: {\n logger: LoggerService;\n events?: EventsService;\n schedule?: SchedulerServiceTaskRunner;\n scheduler?: SchedulerService;\n },\n ): GitlabDiscoveryEntityProvider[] {\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n const providerConfigs = readGitlabConfigs(config);\n const integrations = ScmIntegrations.fromConfig(config).gitlab;\n const providers: GitlabDiscoveryEntityProvider[] = [];\n\n providerConfigs.forEach(providerConfig => {\n const integration = integrations.byHost(providerConfig.host);\n if (!integration) {\n throw new Error(\n `No gitlab integration found that matches host ${providerConfig.host}`,\n );\n }\n\n if (!options.schedule && !providerConfig.schedule) {\n throw new Error(\n `No schedule provided neither via code nor config for GitlabDiscoveryEntityProvider:${providerConfig.id}.`,\n );\n }\n\n const taskRunner =\n options.schedule ??\n options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n providers.push(\n new GitlabDiscoveryEntityProvider({\n ...options,\n config: providerConfig,\n integration,\n taskRunner,\n }),\n );\n });\n\n return providers;\n }\n\n /**\n * Constructs a GitlabDiscoveryEntityProvider instance.\n *\n * @param options - Configuration options including config, integration, logger, and taskRunner.\n */\n private constructor(options: {\n config: GitlabProviderConfig;\n integration: GitLabIntegration;\n logger: LoggerService;\n events?: EventsService;\n taskRunner: SchedulerServiceTaskRunner;\n }) {\n this.config = options.config;\n this.integration = options.integration;\n this.logger = options.logger.child({\n target: this.getProviderName(),\n });\n this.scheduleFn = this.createScheduleFn(options.taskRunner);\n this.events = options.events;\n this.gitLabClient = new GitLabClient({\n config: this.integration.config,\n logger: this.logger,\n });\n }\n\n getProviderName(): string {\n return `GitlabDiscoveryEntityProvider:${this.config.id}`;\n }\n\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n\n if (this.events) {\n await this.events.subscribe({\n id: this.getProviderName(),\n topics: [TOPIC_REPO_PUSH],\n onEvent: async params => {\n if (params.topic !== TOPIC_REPO_PUSH) {\n return;\n }\n\n await this.onRepoPush(params.eventPayload as WebhookPushEventSchema);\n },\n });\n }\n }\n\n /**\n * Creates a scheduled task runner for refreshing the entity provider.\n *\n * @param taskRunner - The task runner instance.\n * @returns The scheduled function.\n */\n private createScheduleFn(\n taskRunner: SchedulerServiceTaskRunner,\n ): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: GitlabDiscoveryEntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(\n `${this.getProviderName()} refresh failed, ${error}`,\n error,\n );\n }\n },\n });\n };\n }\n\n /**\n * Performs a full scan on the GitLab instance searching for locations to be ingested\n *\n * @param logger - The logger instance for logging.\n */\n async refresh(logger: LoggerService): Promise<void> {\n if (!this.connection) {\n throw new Error(\n `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n );\n }\n\n const projects = paginated<GitLabProject>(\n options => this.gitLabClient.listProjects(options),\n {\n group: this.config.group,\n page: 1,\n per_page: 50,\n ...(!this.config.includeArchivedRepos && { archived: false }),\n ...(this.config.membership && { membership: true }),\n ...(this.config.topics && { topics: this.config.topics }),\n },\n );\n\n const res: Result = {\n scanned: 0,\n matches: [],\n };\n\n for await (const project of projects) {\n if (await this.shouldProcessProject(project, this.gitLabClient)) {\n res.scanned++;\n res.matches.push(project);\n }\n }\n\n const locations = res.matches.map(p => this.createLocationSpec(p));\n\n logger.info(\n `Processed ${locations.length} from scanned ${res.scanned} projects.`,\n );\n await this.connection.applyMutation({\n type: 'full',\n entities: locations.map(location => ({\n locationKey: this.getProviderName(),\n entity: locationSpecToLocationEntity({ location }),\n })),\n });\n }\n\n private createLocationSpec(project: GitLabProject): LocationSpec {\n const project_branch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n return {\n type: 'url',\n target: `${project.web_url}/-/blob/${project_branch}/${this.config.catalogFile}`,\n presence: 'optional',\n };\n }\n\n /**\n * Handles the \"gitlab.push\" event.\n *\n * @param event - The push event payload.\n */\n private async onRepoPush(event: WebhookPushEventSchema): Promise<void> {\n if (!this.connection) {\n throw new Error(\n `Gitlab discovery connection not initialized for ${this.getProviderName()}`,\n );\n }\n this.logger.info(\n `Received push event for ${event.project.path_with_namespace}`,\n );\n\n const project = await this.gitLabClient.getProjectById(event.project_id);\n\n if (!project) {\n this.logger.debug(\n `Ignoring push event for ${event.project.path_with_namespace}`,\n );\n\n return;\n }\n\n if (!(await this.shouldProcessProject(project, this.gitLabClient))) {\n this.logger.debug(`Skipping event ${event.project.path_with_namespace}`);\n return;\n }\n\n // Get array of added, removed or modified files from the push event\n const added = this.getFilesMatchingConfig(\n event,\n 'added',\n this.config.catalogFile,\n );\n const removed = this.getFilesMatchingConfig(\n event,\n 'removed',\n this.config.catalogFile,\n );\n const modified = this.getFilesMatchingConfig(\n event,\n 'modified',\n this.config.catalogFile,\n );\n\n // Modified files will be scheduled to a refresh\n const addedEntities = this.createLocationSpecCommitedFiles(\n event.project,\n added,\n );\n\n const removedEntities = this.createLocationSpecCommitedFiles(\n event.project,\n removed,\n );\n\n if (addedEntities.length > 0 || removedEntities.length > 0) {\n await this.connection.applyMutation({\n type: 'delta',\n added: this.toDeferredEntities(\n addedEntities.map(entity => entity.target),\n ),\n removed: this.toDeferredEntities(\n removedEntities.map(entity => entity.target),\n ),\n });\n }\n\n if (modified.length > 0) {\n const projectBranch =\n this.config.branch ??\n event.project.default_branch ??\n this.config.fallbackBranch;\n\n // scheduling a refresh to both tree and blob (https://git-scm.com/book/en/v2/Git-Internals-Git-Objects)\n await this.connection.refresh({\n keys: [\n ...modified.map(\n filePath =>\n `url:${event.project.web_url}/-/tree/${projectBranch}/${filePath}`,\n ),\n ...modified.map(\n filePath =>\n `url:${event.project.web_url}/-/blob/${projectBranch}/${filePath}`,\n ),\n ],\n });\n }\n\n this.logger.info(\n `Processed GitLab push event from ${event.project.web_url}: added ${added.length} - removed ${removed.length} - modified ${modified.length}`,\n );\n }\n\n /**\n * Gets files matching the specified commit action and catalog file name.\n *\n * @param event - The push event payload.\n * @param action - The action type ('added', 'removed', or 'modified').\n * @param catalogFile - The catalog file name.\n * @returns An array of file paths.\n */\n private getFilesMatchingConfig(\n event: WebhookPushEventSchema,\n action: 'added' | 'removed' | 'modified',\n catalogFile: string,\n ): string[] {\n if (!event.commits) {\n return [];\n }\n\n const matchingFiles = event.commits.flatMap((element: any) =>\n element[action].filter(\n (file: string) => path.basename(file) === catalogFile,\n ),\n );\n\n if (matchingFiles.length === 0) {\n this.logger.debug(\n `No files matching '${catalogFile}' found in the commits.`,\n );\n }\n\n return matchingFiles;\n }\n\n /**\n * Creates Backstage location specs for committed files.\n *\n * @param project - The GitLab project information.\n * @param addedFiles - The array of added file paths.\n * @returns An array of location specs.\n */\n private createLocationSpecCommitedFiles(\n project: WebhookProjectSchema,\n addedFiles: string[],\n ): LocationSpec[] {\n const projectBranch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n // Filter added files that match the catalog file pattern\n const matchingFiles = addedFiles.filter(\n file => path.basename(file) === this.config.catalogFile,\n );\n\n // Create a location spec for each matching file\n const locationSpecs: LocationSpec[] = matchingFiles.map(file => ({\n type: 'url',\n target: `${project.web_url}/-/blob/${projectBranch}/${file}`,\n presence: 'optional',\n }));\n\n return locationSpecs;\n }\n\n /**\n * Converts a target URL to a LocationSpec object.\n *\n * @param target - The target URL to be converted.\n * @returns The LocationSpec object representing the URL.\n */\n private toLocationSpec(target: string): LocationSpec {\n return {\n type: 'url',\n target: target,\n presence: 'optional',\n };\n }\n\n private toDeferredEntities(targets: string[]): DeferredEntity[] {\n return targets\n .map(target => {\n const location = this.toLocationSpec(target);\n\n return locationSpecToLocationEntity({ location });\n })\n .map(entity => {\n return {\n locationKey: this.getProviderName(),\n entity: entity,\n };\n });\n }\n\n private async shouldProcessProject(\n project: GitLabProject,\n client: GitLabClient,\n ): Promise<boolean> {\n if (!this.config.projectPattern.test(project.path_with_namespace ?? '')) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it does not match the project pattern ${this.config.projectPattern}.`,\n );\n return false;\n }\n\n if (\n this.config.group &&\n !project.path_with_namespace!.startsWith(`${this.config.group}/`)\n ) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it does not match the group pattern ${this.config.group}.`,\n );\n return false;\n }\n\n if (\n this.config.skipForkedRepos &&\n project.hasOwnProperty('forked_from_project')\n ) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it is a forked project.`,\n );\n return false;\n }\n\n if (this.config.excludeRepos?.includes(project.path_with_namespace ?? '')) {\n this.logger.debug(\n `Skipping project ${project.path_with_namespace} as it is excluded.`,\n );\n return false;\n }\n\n const project_branch =\n this.config.branch ??\n project.default_branch ??\n this.config.fallbackBranch;\n\n const hasFile = await client.hasFile(\n project.path_with_namespace ?? '',\n project_branch,\n this.config.catalogFile,\n );\n\n return hasFile;\n }\n}\n"],"names":["config","readGitlabConfigs","ScmIntegrations","GitLabClient","uuid","paginated","locationSpecToLocationEntity","path"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,MAAM,eAAkB,GAAA,aAAA;AAgBjB,MAAM,6BAAwD,CAAA;AAAA,EAClD,MAAA;AAAA,EACA,WAAA;AAAA,EACA,MAAA;AAAA,EACA,UAAA;AAAA,EACT,UAAA;AAAA,EACS,MAAA;AAAA,EACA,YAAA;AAAA,EAEjB,OAAO,UACL,CAAAA,QAAA,EACA,OAMiC,EAAA;AACjC,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA;AAAA;AAGlE,IAAM,MAAA,eAAA,GAAkBC,yBAAkBD,QAAM,CAAA;AAChD,IAAA,MAAM,YAAe,GAAAE,2BAAA,CAAgB,UAAW,CAAAF,QAAM,CAAE,CAAA,MAAA;AACxD,IAAA,MAAM,YAA6C,EAAC;AAEpD,IAAA,eAAA,CAAgB,QAAQ,CAAkB,cAAA,KAAA;AACxC,MAAA,MAAM,WAAc,GAAA,YAAA,CAAa,MAAO,CAAA,cAAA,CAAe,IAAI,CAAA;AAC3D,MAAA,IAAI,CAAC,WAAa,EAAA;AAChB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,8CAAA,EAAiD,eAAe,IAAI,CAAA;AAAA,SACtE;AAAA;AAGF,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,CAAA,mFAAA,EAAsF,eAAe,EAAE,CAAA,CAAA;AAAA,SACzG;AAAA;AAGF,MAAA,MAAM,aACJ,OAAQ,CAAA,QAAA,IACR,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA;AAEvE,MAAU,SAAA,CAAA,IAAA;AAAA,QACR,IAAI,6BAA8B,CAAA;AAAA,UAChC,GAAG,OAAA;AAAA,UACH,MAAQ,EAAA,cAAA;AAAA,UACR,WAAA;AAAA,UACA;AAAA,SACD;AAAA,OACH;AAAA,KACD,CAAA;AAED,IAAO,OAAA,SAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,YAAY,OAMjB,EAAA;AACD,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA;AAC3B,IAAK,IAAA,CAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,MACjC,MAAA,EAAQ,KAAK,eAAgB;AAAA,KAC9B,CAAA;AACD,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAK,gBAAiB,CAAA,OAAA,CAAQ,UAAU,CAAA;AAC1D,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAK,IAAA,CAAA,YAAA,GAAe,IAAIG,mBAAa,CAAA;AAAA,MACnC,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,QAAQ,IAAK,CAAA;AAAA,KACd,CAAA;AAAA;AACH,EAEA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,8BAAA,EAAiC,IAAK,CAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA;AACxD,EAEA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA;AAEtB,IAAA,IAAI,KAAK,MAAQ,EAAA;AACf,MAAM,MAAA,IAAA,CAAK,OAAO,SAAU,CAAA;AAAA,QAC1B,EAAA,EAAI,KAAK,eAAgB,EAAA;AAAA,QACzB,MAAA,EAAQ,CAAC,eAAe,CAAA;AAAA,QACxB,OAAA,EAAS,OAAM,MAAU,KAAA;AACvB,UAAI,IAAA,MAAA,CAAO,UAAU,eAAiB,EAAA;AACpC,YAAA;AAAA;AAGF,UAAM,MAAA,IAAA,CAAK,UAAW,CAAA,MAAA,CAAO,YAAsC,CAAA;AAAA;AACrE,OACD,CAAA;AAAA;AACH;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,iBACN,UACqB,EAAA;AACrB,IAAA,OAAO,YAAY;AACjB,MAAA,MAAM,MAAS,GAAA,CAAA,EAAG,IAAK,CAAA,eAAA,EAAiB,CAAA,QAAA,CAAA;AACxC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,6BAA8B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC3D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG;AAAA,WACzB,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA;AAAA,mBAClB,KAAO,EAAA;AACd,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAC,oBAAoB,KAAK,CAAA,CAAA;AAAA,cAClD;AAAA,aACF;AAAA;AACF;AACF,OACD,CAAA;AAAA,KACH;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAQ,MAAsC,EAAA;AAClD,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,IAAK,CAAA,eAAA,EAAiB,CAAA;AAAA,OAC3E;AAAA;AAGF,IAAA,MAAM,QAAW,GAAAC,gBAAA;AAAA,MACf,CAAW,OAAA,KAAA,IAAA,CAAK,YAAa,CAAA,YAAA,CAAa,OAAO,CAAA;AAAA,MACjD;AAAA,QACE,KAAA,EAAO,KAAK,MAAO,CAAA,KAAA;AAAA,QACnB,IAAM,EAAA,CAAA;AAAA,QACN,QAAU,EAAA,EAAA;AAAA,QACV,GAAI,CAAC,IAAA,CAAK,OAAO,oBAAwB,IAAA,EAAE,UAAU,KAAM,EAAA;AAAA,QAC3D,GAAI,IAAK,CAAA,MAAA,CAAO,UAAc,IAAA,EAAE,YAAY,IAAK,EAAA;AAAA,QACjD,GAAI,KAAK,MAAO,CAAA,MAAA,IAAU,EAAE,MAAQ,EAAA,IAAA,CAAK,OAAO,MAAO;AAAA;AACzD,KACF;AAEA,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS;AAAC,KACZ;AAEA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAA,IAAI,MAAM,IAAK,CAAA,oBAAA,CAAqB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAG,EAAA;AAC/D,QAAI,GAAA,CAAA,OAAA,EAAA;AACJ,QAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA;AAAA;AAC1B;AAGF,IAAM,MAAA,SAAA,GAAY,IAAI,OAAQ,CAAA,GAAA,CAAI,OAAK,IAAK,CAAA,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAEjE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,CAAa,UAAA,EAAA,SAAA,CAAU,MAAM,CAAA,cAAA,EAAiB,IAAI,OAAO,CAAA,UAAA;AAAA,KAC3D;AACA,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAa,QAAA,MAAA;AAAA,QACnC,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAQ,EAAAC,8CAAA,CAA6B,EAAE,QAAA,EAAU;AAAA,OACjD,CAAA;AAAA,KACH,CAAA;AAAA;AACH,EAEQ,mBAAmB,OAAsC,EAAA;AAC/D,IAAA,MAAM,iBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAEd,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,GAAG,OAAQ,CAAA,OAAO,WAAW,cAAc,CAAA,CAAA,EAAI,IAAK,CAAA,MAAA,CAAO,WAAW,CAAA,CAAA;AAAA,MAC9E,QAAU,EAAA;AAAA,KACZ;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,WAAW,KAA8C,EAAA;AACrE,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gDAAA,EAAmD,IAAK,CAAA,eAAA,EAAiB,CAAA;AAAA,OAC3E;AAAA;AAEF,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAA;AAAA,KAC9D;AAEA,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,YAAa,CAAA,cAAA,CAAe,MAAM,UAAU,CAAA;AAEvE,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,wBAAA,EAA2B,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAA;AAAA,OAC9D;AAEA,MAAA;AAAA;AAGF,IAAA,IAAI,CAAE,MAAM,IAAA,CAAK,qBAAqB,OAAS,EAAA,IAAA,CAAK,YAAY,CAAI,EAAA;AAClE,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,eAAA,EAAkB,KAAM,CAAA,OAAA,CAAQ,mBAAmB,CAAE,CAAA,CAAA;AACvE,MAAA;AAAA;AAIF,IAAA,MAAM,QAAQ,IAAK,CAAA,sBAAA;AAAA,MACjB,KAAA;AAAA,MACA,OAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AACA,IAAA,MAAM,UAAU,IAAK,CAAA,sBAAA;AAAA,MACnB,KAAA;AAAA,MACA,SAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AACA,IAAA,MAAM,WAAW,IAAK,CAAA,sBAAA;AAAA,MACpB,KAAA;AAAA,MACA,UAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AAGA,IAAA,MAAM,gBAAgB,IAAK,CAAA,+BAAA;AAAA,MACzB,KAAM,CAAA,OAAA;AAAA,MACN;AAAA,KACF;AAEA,IAAA,MAAM,kBAAkB,IAAK,CAAA,+BAAA;AAAA,MAC3B,KAAM,CAAA,OAAA;AAAA,MACN;AAAA,KACF;AAEA,IAAA,IAAI,aAAc,CAAA,MAAA,GAAS,CAAK,IAAA,eAAA,CAAgB,SAAS,CAAG,EAAA;AAC1D,MAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,QAClC,IAAM,EAAA,OAAA;AAAA,QACN,OAAO,IAAK,CAAA,kBAAA;AAAA,UACV,aAAc,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA,MAAA,CAAO,MAAM;AAAA,SAC3C;AAAA,QACA,SAAS,IAAK,CAAA,kBAAA;AAAA,UACZ,eAAgB,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA,MAAA,CAAO,MAAM;AAAA;AAC7C,OACD,CAAA;AAAA;AAGH,IAAI,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AACvB,MAAM,MAAA,aAAA,GACJ,KAAK,MAAO,CAAA,MAAA,IACZ,MAAM,OAAQ,CAAA,cAAA,IACd,KAAK,MAAO,CAAA,cAAA;AAGd,MAAM,MAAA,IAAA,CAAK,WAAW,OAAQ,CAAA;AAAA,QAC5B,IAAM,EAAA;AAAA,UACJ,GAAG,QAAS,CAAA,GAAA;AAAA,YACV,CAAA,QAAA,KACE,OAAO,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,QAAQ,CAAA;AAAA,WACpE;AAAA,UACA,GAAG,QAAS,CAAA,GAAA;AAAA,YACV,CAAA,QAAA,KACE,OAAO,KAAM,CAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,QAAQ,CAAA;AAAA;AACpE;AACF,OACD,CAAA;AAAA;AAGH,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,MACV,CAAoC,iCAAA,EAAA,KAAA,CAAM,OAAQ,CAAA,OAAO,CAAW,QAAA,EAAA,KAAA,CAAM,MAAM,CAAA,WAAA,EAAc,OAAQ,CAAA,MAAM,CAAe,YAAA,EAAA,QAAA,CAAS,MAAM,CAAA;AAAA,KAC5I;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,sBAAA,CACN,KACA,EAAA,MAAA,EACA,WACU,EAAA;AACV,IAAI,IAAA,CAAC,MAAM,OAAS,EAAA;AAClB,MAAA,OAAO,EAAC;AAAA;AAGV,IAAM,MAAA,aAAA,GAAgB,MAAM,OAAQ,CAAA,OAAA;AAAA,MAAQ,CAAC,OAAA,KAC3C,OAAQ,CAAA,MAAM,CAAE,CAAA,MAAA;AAAA,QACd,CAAC,IAAA,KAAiBC,eAAK,CAAA,QAAA,CAAS,IAAI,CAAM,KAAA;AAAA;AAC5C,KACF;AAEA,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,sBAAsB,WAAW,CAAA,uBAAA;AAAA,OACnC;AAAA;AAGF,IAAO,OAAA,aAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,+BAAA,CACN,SACA,UACgB,EAAA;AAChB,IAAA,MAAM,gBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAGd,IAAA,MAAM,gBAAgB,UAAW,CAAA,MAAA;AAAA,MAC/B,UAAQA,eAAK,CAAA,QAAA,CAAS,IAAI,CAAA,KAAM,KAAK,MAAO,CAAA;AAAA,KAC9C;AAGA,IAAM,MAAA,aAAA,GAAgC,aAAc,CAAA,GAAA,CAAI,CAAS,IAAA,MAAA;AAAA,MAC/D,IAAM,EAAA,KAAA;AAAA,MACN,QAAQ,CAAG,EAAA,OAAA,CAAQ,OAAO,CAAW,QAAA,EAAA,aAAa,IAAI,IAAI,CAAA,CAAA;AAAA,MAC1D,QAAU,EAAA;AAAA,KACV,CAAA,CAAA;AAEF,IAAO,OAAA,aAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,eAAe,MAA8B,EAAA;AACnD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA;AAAA,MACA,QAAU,EAAA;AAAA,KACZ;AAAA;AACF,EAEQ,mBAAmB,OAAqC,EAAA;AAC9D,IAAO,OAAA,OAAA,CACJ,IAAI,CAAU,MAAA,KAAA;AACb,MAAM,MAAA,QAAA,GAAW,IAAK,CAAA,cAAA,CAAe,MAAM,CAAA;AAE3C,MAAO,OAAAD,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,KACjD,CACA,CAAA,GAAA,CAAI,CAAU,MAAA,KAAA;AACb,MAAO,OAAA;AAAA,QACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC;AAAA,OACF;AAAA,KACD,CAAA;AAAA;AACL,EAEA,MAAc,oBACZ,CAAA,OAAA,EACA,MACkB,EAAA;AAClB,IAAI,IAAA,CAAC,KAAK,MAAO,CAAA,cAAA,CAAe,KAAK,OAAQ,CAAA,mBAAA,IAAuB,EAAE,CAAG,EAAA;AACvE,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,oBAAoB,OAAQ,CAAA,mBAAmB,CAA6C,0CAAA,EAAA,IAAA,CAAK,OAAO,cAAc,CAAA,CAAA;AAAA,OACxH;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IACE,IAAK,CAAA,MAAA,CAAO,KACZ,IAAA,CAAC,OAAQ,CAAA,mBAAA,CAAqB,UAAW,CAAA,CAAA,EAAG,IAAK,CAAA,MAAA,CAAO,KAAK,CAAA,CAAA,CAAG,CAChE,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,oBAAoB,OAAQ,CAAA,mBAAmB,CAA2C,wCAAA,EAAA,IAAA,CAAK,OAAO,KAAK,CAAA,CAAA;AAAA,OAC7G;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IACE,KAAK,MAAO,CAAA,eAAA,IACZ,OAAQ,CAAA,cAAA,CAAe,qBAAqB,CAC5C,EAAA;AACA,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,iBAAA,EAAoB,QAAQ,mBAAmB,CAAA,2BAAA;AAAA,OACjD;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,IAAI,KAAK,MAAO,CAAA,YAAA,EAAc,SAAS,OAAQ,CAAA,mBAAA,IAAuB,EAAE,CAAG,EAAA;AACzE,MAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,QACV,CAAA,iBAAA,EAAoB,QAAQ,mBAAmB,CAAA,mBAAA;AAAA,OACjD;AACA,MAAO,OAAA,KAAA;AAAA;AAGT,IAAA,MAAM,iBACJ,IAAK,CAAA,MAAA,CAAO,UACZ,OAAQ,CAAA,cAAA,IACR,KAAK,MAAO,CAAA,cAAA;AAEd,IAAM,MAAA,OAAA,GAAU,MAAM,MAAO,CAAA,OAAA;AAAA,MAC3B,QAAQ,mBAAuB,IAAA,EAAA;AAAA,MAC/B,cAAA;AAAA,MACA,KAAK,MAAO,CAAA;AAAA,KACd;AAEA,IAAO,OAAA,OAAA;AAAA;AAEX;;;;"}
|
|
@@ -28,6 +28,9 @@ function readGitlabConfig(id, config) {
|
|
|
28
28
|
) : void 0;
|
|
29
29
|
const restrictUsersToGroup = config.getOptionalBoolean("restrictUsersToGroup") ?? false;
|
|
30
30
|
const includeUsersWithoutSeat = config.getOptionalBoolean("includeUsersWithoutSeat") ?? false;
|
|
31
|
+
const membership = config.getOptionalBoolean("membership");
|
|
32
|
+
const topicsArray = config.getOptionalStringArray("topics");
|
|
33
|
+
const topics = topicsArray?.length ? topicsArray.join(",") : void 0;
|
|
31
34
|
return {
|
|
32
35
|
id,
|
|
33
36
|
group,
|
|
@@ -46,7 +49,9 @@ function readGitlabConfig(id, config) {
|
|
|
46
49
|
includeArchivedRepos,
|
|
47
50
|
excludeRepos,
|
|
48
51
|
restrictUsersToGroup,
|
|
49
|
-
includeUsersWithoutSeat
|
|
52
|
+
includeUsersWithoutSeat,
|
|
53
|
+
membership,
|
|
54
|
+
topics
|
|
50
55
|
};
|
|
51
56
|
}
|
|
52
57
|
function readGitlabConfigs(config) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.cjs.js","sources":["../../src/providers/config.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { GitlabProviderConfig } from '../lib';\n\n/**\n * Extracts the gitlab config from a config object\n *\n * @public\n *\n * @param id - The provider key\n * @param config - The config object to extract from\n */\nfunction readGitlabConfig(id: string, config: Config): GitlabProviderConfig {\n const group = config.getOptionalString('group') ?? '';\n const host = config.getString('host');\n const branch = config.getOptionalString('branch');\n const fallbackBranch = config.getOptionalString('fallbackBranch') ?? 'master';\n const catalogFile =\n config.getOptionalString('entityFilename') ?? 'catalog-info.yaml';\n const projectPattern = new RegExp(\n config.getOptionalString('projectPattern') ?? /[\\s\\S]*/,\n );\n const userPattern = new RegExp(\n config.getOptionalString('userPattern') ?? /[\\s\\S]*/,\n );\n const groupPattern = new RegExp(\n config.getOptionalString('groupPattern') ?? /[\\s\\S]*/,\n );\n const orgEnabled: boolean = config.getOptionalBoolean('orgEnabled') ?? false;\n const allowInherited: boolean =\n config.getOptionalBoolean('allowInherited') ?? false;\n const relations: string[] = config.getOptionalStringArray('relations') ?? [];\n\n const skipForkedRepos: boolean =\n config.getOptionalBoolean('skipForkedRepos') ?? false;\n\n const includeArchivedRepos: boolean =\n config.getOptionalBoolean('includeArchivedRepos') ?? false;\n const excludeRepos: string[] =\n config.getOptionalStringArray('excludeRepos') ?? [];\n\n const schedule = config.has('schedule')\n ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n config.getConfig('schedule'),\n )\n : undefined;\n const restrictUsersToGroup =\n config.getOptionalBoolean('restrictUsersToGroup') ?? false;\n\n const includeUsersWithoutSeat =\n config.getOptionalBoolean('includeUsersWithoutSeat') ?? false;\n\n return {\n id,\n group,\n branch,\n fallbackBranch,\n host,\n catalogFile,\n projectPattern,\n userPattern,\n groupPattern,\n schedule,\n orgEnabled,\n allowInherited,\n relations,\n skipForkedRepos,\n includeArchivedRepos,\n excludeRepos,\n restrictUsersToGroup,\n includeUsersWithoutSeat,\n };\n}\n\n/**\n * Extracts the gitlab config from a config object array\n *\n * @public\n *\n * @param config - The config object to extract from\n */\nexport function readGitlabConfigs(config: Config): GitlabProviderConfig[] {\n const configs: GitlabProviderConfig[] = [];\n\n const providerConfigs = config.getOptionalConfig('catalog.providers.gitlab');\n\n if (!providerConfigs) {\n return configs;\n }\n\n for (const id of providerConfigs.keys()) {\n configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));\n }\n\n return configs;\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;AA4BA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AAC1E,EAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,CAAK,IAAA,EAAA;AACnD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AACpC,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAChD,EAAA,MAAM,cAAiB,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA,QAAA;AACrE,EAAA,MAAM,WACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA,mBAAA;AAChD,EAAA,MAAM,iBAAiB,IAAI,MAAA;AAAA,IACzB,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA;AAAA,GAChD;AACA,EAAA,MAAM,cAAc,IAAI,MAAA;AAAA,IACtB,MAAA,CAAO,iBAAkB,CAAA,aAAa,CAAK,IAAA;AAAA,GAC7C;AACA,EAAA,MAAM,eAAe,IAAI,MAAA;AAAA,IACvB,MAAA,CAAO,iBAAkB,CAAA,cAAc,CAAK,IAAA;AAAA,GAC9C;AACA,EAAA,MAAM,UAAsB,GAAA,MAAA,CAAO,kBAAmB,CAAA,YAAY,CAAK,IAAA,KAAA;AACvE,EAAA,MAAM,cACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,gBAAgB,CAAK,IAAA,KAAA;AACjD,EAAA,MAAM,SAAsB,GAAA,MAAA,CAAO,sBAAuB,CAAA,WAAW,KAAK,EAAC;AAE3E,EAAA,MAAM,eACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,iBAAiB,CAAK,IAAA,KAAA;AAElD,EAAA,MAAM,oBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,sBAAsB,CAAK,IAAA,KAAA;AACvD,EAAA,MAAM,YACJ,GAAA,MAAA,CAAO,sBAAuB,CAAA,cAAc,KAAK,EAAC;AAEpD,EAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,UAAU,CAClC,GAAAA,qEAAA;AAAA,IACE,MAAA,CAAO,UAAU,UAAU;AAAA,GAE7B,GAAA,KAAA,CAAA;AACJ,EAAA,MAAM,oBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,sBAAsB,CAAK,IAAA,KAAA;AAEvD,EAAA,MAAM,uBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE1D,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,MAAA;AAAA,IACA,cAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,WAAA;AAAA,IACA,YAAA;AAAA,IACA,QAAA;AAAA,IACA,UAAA;AAAA,IACA,cAAA;AAAA,IACA,SAAA;AAAA,IACA,eAAA;AAAA,IACA,oBAAA;AAAA,IACA,YAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA,GACF;AACF;AASO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA;AAAA;AAGT,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA;AAAA;AAGlE,EAAO,OAAA,OAAA;AACT;;;;"}
|
|
1
|
+
{"version":3,"file":"config.cjs.js","sources":["../../src/providers/config.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { GitlabProviderConfig } from '../lib';\n\n/**\n * Extracts the gitlab config from a config object\n *\n * @public\n *\n * @param id - The provider key\n * @param config - The config object to extract from\n */\nfunction readGitlabConfig(id: string, config: Config): GitlabProviderConfig {\n const group = config.getOptionalString('group') ?? '';\n const host = config.getString('host');\n const branch = config.getOptionalString('branch');\n const fallbackBranch = config.getOptionalString('fallbackBranch') ?? 'master';\n const catalogFile =\n config.getOptionalString('entityFilename') ?? 'catalog-info.yaml';\n const projectPattern = new RegExp(\n config.getOptionalString('projectPattern') ?? /[\\s\\S]*/,\n );\n const userPattern = new RegExp(\n config.getOptionalString('userPattern') ?? /[\\s\\S]*/,\n );\n const groupPattern = new RegExp(\n config.getOptionalString('groupPattern') ?? /[\\s\\S]*/,\n );\n const orgEnabled: boolean = config.getOptionalBoolean('orgEnabled') ?? false;\n const allowInherited: boolean =\n config.getOptionalBoolean('allowInherited') ?? false;\n const relations: string[] = config.getOptionalStringArray('relations') ?? [];\n\n const skipForkedRepos: boolean =\n config.getOptionalBoolean('skipForkedRepos') ?? false;\n\n const includeArchivedRepos: boolean =\n config.getOptionalBoolean('includeArchivedRepos') ?? false;\n const excludeRepos: string[] =\n config.getOptionalStringArray('excludeRepos') ?? [];\n\n const schedule = config.has('schedule')\n ? readSchedulerServiceTaskScheduleDefinitionFromConfig(\n config.getConfig('schedule'),\n )\n : undefined;\n const restrictUsersToGroup =\n config.getOptionalBoolean('restrictUsersToGroup') ?? false;\n\n const includeUsersWithoutSeat =\n config.getOptionalBoolean('includeUsersWithoutSeat') ?? false;\n\n const membership = config.getOptionalBoolean('membership');\n\n const topicsArray = config.getOptionalStringArray('topics');\n const topics = topicsArray?.length ? topicsArray.join(',') : undefined;\n\n return {\n id,\n group,\n branch,\n fallbackBranch,\n host,\n catalogFile,\n projectPattern,\n userPattern,\n groupPattern,\n schedule,\n orgEnabled,\n allowInherited,\n relations,\n skipForkedRepos,\n includeArchivedRepos,\n excludeRepos,\n restrictUsersToGroup,\n includeUsersWithoutSeat,\n membership,\n topics,\n };\n}\n\n/**\n * Extracts the gitlab config from a config object array\n *\n * @public\n *\n * @param config - The config object to extract from\n */\nexport function readGitlabConfigs(config: Config): GitlabProviderConfig[] {\n const configs: GitlabProviderConfig[] = [];\n\n const providerConfigs = config.getOptionalConfig('catalog.providers.gitlab');\n\n if (!providerConfigs) {\n return configs;\n }\n\n for (const id of providerConfigs.keys()) {\n configs.push(readGitlabConfig(id, providerConfigs.getConfig(id)));\n }\n\n return configs;\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;AA4BA,SAAS,gBAAA,CAAiB,IAAY,MAAsC,EAAA;AAC1E,EAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,CAAK,IAAA,EAAA;AACnD,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,MAAM,CAAA;AACpC,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA;AAChD,EAAA,MAAM,cAAiB,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA,QAAA;AACrE,EAAA,MAAM,WACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA,mBAAA;AAChD,EAAA,MAAM,iBAAiB,IAAI,MAAA;AAAA,IACzB,MAAA,CAAO,iBAAkB,CAAA,gBAAgB,CAAK,IAAA;AAAA,GAChD;AACA,EAAA,MAAM,cAAc,IAAI,MAAA;AAAA,IACtB,MAAA,CAAO,iBAAkB,CAAA,aAAa,CAAK,IAAA;AAAA,GAC7C;AACA,EAAA,MAAM,eAAe,IAAI,MAAA;AAAA,IACvB,MAAA,CAAO,iBAAkB,CAAA,cAAc,CAAK,IAAA;AAAA,GAC9C;AACA,EAAA,MAAM,UAAsB,GAAA,MAAA,CAAO,kBAAmB,CAAA,YAAY,CAAK,IAAA,KAAA;AACvE,EAAA,MAAM,cACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,gBAAgB,CAAK,IAAA,KAAA;AACjD,EAAA,MAAM,SAAsB,GAAA,MAAA,CAAO,sBAAuB,CAAA,WAAW,KAAK,EAAC;AAE3E,EAAA,MAAM,eACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,iBAAiB,CAAK,IAAA,KAAA;AAElD,EAAA,MAAM,oBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,sBAAsB,CAAK,IAAA,KAAA;AACvD,EAAA,MAAM,YACJ,GAAA,MAAA,CAAO,sBAAuB,CAAA,cAAc,KAAK,EAAC;AAEpD,EAAA,MAAM,QAAW,GAAA,MAAA,CAAO,GAAI,CAAA,UAAU,CAClC,GAAAA,qEAAA;AAAA,IACE,MAAA,CAAO,UAAU,UAAU;AAAA,GAE7B,GAAA,KAAA,CAAA;AACJ,EAAA,MAAM,oBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,sBAAsB,CAAK,IAAA,KAAA;AAEvD,EAAA,MAAM,uBACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,yBAAyB,CAAK,IAAA,KAAA;AAE1D,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,kBAAA,CAAmB,YAAY,CAAA;AAEzD,EAAM,MAAA,WAAA,GAAc,MAAO,CAAA,sBAAA,CAAuB,QAAQ,CAAA;AAC1D,EAAA,MAAM,SAAS,WAAa,EAAA,MAAA,GAAS,WAAY,CAAA,IAAA,CAAK,GAAG,CAAI,GAAA,KAAA,CAAA;AAE7D,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,MAAA;AAAA,IACA,cAAA;AAAA,IACA,IAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,WAAA;AAAA,IACA,YAAA;AAAA,IACA,QAAA;AAAA,IACA,UAAA;AAAA,IACA,cAAA;AAAA,IACA,SAAA;AAAA,IACA,eAAA;AAAA,IACA,oBAAA;AAAA,IACA,YAAA;AAAA,IACA,oBAAA;AAAA,IACA,uBAAA;AAAA,IACA,UAAA;AAAA,IACA;AAAA,GACF;AACF;AASO,SAAS,kBAAkB,MAAwC,EAAA;AACxE,EAAA,MAAM,UAAkC,EAAC;AAEzC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA;AAE3E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA;AAAA;AAGT,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,gBAAiB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA;AAAA;AAGlE,EAAO,OAAA,OAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-gitlab",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.5-next.1",
|
|
4
4
|
"description": "A Backstage catalog backend module that helps integrate towards GitLab",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -65,23 +65,23 @@
|
|
|
65
65
|
"test": "backstage-cli package test"
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
68
|
-
"@backstage/backend-defaults": "
|
|
69
|
-
"@backstage/backend-plugin-api": "
|
|
70
|
-
"@backstage/catalog-model": "
|
|
71
|
-
"@backstage/config": "
|
|
72
|
-
"@backstage/integration": "
|
|
73
|
-
"@backstage/plugin-catalog-common": "
|
|
74
|
-
"@backstage/plugin-catalog-node": "
|
|
75
|
-
"@backstage/plugin-events-node": "
|
|
68
|
+
"@backstage/backend-defaults": "0.9.0-next.1",
|
|
69
|
+
"@backstage/backend-plugin-api": "1.2.1",
|
|
70
|
+
"@backstage/catalog-model": "1.7.3",
|
|
71
|
+
"@backstage/config": "1.3.2",
|
|
72
|
+
"@backstage/integration": "1.16.3-next.0",
|
|
73
|
+
"@backstage/plugin-catalog-common": "1.1.3",
|
|
74
|
+
"@backstage/plugin-catalog-node": "1.16.1",
|
|
75
|
+
"@backstage/plugin-events-node": "0.4.9",
|
|
76
76
|
"@gitbeaker/rest": "^40.0.3",
|
|
77
77
|
"lodash": "^4.17.21",
|
|
78
78
|
"node-fetch": "^2.7.0",
|
|
79
79
|
"uuid": "^11.0.0"
|
|
80
80
|
},
|
|
81
81
|
"devDependencies": {
|
|
82
|
-
"@backstage/backend-test-utils": "
|
|
83
|
-
"@backstage/cli": "
|
|
84
|
-
"@backstage/plugin-events-backend-test-utils": "
|
|
82
|
+
"@backstage/backend-test-utils": "1.3.2-next.1",
|
|
83
|
+
"@backstage/cli": "0.32.0-next.1",
|
|
84
|
+
"@backstage/plugin-events-backend-test-utils": "0.1.42",
|
|
85
85
|
"@types/lodash": "^4.14.151",
|
|
86
86
|
"luxon": "^3.0.0",
|
|
87
87
|
"msw": "^1.0.0"
|