@backstage/plugin-catalog-backend-module-gitlab 0.1.2-next.1 → 0.1.3-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 CHANGED
@@ -1,5 +1,35 @@
1
1
  # @backstage/plugin-catalog-backend-module-gitlab
2
2
 
3
+ ## 0.1.3-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-common@0.13.3-next.2
9
+ - @backstage/plugin-catalog-backend@1.1.2-next.2
10
+ - @backstage/config@1.0.1-next.0
11
+ - @backstage/catalog-model@1.0.2-next.0
12
+ - @backstage/integration@1.2.0-next.1
13
+
14
+ ## 0.1.3-next.0
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+ - @backstage/backend-common@0.13.3-next.0
20
+ - @backstage/integration@1.2.0-next.0
21
+ - @backstage/plugin-catalog-backend@1.1.2-next.0
22
+
23
+ ## 0.1.2
24
+
25
+ ### Patch Changes
26
+
27
+ - Updated dependencies
28
+ - @backstage/plugin-catalog-backend@1.1.0
29
+ - @backstage/integration@1.1.0
30
+ - @backstage/catalog-model@1.0.1
31
+ - @backstage/backend-common@0.13.2
32
+
3
33
  ## 0.1.2-next.1
4
34
 
5
35
  ### Patch Changes
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/lib/client.ts","../src/GitLabDiscoveryProcessor.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 fetch from 'node-fetch';\nimport {\n getGitLabRequestOptions,\n GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { Logger } from 'winston';\n\nexport type ListOptions = {\n [key: string]: string | number | boolean | undefined;\n group?: string;\n per_page?: number | undefined;\n page?: number | undefined;\n};\n\nexport type PagedResponse<T> = {\n items: T[];\n nextPage?: number;\n};\n\nexport class GitLabClient {\n private readonly config: GitLabIntegrationConfig;\n private readonly logger: Logger;\n\n constructor(options: { config: GitLabIntegrationConfig; logger: Logger }) {\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(options?: ListOptions): 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 /**\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?: ListOptions,\n ): Promise<PagedResponse<T>> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n for (const key in options) {\n if (options[key]) {\n request.searchParams.append(key, options[key]!.toString());\n }\n }\n\n this.logger.debug(`Fetching: ${request.toString()}`);\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\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 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\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: ListOptions) => Promise<PagedResponse<T>>,\n options: ListOptions,\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","/*\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 CacheClient,\n CacheManager,\n PluginCacheManager,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n ScmIntegrationRegistry,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n LocationSpec,\n processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { GitLabClient, GitLabProject, paginated } from './lib';\n\n/**\n * Extracts repositories out of an GitLab instance.\n * @public\n */\nexport class GitLabDiscoveryProcessor implements CatalogProcessor {\n private readonly integrations: ScmIntegrationRegistry;\n private readonly logger: Logger;\n private readonly cache: CacheClient;\n\n static fromConfig(config: Config, options: { logger: Logger }) {\n const integrations = ScmIntegrations.fromConfig(config);\n const pluginCache =\n CacheManager.fromConfig(config).forPlugin('gitlab-discovery');\n\n return new GitLabDiscoveryProcessor({\n ...options,\n integrations,\n pluginCache,\n });\n }\n\n private constructor(options: {\n integrations: ScmIntegrationRegistry;\n pluginCache: PluginCacheManager;\n logger: Logger;\n }) {\n this.integrations = options.integrations;\n this.cache = options.pluginCache.getClient();\n this.logger = options.logger;\n }\n\n getProcessorName(): string {\n return 'GitLabDiscoveryProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'gitlab-discovery') {\n return false;\n }\n\n const { group, host, branch, catalogPath } = parseUrl(location.target);\n\n const integration = this.integrations.gitlab.byUrl(`https://${host}`);\n if (!integration) {\n throw new Error(\n `There is no GitLab integration that matches ${host}. Please add a configuration entry for it under integrations.gitlab`,\n );\n }\n\n const client = new GitLabClient({\n config: integration.config,\n logger: this.logger,\n });\n const startTimestamp = Date.now();\n this.logger.debug(`Reading GitLab projects from ${location.target}`);\n\n const projects = paginated(options => client.listProjects(options), {\n group,\n last_activity_after: await this.updateLastActivity(),\n page: 1,\n });\n\n const res: Result = {\n scanned: 0,\n matches: [],\n };\n for await (const project of projects) {\n res.scanned++;\n\n if (project.archived) {\n continue;\n }\n\n if (branch === '*' && project.default_branch === undefined) {\n continue;\n }\n\n res.matches.push(project);\n }\n\n for (const project of res.matches) {\n const project_branch = branch === '*' ? project.default_branch : branch;\n\n emit(\n processingResult.location({\n type: 'url',\n // The format expected by the GitLabUrlReader:\n // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n //\n // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.\n // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw\n // URL here won't work either.\n target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,\n presence: 'optional',\n }),\n );\n }\n\n const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n this.logger.debug(\n `Read ${res.scanned} GitLab repositories in ${duration} seconds`,\n );\n\n return true;\n }\n\n private async updateLastActivity(): Promise<string | undefined> {\n const cacheKey = `processors/${this.getProcessorName()}/last-activity`;\n const lastActivity = await this.cache.get(cacheKey);\n await this.cache.set(cacheKey, new Date().toISOString());\n return lastActivity as string | undefined;\n }\n}\n\ntype Result = {\n scanned: number;\n matches: GitLabProject[];\n};\n\n/*\n * Helpers\n */\n\nexport function parseUrl(urlString: string): {\n group?: string;\n host: string;\n branch: string;\n catalogPath: string;\n} {\n const url = new URL(urlString);\n const path = url.pathname.substr(1).split('/');\n\n // (/group/subgroup)/blob/branch|*/filepath\n const blobIndex = path.findIndex(p => p === 'blob');\n if (blobIndex !== -1 && path.length > blobIndex + 2) {\n const group =\n blobIndex > 0 ? path.slice(0, blobIndex).join('/') : undefined;\n\n return {\n group,\n host: url.host,\n branch: decodeURIComponent(path[blobIndex + 1]),\n catalogPath: decodeURIComponent(path.slice(blobIndex + 2).join('/')),\n };\n }\n\n throw new Error(`Failed to parse ${urlString}`);\n}\n"],"names":["fetch","getGitLabRequestOptions","ScmIntegrations","CacheManager","processingResult"],"mappings":";;;;;;;;;;;;;AAmCO,MAAM,YAAa,CAAA;AAAA,EAIxB,YAAY,OAA8D,EAAA;AACxE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAKA,aAAyB,GAAA;AACvB,IAAO,OAAA,IAAA,CAAK,OAAO,IAAS,KAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAAA,MAEM,aAAa,OAAoD,EAAA;AACrE,IAAA,IAAI,mCAAS,KAAO,EAAA;AAClB,MAAA,OAAO,KAAK,YACV,CAAA,CAAA,QAAA,EAAW,kBAAmB,CAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,KAAK,CAC5C,CAAA,SAAA,CAAA,EAAA;AAAA,QACK,GAAA,OAAA;AAAA,QACH,iBAAmB,EAAA,IAAA;AAAA,OAEvB,CAAA,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,CAAA,SAAA,CAAA,EAAa,OAAO,CAAA,CAAA;AAAA,GAC/C;AAAA,EAcM,MAAA,YAAA,CACJ,UACA,OAC2B,EAAA;AAC3B,IAAA,MAAM,UAAU,IAAI,GAAA,CAAI,GAAG,IAAK,CAAA,MAAA,CAAO,aAAa,QAAU,CAAA,CAAA,CAAA,CAAA;AAC9D,IAAA,KAAA,MAAW,OAAO,OAAS,EAAA;AACzB,MAAA,IAAI,QAAQ,GAAM,CAAA,EAAA;AAChB,QAAA,OAAA,CAAQ,aAAa,MAAO,CAAA,GAAA,EAAK,OAAQ,CAAA,GAAA,CAAA,CAAM,UAAU,CAAA,CAAA;AAAA,OAC3D;AAAA,KACF;AAEA,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAa,UAAA,EAAA,OAAA,CAAQ,UAAY,CAAA,CAAA,CAAA,CAAA;AACnD,IAAM,MAAA,QAAA,GAAW,MAAMA,yBACrB,CAAA,OAAA,CAAQ,UACR,EAAAC,mCAAA,CAAwB,IAAK,CAAA,MAAM,CACrC,CAAA,CAAA;AACA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,IAAI,MACR,CAAqC,kCAAA,EAAA,OAAA,CAAQ,UAC3C,CAAA,uBAAA,EAAA,QAAA,CAAS,MACL,CAAA,GAAA,EAAA,QAAA,CAAS,UACjB,CAAA,CAAA,CAAA,CAAA;AAAA,KACF;AACA,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,CAAA;AAEnD,MAAO,OAAA;AAAA,QACL,KAAA;AAAA,QACA,QAAU,EAAA,QAAA,GAAW,MAAO,CAAA,QAAQ,CAAI,GAAA,IAAA;AAAA,OAC1C,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAA;AAcA,gBAAA,SAAA,CACE,SACA,OACA,EAAA;AACA,EAAI,IAAA,GAAA,CAAA;AACJ,EAAG,GAAA;AACD,IAAM,GAAA,GAAA,MAAM,QAAQ,OAAO,CAAA,CAAA;AAC3B,IAAA,OAAA,CAAQ,OAAO,GAAI,CAAA,QAAA,CAAA;AACnB,IAAW,KAAA,MAAA,IAAA,IAAQ,IAAI,KAAO,EAAA;AAC5B,MAAM,MAAA,IAAA,CAAA;AAAA,KACR;AAAA,WACO,GAAI,CAAA,QAAA,EAAA;AACf;;AChGO,MAAM,wBAAqD,CAAA;AAAA,EAKzD,OAAA,UAAA,CAAW,QAAgB,OAA6B,EAAA;AAC7D,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,IAAA,MAAM,cACJC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,kBAAkB,CAAA,CAAA;AAE9D,IAAA,OAAO,IAAI,wBAAyB,CAAA;AAAA,MAC/B,GAAA,OAAA;AAAA,MACH,YAAA;AAAA,MACA,WAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAIjB,EAAA;AACD,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAK,IAAA,CAAA,KAAA,GAAQ,OAAQ,CAAA,WAAA,CAAY,SAAU,EAAA,CAAA;AAC3C,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AAAA,GACxB;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,0BAAA,CAAA;AAAA,GACT;AAAA,EAEM,MAAA,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,kBAAoB,EAAA;AACxC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,EAAE,KAAO,EAAA,IAAA,EAAM,QAAQ,WAAgB,EAAA,GAAA,QAAA,CAAS,SAAS,MAAM,CAAA,CAAA;AAErE,IAAA,MAAM,cAAc,IAAK,CAAA,YAAA,CAAa,MAAO,CAAA,KAAA,CAAM,WAAW,IAAM,CAAA,CAAA,CAAA,CAAA;AACpE,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAM,MAAA,IAAI,KACR,CAAA,CAAA,4CAAA,EAA+C,IACjD,CAAA,mEAAA,CAAA,CAAA,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,MAAA,GAAS,IAAI,YAAa,CAAA;AAAA,MAC9B,QAAQ,WAAY,CAAA,MAAA;AAAA,MACpB,QAAQ,IAAK,CAAA,MAAA;AAAA,KACd,CAAA,CAAA;AACD,IAAM,MAAA,cAAA,GAAiB,KAAK,GAAI,EAAA,CAAA;AAChC,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAAgC,6BAAA,EAAA,QAAA,CAAS,MAAQ,CAAA,CAAA,CAAA,CAAA;AAEnE,IAAA,MAAM,WAAW,SAAU,CAAA,CAAA,OAAA,KAAW,MAAO,CAAA,YAAA,CAAa,OAAO,CAAG,EAAA;AAAA,MAClE,KAAA;AAAA,MACA,mBAAA,EAAqB,MAAM,IAAA,CAAK,kBAAmB,EAAA;AAAA,MACnD,IAAM,EAAA,CAAA;AAAA,KACP,CAAA,CAAA;AAED,IAAA,MAAM,GAAc,GAAA;AAAA,MAClB,OAAS,EAAA,CAAA;AAAA,MACT,SAAS,EAAC;AAAA,KACZ,CAAA;AACA,IAAA,WAAA,MAAiB,WAAW,QAAU,EAAA;AACpC,MAAI,GAAA,CAAA,OAAA,EAAA,CAAA;AAEJ,MAAA,IAAI,QAAQ,QAAU,EAAA;AACpB,QAAA,SAAA;AAAA,OACF;AAEA,MAAA,IAAI,MAAW,KAAA,GAAA,IAAO,OAAQ,CAAA,cAAA,KAAmB,KAAW,CAAA,EAAA;AAC1D,QAAA,SAAA;AAAA,OACF;AAEA,MAAI,GAAA,CAAA,OAAA,CAAQ,KAAK,OAAO,CAAA,CAAA;AAAA,KAC1B;AAEA,IAAW,KAAA,MAAA,OAAA,IAAW,IAAI,OAAS,EAAA;AACjC,MAAA,MAAM,cAAiB,GAAA,MAAA,KAAW,GAAM,GAAA,OAAA,CAAQ,cAAiB,GAAA,MAAA,CAAA;AAEjE,MAAA,IAAA,CACEC,sCAAiB,QAAS,CAAA;AAAA,QACxB,IAAM,EAAA,KAAA;AAAA,QAON,MAAQ,EAAA,CAAA,EAAG,OAAQ,CAAA,OAAA,CAAA,QAAA,EAAkB,cAAkB,CAAA,CAAA,EAAA,WAAA,CAAA,CAAA;AAAA,QACvD,QAAU,EAAA,UAAA;AAAA,OACX,CACH,CAAA,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAa,CAAK,CAAA,IAAA,CAAA,GAAA,KAAQ,cAAkB,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AACjE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CACV,CAAQ,KAAA,EAAA,GAAA,CAAI,kCAAkC,QAChD,CAAA,QAAA,CAAA,CAAA,CAAA;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAAA,MAEc,kBAAkD,GAAA;AAC9D,IAAM,MAAA,QAAA,GAAW,CAAc,WAAA,EAAA,IAAA,CAAK,gBAAiB,EAAA,CAAA,cAAA,CAAA,CAAA;AACrD,IAAA,MAAM,YAAe,GAAA,MAAM,IAAK,CAAA,KAAA,CAAM,IAAI,QAAQ,CAAA,CAAA;AAClD,IAAM,MAAA,IAAA,CAAK,MAAM,GAAI,CAAA,QAAA,EAAU,IAAI,IAAK,EAAA,CAAE,aAAa,CAAA,CAAA;AACvD,IAAO,OAAA,YAAA,CAAA;AAAA,GACT;AACF,CAAA;AAWO,SAAA,QAAA,CAAkB,SAKvB,EAAA;AACA,EAAM,MAAA,GAAA,GAAM,IAAI,GAAA,CAAI,SAAS,CAAA,CAAA;AAC7B,EAAA,MAAM,OAAO,GAAI,CAAA,QAAA,CAAS,OAAO,CAAC,CAAA,CAAE,MAAM,GAAG,CAAA,CAAA;AAG7C,EAAA,MAAM,SAAY,GAAA,IAAA,CAAK,SAAU,CAAA,CAAA,CAAA,KAAK,MAAM,MAAM,CAAA,CAAA;AAClD,EAAA,IAAI,SAAc,KAAA,CAAA,CAAA,IAAM,IAAK,CAAA,MAAA,GAAS,YAAY,CAAG,EAAA;AACnD,IAAM,MAAA,KAAA,GACJ,SAAY,GAAA,CAAA,GAAI,IAAK,CAAA,KAAA,CAAM,GAAG,SAAS,CAAA,CAAE,IAAK,CAAA,GAAG,CAAI,GAAA,KAAA,CAAA,CAAA;AAEvD,IAAO,OAAA;AAAA,MACL,KAAA;AAAA,MACA,MAAM,GAAI,CAAA,IAAA;AAAA,MACV,MAAQ,EAAA,kBAAA,CAAmB,IAAK,CAAA,SAAA,GAAY,CAAE,CAAA,CAAA;AAAA,MAC9C,WAAA,EAAa,mBAAmB,IAAK,CAAA,KAAA,CAAM,YAAY,CAAC,CAAA,CAAE,IAAK,CAAA,GAAG,CAAC,CAAA;AAAA,KACrE,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,IAAI,KAAM,CAAA,CAAA,gBAAA,EAAmB,SAAW,CAAA,CAAA,CAAA,CAAA;AAChD;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/lib/client.ts","../src/GitLabDiscoveryProcessor.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 fetch from 'node-fetch';\nimport {\n getGitLabRequestOptions,\n GitLabIntegrationConfig,\n} from '@backstage/integration';\nimport { Logger } from 'winston';\n\nexport type ListOptions = {\n [key: string]: string | number | boolean | undefined;\n group?: string;\n per_page?: number | undefined;\n page?: number | undefined;\n};\n\nexport type PagedResponse<T> = {\n items: T[];\n nextPage?: number;\n};\n\nexport class GitLabClient {\n private readonly config: GitLabIntegrationConfig;\n private readonly logger: Logger;\n\n constructor(options: { config: GitLabIntegrationConfig; logger: Logger }) {\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(options?: ListOptions): 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 /**\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?: ListOptions,\n ): Promise<PagedResponse<T>> {\n const request = new URL(`${this.config.apiBaseUrl}${endpoint}`);\n for (const key in options) {\n if (options[key]) {\n request.searchParams.append(key, options[key]!.toString());\n }\n }\n\n this.logger.debug(`Fetching: ${request.toString()}`);\n const response = await fetch(\n request.toString(),\n getGitLabRequestOptions(this.config),\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 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\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: ListOptions) => Promise<PagedResponse<T>>,\n options: ListOptions,\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","/*\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 CacheClient,\n CacheManager,\n PluginCacheManager,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport {\n ScmIntegrationRegistry,\n ScmIntegrations,\n} from '@backstage/integration';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n LocationSpec,\n processingResult,\n} from '@backstage/plugin-catalog-backend';\nimport { Logger } from 'winston';\nimport { GitLabClient, GitLabProject, paginated } from './lib';\n\n/**\n * Extracts repositories out of an GitLab instance.\n * @public\n */\nexport class GitLabDiscoveryProcessor implements CatalogProcessor {\n private readonly integrations: ScmIntegrationRegistry;\n private readonly logger: Logger;\n private readonly cache: CacheClient;\n\n static fromConfig(config: Config, options: { logger: Logger }) {\n const integrations = ScmIntegrations.fromConfig(config);\n const pluginCache =\n CacheManager.fromConfig(config).forPlugin('gitlab-discovery');\n\n return new GitLabDiscoveryProcessor({\n ...options,\n integrations,\n pluginCache,\n });\n }\n\n private constructor(options: {\n integrations: ScmIntegrationRegistry;\n pluginCache: PluginCacheManager;\n logger: Logger;\n }) {\n this.integrations = options.integrations;\n this.cache = options.pluginCache.getClient();\n this.logger = options.logger;\n }\n\n getProcessorName(): string {\n return 'GitLabDiscoveryProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'gitlab-discovery') {\n return false;\n }\n\n const { group, host, branch, catalogPath } = parseUrl(location.target);\n\n const integration = this.integrations.gitlab.byUrl(`https://${host}`);\n if (!integration) {\n throw new Error(\n `There is no GitLab integration that matches ${host}. Please add a configuration entry for it under integrations.gitlab`,\n );\n }\n\n const client = new GitLabClient({\n config: integration.config,\n logger: this.logger,\n });\n const startTimestamp = Date.now();\n this.logger.debug(`Reading GitLab projects from ${location.target}`);\n\n const projects = paginated(options => client.listProjects(options), {\n group,\n last_activity_after: await this.updateLastActivity(),\n page: 1,\n });\n\n const res: Result = {\n scanned: 0,\n matches: [],\n };\n for await (const project of projects) {\n res.scanned++;\n\n if (project.archived) {\n continue;\n }\n\n if (branch === '*' && project.default_branch === undefined) {\n continue;\n }\n\n res.matches.push(project);\n }\n\n for (const project of res.matches) {\n const project_branch = branch === '*' ? project.default_branch : branch;\n\n emit(\n processingResult.location({\n type: 'url',\n // The format expected by the GitLabUrlReader:\n // https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath\n //\n // This unfortunately will trigger another API call in `getGitLabFileFetchUrl` to get the project ID.\n // The alternative is using the `buildRawUrl` function, which does not support subgroups, so providing a raw\n // URL here won't work either.\n target: `${project.web_url}/-/blob/${project_branch}/${catalogPath}`,\n presence: 'optional',\n }),\n );\n }\n\n const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n this.logger.debug(\n `Read ${res.scanned} GitLab repositories in ${duration} seconds`,\n );\n\n return true;\n }\n\n private async updateLastActivity(): Promise<string | undefined> {\n const cacheKey = `processors/${this.getProcessorName()}/last-activity`;\n const lastActivity = await this.cache.get(cacheKey);\n await this.cache.set(cacheKey, new Date().toISOString());\n return lastActivity as string | undefined;\n }\n}\n\ntype Result = {\n scanned: number;\n matches: GitLabProject[];\n};\n\n/*\n * Helpers\n */\n\nexport function parseUrl(urlString: string): {\n group?: string;\n host: string;\n branch: string;\n catalogPath: string;\n} {\n const url = new URL(urlString);\n const path = url.pathname.substr(1).split('/');\n\n // (/group/subgroup)/blob/branch|*/filepath\n const blobIndex = path.findIndex(p => p === 'blob');\n if (blobIndex !== -1 && path.length > blobIndex + 2) {\n const group =\n blobIndex > 0 ? path.slice(0, blobIndex).join('/') : undefined;\n\n return {\n group,\n host: url.host,\n branch: decodeURIComponent(path[blobIndex + 1]),\n catalogPath: decodeURIComponent(path.slice(blobIndex + 2).join('/')),\n };\n }\n\n throw new Error(`Failed to parse ${urlString}`);\n}\n"],"names":["fetch","getGitLabRequestOptions","ScmIntegrations","CacheManager","processingResult"],"mappings":";;;;;;;;;;;;;AAIO,MAAM,YAAY,CAAC;AAC1B,EAAE,WAAW,CAAC,OAAO,EAAE;AACvB,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACjC,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACjC,GAAG;AACH,EAAE,aAAa,GAAG;AAClB,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC;AAC7C,GAAG;AACH,EAAE,MAAM,YAAY,CAAC,OAAO,EAAE;AAC9B,IAAI,IAAI,OAAO,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE;AAClD,MAAM,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,kBAAkB,CAAC,OAAO,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,EAAE;AACnH,QAAQ,GAAG,OAAO;AAClB,QAAQ,iBAAiB,EAAE,IAAI;AAC/B,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;AACnD,GAAG;AACH,EAAE,MAAM,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE;AACxC,IAAI,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AACpE,IAAI,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;AAC/B,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE;AACxB,QAAQ,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAClE,OAAO;AACP,KAAK;AACL,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;AACzD,IAAI,MAAM,QAAQ,GAAG,MAAMA,yBAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAEC,mCAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;AAC3F,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;AACtB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kCAAkC,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,uBAAuB,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACnJ,KAAK;AACL,IAAI,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK;AAC3C,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAC3D,MAAM,OAAO;AACb,QAAQ,KAAK;AACb,QAAQ,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI;AACpD,OAAO,CAAC;AACR,KAAK,CAAC,CAAC;AACP,GAAG;AACH,CAAC;AACM,gBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE;AACnD,EAAE,IAAI,GAAG,CAAC;AACV,EAAE,GAAG;AACL,IAAI,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,IAAI,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC;AAChC,IAAI,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE;AAClC,MAAM,MAAM,IAAI,CAAC;AACjB,KAAK;AACL,GAAG,QAAQ,GAAG,CAAC,QAAQ,EAAE;AACzB;;ACzCO,MAAM,wBAAwB,CAAC;AACtC,EAAE,OAAO,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE;AACrC,IAAI,MAAM,YAAY,GAAGC,2BAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC5D,IAAI,MAAM,WAAW,GAAGC,0BAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;AACtF,IAAI,OAAO,IAAI,wBAAwB,CAAC;AACxC,MAAM,GAAG,OAAO;AAChB,MAAM,YAAY;AAClB,MAAM,WAAW;AACjB,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,WAAW,CAAC,OAAO,EAAE;AACvB,IAAI,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAC7C,IAAI,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;AACjD,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACjC,GAAG;AACH,EAAE,gBAAgB,GAAG;AACrB,IAAI,OAAO,0BAA0B,CAAC;AACtC,GAAG;AACH,EAAE,MAAM,YAAY,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE;AAChD,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,kBAAkB,EAAE;AAC9C,MAAM,OAAO,KAAK,CAAC;AACnB,KAAK;AACL,IAAI,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC3E,IAAI,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC1E,IAAI,IAAI,CAAC,WAAW,EAAE;AACtB,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,4CAA4C,EAAE,IAAI,CAAC,mEAAmE,CAAC,CAAC,CAAC;AAChJ,KAAK;AACL,IAAI,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC;AACpC,MAAM,MAAM,EAAE,WAAW,CAAC,MAAM;AAChC,MAAM,MAAM,EAAE,IAAI,CAAC,MAAM;AACzB,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;AACtC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,6BAA6B,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzE,IAAI,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;AAC1E,MAAM,KAAK;AACX,MAAM,mBAAmB,EAAE,MAAM,IAAI,CAAC,kBAAkB,EAAE;AAC1D,MAAM,IAAI,EAAE,CAAC;AACb,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,GAAG,GAAG;AAChB,MAAM,OAAO,EAAE,CAAC;AAChB,MAAM,OAAO,EAAE,EAAE;AACjB,KAAK,CAAC;AACN,IAAI,WAAW,MAAM,OAAO,IAAI,QAAQ,EAAE;AAC1C,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;AACpB,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC5B,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,IAAI,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,cAAc,KAAK,KAAK,CAAC,EAAE;AAC/D,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAChC,KAAK;AACL,IAAI,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,OAAO,EAAE;AACvC,MAAM,MAAM,cAAc,GAAG,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC;AAC9E,MAAM,IAAI,CAACC,qCAAgB,CAAC,QAAQ,CAAC;AACrC,QAAQ,IAAI,EAAE,KAAK;AACnB,QAAQ,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;AAC5E,QAAQ,QAAQ,EAAE,UAAU;AAC5B,OAAO,CAAC,CAAC,CAAC;AACV,KAAK;AACL,IAAI,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,wBAAwB,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxF,IAAI,OAAO,IAAI,CAAC;AAChB,GAAG;AACH,EAAE,MAAM,kBAAkB,GAAG;AAC7B,IAAI,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,cAAc,CAAC,CAAC;AAC3E,IAAI,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACxD,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,IAAI,OAAO,YAAY,CAAC;AACxB,GAAG;AACH,CAAC;AACM,SAAS,QAAQ,CAAC,SAAS,EAAE;AACpC,EAAE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;AACjC,EAAE,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACjD,EAAE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC;AACxD,EAAE,IAAI,SAAS,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,GAAG,CAAC,EAAE;AACvD,IAAI,MAAM,KAAK,GAAG,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;AAC9E,IAAI,OAAO;AACX,MAAM,KAAK;AACX,MAAM,IAAI,EAAE,GAAG,CAAC,IAAI;AACpB,MAAM,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;AACrD,MAAM,WAAW,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1E,KAAK,CAAC;AACN,GAAG;AACH,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAClD;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-gitlab",
3
3
  "description": "A Backstage catalog backend module that helps integrate towards GitLab",
4
- "version": "0.1.2-next.1",
4
+ "version": "0.1.3-next.1",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -33,12 +33,12 @@
33
33
  "start": "backstage-cli package start"
34
34
  },
35
35
  "dependencies": {
36
- "@backstage/backend-common": "^0.13.2-next.1",
37
- "@backstage/catalog-model": "^1.0.1-next.0",
38
- "@backstage/config": "^1.0.0",
36
+ "@backstage/backend-common": "^0.13.3-next.2",
37
+ "@backstage/catalog-model": "^1.0.2-next.0",
38
+ "@backstage/config": "^1.0.1-next.0",
39
39
  "@backstage/errors": "^1.0.0",
40
- "@backstage/integration": "^1.1.0-next.1",
41
- "@backstage/plugin-catalog-backend": "^1.1.0-next.1",
40
+ "@backstage/integration": "^1.2.0-next.1",
41
+ "@backstage/plugin-catalog-backend": "^1.1.2-next.2",
42
42
  "@backstage/types": "^1.0.0",
43
43
  "lodash": "^4.17.21",
44
44
  "msw": "^0.35.0",
@@ -46,12 +46,12 @@
46
46
  "winston": "^3.2.1"
47
47
  },
48
48
  "devDependencies": {
49
- "@backstage/backend-test-utils": "^0.1.23-next.1",
50
- "@backstage/cli": "^0.17.0-next.1",
49
+ "@backstage/backend-test-utils": "^0.1.24-next.1",
50
+ "@backstage/cli": "^0.17.1-next.2",
51
51
  "@types/lodash": "^4.14.151"
52
52
  },
53
53
  "files": [
54
54
  "dist"
55
55
  ],
56
- "gitHead": "57d12dcc35aeb6c33b09e51d1efc3408c574f109"
56
+ "gitHead": "cfbf5762d7d91eee18999306b21d63840400ee29"
57
57
  }